FriendsOfSymfony / FOSHttpCache

src/Test/NginxTest.php

<?php

/*
 * This file is part of the FOSHttpCache package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\HttpCache\Test;

use FOS\HttpCache\ProxyClient\HttpDispatcher;
use FOS\HttpCache\ProxyClient\Nginx;
use FOS\HttpCache\Test\Proxy\NginxProxy;

/**
 * Starts and clears the NGINX proxy between tests.
 *
 * You can define constants in your phpunit.xml to control how this test behaves.
 *
 * Note that the WEB_SERVER_HOSTNAME must also match with what you have in your
 * NGINX configuration file.
 *
 * To define constants in the phpunit file, use this syntax:
 * <php>
 *     <const name="NGINX_FILE" value="./tests/FOS/HttpCache/Tests/Functional/Fixtures/nginx/fos.conf" />
 * </php>
 *
 * NGINX_FILE          NGINX configuration file (required if not passed to setUp)
 * NGINX_BINARY        Executable for NGINX. This can also be the full path
 *                     to the file if the binary is not automatically found
 *                     (default nginx)
 * NGINX_PORT          Port NGINX listens to (default 8088)
 * NGINX_CACHE_PATH    directory to use for cache
 *                     Must match `proxy_cache_path` directive in
 *                     your configuration file.
 *                     (default sys_get_temp_dir() + '/foshttpcache-nginx')
 * WEB_SERVER_HOSTNAME hostname where your application can be reached (required)
 */
trait NginxTest
{
    /**
     * @var Nginx
     */
    protected $proxyClient;

    /**
     * @var NginxProxy
     */
    protected $proxy;

    protected function setUp(): void
    {
        $this->getProxy()->clear();
    }

    protected function tearDown(): void
    {
        $this->getProxy()->stop();
    }

    /**
     * The default implementation looks at the constant NGINX_FILE.
     *
     * @throws \Exception
     *
     * @return string the path to the NGINX server configuration file to use with this test
     */
    protected function getConfigFile()
    {
        // @codeCoverageIgnoreStart
        if (!defined('NGINX_FILE')) {
            throw new \Exception(
                'Specify the NGINX'
                .' configuration file path in phpunit.xml or override getConfigFile()'
            );
        }
        // @codeCoverageIgnoreEnd

        // NGINX needs an absolute path
        return realpath(NGINX_FILE);

The constant FOS\HttpCache\Test\NGINX_FILE was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * Defaults to "nginx".
     *
     * @return string
     */
    protected function getBinary()
    {
        return defined('NGINX_BINARY') ? NGINX_BINARY : null;

The constant FOS\HttpCache\Test\NGINX_BINARY was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * Defaults to 8088.
     *
     * @return int
     */
    protected function getCachingProxyPort()
    {
        return defined('NGINX_PORT') ? NGINX_PORT : 8088;

The constant FOS\HttpCache\Test\NGINX_PORT was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * Get NGINX cache directory.
     */
    protected function getCacheDir()
    {
        return defined('NGINX_CACHE_PATH') ? NGINX_CACHE_PATH : null;

The constant FOS\HttpCache\Test\NGINX_CACHE_PATH was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * Get the hostname where your application can be reached.
     *
     * @throws \Exception
     *
     * @return string
     */
    protected function getHostName()
    {
        // @codeCoverageIgnoreStart
        if (!defined('WEB_SERVER_HOSTNAME')) {
            throw new \Exception(
                'To use this test, you need to define the WEB_SERVER_HOSTNAME constant in your phpunit.xml'
            );
        }
        // @codeCoverageIgnoreEnd

        return WEB_SERVER_HOSTNAME;

The constant FOS\HttpCache\Test\WEB_SERVER_HOSTNAME was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * @return NginxProxy
     */
    protected function getProxy()
    {
        if (null === $this->proxy) {
            $this->proxy = new NginxProxy($this->getConfigFile());
            $this->proxy->setPort($this->getCachingProxyPort());

            if ($this->getBinary()) {
                $this->proxy->setBinary($this->getBinary());
            }

            if ($this->getCacheDir()) {
                $this->proxy->setCacheDir($this->getCacheDir());
            }
        }

        return $this->proxy;
    }

    /**
     * Get proxy client.
     *
     * @param string $purgeLocation Optional purgeLocation
     *
     * @return Nginx
     */
    protected function getProxyClient($purgeLocation = '')
    {
        if (null === $this->proxyClient) {
            $httpDispatcher = new HttpDispatcher(
                ['http://127.0.0.1:'.$this->getCachingProxyPort()],
                $this->getHostName().':'.$this->getCachingProxyPort()
            );

            $this->proxyClient = new Nginx($httpDispatcher, [
                'purge_location' => $purgeLocation,
            ]);
        }

        return $this->proxyClient;
    }
}