class ConfigOtherModuleTest

Same name in other branches
  1. 9 core/modules/config/tests/src/Functional/ConfigOtherModuleTest.php \Drupal\Tests\config\Functional\ConfigOtherModuleTest
  2. 8.9.x core/modules/config/tests/src/Functional/ConfigOtherModuleTest.php \Drupal\Tests\config\Functional\ConfigOtherModuleTest
  3. 11.x core/modules/config/tests/src/Kernel/ConfigOtherModuleTest.php \Drupal\Tests\config\Kernel\ConfigOtherModuleTest

Tests default configuration provided by a module that does not own it.

@group config

Hierarchy

Expanded class hierarchy of ConfigOtherModuleTest

File

core/modules/config/tests/src/Kernel/ConfigOtherModuleTest.php, line 15

Namespace

Drupal\Tests\config\Kernel
View source
class ConfigOtherModuleTest extends KernelTestBase {
    
    /**
     * Tests enabling the provider of the default configuration first.
     */
    public function testInstallOtherModuleFirst() : void {
        $this->installModule('config_other_module_config_test');
        // Check that the config entity doesn't exist before the config_test module
        // is enabled. We cannot use the entity system because the config_test
        // entity type does not exist.
        $config = $this->config('config_test.dynamic.other_module_test');
        $this->assertTrue($config->isNew(), 'Default configuration for other modules is not installed if that module is not enabled.');
        // Install the module that provides the entity type. This installs the
        // default configuration.
        $this->installModule('config_test');
        $this->assertNotEmpty($this->getStorage()
            ->load('other_module_test'), 'Default configuration has been installed.');
        // Uninstall the module that provides the entity type. This will remove the
        // default configuration.
        $this->uninstallModule('config_test');
        $config = $this->config('config_test.dynamic.other_module_test');
        $this->assertTrue($config->isNew(), 'Default configuration for other modules is removed when the config entity provider is disabled.');
        // Install the module that provides the entity type again. This installs the
        // default configuration.
        $this->installModule('config_test');
        
        /** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $other_module_config_entity */
        $other_module_config_entity = $this->getStorage()
            ->load('other_module_test');
        $this->assertNotEmpty($other_module_config_entity, "Default configuration has been recreated.");
        // Update the default configuration to test that the changes are preserved
        // if the module that provides the default configuration is uninstalled.
        $other_module_config_entity->set('style', "The piano ain't got no wrong notes.");
        $other_module_config_entity->save();
        // Uninstall the module that provides the default configuration.
        $this->uninstallModule('config_other_module_config_test');
        $this->assertNotEmpty($this->getStorage()
            ->load('other_module_test'), 'Default configuration for other modules is not removed when the module that provides it is uninstalled.');
        // Default configuration provided by config_test should still exist.
        $this->assertNotEmpty($this->getStorage()
            ->load('dotted.default'), 'The configuration is not deleted.');
        // Re-enable module to test that pre-existing optional configuration does
        // not throw an error.
        $this->installModule('config_other_module_config_test');
        $this->assertTrue(\Drupal::moduleHandler()->moduleExists('config_other_module_config_test'), 'The config_other_module_config_test module is installed.');
        // Ensure that optional configuration with unmet dependencies is only
        // installed once all the dependencies are met.
        $this->assertNull($this->getStorage()
            ->load('other_module_test_unmet'), 'The optional configuration config_test.dynamic.other_module_test_unmet whose dependencies are not met is not created.');
        $this->assertNull($this->getStorage()
            ->load('other_module_test_optional_entity_unmet'), 'The optional configuration config_test.dynamic.other_module_test_optional_entity_unmet whose dependencies are not met is not created.');
        $this->installModule('config_test_language');
        $this->assertNull($this->getStorage()
            ->load('other_module_test_optional_entity_unmet'), 'The optional configuration config_test.dynamic.other_module_test_optional_entity_unmet whose dependencies are met is not created.');
        $this->installModule('config_install_dependency_test');
        $this->assertNotEmpty($this->getStorage()
            ->load('other_module_test_unmet'), 'The optional configuration config_test.dynamic.other_module_test_unmet whose dependencies are met is now created.');
        // The following configuration entity's dependencies are now met. It is
        // indirectly dependent on the config_install_dependency_test module because
        // it has a dependency on the config_test.dynamic.dependency_for_unmet2
        // configuration provided by that module and, therefore, should be created.
        $this->assertNotEmpty($this->getStorage()
            ->load('other_module_test_optional_entity_unmet2'), 'The optional configuration config_test.dynamic.other_module_test_optional_entity_unmet2 whose dependencies are met is now created.');
        // The following configuration entity's dependencies are now met even though
        // it has no direct dependency on the module. It is indirectly dependent on
        // the config_install_dependency_test module because it has a dependency on
        // the config_test.dynamic.other_module_test_unmet configuration that is
        // dependent on the config_install_dependency_test module and, therefore,
        // should be created.
        $entity = $this->getStorage()
            ->load('other_module_test_optional_entity_unmet');
        $this->assertNotEmpty($entity, 'The optional configuration config_test.dynamic.other_module_test_optional_entity_unmet whose dependencies are met is created.');
        $entity->delete();
        // Install another module to ensure the configuration just deleted is not
        // recreated.
        $this->installModule('config');
        $this->assertNull($this->getStorage()
            ->load('other_module_test_optional_entity_unmet'), 'The optional configuration config_test.dynamic.other_module_test_optional_entity_unmet whose dependencies are met is not installed when an unrelated module is installed.');
        // Ensure that enforced dependencies do not overwrite base ones.
        $this->installModule('config_install_dependency_enforced_combo_test');
        $this->assertTrue(\Drupal::moduleHandler()->moduleExists('config_install_dependency_enforced_combo_test'), 'The config_install_dependency_enforced_combo_test module is installed.');
        $this->assertNull($this->getStorage()
            ->load('config_test.dynamic.enforced_and_base_dependencies'), 'The optional configuration config_test.dynamic.enforced_and_base_dependencies whose enforced dependencies are met but base module dependencies are not met is not created.');
    }
    
    /**
     * Tests enabling the provider of the config entity type first.
     */
    public function testInstallConfigEntityModuleFirst() : void {
        $this->installModule('config_test');
        $this->assertNull($this->getStorage()
            ->load('other_module_test'), 'Default configuration provided by config_other_module_config_test does not exist.');
        $this->installModule('config_other_module_config_test');
        $this->assertNotEmpty($this->getStorage()
            ->load('other_module_test'), 'Default configuration provided by config_other_module_config_test has been installed.');
    }
    
    /**
     * Tests uninstalling Node module removes views which are dependent on it.
     */
    public function testUninstall() : void {
        $this->installModule('views');
        $this->assertNull($this->getStorage('view')
            ->load('frontpage'), 'After installing Views, frontpage view which is dependant on the Node and Views modules does not exist.');
        $this->installModule('node');
        $this->assertNotNull($this->getStorage('view')
            ->load('frontpage'), 'After installing Node, frontpage view which is dependant on the Node and Views modules exists.');
        $this->uninstallModule('node');
        $this->assertNull($this->getStorage('view')
            ->load('frontpage'), 'After uninstalling Node, frontpage view which is dependant on the Node and Views modules does not exist.');
    }
    
    /**
     * Installs a module.
     *
     * @param string $module
     *   The module name.
     */
    protected function installModule(string $module) : void {
        $this->container
            ->get('module_installer')
            ->install([
            $module,
        ]);
        $this->container = \Drupal::getContainer();
    }
    
    /**
     * Uninstalls a module.
     *
     * @param string $module
     *   The module name.
     */
    protected function uninstallModule(string $module) : void {
        $this->container
            ->get('module_installer')
            ->uninstall([
            $module,
        ]);
        $this->container = \Drupal::getContainer();
    }
    
    /**
     * Gets the provided entity type's storage.
     *
     * @param string $entity_type_id
     *   (optional) The entity type ID to get a storage for. Defaults to
     *   'config_test'.
     *
     * @return \Drupal\Core\Entity\EntityStorageInterface
     *   The entity type's storage.
     */
    protected function getStorage(string $entity_type_id = 'config_test') : EntityStorageInterface {
        return \Drupal::entityTypeManager()->getStorage($entity_type_id);
    }

}

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 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.
ConfigOtherModuleTest::getStorage protected function Gets the provided entity type's storage.
ConfigOtherModuleTest::installModule protected function Installs a module.
ConfigOtherModuleTest::testInstallConfigEntityModuleFirst public function Tests enabling the provider of the config entity type first.
ConfigOtherModuleTest::testInstallOtherModuleFirst public function Tests enabling the provider of the default configuration first.
ConfigOtherModuleTest::testUninstall public function Tests uninstalling Node module removes views which are dependent on it.
ConfigOtherModuleTest::uninstallModule protected function Uninstalls a module.
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
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 install. 558
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
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. 7
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 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 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 401
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
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.