class InstallerExistingConfigSyncDirectoryMultilingualTest

Same name in other branches
  1. 9 core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigSyncDirectoryMultilingualTest.php \Drupal\FunctionalTests\Installer\InstallerExistingConfigSyncDirectoryMultilingualTest
  2. 8.9.x core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigSyncDirectoryMultilingualTest.php \Drupal\FunctionalTests\Installer\InstallerExistingConfigSyncDirectoryMultilingualTest
  3. 10 core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigSyncDirectoryMultilingualTest.php \Drupal\FunctionalTests\Installer\InstallerExistingConfigSyncDirectoryMultilingualTest

Verifies that installing from existing configuration works.

@group Installer

Hierarchy

Expanded class hierarchy of InstallerExistingConfigSyncDirectoryMultilingualTest

File

core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigSyncDirectoryMultilingualTest.php, line 16

Namespace

Drupal\FunctionalTests\Installer
View source
class InstallerExistingConfigSyncDirectoryMultilingualTest extends InstallerConfigDirectoryTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected $profile = 'testing_config_install_multilingual';
    
    /**
     * {@inheritdoc}
     */
    protected $existingSyncDirectory = TRUE;
    
    /**
     * Installer step: Select installation profile.
     */
    protected function setUpProfile() {
        // Ensure the site name 'Multilingual' appears as expected in the 'Use
        // existing configuration' radio description.
        $this->assertSession()
            ->pageTextContains('Install Multilingual using existing configuration.');
        return parent::setUpProfile();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getConfigLocation() : string {
        return __DIR__ . '/../../../fixtures/config_install/multilingual';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function prepareEnvironment() : void {
        parent::prepareEnvironment();
        // Place custom local translations in the translations directory and fix up
        // configuration.
        mkdir($this->publicFilesDirectory . '/translations', 0777, TRUE);
        file_put_contents($this->publicFilesDirectory . '/translations/drupal-8.0.0.es.po', $this->getPo('es'));
        $locale_settings = Yaml::decode(file_get_contents($this->siteDirectory . '/config/sync/locale.settings.yml'));
        $locale_settings['translation']['use_source'] = 'local';
        $locale_settings['translation']['path'] = $this->publicFilesDirectory . '/translations';
        file_put_contents($this->siteDirectory . '/config/sync/locale.settings.yml', Yaml::encode($locale_settings));
    }
    
    /**
     * Confirms that the installation installed the configuration correctly.
     */
    public function testConfigSync() : void {
        $comparer = $this->configImporter()
            ->getStorageComparer();
        $expected_changelist_default_collection = [
            'create' => [],
            // The system.mail is changed configuration because the test system
            // changes it to ensure that mails are not sent.
'update' => [
                'system.mail',
            ],
            'delete' => [],
            'rename' => [],
        ];
        $this->assertEquals($expected_changelist_default_collection, $comparer->getChangelist());
        $expected_changelist_spanish_collection = [
            'create' => [],
            // The view was untranslated but the translation exists so the installer
            // performs the translation.
'update' => [
                'views.view.who_s_new',
            ],
            'delete' => [],
            'rename' => [],
        ];
        $this->assertEquals($expected_changelist_spanish_collection, $comparer->getChangelist(NULL, 'language.es'));
        // Ensure that menu blocks have been created correctly.
        $this->assertSession()
            ->responseNotContains('This block is broken or missing.');
        $this->assertSession()
            ->linkExists('Add content');
        // Ensure that the Spanish translation of anonymous is the one from
        // configuration and not the PO file.
        // cspell:disable-next-line
        $this->assertSame('Anónimo', \Drupal::languageManager()->getLanguageConfigOverride('es', 'user.settings')
            ->get('anonymous'));
        
        /** @var \Drupal\locale\StringStorageInterface $locale_storage */
        $locale_storage = \Drupal::service('locale.storage');
        // If configuration contains a translation that is not in the po file then
        // _install_config_locale_overrides_process_batch() will create a customized
        // translation.
        $translation = $locale_storage->findTranslation([
            'source' => 'Anonymous',
            'language' => 'es',
        ]);
        $this->assertSame('Anónimo', $translation->getString());
        $this->assertTrue((bool) $translation->customized, "A customized translation has been created for Anonymous");
        // If configuration contains a translation that is in the po file then
        // _install_config_locale_overrides_process_batch() will not create a
        // customized translation.
        $translation = $locale_storage->findTranslation([
            'source' => 'Apply',
            'language' => 'es',
        ]);
        $this->assertSame('Aplicar', $translation->getString());
        $this->assertFalse((bool) $translation->customized, "A non-customized translation has been created for Apply");
        
        /** @var \Drupal\language\Config\LanguageConfigOverride $view_config */
        // Ensure that views are translated as expected.
        $view_config = \Drupal::languageManager()->getLanguageConfigOverride('es', 'views.view.who_s_new');
        $this->assertSame('Aplicar', $view_config->get('display.default.display_options.exposed_form.options.submit_button'));
        $view_config = \Drupal::languageManager()->getLanguageConfigOverride('es', 'views.view.archive');
        $this->assertSame('Aplicar', $view_config->get('display.default.display_options.exposed_form.options.submit_button'));
        // Manually update the translation status so can re-run the import.
        $status = locale_translation_get_status();
        $status['drupal']['es']->type = 'local';
        $status['drupal']['es']->files['local']->timestamp = time();
        \Drupal::keyValue('locale.translation_status')->set('drupal', $status['drupal']);
        // Run the translation import.
        $this->drupalGet('admin/reports/translations');
        $this->submitForm([], 'Update translations');
        // Ensure that only the config we expected to have changed has.
        $comparer = $this->configImporter()
            ->getStorageComparer();
        $expected_changelist_spanish_collection = [
            'create' => [],
            // The view was untranslated but the translation exists so the installer
            // performs the translation.
'update' => [
                'views.view.who_s_new',
            ],
            'delete' => [],
            'rename' => [],
        ];
        $this->assertEquals($expected_changelist_spanish_collection, $comparer->getChangelist(NULL, 'language.es'));
        // Change a translation and ensure configuration is updated.
        $po = <<<PO
msgid ""
msgstr ""

msgid "Anonymous"
msgstr "Anonymous es"

msgid "Apply"
msgstr "Aplicar New"

PO;
        file_put_contents($this->publicFilesDirectory . '/translations/drupal-8.0.0.es.po', $po);
        // Manually update the translation status so can re-run the import.
        $status = locale_translation_get_status();
        $status['drupal']['es']->type = 'local';
        $status['drupal']['es']->files['local']->timestamp = time();
        \Drupal::keyValue('locale.translation_status')->set('drupal', $status['drupal']);
        // Run the translation import.
        $this->drupalGet('admin/reports/translations');
        $this->submitForm([], 'Update translations');
        $translation = \Drupal::service('locale.storage')->findTranslation([
            'source' => 'Apply',
            'language' => 'es',
        ]);
        $this->assertSame('Aplicar New', $translation->getString());
        $this->assertFalse((bool) $translation->customized, "A non-customized translation has been created for Apply");
        // Ensure that only the config we expected to have changed has.
        $comparer = $this->configImporter()
            ->getStorageComparer();
        $expected_changelist_spanish_collection = [
            'create' => [],
            // All views with 'Aplicar' will have been changed to use the new
            // translation.
'update' => [
                'views.view.archive',
                'views.view.content_recent',
                'views.view.frontpage',
                'views.view.glossary',
                'views.view.who_s_new',
                'views.view.who_s_online',
            ],
            'delete' => [],
            'rename' => [],
        ];
        $this->assertEquals($expected_changelist_spanish_collection, $comparer->getChangelist(NULL, 'language.es'));
    }
    
    /**
     * Returns the string for the test .po file.
     *
     * @param string $langcode
     *   The language code.
     *
     * @return string
     *   Contents for the test .po file.
     */
    protected function getPo($langcode) : string {
        return <<<PO
msgid ""
msgstr ""

msgid "Anonymous"
msgstr "Anonymous {<span class="php-variable">$langcode</span>}"

msgid "Apply"
msgstr "Aplicar"

PO;
    }

}

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. 723
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::initMink protected function Initializes Mink sessions. 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::__construct public function 1
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
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 &#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::$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::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
InstallerConfigDirectoryTestBase::copyDirectory protected function This copies a source directory to a destination directory recursively.
InstallerConfigDirectoryTestBase::installParameters protected function Returns the parameters that will be used when the test installs Drupal. Overrides InstallerTestBase::installParameters
InstallerExistingConfigSyncDirectoryMultilingualTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
InstallerExistingConfigSyncDirectoryMultilingualTest::$existingSyncDirectory protected property Overrides InstallerConfigDirectoryTestBase::$existingSyncDirectory
InstallerExistingConfigSyncDirectoryMultilingualTest::$profile protected property This is set by the profile in the core.extension extracted. Overrides InstallerConfigDirectoryTestBase::$profile
InstallerExistingConfigSyncDirectoryMultilingualTest::getConfigLocation protected function Gets the path to the configuration directory. Overrides InstallerConfigDirectoryTestBase::getConfigLocation
InstallerExistingConfigSyncDirectoryMultilingualTest::getPo protected function Returns the string for the test .po file.
InstallerExistingConfigSyncDirectoryMultilingualTest::prepareEnvironment protected function Prepares the current environment for running the test. Overrides InstallerConfigDirectoryTestBase::prepareEnvironment
InstallerExistingConfigSyncDirectoryMultilingualTest::setUpProfile protected function Installer step: Select installation profile. Overrides InstallerConfigDirectoryTestBase::setUpProfile
InstallerExistingConfigSyncDirectoryMultilingualTest::testConfigSync public function Confirms that the installation installed the configuration correctly. Overrides InstallerConfigDirectoryTestBase::testConfigSync
InstallerTestBase::$isInstalled protected property Whether the installer has completed.
InstallerTestBase::$langcode protected property The language code in which to install Drupal. 9
InstallerTestBase::$parameters protected property Additional parameters to use for installer screens.
InstallerTestBase::$settings protected property Custom settings.php values to write for a test run.
InstallerTestBase::$translations protected property A string translation map used for translated installer screens.
InstallerTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
InstallerTestBase::installDrupal public function We are testing the installer, so set up a minimal environment for that. Overrides BrowserTestBase::installDrupal
InstallerTestBase::refreshVariables protected function FunctionalTestSetupTrait::refreshVariables() tries to operate on persistent
storage, which is only available after the installer completed.
Overrides RefreshVariablesTrait::refreshVariables
InstallerTestBase::setUp protected function Overrides BrowserTestBase::setUp 1
InstallerTestBase::setUpLanguage protected function Installer step: Select language. 15
InstallerTestBase::setUpRequirementsProblem protected function Installer step: Requirements problem. 6
InstallerTestBase::setUpSettings protected function Installer step: Configure settings. 21
InstallerTestBase::setUpSite protected function Final installer step: Configure site. 19
InstallerTestBase::visitInstaller protected function Visits the interactive installer. 7
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.
RequirementsPageTrait::assertErrorSummaries protected function Asserts the given error summaries are present on the page.
RequirementsPageTrait::assertRequirementSummaries protected function Asserts the given requirements section summaries are present on the page.
RequirementsPageTrait::assertWarningSummaries protected function Asserts the given warning summaries are present on the page.
RequirementsPageTrait::continueOnExpectedWarnings protected function Continues installation when the expected warnings are found.
RequirementsPageTrait::updateRequirementsProblem protected function Handles the update requirements page.
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. 4
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.