class DrupalKernelTest

Same name in this branch
  1. 8.9.x core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\KernelTests\Core\DrupalKernel\DrupalKernelTest
Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\KernelTests\Core\DrupalKernel\DrupalKernelTest
  2. 9 core/tests/Drupal/Tests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\Tests\Core\DrupalKernel\DrupalKernelTest
  3. 10 core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\KernelTests\Core\DrupalKernel\DrupalKernelTest
  4. 10 core/tests/Drupal/Tests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\Tests\Core\DrupalKernel\DrupalKernelTest
  5. 11.x core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\KernelTests\Core\DrupalKernel\DrupalKernelTest
  6. 11.x core/tests/Drupal/Tests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\Tests\Core\DrupalKernel\DrupalKernelTest

@coversDefaultClass \Drupal\Core\DrupalKernel @group DrupalKernel

Hierarchy

Expanded class hierarchy of DrupalKernelTest

File

core/tests/Drupal/Tests/Core/DrupalKernel/DrupalKernelTest.php, line 15

Namespace

Drupal\Tests\Core\DrupalKernel
View source
class DrupalKernelTest extends UnitTestCase {
    
    /**
     * Tests hostname validation with settings.
     *
     * @covers ::setupTrustedHosts
     * @dataProvider providerTestTrustedHosts
     */
    public function testTrustedHosts($host, $server_name, $message, $expected = FALSE) {
        $request = new Request();
        $trusted_host_patterns = [
            '^example\\.com$',
            '^.+\\.example\\.com$',
            '^example\\.org',
            '^.+\\.example\\.org',
        ];
        if (!empty($host)) {
            $request->headers
                ->set('HOST', $host);
        }
        $request->server
            ->set('SERVER_NAME', $server_name);
        $method = new \ReflectionMethod('Drupal\\Core\\DrupalKernel', 'setupTrustedHosts');
        $method->setAccessible(TRUE);
        $valid_host = $method->invoke(NULL, $request, $trusted_host_patterns);
        $this->assertSame($expected, $valid_host, $message);
        // Reset the trusted hosts because it is statically stored on the request.
        $method->invoke(NULL, $request, []);
        // Reset the request factory because it is statically stored on the request.
        Request::setFactory(NULL);
    }
    
    /**
     * Tests the reregistration of autoloaders if APCu available.
     *
     * This test runs in a separate process since it registers class loaders and
     * results in statics being set.
     *
     * @runInSeparateProcess
     * @preserveGlobalState disabled
     * @requires function apcu_fetch
     * @covers ::initializeSettings
     */
    public function testInitializeSettings() {
        $request = new Request();
        $classloader = new fakeAutoloader();
        // Create a kernel suitable for testing.
        $kernel = $this->getMockBuilder(DrupalKernel::class)
            ->disableOriginalConstructor()
            ->setMethods([
            'do_not_mock_any_methods',
        ])
            ->getMock();
        $classloader_property = new \ReflectionProperty($kernel, 'classLoader');
        $classloader_property->setAccessible(TRUE);
        $classloader_property->setValue($kernel, $classloader);
        $method = new \ReflectionMethod($kernel, 'initializeSettings');
        $method->setAccessible(TRUE);
        // Prepend another autoloader to simulate Drush's autoloader.
        $fake_drush_autoloader = function () {
            return NULL;
        };
        spl_autoload_register($fake_drush_autoloader, TRUE, TRUE);
        // Before calling DrupalKernel::initializeSettings() the first autoloader
        // is the fake Drush autoloader.
        $this->assertSame($fake_drush_autoloader, spl_autoload_functions()[0]);
        // Call DrupalKernel::initializeSettings() to simulate part of a Drupal
        // bootstrap. During the include of autoload.php Composer would prepend
        // Drupal's autoloader and then this method should not result in Drush's
        // autoloader becoming the first autoloader even if it swaps out
        // Composer's autoloader for an optimised one.
        $method->invoke($kernel, $request);
        $autoloaders = spl_autoload_functions();
        // The first autoloader should be the APCu based autoloader.
        $this->assertInstanceOf(ApcClassLoader::class, $autoloaders[0][0]);
        // The second autoloader should be the original autoloader the kernel was
        // constructed with.
        $this->assertSame($classloader, $autoloaders[1][0]);
        // The third autoloader should be Drush's autoloader.
        $this->assertSame($fake_drush_autoloader, $autoloaders[2]);
        // Reset the request factory because it is statically stored on the
        // request.
        Request::setFactory(NULL);
    }
    
    /**
     * Provides test data for testTrustedHosts().
     */
    public function providerTestTrustedHosts() {
        $data = [];
        // Tests canonical URL.
        $data[] = [
            'www.example.com',
            'www.example.com',
            'canonical URL is trusted',
            TRUE,
        ];
        // Tests missing hostname for HTTP/1.0 compatibility where the Host
        // header is optional.
        $data[] = [
            NULL,
            'www.example.com',
            'empty Host is valid',
            TRUE,
        ];
        // Tests the additional patterns from the settings.
        $data[] = [
            'example.com',
            'www.example.com',
            'host from settings is trusted',
            TRUE,
        ];
        $data[] = [
            'subdomain.example.com',
            'www.example.com',
            'host from settings is trusted',
            TRUE,
        ];
        $data[] = [
            'www.example.org',
            'www.example.com',
            'host from settings is trusted',
            TRUE,
        ];
        $data[] = [
            'example.org',
            'www.example.com',
            'host from settings is trusted',
            TRUE,
        ];
        // Tests mismatch.
        $data[] = [
            'www.blackhat.com',
            'www.example.com',
            'unspecified host is untrusted',
            FALSE,
        ];
        return $data;
    }
    
    /**
     * Tests site path finding.
     *
     * This test is run in a separate process since it defines DRUPAL_ROOT. This
     * stops any possible pollution of other tests.
     *
     * @covers ::findSitePath
     * @runInSeparateProcess
     */
    public function testFindSitePath() {
        $vfs_root = vfsStream::setup('drupal_root');
        $sites_php = <<<'EOD'
<?php
$sites['8888.www.example.org'] = 'example';
EOD;
        // Create the expected directory structure.
        vfsStream::create([
            'sites' => [
                'sites.php' => $sites_php,
                'example' => [
                    'settings.php' => 'test',
                ],
            ],
        ]);
        $request = new Request();
        $request->server
            ->set('SERVER_NAME', 'www.example.org');
        $request->server
            ->set('SERVER_PORT', '8888');
        $request->server
            ->set('SCRIPT_NAME', '/index.php');
        $this->assertEquals('sites/example', DrupalKernel::findSitePath($request, TRUE, $vfs_root->url('drupal_root')));
        $this->assertEquals('sites/example', DrupalKernel::findSitePath($request, FALSE, $vfs_root->url('drupal_root')));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overrides
DrupalKernelTest::providerTestTrustedHosts public function Provides test data for testTrustedHosts().
DrupalKernelTest::testFindSitePath public function Tests site path finding.
DrupalKernelTest::testInitializeSettings public function Tests the reregistration of autoloaders if APCu available.
DrupalKernelTest::testTrustedHosts public function Tests hostname validation with settings.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated protected function Mocks a block with a block plugin. 1
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.
UnitTestCase::setUp protected function 340

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.