zenstruck / browser

src/Browser/Test/HasBrowser.php

<?php

namespace Zenstruck\Browser\Test;

use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Component\BrowserKit\HttpBrowser as HttpBrowserClient;
use Symfony\Component\Panther\Client as PantherClient;
use Symfony\Component\Panther\PantherTestCase;
use Zenstruck\Browser\HttpBrowser;
use Zenstruck\Browser\KernelBrowser;
use Zenstruck\Browser\PantherBrowser;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
trait HasBrowser
{
    /** @var HttpBrowserClient[] */
    private static array $httpBrowserClients = [];
    private static ?PantherClient $primaryPantherClient = null;

    /**
     * @internal
     * @after
     */
    final public static function _resetBrowserClients(): void
    {
        self::$httpBrowserClients = [];
        self::$primaryPantherClient = null;
    }

    protected function pantherBrowser(array $options = [], array $kernelOptions = [], array $managerOptions = []): PantherBrowser
    {
        $class = $_SERVER['PANTHER_BROWSER_CLASS'] ?? PantherBrowser::class;

        if (!\is_a($class, PantherBrowser::class, true)) {
            throw new \RuntimeException(\sprintf('"PANTHER_BROWSER_CLASS" env variable must reference a class that extends %s.', PantherBrowser::class));
        }

        if (self::$primaryPantherClient) {
            $browser = new $class(static::createAdditionalPantherClient());
        } else {
            self::$primaryPantherClient = static::createPantherClient(
                \array_merge(['browser' => $_SERVER['PANTHER_BROWSER'] ?? static::CHROME], $options),

The constant Zenstruck\Browser\Test\HasBrowser::CHROME was not found. Maybe you did not declare it correctly or list all dependencies?

                $kernelOptions,
                $managerOptions
            );

            $browser = new $class(self::$primaryPantherClient);
        }

        BrowserExtension::registerBrowser($browser);

        return $browser
            ->setSourceDir($_SERVER['BROWSER_SOURCE_DIR'] ?? './var/browser/source')
            ->setScreenshotDir($_SERVER['BROWSER_SCREENSHOT_DIR'] ?? './var/browser/screenshots')
            ->setConsoleLogDir($_SERVER['BROWSER_CONSOLE_LOG_DIR'] ?? './var/browser/console-logs')
        ;
    }

    protected function httpBrowser(array $kernelOptions = [], array $pantherOptions = []): HttpBrowser
    {
        $class = $_SERVER['HTTP_BROWSER_CLASS'] ?? HttpBrowser::class;

        if (!\is_a($class, HttpBrowser::class, true)) {
            throw new \RuntimeException(\sprintf('"HTTP_BROWSER_CLASS" env variable must reference a class that extends %s.', HttpBrowser::class));
        }

        $baseUri = $_SERVER['HTTP_BROWSER_URI'] ?? null;

        if (!$baseUri && !$this instanceof PantherTestCase) {
            throw new \RuntimeException(\sprintf('If not using "HTTP_BROWSER_URI", your TestCase must extend "%s".', PantherTestCase::class));
        }

        if (!$baseUri) {
            self::startWebServer($pantherOptions);

            $baseUri = self::$baseUri;
        }

        // copied from PantherTestCaseTrait::createHttpBrowserClient()
        $client = new HttpBrowserClient();
        $urlComponents = \parse_url($baseUri);
        $host = $urlComponents['host'];

        if (isset($urlComponents['port'])) {
            $host .= ":{$urlComponents['port']}";
        }

        $client->setServerParameter('HTTP_HOST', $host);

        if ('https' === ($urlComponents['scheme'] ?? 'http')) {
            $client->setServerParameter('HTTPS', 'true');
        }

        $browser = new $class(self::$httpBrowserClients[] = $client);

        if ($this instanceof KernelTestCase) {
            if (!static::$booted) {

The property booted is declared protected in Symfony\Bundle\FrameworkBundle\Test\KernelTestCase and cannot be accessed from this context.

                static::bootKernel($kernelOptions);
            }

            $container = \method_exists(static::class, 'getContainer') ? static::getContainer() : static::$container;

The property container is declared protected in Symfony\Bundle\FrameworkBundle\Test\KernelTestCase and cannot be accessed from this context.

            if ($container->has('profiler')) {
                $browser->setProfiler($container->get('profiler'));
            }
        }

        BrowserExtension::registerBrowser($browser);

        return $browser
            ->setSourceDir($_SERVER['BROWSER_SOURCE_DIR'] ?? './var/browser/source')
        ;
    }

    protected function browser(array $kernelOptions = [], array $server = []): KernelBrowser
    {
        if (!$this instanceof KernelTestCase) {
            throw new \RuntimeException(\sprintf('The "%s" method can only be used on TestCases that extend "%s".', __METHOD__, KernelTestCase::class));
        }

        $class = $_SERVER['KERNEL_BROWSER_CLASS'] ?? KernelBrowser::class;

        if (!\is_a($class, KernelBrowser::class, true)) {
            throw new \RuntimeException(\sprintf('"KERNEL_BROWSER_CLASS" env variable must reference a class that extends %s.', KernelBrowser::class));
        }

        if ($this instanceof WebTestCase) {
            static::ensureKernelShutdown();

            $browser = new $class(static::createClient($kernelOptions, $server));
        } else {
            // reboot kernel before starting browser
            static::bootKernel($kernelOptions);

            $container = \method_exists(static::class, 'getContainer') ? static::getContainer() : static::$container;

The property container is declared protected in Symfony\Bundle\FrameworkBundle\Test\KernelTestCase and cannot be accessed from this context.

            if (!$container->has('test.client')) {
                throw new \RuntimeException('The Symfony test client is not enabled.');
            }

            $client = $container->get('test.client');
            $client->setServerParameters($server);

            $browser = new $class($client);
        }

        BrowserExtension::registerBrowser($browser);

        return $browser
            ->setSourceDir($_SERVER['BROWSER_SOURCE_DIR'] ?? './var/browser/source')
        ;
    }
}