class LocaleUpdateTest in Drupal 10

Tests for updating the interface translations of projects.

@group locale

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\locale\Functional\LocaleUpdateBase
    • class \Drupal\Tests\locale\Functional\LocaleUpdateTest

File

core/modules/locale/tests/src/Functional/LocaleUpdateTest.php, line 13

Namespace

Drupal\Tests\locale\Functional

class LocaleUpdateTest extends LocaleUpdateBase {

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $module_handler = \Drupal::moduleHandler();
    $module_handler
      ->loadInclude('locale', 'inc', 'locale.compare');
    $module_handler
      ->loadInclude('locale', 'inc', 'locale.fetch');
    $admin_user = $this
      ->drupalCreateUser([
      'administer modules',
      'administer site configuration',
      'administer languages',
      'access administration pages',
      'translate interface',
    ]);
    $this
      ->drupalLogin($admin_user);

    // We use German as test language. This language must match the translation
    // file that come with the locale_test module (test.de.po) and can therefore
    // not be chosen randomly.
    $this
      ->addLanguage('de');
  }

  /**
   * Checks if local or remote translation sources are detected.
   *
   * The translation status process by default checks the status of the
   * installed projects. For testing purpose a predefined set of modules with
   * fixed file names and release versions is used. This custom project
   * definition is applied using a hook_locale_translation_projects_alter
   * implementation in the locale_test module.
   *
   * This test generates a set of local and remote translation files in their
   * respective local and remote translation directory. The test checks whether
   * the most recent files are selected in the different check scenarios: check
   * for local files only, check for both local and remote files.
   */
  public function testUpdateCheckStatus() {

    // Case when contributed modules are absent.
    $this
      ->drupalGet('admin/reports/translations');
    $this
      ->assertSession()
      ->pageTextContains('Missing translations for one project');
    $config = $this
      ->config('locale.settings');

    // Set a flag to let the locale_test module replace the project data with a
    // set of test projects.
    \Drupal::state()
      ->set('locale.test_projects_alter', TRUE);

    // Create local and remote translations files.
    $this
      ->setTranslationFiles();
    $config
      ->set('translation.default_filename', '%project-%version.%language._po')
      ->save();

    // Set the test conditions.
    $edit = [
      'use_source' => LOCALE_TRANSLATION_USE_SOURCE_LOCAL,
    ];
    $this
      ->drupalGet('admin/config/regional/translate/settings');
    $this
      ->submitForm($edit, 'Save configuration');

    // Get status of translation sources at local file system.
    $this
      ->drupalGet('admin/reports/translations/check');
    $result = locale_translation_get_status();
    $this
      ->assertEquals(LOCALE_TRANSLATION_LOCAL, $result['contrib_module_one']['de']->type, 'Translation of contrib_module_one found');
    $this
      ->assertEquals($this->timestampOld, $result['contrib_module_one']['de']->timestamp, 'Translation timestamp found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_LOCAL, $result['contrib_module_two']['de']->type, 'Translation of contrib_module_two found');
    $this
      ->assertEquals($this->timestampNew, $result['contrib_module_two']['de']->timestamp, 'Translation timestamp found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_LOCAL, $result['locale_test']['de']->type, 'Translation of locale_test found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_LOCAL, $result['custom_module_one']['de']->type, 'Translation of custom_module_one found');

    // Set the test conditions.
    $edit = [
      'use_source' => LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL,
    ];
    $this
      ->drupalGet('admin/config/regional/translate/settings');
    $this
      ->submitForm($edit, 'Save configuration');

    // Get status of translation sources at both local and remote locations.
    $this
      ->drupalGet('admin/reports/translations/check');
    $result = locale_translation_get_status();
    $this
      ->assertEquals(LOCALE_TRANSLATION_REMOTE, $result['contrib_module_one']['de']->type, 'Translation of contrib_module_one found');
    $this
      ->assertEquals($this->timestampNew, $result['contrib_module_one']['de']->timestamp, 'Translation timestamp found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_LOCAL, $result['contrib_module_two']['de']->type, 'Translation of contrib_module_two found');
    $this
      ->assertEquals($this->timestampNew, $result['contrib_module_two']['de']->timestamp, 'Translation timestamp found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_LOCAL, $result['contrib_module_three']['de']->type, 'Translation of contrib_module_three found');
    $this
      ->assertEquals($this->timestampOld, $result['contrib_module_three']['de']->timestamp, 'Translation timestamp found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_LOCAL, $result['locale_test']['de']->type, 'Translation of locale_test found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_LOCAL, $result['custom_module_one']['de']->type, 'Translation of custom_module_one found');
  }

  /**
   * Tests translation import from remote sources.
   *
   * Test conditions:
   *  - Source: remote and local files
   *  - Import overwrite: all existing translations
   */
  public function testUpdateImportSourceRemote() {
    $config = $this
      ->config('locale.settings');

    // Build the test environment.
    $this
      ->setTranslationFiles();
    $this
      ->setCurrentTranslations();
    $config
      ->set('translation.default_filename', '%project-%version.%language._po');

    // Set the update conditions for this test.
    $edit = [
      'use_source' => LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL,
      'overwrite' => LOCALE_TRANSLATION_OVERWRITE_ALL,
    ];
    $this
      ->drupalGet('admin/config/regional/translate/settings');
    $this
      ->submitForm($edit, 'Save configuration');

    // Get the translation status.
    $this
      ->drupalGet('admin/reports/translations/check');

    // Check the status on the Available translation status page.
    $this
      ->assertSession()
      ->responseContains('<label for="edit-langcodes-de" class="visually-hidden">Update German</label>');
    $this
      ->assertSession()
      ->pageTextContains('Updates for: Contributed module one, Contributed module two, Custom module one, Locale test');

    /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
    $date_formatter = $this->container
      ->get('date.formatter');
    $this
      ->assertSession()
      ->pageTextContains('Contributed module one (' . $date_formatter
      ->format($this->timestampNew, 'html_date') . ')');
    $this
      ->assertSession()
      ->pageTextContains('Contributed module two (' . $date_formatter
      ->format($this->timestampNew, 'html_date') . ')');

    // Execute the translation update.
    $this
      ->drupalGet('admin/reports/translations');
    $this
      ->submitForm([], 'Update translations');

    // Check if the translation has been updated, using the status cache.
    $status = locale_translation_get_status();
    $this
      ->assertEquals(LOCALE_TRANSLATION_CURRENT, $status['contrib_module_one']['de']->type, 'Translation of contrib_module_one found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_CURRENT, $status['contrib_module_two']['de']->type, 'Translation of contrib_module_two found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_CURRENT, $status['contrib_module_three']['de']->type, 'Translation of contrib_module_three found');

    // Check the new translation status.
    // The static cache needs to be flushed first to get the most recent data
    // from the database. The function was called earlier during this test.
    drupal_static_reset('locale_translation_get_file_history');
    $history = locale_translation_get_file_history();

    // Verify that the translation of contrib_module_one is imported and
    // updated.
    $this
      ->assertGreaterThanOrEqual($this->timestampNow, $history['contrib_module_one']['de']->timestamp);
    $this
      ->assertGreaterThanOrEqual($this->timestampNow, $history['contrib_module_one']['de']->last_checked);
    $this
      ->assertEquals($this->timestampNew, $history['contrib_module_two']['de']->timestamp, 'Translation of contrib_module_two is imported');

    // Verify that the translation of contrib_module_two is updated.
    $this
      ->assertGreaterThanOrEqual($this->timestampNow, $history['contrib_module_two']['de']->last_checked);
    $this
      ->assertEquals($this->timestampMedium, $history['contrib_module_three']['de']->timestamp, 'Translation of contrib_module_three is not imported');
    $this
      ->assertEquals($this->timestampMedium, $history['contrib_module_three']['de']->last_checked, 'Translation of contrib_module_three is not updated');

    // Check whether existing translations have (not) been overwritten.
    // cSpell:disable
    $this
      ->assertEquals('Januar_1', t('January', [], [
      'langcode' => 'de',
    ]), 'Translation of January');
    $this
      ->assertEquals('Februar_2', t('February', [], [
      'langcode' => 'de',
    ]), 'Translation of February');
    $this
      ->assertEquals('Marz_2', t('March', [], [
      'langcode' => 'de',
    ]), 'Translation of March');
    $this
      ->assertEquals('April_2', t('April', [], [
      'langcode' => 'de',
    ]), 'Translation of April');
    $this
      ->assertEquals('Mai_customized', t('May', [], [
      'langcode' => 'de',
    ]), 'Translation of May');
    $this
      ->assertEquals('Juni', t('June', [], [
      'langcode' => 'de',
    ]), 'Translation of June');
    $this
      ->assertEquals('Montag', t('Monday', [], [
      'langcode' => 'de',
    ]), 'Translation of Monday');

    // cSpell:enable
  }

  /**
   * Tests translation import from local sources.
   *
   * Test conditions:
   *  - Source: local files only
   *  - Import overwrite: all existing translations
   */
  public function testUpdateImportSourceLocal() {
    $config = $this
      ->config('locale.settings');

    // Build the test environment.
    $this
      ->setTranslationFiles();
    $this
      ->setCurrentTranslations();
    $config
      ->set('translation.default_filename', '%project-%version.%language._po');

    // Set the update conditions for this test.
    $edit = [
      'use_source' => LOCALE_TRANSLATION_USE_SOURCE_LOCAL,
      'overwrite' => LOCALE_TRANSLATION_OVERWRITE_ALL,
    ];
    $this
      ->drupalGet('admin/config/regional/translate/settings');
    $this
      ->submitForm($edit, 'Save configuration');

    // Execute the translation update.
    $this
      ->drupalGet('admin/reports/translations/check');
    $this
      ->drupalGet('admin/reports/translations');
    $this
      ->submitForm([], 'Update translations');

    // Check if the translation has been updated, using the status cache.
    $status = locale_translation_get_status();
    $this
      ->assertEquals(LOCALE_TRANSLATION_CURRENT, $status['contrib_module_one']['de']->type, 'Translation of contrib_module_one found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_CURRENT, $status['contrib_module_two']['de']->type, 'Translation of contrib_module_two found');
    $this
      ->assertEquals(LOCALE_TRANSLATION_CURRENT, $status['contrib_module_three']['de']->type, 'Translation of contrib_module_three found');

    // Check the new translation status.
    // The static cache needs to be flushed first to get the most recent data
    // from the database. The function was called earlier during this test.
    drupal_static_reset('locale_translation_get_file_history');
    $history = locale_translation_get_file_history();

    // Verify that the translation of contrib_module_one is imported.
    $this
      ->assertGreaterThanOrEqual($this->timestampMedium, $history['contrib_module_one']['de']->timestamp);
    $this
      ->assertEquals($this->timestampMedium, $history['contrib_module_one']['de']->last_checked, 'Translation of contrib_module_one is updated');
    $this
      ->assertEquals($this->timestampNew, $history['contrib_module_two']['de']->timestamp, 'Translation of contrib_module_two is imported');

    // Verify that the translation of contrib_module_two is updated.
    $this
      ->assertGreaterThanOrEqual($this->timestampNow, $history['contrib_module_two']['de']->last_checked);
    $this
      ->assertEquals($this->timestampMedium, $history['contrib_module_three']['de']->timestamp, 'Translation of contrib_module_three is not imported');
    $this
      ->assertEquals($this->timestampMedium, $history['contrib_module_three']['de']->last_checked, 'Translation of contrib_module_three is not updated');

    // Check whether existing translations have (not) been overwritten.
    // cSpell:disable
    $this
      ->assertEquals('Januar_customized', t('January', [], [
      'langcode' => 'de',
    ]), 'Translation of January');
    $this
      ->assertEquals('Februar_2', t('February', [], [
      'langcode' => 'de',
    ]), 'Translation of February');
    $this
      ->assertEquals('Marz_2', t('March', [], [
      'langcode' => 'de',
    ]), 'Translation of March');
    $this
      ->assertEquals('April_2', t('April', [], [
      'langcode' => 'de',
    ]), 'Translation of April');
    $this
      ->assertEquals('Mai_customized', t('May', [], [
      'langcode' => 'de',
    ]), 'Translation of May');
    $this
      ->assertEquals('Juni', t('June', [], [
      'langcode' => 'de',
    ]), 'Translation of June');
    $this
      ->assertEquals('Montag', t('Monday', [], [
      'langcode' => 'de',
    ]), 'Translation of Monday');

    // cSpell:enable
  }

  /**
   * Tests translation import and only overwrite non-customized translations.
   *
   * Test conditions:
   *  - Source: remote and local files
   *  - Import overwrite: only overwrite non-customized translations
   */
  public function testUpdateImportModeNonCustomized() {
    $config = $this
      ->config('locale.settings');

    // Build the test environment.
    $this
      ->setTranslationFiles();
    $this
      ->setCurrentTranslations();
    $config
      ->set('translation.default_filename', '%project-%version.%language._po');

    // Set the test conditions.
    $edit = [
      'use_source' => LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL,
      'overwrite' => LOCALE_TRANSLATION_OVERWRITE_NON_CUSTOMIZED,
    ];
    $this
      ->drupalGet('admin/config/regional/translate/settings');
    $this
      ->submitForm($edit, 'Save configuration');

    // Execute translation update.
    $this
      ->drupalGet('admin/reports/translations/check');
    $this
      ->drupalGet('admin/reports/translations');
    $this
      ->submitForm([], 'Update translations');

    // Check whether existing translations have (not) been overwritten.
    // cSpell:disable
    $this
      ->assertEquals('Januar_customized', t('January', [], [
      'langcode' => 'de',
    ]), 'Translation of January');
    $this
      ->assertEquals('Februar_customized', t('February', [], [
      'langcode' => 'de',
    ]), 'Translation of February');
    $this
      ->assertEquals('Marz_2', t('March', [], [
      'langcode' => 'de',
    ]), 'Translation of March');
    $this
      ->assertEquals('April_2', t('April', [], [
      'langcode' => 'de',
    ]), 'Translation of April');
    $this
      ->assertEquals('Mai_customized', t('May', [], [
      'langcode' => 'de',
    ]), 'Translation of May');
    $this
      ->assertEquals('Juni', t('June', [], [
      'langcode' => 'de',
    ]), 'Translation of June');
    $this
      ->assertEquals('Montag', t('Monday', [], [
      'langcode' => 'de',
    ]), 'Translation of Monday');

    // cSpell:enable
  }

  /**
   * Tests translation import and don't overwrite any translation.
   *
   * Test conditions:
   *  - Source: remote and local files
   *  - Import overwrite: don't overwrite any existing translation
   */
  public function testUpdateImportModeNone() {
    $config = $this
      ->config('locale.settings');

    // Build the test environment.
    $this
      ->setTranslationFiles();
    $this
      ->setCurrentTranslations();
    $config
      ->set('translation.default_filename', '%project-%version.%language._po');

    // Set the test conditions.
    $edit = [
      'use_source' => LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL,
      'overwrite' => LOCALE_TRANSLATION_OVERWRITE_NONE,
    ];
    $this
      ->drupalGet('admin/config/regional/translate/settings');
    $this
      ->submitForm($edit, 'Save configuration');

    // Execute translation update.
    $this
      ->drupalGet('admin/reports/translations/check');
    $this
      ->drupalGet('admin/reports/translations');
    $this
      ->submitForm([], 'Update translations');

    // Check whether existing translations have (not) been overwritten.
    // cSpell:disable
    $this
      ->assertTranslation('January', 'Januar_customized', 'de');
    $this
      ->assertTranslation('February', 'Februar_customized', 'de');
    $this
      ->assertTranslation('March', 'Marz', 'de');
    $this
      ->assertTranslation('April', 'April_2', 'de');
    $this
      ->assertTranslation('May', 'Mai_customized', 'de');
    $this
      ->assertTranslation('June', 'Juni', 'de');
    $this
      ->assertTranslation('Monday', 'Montag', 'de');

    // cSpell:enable
  }

  /**
   * Tests automatic translation import when a module is enabled.
   */
  public function testEnableUninstallModule() {

    // Make the hidden test modules look like a normal custom module.
    \Drupal::state()
      ->set('locale.test_system_info_alter', TRUE);

    // Check if there is no translation yet.
    $this
      ->assertTranslation('Tuesday', '', 'de');

    // Enable a module.
    $edit = [
      'modules[locale_test_translate][enable]' => 'locale_test_translate',
    ];
    $this
      ->drupalGet('admin/modules');
    $this
      ->submitForm($edit, 'Install');

    // Check if translations have been imported.
    $this
      ->assertSession()
      ->pageTextContains("One translation file imported. 7 translations were added, 0 translations were updated and 0 translations were removed.");

    // cSpell:disable-next-line
    $this
      ->assertTranslation('Tuesday', 'Dienstag', 'de');
    $edit = [
      'uninstall[locale_test_translate]' => 1,
    ];
    $this
      ->drupalGet('admin/modules/uninstall');
    $this
      ->submitForm($edit, 'Uninstall');
    $this
      ->submitForm([], 'Uninstall');

    // Check if the file data is removed from the database.
    $history = locale_translation_get_file_history();
    $this
      ->assertFalse(isset($history['locale_test_translate']), 'Project removed from the file history');
    $projects = locale_translation_get_projects();
    $this
      ->assertFalse(isset($projects['locale_test_translate']), 'Project removed from the project list');
  }

  /**
   * Tests automatic translation import when a language is added.
   *
   * When a language is added, the system will check for translations files of
   * enabled modules and will import them. When a language is removed the system
   * will remove all translations of that language from the database.
   */
  public function testEnableLanguage() {

    // Make the hidden test modules look like a normal custom module.
    \Drupal::state()
      ->set('locale.test_system_info_alter', TRUE);

    // Enable a module.
    $edit = [
      'modules[locale_test_translate][enable]' => 'locale_test_translate',
    ];
    $this
      ->drupalGet('admin/modules');
    $this
      ->submitForm($edit, 'Install');

    // Check if there is no Dutch translation yet.
    $this
      ->assertTranslation('Extraday', '', 'nl');

    // cSpell:disable-next-line
    $this
      ->assertTranslation('Tuesday', 'Dienstag', 'de');

    // Add a language.
    $edit = [
      'predefined_langcode' => 'nl',
    ];
    $this
      ->drupalGet('admin/config/regional/language/add');
    $this
      ->submitForm($edit, 'Add language');

    // Check if the right number of translations are added.
    $this
      ->assertSession()
      ->pageTextContains("One translation file imported. 8 translations were added, 0 translations were updated and 0 translations were removed.");

    // cSpell:disable-next-line
    $this
      ->assertTranslation('Extraday', 'extra dag', 'nl');

    // Check if the language data is added to the database.
    $connection = Database::getConnection();
    $result = $connection
      ->select('locale_file', 'lf')
      ->fields('lf', [
      'project',
    ])
      ->condition('langcode', 'nl')
      ->execute()
      ->fetchField();
    $this
      ->assertNotEmpty($result, 'Files added to file history');

    // Remove a language.
    $this
      ->drupalGet('admin/config/regional/language/delete/nl');
    $this
      ->submitForm([], 'Delete');

    // Check if the language data is removed from the database.
    $result = $connection
      ->select('locale_file', 'lf')
      ->fields('lf', [
      'project',
    ])
      ->condition('langcode', 'nl')
      ->execute()
      ->fetchField();
    $this
      ->assertFalse($result, 'Files removed from file history');

    // Check that the Dutch translation is gone.
    $this
      ->assertTranslation('Extraday', '', 'nl');

    // cSpell:disable-next-line
    $this
      ->assertTranslation('Tuesday', 'Dienstag', 'de');
  }

  /**
   * Tests automatic translation import when a custom language is added.
   */
  public function testEnableCustomLanguage() {

    // Make the hidden test modules look like a normal custom module.
    \Drupal::state()
      ->set('locale.test_system_info_alter', TRUE);

    // Enable a module.
    $edit = [
      'modules[locale_test_translate][enable]' => 'locale_test_translate',
    ];
    $this
      ->drupalGet('admin/modules');
    $this
      ->submitForm($edit, 'Install');

    // Create a custom language with language code 'xx' and a random
    // name.
    $langcode = 'xx';
    $name = $this
      ->randomMachineName(16);
    $edit = [
      'predefined_langcode' => 'custom',
      'langcode' => $langcode,
      'label' => $name,
      'direction' => LanguageInterface::DIRECTION_LTR,
    ];
    $this
      ->drupalGet('admin/config/regional/language/add');
    $this
      ->submitForm($edit, 'Add custom language');

    // Ensure the translation file is automatically imported when the language
    // was added.
    $this
      ->assertSession()
      ->pageTextContains('One translation file imported.');
    $this
      ->assertSession()
      ->pageTextContains('One translation string was skipped because of disallowed or malformed HTML');

    // Ensure the strings were successfully imported.
    $search = [
      'string' => 'lundi',
      'langcode' => $langcode,
      'translation' => 'translated',
    ];
    $this
      ->drupalGet('admin/config/regional/translate');
    $this
      ->submitForm($search, 'Filter');
    $this
      ->assertSession()
      ->pageTextNotContains('No strings available.');

    // Ensure the multiline string was imported.
    $search = [
      'string' => 'Source string for multiline translation',
      'langcode' => $langcode,
      'translation' => 'all',
    ];
    $this
      ->drupalGet('admin/config/regional/translate');
    $this
      ->submitForm($search, 'Filter');
    $this
      ->assertSession()
      ->pageTextContains('Multiline translation string to make sure that import works with it.');

    // Ensure 'Allowed HTML source string' was imported but the translation for
    // 'Another allowed HTML source string' was not because it contains invalid
    // HTML.
    $search = [
      'string' => 'HTML source string',
      'langcode' => $langcode,
      'translation' => 'all',
    ];
    $this
      ->drupalGet('admin/config/regional/translate');
    $this
      ->submitForm($search, 'Filter');
    $this
      ->assertSession()
      ->pageTextContains('Allowed HTML source string');
    $this
      ->assertSession()
      ->pageTextNotContains('Another allowed HTML source string');
  }

}