class RecipeRunnerTest

Same name and namespace in other branches
  1. 10 core/tests/Drupal/KernelTests/Core/Recipe/RecipeRunnerTest.php \Drupal\KernelTests\Core\Recipe\RecipeRunnerTest

@coversDefaultClass \Drupal\Core\Recipe\RecipeRunner @group Recipe

Hierarchy

Expanded class hierarchy of RecipeRunnerTest

File

core/tests/Drupal/KernelTests/Core/Recipe/RecipeRunnerTest.php, line 21

Namespace

Drupal\KernelTests\Core\Recipe
View source
class RecipeRunnerTest extends KernelTestBase {
    use RecipeTestTrait;
    public function testModuleInstall() : void {
        // Test the state prior to applying the recipe.
        $this->assertFalse($this->container
            ->get('module_handler')
            ->moduleExists('filter'), 'The filter module is not installed');
        $this->assertFalse($this->container
            ->get('module_handler')
            ->moduleExists('text'), 'The text module is not installed');
        $this->assertFalse($this->container
            ->get('module_handler')
            ->moduleExists('node'), 'The node module is not installed');
        $this->assertFalse($this->container
            ->get('config.storage')
            ->exists('node.settings'), 'The node.settings configuration does not exist');
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/install_two_modules');
        RecipeRunner::processRecipe($recipe);
        // Test the state after applying the recipe.
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('filter'), 'The filter module is installed');
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('text'), 'The text module is installed');
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('node'), 'The node module is installed');
        $this->assertTrue($this->container
            ->get('config.storage')
            ->exists('node.settings'), 'The node.settings configuration has been created');
        $this->assertFalse($this->config('node.settings')
            ->get('use_admin_theme'), 'The node.settings:use_admin_theme is set to FALSE');
    }
    public function testModuleAndThemeInstall() : void {
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/base_theme_and_views');
        RecipeRunner::processRecipe($recipe);
        // Test the state after applying the recipe.
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('views'), 'The views module is installed');
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('node'), 'The node module is installed');
        $this->assertTrue($this->container
            ->get('theme_handler')
            ->themeExists('test_basetheme'), 'The test_basetheme theme is installed');
        $this->assertTrue($this->container
            ->get('theme_handler')
            ->themeExists('test_subtheme'), 'The test_subtheme theme is installed');
        $this->assertTrue($this->container
            ->get('theme_handler')
            ->themeExists('test_subsubtheme'), 'The test_subsubtheme theme is installed');
        $this->assertTrue($this->container
            ->get('config.storage')
            ->exists('node.settings'), 'The node.settings configuration has been created');
        $this->assertFalse($this->container
            ->get('config.storage')
            ->exists('views.view.archive'), 'The views.view.archive configuration has not been created');
        $this->assertEmpty(View::loadMultiple(), "No views exist");
    }
    public function testThemeModuleDependenciesInstall() : void {
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/theme_with_module_dependencies');
        RecipeRunner::processRecipe($recipe);
        // Test the state after applying the recipe.
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('test_module_required_by_theme'), 'The test_module_required_by_theme module is installed');
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('test_another_module_required_by_theme'), 'The test_another_module_required_by_theme module is installed');
        $this->assertTrue($this->container
            ->get('theme_handler')
            ->themeExists('test_theme_depending_on_modules'), 'The test_theme_depending_on_modules theme is installed');
    }
    public function testModuleConfigurationOverride() : void {
        // Test the state prior to applying the recipe.
        $this->assertEmpty($this->container
            ->get('config.factory')
            ->listAll('node.'), 'There is no node configuration');
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/install_node_with_config');
        RecipeRunner::processRecipe($recipe);
        // Test the state after applying the recipe.
        $this->assertTrue($this->container
            ->get('config.storage')
            ->exists('node.settings'), 'The node.settings configuration has been created');
        $this->assertTrue($this->container
            ->get('config.storage')
            ->exists('node.settings'), 'The node.settings configuration has been created');
        $this->assertTrue($this->config('node.settings')
            ->get('use_admin_theme'), 'The node.settings:use_admin_theme is set to TRUE');
        $this->assertSame('Test content type', NodeType::load('test')?->label());
        $node_type_data = $this->config('node.type.test')
            ->get();
        $this->assertGreaterThan(0, strlen($node_type_data['uuid']), 'The node type configuration has been assigned a UUID.');
        // cSpell:disable-next-line
        $this->assertSame('8Jlq8CmNXHVtNIHBHgFGpnAKthlUz0XoW_D0g56QXqY', $node_type_data['_core']['default_config_hash']);
    }
    public function testApplySameRecipe() : void {
        // Test the state prior to applying the recipe.
        $this->assertEmpty($this->container
            ->get('config.factory')
            ->listAll('node.'), 'There is no node configuration');
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/install_node_with_config');
        RecipeRunner::processRecipe($recipe);
        // Test the state prior to applying the recipe.
        $this->assertNotEmpty($this->container
            ->get('config.factory')
            ->listAll('node.'), 'There is node configuration');
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/install_node_with_config');
        RecipeRunner::processRecipe($recipe);
        $this->assertTrue(TRUE, 'Applying a recipe for the second time with no config changes results in a successful application');
        $type = NodeType::load('test');
        $type->setNewRevision(FALSE);
        $type->save();
        $this->expectException(RecipePreExistingConfigException::class);
        $this->expectExceptionMessage("The configuration 'node.type.test' exists already and does not match the recipe's configuration");
        Recipe::createFromDirectory('core/tests/fixtures/recipes/install_node_with_config');
    }
    public function testConfigFromModule() : void {
        // Test the state prior to applying the recipe.
        $this->assertEmpty($this->container
            ->get('config.factory')
            ->listAll('config_test.'), 'There is no config_test configuration');
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/config_from_module');
        RecipeRunner::processRecipe($recipe);
        // Test the state after to applying the recipe.
        $this->assertNotEmpty($this->container
            ->get('config.factory')
            ->listAll('config_test.'), 'There is config_test configuration');
        $config_test_entities = \Drupal::entityTypeManager()->getStorage('config_test')
            ->loadMultiple();
        $this->assertSame([
            'dotted.default',
            'override',
        ], array_keys($config_test_entities));
    }
    public function testConfigWildcard() : void {
        // Test the state prior to applying the recipe.
        $this->assertEmpty($this->container
            ->get('config.factory')
            ->listAll('config_test.'), 'There is no config_test configuration');
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/config_wildcard');
        RecipeRunner::processRecipe($recipe);
        // Test the state after to applying the recipe.
        $this->assertNotEmpty($this->container
            ->get('config.factory')
            ->listAll('config_test.'), 'There is config_test configuration');
        $config_test_entities = \Drupal::entityTypeManager()->getStorage('config_test')
            ->loadMultiple();
        $this->assertSame([
            'dotted.default',
            'override',
            'override_unmet',
        ], array_keys($config_test_entities));
        $this->assertSame('Default', $config_test_entities['dotted.default']->label());
        $this->assertSame('herp', $this->config('config_test.system')
            ->get('404'));
    }
    public function testConfigFromModuleAndRecipe() : void {
        // Test the state prior to applying the recipe.
        $this->assertEmpty($this->container
            ->get('config.factory')
            ->listAll('config_test.'), 'There is no config_test configuration');
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/config_from_module_and_recipe');
        RecipeRunner::processRecipe($recipe);
        // Test the state after to applying the recipe.
        $this->assertNotEmpty($this->container
            ->get('config.factory')
            ->listAll('config_test.'), 'There is config_test configuration');
        $config_test_entities = \Drupal::entityTypeManager()->getStorage('config_test')
            ->loadMultiple();
        $this->assertSame([
            'dotted.default',
            'override',
            'override_unmet',
        ], array_keys($config_test_entities));
        $this->assertSame('Provided by recipe', $config_test_entities['dotted.default']->label());
        $this->assertSame('foo', $this->config('config_test.system')
            ->get('404'));
    }
    public function testRecipeInclude() : void {
        // Test the state prior to applying the recipe.
        $this->assertEmpty($this->container
            ->get('config.factory')
            ->listAll('node.'), 'There is no node configuration');
        $this->assertFalse($this->container
            ->get('module_handler')
            ->moduleExists('dblog'), 'Dblog module not installed');
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/recipe_include');
        RecipeRunner::processRecipe($recipe);
        // Test the state after to applying the recipe.
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('dblog'), 'Dblog module installed');
        $this->assertSame('Test content type', NodeType::load('test')?->label());
        $this->assertSame('Another test content type', NodeType::load('another_test')?->label());
    }
    public function testConfigActions() : void {
        // Test the state prior to applying the recipe.
        $this->assertEmpty($this->container
            ->get('config.factory')
            ->listAll('config_test.'), 'There is no config_test configuration');
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/config_actions');
        RecipeRunner::processRecipe($recipe);
        // Test the state after to applying the recipe.
        $storage = \Drupal::entityTypeManager()->getStorage('config_test');
        $config_test_entity = $storage->load('recipe');
        $this->assertInstanceOf(ConfigTest::class, $config_test_entity);
        $this->assertSame('Created by recipe', $config_test_entity->label());
        $this->assertSame('Set by recipe', $config_test_entity->getProtectedProperty());
        $this->assertSame('not bar', $this->config('config_test.system')
            ->get('foo'));
    }
    public function testConfigActionsPreExistingConfig() : void {
        $this->enableModules([
            'config_test',
        ]);
        $this->installConfig([
            'config_test',
        ]);
        $this->assertSame('bar', $this->config('config_test.system')
            ->get('foo'));
        $storage = \Drupal::entityTypeManager()->getStorage('config_test');
        $config_test_entity = $storage->create([
            'id' => 'recipe',
            'label' => 'Created by test',
        ]);
        $this->assertInstanceOf(ConfigTest::class, $config_test_entity);
        $config_test_entity->setProtectedProperty('Set by test');
        $config_test_entity->save();
        $recipe = Recipe::createFromDirectory('core/tests/fixtures/recipes/config_actions');
        RecipeRunner::processRecipe($recipe);
        // Test the state after to applying the recipe.
        $config_test_entity = $storage->load('recipe');
        $this->assertInstanceOf(ConfigTest::class, $config_test_entity);
        $this->assertSame('Created by test', $config_test_entity->label());
        $this->assertSame('Set by recipe', $config_test_entity->getProtectedProperty());
        $this->assertSame('not bar', $this->config('config_test.system')
            ->get('foo'));
    }
    public function testInvalidConfigAction() : void {
        $recipe_data = <<<YAML
name: Invalid config action
install:
  - config_test
config:
  actions:
    config_test.dynamic.recipe:
      ensure_exists:
        label: 'Created by recipe'
      setBody: 'Description set by recipe'
YAML;
        $recipe = $this->createRecipe($recipe_data);
        $this->expectException(PluginNotFoundException::class);
        $this->expectExceptionMessage('The "setBody" plugin does not exist.');
        RecipeRunner::processRecipe($recipe);
    }
    public function testRecipesAreDisambiguatedByPath() : void {
        $recipe_data = <<<YAML
name: 'Recipe include'
recipes:
  - core/tests/fixtures/recipes/recipe_include
install:
  - config_test
YAML;
        $recipe = $this->createRecipe($recipe_data, 'recipe_include');
        RecipeRunner::processRecipe($recipe);
        // Test the state after to applying the recipe.
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('dblog'), 'Dblog module installed');
        $this->assertTrue($this->container
            ->get('module_handler')
            ->moduleExists('config_test'), 'Config test module installed');
        $this->assertSame('Test content type', NodeType::load('test')?->label());
        $this->assertSame('Another test content type', NodeType::load('another_test')?->label());
        $operations = RecipeRunner::toBatchOperations($recipe);
        $this->assertSame('triggerEvent', $operations[7][0][1]);
        $this->assertSame('Install node with config', $operations[7][1][0]->name);
        $this->assertStringEndsWith('core/tests/fixtures/recipes/install_node_with_config', $operations[7][1][0]->path);
        $this->assertSame('triggerEvent', $operations[10][0][1]);
        $this->assertSame('Recipe include', $operations[10][1][0]->name);
        $this->assertStringEndsWith('core/tests/fixtures/recipes/recipe_include', $operations[10][1][0]->path);
        $this->assertSame('triggerEvent', $operations[12][0][1]);
        $this->assertSame('Recipe include', $operations[12][1][0]->name);
        $this->assertSame($this->siteDirectory . '/recipes/recipe_include', $operations[12][1][0]->path);
    }

}

Members

Title Sort descending 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 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 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 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 protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked 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 protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected 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 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 protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector 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 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 protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper 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.
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. 3
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 enable. 547
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. 8
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
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. 1
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 enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable 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 27
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 395
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::tearDown protected function 7
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.
RecipeRunnerTest::testApplySameRecipe public function
RecipeRunnerTest::testConfigActions public function
RecipeRunnerTest::testConfigActionsPreExistingConfig public function
RecipeRunnerTest::testConfigFromModule public function
RecipeRunnerTest::testConfigFromModuleAndRecipe public function
RecipeRunnerTest::testConfigWildcard public function
RecipeRunnerTest::testInvalidConfigAction public function
RecipeRunnerTest::testModuleAndThemeInstall public function
RecipeRunnerTest::testModuleConfigurationOverride public function
RecipeRunnerTest::testModuleInstall public function
RecipeRunnerTest::testRecipeInclude public function
RecipeRunnerTest::testRecipesAreDisambiguatedByPath public function
RecipeRunnerTest::testThemeModuleDependenciesInstall public function
RecipeTestTrait::applyRecipe protected function Applies a recipe to the site.
RecipeTestTrait::createRecipe protected function Creates a recipe in a temporary directory.
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.