class ConfigInstallProfileOverrideTest

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

Tests that configuration objects are correct after various operations.

The installation and removal of configuration objects in install, disable and uninstall functionality is tested.

@group config

Hierarchy

Expanded class hierarchy of ConfigInstallProfileOverrideTest

File

core/modules/config/tests/src/Functional/ConfigInstallProfileOverrideTest.php, line 24

Namespace

Drupal\Tests\config\Functional
View source
class ConfigInstallProfileOverrideTest extends BrowserTestBase {
    
    /**
     * The profile to install as a basis for testing.
     *
     * @var string
     */
    protected $profile = 'testing_config_overrides';
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests install profile config changes.
     */
    public function testInstallProfileConfigOverwrite() : void {
        $config_name = 'system.cron';
        // The expected configuration from the system module.
        $expected_original_data = [
            'threshold' => [
                'requirements_warning' => 172800,
                'requirements_error' => 1209600,
            ],
            'logging' => TRUE,
        ];
        // The expected active configuration altered by the install profile.
        $expected_profile_data = [
            'threshold' => [
                'requirements_warning' => 259200,
                'requirements_error' => 1209600,
            ],
            'logging' => TRUE,
        ];
        $expected_profile_data = [
            '_core' => [
                'default_config_hash' => Crypt::hashBase64(serialize($expected_profile_data)),
            ],
        ] + $expected_profile_data;
        // Verify that the original data matches. We have to read the module config
        // file directly, because the install profile default system.cron.yml
        // configuration file was used to create the active configuration.
        $config_dir = $this->getModulePath('system') . '/' . InstallStorage::CONFIG_INSTALL_DIRECTORY;
        $this->assertDirectoryExists($config_dir);
        $source_storage = new FileStorage($config_dir);
        $data = $source_storage->read($config_name);
        $this->assertSame($expected_original_data, $data);
        // Verify that active configuration matches the expected data, which was
        // created from the testing install profile's system.cron.yml file.
        $config = $this->config($config_name);
        $this->assertSame($expected_profile_data, $config->get());
        $config = $this->config('system.site');
        // Verify the system.site config has a valid UUID.
        $this->assertTrue(Uuid::isValid($config->get('uuid')));
        // Verify the profile overrides have been used.
        $this->assertEquals(91, $config->get('weight_select_max'));
        // Ensure the site configure form is used.
        $this->assertEquals('Drupal', $config->get('name'));
        $this->assertEquals('simpletest@example.com', $config->get('mail'));
        // Ensure that the configuration entity has the expected dependencies and
        // overrides.
        $action = Action::load('user_block_user_action');
        $this->assertEquals('Overridden block the selected user(s)', $action->label());
        $action = Action::load('user_cancel_user_action');
        $this->assertEquals('Cancel the selected user account(s)', $action->label(), 'Default configuration that is not overridden is not affected.');
        // Ensure that optional configuration can be overridden.
        $config_test = \Drupal::entityTypeManager()->getStorage('entity_test_bundle')
            ->load('install_test');
        $this->assertEquals('Optional configuration can be overridden.', $config_test->label());
        $config_test = \Drupal::entityTypeManager()->getStorage('entity_test_bundle')
            ->load('install_test2');
        $this->assertEquals('Optional configuration that is not overridden.', $config_test->label());
        // Ensure the optional configuration is installed. Note that the overridden
        // EntityTestBundle config with ID testing_config_overrides has a
        // dependency on EntityTestBundle with ID testing_config_overrides_module,
        // so it has to exist.
        $this->assertInstanceOf(EntityTestBundle::class, \Drupal::entityTypeManager()->getStorage('entity_test_bundle')
            ->load('testing_config_overrides_module'));
        // Ensure that optional configuration from a profile is created if
        // dependencies are met.
        $this->assertEquals('Config override test', \Drupal::entityTypeManager()->getStorage('entity_test_bundle')
            ->load('testing_config_overrides')
            ->label());
        // Ensure that optional configuration from a profile is not created if
        // dependencies are not met. Cannot use the entity system since the entity
        // type does not exist.
        $optional_dir = $this->getModulePath('testing_config_overrides') . '/' . InstallStorage::CONFIG_OPTIONAL_DIRECTORY;
        $optional_storage = new FileStorage($optional_dir);
        foreach ([
            'config_test.dynamic.dotted.default',
            'config_test.dynamic.override',
            'config_test.dynamic.override_unmet',
        ] as $id) {
            $this->assertTrue(\Drupal::config($id)->isNew(), "The config_test entity {$id} contained in the profile's optional directory does not exist.");
            // Make that we don't get false positives from the assertion above.
            $this->assertTrue($optional_storage->exists($id), "The config_test entity {$id} does exist in the profile's optional directory.");
        }
        // Install the config_test module and ensure that the override from the
        // install profile is used. Optional configuration can override
        // configuration in a modules config/install directory.
        $this->container
            ->get('module_installer')
            ->install([
            'config_test',
        ]);
        $this->rebuildContainer();
        $config_test_storage = \Drupal::entityTypeManager()->getStorage('config_test');
        $this->assertEquals('Default install profile override', $config_test_storage->load('dotted.default')
            ->label(), 'The config_test entity is overridden by the profile optional configuration.');
        // Test that override of optional configuration does work.
        $this->assertEquals('Override', $config_test_storage->load('override')
            ->label(), 'The optional config_test entity is overridden by the profile optional configuration.');
        // Test that override of optional configuration which introduces an unmet
        // dependency does not get created.
        $this->assertNull($config_test_storage->load('override_unmet'), 'The optional config_test entity with unmet dependencies is not created.');
        $this->assertNull($config_test_storage->load('completely_new'), 'The completely new optional config_test entity with unmet dependencies is not created.');
        // Installing dblog creates the optional configuration.
        $this->container
            ->get('module_installer')
            ->install([
            'dblog',
        ]);
        $this->rebuildContainer();
        $this->assertEquals('Override', $config_test_storage->load('override_unmet')
            ->label(), 'The optional config_test entity is overridden by the profile optional configuration and is installed when its dependencies are met.');
        $config_test_new = $config_test_storage->load('completely_new');
        $this->assertEquals('Completely new optional configuration', $config_test_new->label(), 'The optional config_test entity is provided by the profile optional configuration and is installed when its dependencies are met.');
        $config_test_new->delete();
        // Install another module that provides optional configuration and ensure
        // that deleted profile configuration is not re-created.
        $this->container
            ->get('module_installer')
            ->install([
            'config_other_module_config_test',
        ]);
        $this->rebuildContainer();
        $config_test_storage = \Drupal::entityTypeManager()->getStorage('config_test');
        $this->assertNull($config_test_storage->load('completely_new'));
        // Ensure the authenticated role has the access entity_test_bundle permission.
        $role = Role::load(Role::AUTHENTICATED_ID);
        $this->assertTrue($role->hasPermission('administer entity_test_bundle content'), 'The Authenticated role has the "administer entity_test_bundle content" permission.');
        $this->assertEquals([
            'module' => [
                'entity_test',
            ],
        ], $role->getDependencies());
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$modules protected static property Modules to install. 726
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUp protected function 554
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigInstallProfileOverrideTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ConfigInstallProfileOverrideTest::$profile protected property The profile to install as a basis for testing. Overrides BrowserTestBase::$profile
ConfigInstallProfileOverrideTest::testInstallProfileConfigOverwrite public function Tests install profile config changes.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
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.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 8
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 29
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 5
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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