class ConfigInstallWebTest

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

Tests configuration objects before and after module install and uninstall.

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

@group config

Hierarchy

Expanded class hierarchy of ConfigInstallWebTest

File

core/modules/config/tests/src/Functional/ConfigInstallWebTest.php, line 21

Namespace

Drupal\Tests\config\Functional
View source
class ConfigInstallWebTest extends BrowserTestBase {
    
    /**
     * The admin user used in this test.
     */
    protected $adminUser;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->adminUser = $this->drupalCreateUser([
            'administer modules',
            'administer themes',
            'administer site configuration',
        ]);
        // Ensure the global variable being asserted by this test does not exist;
        // a previous test executed in this request/process might have set it.
        unset($GLOBALS['hook_config_test']);
    }
    
    /**
     * Tests module re-installation.
     */
    public function testIntegrationModuleReinstallation() {
        $default_config = 'config_integration_test.settings';
        $default_configuration_entity = 'config_test.dynamic.config_integration_test';
        // Install the config_test module we're integrating with.
        \Drupal::service('module_installer')->install([
            'config_test',
        ]);
        // Verify the configuration does not exist prior to installation.
        $config_static = $this->config($default_config);
        $this->assertTrue($config_static->isNew());
        $config_entity = $this->config($default_configuration_entity);
        $this->assertTrue($config_entity->isNew());
        // Install the integration module.
        \Drupal::service('module_installer')->install([
            'config_integration_test',
        ]);
        $this->resetAll();
        // Verify that default module config exists.
        \Drupal::configFactory()->reset($default_config);
        \Drupal::configFactory()->reset($default_configuration_entity);
        $config_static = $this->config($default_config);
        $this->assertFalse($config_static->isNew());
        $this->assertSame('default setting', $config_static->get('foo'));
        $config_entity = $this->config($default_configuration_entity);
        $this->assertFalse($config_entity->isNew());
        $this->assertSame('Default integration config label', $config_entity->get('label'));
        // Customize both configuration objects.
        $config_static->set('foo', 'customized setting')
            ->save();
        $config_entity->set('label', 'Customized integration config label')
            ->save();
        // @todo FIXME: Setting config keys WITHOUT SAVING retains the changed config
        //   object in memory. Every new call to $this->config() MUST revert in-memory changes
        //   that haven't been saved!
        //   In other words: This test passes even without this reset, but it shouldn't.
        $this->container
            ->get('config.factory')
            ->reset();
        // Disable and uninstall the integration module.
        $this->container
            ->get('module_installer')
            ->uninstall([
            'config_integration_test',
        ]);
        // Verify the integration module's config was uninstalled.
        $config_static = $this->config($default_config);
        $this->assertTrue($config_static->isNew());
        // Verify the integration config still exists.
        $config_entity = $this->config($default_configuration_entity);
        $this->assertFalse($config_entity->isNew());
        $this->assertSame('Customized integration config label', $config_entity->get('label'));
        // Reinstall the integration module.
        try {
            \Drupal::service('module_installer')->install([
                'config_integration_test',
            ]);
            $this->fail('Expected PreExistingConfigException not thrown.');
        } catch (PreExistingConfigException $e) {
            $this->assertEquals('config_integration_test', $e->getExtension());
            $this->assertEquals([
                StorageInterface::DEFAULT_COLLECTION => [
                    'config_test.dynamic.config_integration_test',
                ],
            ], $e->getConfigObjects());
            $this->assertEquals('Configuration objects (config_test.dynamic.config_integration_test) provided by config_integration_test already exist in active configuration', $e->getMessage());
        }
        // Delete the configuration entity so that the install will work.
        $config_entity->delete();
        \Drupal::service('module_installer')->install([
            'config_integration_test',
        ]);
        // Verify the integration module's config was re-installed.
        \Drupal::configFactory()->reset($default_config);
        \Drupal::configFactory()->reset($default_configuration_entity);
        $config_static = $this->config($default_config);
        $this->assertFalse($config_static->isNew());
        $this->assertSame('default setting', $config_static->get('foo'));
        // Verify the integration config is using the default.
        $config_entity = \Drupal::config($default_configuration_entity);
        $this->assertFalse($config_entity->isNew());
        $this->assertSame('Default integration config label', $config_entity->get('label'));
    }
    
    /**
     * Tests pre-existing configuration detection.
     */
    public function testPreExistingConfigInstall() {
        $this->drupalLogin($this->adminUser);
        // Try to install config_install_fail_test and config_test. Doing this
        // will install the config_test module first because it is a dependency of
        // config_install_fail_test.
        // @see \Drupal\system\Form\ModulesListForm::submitForm()
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config_test][enable]' => TRUE,
            'modules[config_install_fail_test][enable]' => TRUE,
        ], 'Install');
        $this->assertSession()
            ->responseContains('Unable to install Configuration install fail test, <em class="placeholder">config_test.dynamic.dotted.default</em> already exists in active configuration.');
        // Uninstall the config_test module to test the confirm form.
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm([
            'uninstall[config_test]' => TRUE,
        ], 'Uninstall');
        $this->submitForm([], 'Uninstall');
        // Try to install config_install_fail_test without selecting config_test.
        // The user is shown a confirm form because the config_test module is a
        // dependency.
        // @see \Drupal\system\Form\ModulesListConfirmForm::submitForm()
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config_install_fail_test][enable]' => TRUE,
        ], 'Install');
        $this->submitForm([], 'Continue');
        $this->assertSession()
            ->responseContains('Unable to install Configuration install fail test, <em class="placeholder">config_test.dynamic.dotted.default</em> already exists in active configuration.');
        // Test that collection configuration clashes during a module install are
        // reported correctly.
        \Drupal::service('module_installer')->install([
            'language',
        ]);
        $this->rebuildContainer();
        ConfigurableLanguage::createFromLangcode('fr')->save();
        \Drupal::languageManager()->getLanguageConfigOverride('fr', 'config_test.dynamic.dotted.default')
            ->set('label', 'Je suis Charlie')
            ->save();
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config_install_fail_test][enable]' => TRUE,
        ], 'Install');
        $this->assertSession()
            ->responseContains('Unable to install Configuration install fail test, <em class="placeholder">config_test.dynamic.dotted.default, language/fr/config_test.dynamic.dotted.default</em> already exist in active configuration.');
        // Test installing a theme through the UI that has existing configuration.
        // This relies on the fact the config_test has been installed and created
        // the config_test.dynamic.dotted.default configuration and the translation
        // override created still exists.
        $this->drupalGet('admin/appearance');
        $url = $this->xpath("//a[contains(@href,'config_clash_test_theme') and contains(@href,'/install?')]/@href")[0];
        $this->drupalGet($this->getAbsoluteUrl($url->getText()));
        $this->assertSession()
            ->responseContains('Unable to install config_clash_test_theme, <em class="placeholder">config_test.dynamic.dotted.default, language/fr/config_test.dynamic.dotted.default</em> already exist in active configuration.');
        // Test installing a theme through the API that has existing configuration.
        try {
            \Drupal::service('theme_installer')->install([
                'config_clash_test_theme',
            ]);
            $this->fail('Expected PreExistingConfigException not thrown.');
        } catch (PreExistingConfigException $e) {
            $this->assertEquals('config_clash_test_theme', $e->getExtension());
            $this->assertEquals([
                StorageInterface::DEFAULT_COLLECTION => [
                    'config_test.dynamic.dotted.default',
                ],
                'language.fr' => [
                    'config_test.dynamic.dotted.default',
                ],
            ], $e->getConfigObjects());
            $this->assertEquals('Configuration objects (config_test.dynamic.dotted.default, language/fr/config_test.dynamic.dotted.default) provided by config_clash_test_theme already exist in active configuration', $e->getMessage());
        }
    }
    
    /**
     * Tests unmet dependencies detection.
     */
    public function testUnmetDependenciesInstall() {
        $this->drupalLogin($this->adminUser);
        // We need to install separately since config_install_dependency_test does
        // not depend on config_test and order is important.
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config_test][enable]' => TRUE,
        ], 'Install');
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config_install_dependency_test][enable]' => TRUE,
        ], 'Install');
        $this->assertSession()
            ->responseContains('Unable to install <em class="placeholder">Config install dependency test</em> due to unmet dependencies: <em class="placeholder">config_test.dynamic.other_module_test_with_dependency (config_other_module_config_test, config_test.dynamic.dotted.english)</em>');
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config_test_language][enable]' => TRUE,
        ], 'Install');
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config_install_dependency_test][enable]' => TRUE,
        ], 'Install');
        $this->assertSession()
            ->responseContains('Unable to install <em class="placeholder">Config install dependency test</em> due to unmet dependencies: <em class="placeholder">config_test.dynamic.other_module_test_with_dependency (config_other_module_config_test)</em>');
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config_other_module_config_test][enable]' => TRUE,
        ], 'Install');
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config_install_dependency_test][enable]' => TRUE,
        ], 'Install');
        $this->rebuildContainer();
        $this->assertInstanceOf(ConfigTest::class, \Drupal::entityTypeManager()->getStorage('config_test')
            ->load('other_module_test_with_dependency'));
    }
    
    /**
     * Tests config_requirements().
     */
    public function testConfigModuleRequirements() {
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[config][enable]' => TRUE,
        ], 'Install');
        $directory = Settings::get('config_sync_directory');
        try {
            \Drupal::service('file_system')->deleteRecursive($directory);
        } catch (FileException $e) {
            // Ignore failed deletes.
        }
        $this->drupalGet('/admin/reports/status');
        $this->assertSession()
            ->pageTextContains("The directory {$directory} does not exist.");
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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::$htmlOutputFile protected property The file name to write the list of URLs to.
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 drupal_rewrite_settings().
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 enable. 673
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 37
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
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 Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
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::__sleep public function Prevents serializing any properties.
ConfigInstallWebTest::$adminUser protected property The admin user used in this test.
ConfigInstallWebTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ConfigInstallWebTest::setUp protected function Overrides BrowserTestBase::setUp
ConfigInstallWebTest::testConfigModuleRequirements public function Tests config_requirements().
ConfigInstallWebTest::testIntegrationModuleReinstallation public function Tests module re-installation.
ConfigInstallWebTest::testPreExistingConfigInstall public function Tests pre-existing configuration detection.
ConfigInstallWebTest::testUnmetDependenciesInstall public function Tests unmet dependencies detection.
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
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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
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.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
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. 3
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
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::$randomGenerator protected property The random generator.
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. 1
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 public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
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::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
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. 1
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. 1
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::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
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::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. 2
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::drupalPostForm Deprecated protected function Executes a form submission.
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.