class DrupalKernelTest

Same name in this branch
  1. 11.x core/tests/Drupal/Tests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\Tests\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. 8.9.x core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\KernelTests\Core\DrupalKernel\DrupalKernelTest
  4. 8.9.x core/tests/Drupal/Tests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\Tests\Core\DrupalKernel\DrupalKernelTest
  5. 10 core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\KernelTests\Core\DrupalKernel\DrupalKernelTest
  6. 10 core/tests/Drupal/Tests/Core/DrupalKernel/DrupalKernelTest.php \Drupal\Tests\Core\DrupalKernel\DrupalKernelTest

Tests DIC compilation to disk.

@group DrupalKernel @coversDefaultClass \Drupal\Core\DrupalKernel

Hierarchy

Expanded class hierarchy of DrupalKernelTest

File

core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php, line 24

Namespace

Drupal\KernelTests\Core\DrupalKernel
View source
class DrupalKernelTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function tearDown() : void {
        $currentErrorHandler = Error::currentErrorHandler();
        if (is_string($currentErrorHandler) && $currentErrorHandler === '_drupal_error_handler') {
            restore_error_handler();
        }
        parent::tearDown();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function bootKernel() : void {
        // Do not boot the kernel, because we are testing aspects of this process.
    }
    
    /**
     * Build a kernel for testings.
     *
     * Because the bootstrap is in DrupalKernel::boot and that involved loading
     * settings from the filesystem we need to go to extra lengths to build a kernel
     * for testing.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   A request object to use in booting the kernel.
     * @param array $modules_enabled
     *   A list of modules to install on the kernel.
     *
     * @return \Drupal\Core\DrupalKernel
     *   New kernel for testing.
     */
    protected function getTestKernel(Request $request, ?array $modules_enabled = NULL) {
        // Manually create kernel to avoid replacing settings.
        $class_loader = (require $this->root . '/autoload.php');
        $kernel = DrupalKernel::createFromRequest($request, $class_loader, 'testing');
        $this->setSetting('container_yamls', []);
        $this->setSetting('hash_salt', $this->databasePrefix);
        if (isset($modules_enabled)) {
            $kernel->updateModules($modules_enabled);
        }
        $kernel->boot();
        return $kernel;
    }
    
    /**
     * Tests DIC compilation.
     */
    public function testCompileDIC() : void {
        // @todo Write a memory based storage backend for testing.
        $modules_enabled = [
            'system' => 'system',
            'user' => 'user',
        ];
        $request = Request::createFromGlobals();
        $this->getTestKernel($request, $modules_enabled);
        // Instantiate it a second time and we should get the compiled Container
        // class.
        $kernel = $this->getTestKernel($request);
        $container = $kernel->getContainer();
        $refClass = new \ReflectionClass($container);
        $is_compiled_container = !$refClass->isSubclassOf('Symfony\\Component\\DependencyInjection\\ContainerBuilder');
        $this->assertTrue($is_compiled_container);
        // Verify that the list of modules is the same for the initial and the
        // compiled container.
        $module_list = array_keys($container->get('module_handler')
            ->getModuleList());
        $this->assertEquals(array_values($modules_enabled), $module_list);
        // Get the container another time, simulating a "production" environment.
        $container = $this->getTestKernel($request, NULL)
            ->getContainer();
        $refClass = new \ReflectionClass($container);
        $is_compiled_container = !$refClass->isSubclassOf('Symfony\\Component\\DependencyInjection\\ContainerBuilder');
        $this->assertTrue($is_compiled_container);
        // Verify that the list of modules is the same for the initial and the
        // compiled container.
        $module_list = array_keys($container->get('module_handler')
            ->getModuleList());
        $this->assertEquals(array_values($modules_enabled), $module_list);
        // Test that our synthetic services are there.
        $class_loader = $container->get('class_loader');
        $refClass = new \ReflectionClass($class_loader);
        $this->assertTrue($refClass->hasMethod('loadClass'), 'Container has a class loader');
        // We make this assertion here purely to show that the new container below
        // is functioning correctly, i.e. we get a brand new ContainerBuilder
        // which has the required new services, after changing the list of enabled
        // modules.
        $this->assertFalse($container->has('service_provider_test_class'));
        // Add another module so that we can test that the new module's bundle is
        // registered to the new container.
        $modules_enabled['service_provider_test'] = 'service_provider_test';
        $this->getTestKernel($request, $modules_enabled);
        // Instantiate it a second time and we should not get a ContainerBuilder
        // class because we are loading the container definition from cache.
        $kernel = $this->getTestKernel($request, $modules_enabled);
        $container = $kernel->getContainer();
        $refClass = new \ReflectionClass($container);
        $is_container_builder = $refClass->isSubclassOf('Symfony\\Component\\DependencyInjection\\ContainerBuilder');
        $this->assertFalse($is_container_builder, 'Container is not a builder');
        // Assert that the new module's bundle was registered to the new container.
        $this->assertTrue($container->has('service_provider_test_class'), 'Container has test service');
        // Test that our synthetic services are there.
        $class_loader = $container->get('class_loader');
        $refClass = new \ReflectionClass($class_loader);
        $this->assertTrue($refClass->hasMethod('loadClass'), 'Container has a class loader');
        // Check that the location of the new module is registered.
        $modules = $container->getParameter('container.modules');
        $module_extension_list = $container->get('extension.list.module');
        $this->assertEquals([
            'type' => 'module',
            'pathname' => $module_extension_list->getPathname('service_provider_test'),
            'filename' => NULL,
        ], $modules['service_provider_test']);
        // Check that the container itself is not among the persist IDs because it
        // does not make sense to persist the container itself.
        $persist_ids = $container->getParameter('persist_ids');
        $this->assertNotContains('service_container', $persist_ids);
    }
    
    /**
     * Tests repeated loading of compiled DIC with different environment.
     */
    public function testRepeatedBootWithDifferentEnvironment() : void {
        $request = Request::createFromGlobals();
        $class_loader = (require $this->root . '/autoload.php');
        $environments = [
            'testing1',
            'testing1',
            'testing2',
            'testing2',
        ];
        foreach ($environments as $environment) {
            $kernel = DrupalKernel::createFromRequest($request, $class_loader, $environment);
            $this->setSetting('container_yamls', []);
            $this->setSetting('hash_salt', $this->databasePrefix);
            $this->assertInstanceOf(DrupalKernelInterface::class, $kernel->boot(), "Environment {$environment} should boot.");
        }
    }
    
    /**
     * Tests setting of site path after kernel boot.
     */
    public function testPreventChangeOfSitePath() : void {
        // @todo Write a memory based storage backend for testing.
        $modules_enabled = [
            'system' => 'system',
            'user' => 'user',
        ];
        $request = Request::createFromGlobals();
        $kernel = $this->getTestKernel($request, $modules_enabled);
        $pass = FALSE;
        try {
            $kernel->setSitePath('/dev/null');
        } catch (\LogicException) {
            $pass = TRUE;
        }
        $this->assertTrue($pass, 'Throws LogicException if DrupalKernel::setSitePath() is called after boot');
        // Ensure no LogicException if DrupalKernel::setSitePath() is called with
        // identical path after boot.
        $path = $kernel->getSitePath();
        $kernel->setSitePath($path);
    }
    
    /**
     * Data provider for self::testClassLoaderAutoDetect.
     * @return array
     */
    public static function providerClassLoaderAutoDetect() {
        return [
            'TRUE' => [
                TRUE,
            ],
            'FALSE' => [
                FALSE,
            ],
        ];
    }
    
    /**
     * Tests class_loader_auto_detect setting.
     *
     * This test runs in a separate process since it registers class loaders and
     * results in statics being set.
     *
     * @runInSeparateProcess
     * @preserveGlobalState disabled
     * @covers ::boot
     * @dataProvider providerClassLoaderAutoDetect
     *
     * @param bool $value
     *   The value to set class_loader_auto_detect to.
     */
    public function testClassLoaderAutoDetect($value) : void {
        // Create a virtual file system containing items that should be
        // excluded. Exception being modules directory.
        vfsStream::setup('root', NULL, [
            'sites' => [
                'default' => [],
            ],
            'core' => [
                'lib' => [
                    'Drupal' => [
                        'Core' => [],
                        'Component' => [],
                    ],
                ],
            ],
        ]);
        $this->setSetting('class_loader_auto_detect', $value);
        $classloader = $this->prophesize(ClassLoader::class);
        // Assert that we call the setApcuPrefix on the classloader if
        // class_loader_auto_detect is set to TRUE;
        if ($value) {
            $classloader->setApcuPrefix(Argument::type('string'))
                ->shouldBeCalled();
        }
        else {
            $classloader->setApcuPrefix(Argument::type('string'))
                ->shouldNotBeCalled();
        }
        // Create a kernel suitable for testing.
        $kernel = new DrupalKernel('test', $classloader->reveal(), FALSE, vfsStream::url('root'));
        $kernel->setSitePath(vfsStream::url('root/sites/default'));
        $kernel->boot();
    }
    
    /**
     * @covers ::resetContainer
     */
    public function testResetContainer() : void {
        $modules_enabled = [
            'system' => 'system',
            'user' => 'user',
        ];
        $request = Request::createFromGlobals();
        $kernel = $this->getTestKernel($request, $modules_enabled);
        $container = $kernel->getContainer();
        // Ensure services are reset when ::resetContainer is called.
        $this->assertFalse($container->initialized('renderer'));
        $renderer = $container->get('renderer');
        $this->assertTrue($container->initialized('renderer'));
        // Ensure the current user is maintained through a container reset.
        $this->assertSame(0, $container->get('current_user')
            ->id());
        $container->get('current_user')
            ->setInitialAccountId(2);
        // Ensure messages are maintained through a container reset.
        $this->assertEmpty($container->get('messenger')
            ->messagesByType('Container reset'));
        $container->get('messenger')
            ->addMessage('Test reset', 'Container reset');
        $this->assertSame([
            'Test reset',
        ], $container->get('messenger')
            ->messagesByType('Container reset'));
        // Ensure persisted services are persisted.
        $request_stack = $container->get('request_stack');
        $kernel->resetContainer();
        // Ensure services are reset when ::resetContainer is called.
        $this->assertFalse($container->initialized('renderer'));
        $this->assertNotSame($renderer, $container->get('renderer'));
        $this->assertTrue($container->initialized('renderer'));
        $this->assertSame($kernel, $container->get('kernel'));
        // Ensure the current user is maintained through a container reset.
        $this->assertSame(2, $container->get('current_user')
            ->id());
        // Ensure messages are maintained through a container reset.
        $this->assertSame([
            'Test reset',
        ], $container->get('messenger')
            ->messagesByType('Container reset'));
        // Ensure persisted services are persisted.
        $this->assertSame($request_stack, $container->get('request_stack'));
    }
    
    /**
     * Tests system locale.
     */
    public function testLocale() : void {
        $utf8_string = 'äöüßαβγδεζηθικλμνξοσὠ';
        // Test environment locale should be UTF-8.
        $this->assertSame($utf8_string, escapeshellcmd($utf8_string));
        $request = Request::createFromGlobals();
        $kernel = $this->getTestKernel($request);
        // Kernel environment locale should be UTF-8.
        $this->assertSame($utf8_string, escapeshellcmd($utf8_string));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds Deprecated protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern Deprecated protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
DrupalKernelTest::bootKernel protected function Bootstraps a kernel for a test. Overrides KernelTestBase::bootKernel
DrupalKernelTest::getTestKernel protected function Build a kernel for testings.
DrupalKernelTest::providerClassLoaderAutoDetect public static function Data provider for self::testClassLoaderAutoDetect.
DrupalKernelTest::tearDown protected function Overrides KernelTestBase::tearDown
DrupalKernelTest::testClassLoaderAutoDetect public function Tests class_loader_auto_detect setting.
DrupalKernelTest::testCompileDIC public function Tests DIC compilation.
DrupalKernelTest::testLocale public function Tests system locale.
DrupalKernelTest::testPreventChangeOfSitePath public function Tests setting of site path after kernel boot.
DrupalKernelTest::testRepeatedBootWithDifferentEnvironment public function Tests repeated loading of compiled DIC with different environment.
DrupalKernelTest::testResetContainer public function @covers ::resetContainer
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$modules protected static property Modules to install. 566
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 2
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 28
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUp protected function 412
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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