class LocaleConfigTranslationImportTest

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

Tests translation update's effects on configuration translations.

@group locale

Hierarchy

Expanded class hierarchy of LocaleConfigTranslationImportTest

File

core/modules/locale/tests/src/Functional/LocaleConfigTranslationImportTest.php, line 14

Namespace

Drupal\Tests\locale\Functional
View source
class LocaleConfigTranslationImportTest extends BrowserTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'language',
        'locale_test_translate',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
    }
    
    /**
     * Tests update changes configuration translations if enabled after language.
     */
    public function testConfigTranslationImport() {
        $admin_user = $this->drupalCreateUser([
            'administer modules',
            'administer site configuration',
            'administer languages',
            'access administration pages',
            'administer permissions',
        ]);
        $this->drupalLogin($admin_user);
        // Add a language. The Afrikaans translation file of locale_test_translate
        // (test.af.po) has been prepared with a configuration translation.
        ConfigurableLanguage::createFromLangcode('af')->save();
        // Enable locale module.
        $this->container
            ->get('module_installer')
            ->install([
            'locale',
        ]);
        $this->resetAll();
        // Enable import of translations. By default this is disabled for automated
        // tests.
        $this->config('locale.settings')
            ->set('translation.import_enabled', TRUE)
            ->set('translation.use_source', LOCALE_TRANSLATION_USE_SOURCE_LOCAL)
            ->save();
        // Add translation permissions now that the locale module has been enabled.
        $edit = [
            'authenticated[translate interface]' => 'translate interface',
        ];
        $this->drupalGet('admin/people/permissions');
        $this->submitForm($edit, 'Save permissions');
        // Check and update the translation status. This will import the Afrikaans
        // translations of locale_test_translate module.
        $this->drupalGet('admin/reports/translations/check');
        // Override the Drupal core translation status to be up to date.
        // Drupal core should not be a subject in this test.
        $status = locale_translation_get_status();
        $status['drupal']['af']->type = 'current';
        \Drupal::state()->set('locale.translation_status', $status);
        $this->drupalGet('admin/reports/translations');
        $this->submitForm([], 'Update translations');
        // Check if configuration translations have been imported.
        $override = \Drupal::languageManager()->getLanguageConfigOverride('af', 'system.maintenance');
        // cSpell:disable-next-line
        $this->assertEquals('Ons is tans besig met onderhoud op @site. Wees asseblief geduldig, ons sal binnekort weer terug wees.', $override->get('message'));
        // Ensure that \Drupal\locale\LocaleConfigSubscriber::onConfigSave() works
        // as expected during a configuration install that installs locale.
        
        /** @var \Drupal\Core\Config\FileStorage $sync */
        $sync = $this->container
            ->get('config.storage.sync');
        $this->copyConfig($this->container
            ->get('config.storage'), $sync);
        // Add our own translation to the config that will be imported.
        $af_sync = $sync->createCollection('language.af');
        $data = $af_sync->read('system.maintenance');
        $data['message'] = 'Test af message';
        $af_sync->write('system.maintenance', $data);
        // Uninstall locale module.
        $this->container
            ->get('module_installer')
            ->uninstall([
            'locale_test_translate',
        ]);
        $this->container
            ->get('module_installer')
            ->uninstall([
            'locale',
        ]);
        $this->resetAll();
        $this->configImporter()
            ->import();
        $this->drupalGet('admin/reports/translations/check');
        $status = locale_translation_get_status();
        $status['drupal']['af']->type = 'current';
        \Drupal::state()->set('locale.translation_status', $status);
        $this->drupalGet('admin/reports/translations');
        $this->submitForm([], 'Update translations');
        // Check if configuration translations have been imported.
        $override = \Drupal::languageManager()->getLanguageConfigOverride('af', 'system.maintenance');
        $this->assertEquals('Test af message', $override->get('message'));
    }
    
    /**
     * Tests update changes configuration translations if enabled after language.
     */
    public function testConfigTranslationModuleInstall() {
        // Enable locale, block and config_translation modules.
        $this->container
            ->get('module_installer')
            ->install([
            'block',
            'config_translation',
        ]);
        $this->resetAll();
        // The testing profile overrides locale.settings to disable translation
        // import. Test that this override is in place.
        $this->assertFalse($this->config('locale.settings')
            ->get('translation.import_enabled'), 'Translations imports are disabled by default in the Testing profile.');
        $admin_user = $this->drupalCreateUser([
            'administer modules',
            'administer site configuration',
            'administer languages',
            'access administration pages',
            'administer permissions',
            'translate configuration',
        ]);
        $this->drupalLogin($admin_user);
        // Enable import of translations. By default this is disabled for automated
        // tests.
        $this->config('locale.settings')
            ->set('translation.import_enabled', TRUE)
            ->set('translation.use_source', LOCALE_TRANSLATION_USE_SOURCE_LOCAL)
            ->save();
        // Add predefined language.
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm([
            'predefined_langcode' => 'af',
        ], 'Add language');
        // Add the system branding block to the page.
        $this->drupalPlaceBlock('system_branding_block', [
            'region' => 'header',
            'id' => 'site-branding',
        ]);
        $this->drupalGet('admin/config/system/site-information');
        $this->submitForm([
            'site_slogan' => 'Test site slogan',
        ], 'Save configuration');
        $this->drupalGet('admin/config/system/site-information/translate/af/edit');
        $this->submitForm([
            'translation[config_names][system.site][slogan]' => 'Test site slogan in Afrikaans',
        ], 'Save translation');
        // Get the front page and ensure that the translated configuration appears.
        $this->drupalGet('af');
        $this->assertSession()
            ->pageTextContains('Test site slogan in Afrikaans');
        $override = \Drupal::languageManager()->getLanguageConfigOverride('af', 'locale_test_translate.settings');
        $this->assertEquals('Locale can translate Afrikaans', $override->get('translatable_default_with_translation'));
        // Update test configuration.
        $override->set('translatable_no_default', 'This translation is preserved')
            ->set('translatable_default_with_translation', 'This translation is preserved')
            ->set('translatable_default_with_no_translation', 'This translation is preserved')
            ->save();
        // Install any module.
        $this->drupalGet('admin/modules');
        $this->submitForm([
            'modules[dblog][enable]' => 'dblog',
        ], 'Install');
        $this->assertSession()
            ->pageTextContains('Module Database Logging has been enabled.');
        // Get the front page and ensure that the translated configuration still
        // appears.
        $this->drupalGet('af');
        $this->assertSession()
            ->pageTextContains('Test site slogan in Afrikaans');
        $this->rebuildContainer();
        $override = \Drupal::languageManager()->getLanguageConfigOverride('af', 'locale_test_translate.settings');
        $expected = [
            'translatable_no_default' => 'This translation is preserved',
            'translatable_default_with_translation' => 'This translation is preserved',
            'translatable_default_with_no_translation' => 'This translation is preserved',
        ];
        $this->assertEquals($expected, $override->get());
    }
    
    /**
     * Tests removing a string from Locale deletes configuration translations.
     */
    public function testLocaleRemovalAndConfigOverrideDelete() {
        // Enable the locale module.
        $this->container
            ->get('module_installer')
            ->install([
            'locale',
        ]);
        $this->resetAll();
        $admin_user = $this->drupalCreateUser([
            'administer modules',
            'administer site configuration',
            'administer languages',
            'access administration pages',
            'administer permissions',
            'translate interface',
        ]);
        $this->drupalLogin($admin_user);
        // Enable import of translations. By default this is disabled for automated
        // tests.
        $this->config('locale.settings')
            ->set('translation.import_enabled', TRUE)
            ->set('translation.use_source', LOCALE_TRANSLATION_USE_SOURCE_LOCAL)
            ->save();
        // Add predefined language.
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm([
            'predefined_langcode' => 'af',
        ], 'Add language');
        $override = \Drupal::languageManager()->getLanguageConfigOverride('af', 'locale_test_translate.settings');
        $this->assertEquals([
            'translatable_default_with_translation' => 'Locale can translate Afrikaans',
        ], $override->get());
        // Remove the string from translation to simulate a Locale removal. Note
        // that is no current way of doing this in the UI.
        $locale_storage = \Drupal::service('locale.storage');
        $string = $locale_storage->findString([
            'source' => 'Locale can translate',
        ]);
        \Drupal::service('locale.storage')->delete($string);
        // Force a rebuild of config translations.
        $count = Locale::config()->updateConfigTranslations([
            'locale_test_translate.settings',
        ], [
            'af',
        ]);
        $this->assertEquals(1, $count, 'Correct count of updated translations');
        $override = \Drupal::languageManager()->getLanguageConfigOverride('af', 'locale_test_translate.settings');
        $this->assertEquals([], $override->get());
        $this->assertTrue($override->isNew(), 'The configuration override was deleted when the Locale string was deleted.');
    }
    
    /**
     * Tests removing a string from Locale changes configuration translations.
     */
    public function testLocaleRemovalAndConfigOverridePreserve() {
        // Enable the locale module.
        $this->container
            ->get('module_installer')
            ->install([
            'locale',
        ]);
        $this->resetAll();
        $admin_user = $this->drupalCreateUser([
            'administer modules',
            'administer site configuration',
            'administer languages',
            'access administration pages',
            'administer permissions',
            'translate interface',
        ]);
        $this->drupalLogin($admin_user);
        // Enable import of translations. By default this is disabled for automated
        // tests.
        $this->config('locale.settings')
            ->set('translation.import_enabled', TRUE)
            ->set('translation.use_source', LOCALE_TRANSLATION_USE_SOURCE_LOCAL)
            ->save();
        // Add predefined language.
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm([
            'predefined_langcode' => 'af',
        ], 'Add language');
        $override = \Drupal::languageManager()->getLanguageConfigOverride('af', 'locale_test_translate.settings');
        // Update test configuration.
        $override->set('translatable_no_default', 'This translation is preserved')
            ->set('translatable_default_with_no_translation', 'This translation is preserved')
            ->save();
        $expected = [
            'translatable_default_with_translation' => 'Locale can translate Afrikaans',
            'translatable_no_default' => 'This translation is preserved',
            'translatable_default_with_no_translation' => 'This translation is preserved',
        ];
        $this->assertEquals($expected, $override->get());
        // Set the translated string to empty.
        $search = [
            'string' => 'Locale can translate',
            'langcode' => 'af',
            'translation' => 'all',
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($search, 'Filter');
        $textarea = $this->assertSession()
            ->elementExists('xpath', '//textarea');
        $lid = $textarea->getAttribute('name');
        $edit = [
            $lid => '',
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($edit, 'Save translations');
        $override = \Drupal::languageManager()->getLanguageConfigOverride('af', 'locale_test_translate.settings');
        $expected = [
            'translatable_no_default' => 'This translation is preserved',
            'translatable_default_with_no_translation' => 'This translation is preserved',
        ];
        $this->assertEquals($expected, $override->get());
    }
    
    /**
     * Tests setting a non-English language as default and importing configuration.
     */
    public function testConfigTranslationWithNonEnglishLanguageDefault() {
        
        /** @var \Drupal\Core\Extension\ModuleInstallerInterface $module_installer */
        $module_installer = $this->container
            ->get('module_installer');
        ConfigurableLanguage::createFromLangcode('af')->save();
        $module_installer->install([
            'locale',
        ]);
        $this->resetAll();
        
        /** @var \Drupal\locale\StringStorageInterface $local_storage */
        $local_storage = $this->container
            ->get('locale.storage');
        $source_string = 'Locale can translate';
        $translation_string = 'Locale can translate Afrikaans';
        // Create a translation for the "Locale can translate" string, this string
        // can be found in the "locale_test_translate" module's install config.
        $source = $local_storage->createString([
            'source' => $source_string,
        ])
            ->save();
        $local_storage->createTranslation([
            'lid' => $source->getId(),
            'language' => 'af',
            'translation' => $translation_string,
        ])
            ->save();
        // Verify that we can find the newly added string translation, it is not a
        // customized translation.
        $translation = $local_storage->findTranslation([
            'source' => $source_string,
            'language' => 'af',
        ]);
        $this->assertEquals($translation_string, $translation->getString());
        $this->assertFalse((bool) $translation->customized);
        // Uninstall the "locale_test_translate" module, verify that we can still
        // find the string translation.
        $module_installer->uninstall([
            'locale_test_translate',
        ]);
        $this->resetAll();
        $translation = $local_storage->findTranslation([
            'source' => $source_string,
            'language' => 'af',
        ]);
        $this->assertEquals($translation_string, $translation->getString());
        // Set the default language to "Afrikaans" and re-enable the
        // "locale_test_translate" module.
        $this->config('system.site')
            ->set('default_langcode', 'af')
            ->save();
        $module_installer->install([
            'locale_test_translate',
        ]);
        $this->resetAll();
        // Verify that enabling the "locale_test_translate" module didn't cause
        // the string translation to be overwritten.
        $translation = $local_storage->findTranslation([
            'source' => $source_string,
            'language' => 'af',
        ]);
        $this->assertEquals($translation_string, $translation->getString());
        $this->assertFalse((bool) $translation->customized);
    }

}

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'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::$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.
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 '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::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
LocaleConfigTranslationImportTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LocaleConfigTranslationImportTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
LocaleConfigTranslationImportTest::setUp protected function Overrides BrowserTestBase::setUp
LocaleConfigTranslationImportTest::testConfigTranslationImport public function Tests update changes configuration translations if enabled after language.
LocaleConfigTranslationImportTest::testConfigTranslationModuleInstall public function Tests update changes configuration translations if enabled after language.
LocaleConfigTranslationImportTest::testConfigTranslationWithNonEnglishLanguageDefault public function Tests setting a non-English language as default and importing configuration.
LocaleConfigTranslationImportTest::testLocaleRemovalAndConfigOverrideDelete public function Tests removing a string from Locale deletes configuration translations.
LocaleConfigTranslationImportTest::testLocaleRemovalAndConfigOverridePreserve public function Tests removing a string from Locale changes configuration translations.
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.