You are here

Home » API reference » Translation Management Tool 8 » LocaleSourceTest.php

class LocaleSourceTest in Translation Management Tool 8

Basic Locale Source tests.

@group tmgmt

Hierarchy

Expanded class hierarchy of LocaleSourceTest

File

sources/locale/tests/src/Kernel/LocaleSourceTest.php, line 14

Namespace

Drupal\Tests\tmgmt_locale\Kernel
View source 
class LocaleSourceTest extends TMGMTKernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'tmgmt_locale',
  );

  /**
   * {@inheritdoc}
   */
  function setUp() : void {
    parent::setUp();
    $this->langcode = 'de';
    $this->context = 'default';
    \Drupal::service('router.builder')
      ->rebuild();
    $this
      ->installSchema('locale', array(
      'locales_source',
      'locales_target',
    ));
    $file = new \stdClass();
    $file->uri = \Drupal::service('file_system')
      ->realpath(drupal_get_path('module', 'tmgmt_locale') . '/tests/test.xx.po');
    $file->langcode = $this->langcode;
    Gettext::fileToDatabase($file, array());
    $this
      ->addLanguage('es');
  }

  /**
   *  Tests translation of a locale singular term.
   */
  function testSingularTerm() {

    // Obtain one locale string with translation.
    $locale_object = \Drupal::database()
      ->query('SELECT * FROM {locales_source} WHERE source = :source LIMIT 1', array(
      ':source' => 'Hello World',
    ))
      ->fetchObject();
    $source_text = $locale_object->source;

    // Create the new job and job item.
    $job = $this
      ->createJob();
    $job->translator = $this->default_translator
      ->id();
    $job->settings = array();
    $job
      ->save();
    $item1 = $job
      ->addItem('locale', 'default', $locale_object->lid);

    // Check the structure of the imported data.
    $this
      ->assertEqual($item1
      ->getItemId(), $locale_object->lid, 'Locale Strings object correctly saved');
    $this
      ->assertEqual('Locale', $item1
      ->getSourceType());
    $this
      ->assertEqual('Hello World', $item1
      ->getSourceLabel());
    $job
      ->requestTranslation();
    foreach ($job
      ->getItems() as $item) {

      /* @var $item JobItemInterface */
      $item
        ->acceptTranslation();
      $this
        ->assertTrue($item
        ->isAccepted());

      // The source is now available in en and de.
      $this
        ->assertJobItemLangCodes($item, 'en', array(
        'en',
        'de',
      ));
    }

    // Check string translation.
    $expected_translation = $job
      ->getTargetLangcode() . '(' . $job
      ->getRemoteTargetLanguage() . '): ' . $source_text;
    $this
      ->assertTranslation($locale_object->lid, 'de', $expected_translation);

    // Translate the german translation to spanish.
    $target_langcode = 'es';
    $job = $this
      ->createJob('de', $target_langcode);
    $job->translator = $this->default_translator
      ->id();
    $job->settings = array();
    $job
      ->save();
    $item1 = $job
      ->addItem('locale', 'default', $locale_object->lid);
    $this
      ->assertEqual('Locale', $item1
      ->getSourceType());
    $this
      ->assertEqual($expected_translation, $item1
      ->getSourceLabel());
    $job
      ->requestTranslation();
    foreach ($job
      ->getItems() as $item) {

      /* @var $item JobItemInterface */
      $item
        ->acceptTranslation();
      $this
        ->assertTrue($item
        ->isAccepted());

      // The source should be now available for en, de and es languages.
      $this
        ->assertJobItemLangCodes($item, 'en', array(
        'en',
        'de',
        'es',
      ));
    }

    // Check string translation.
    $this
      ->assertTranslation($locale_object->lid, $target_langcode, $job
      ->getTargetLangcode() . ': ' . $expected_translation);
  }

  /**
    +   * Test if the source is able to pull content in requested language.
    +   */
  function testRequestDataForSpecificLanguage() {
    $this
      ->addLanguage('cs');
    $locale_object = \Drupal::database()
      ->query('SELECT * FROM {locales_source} WHERE source = :source LIMIT 1', array(
      ':source' => 'Hello World',
    ))
      ->fetchObject();
    $plugin = $this->container
      ->get('plugin.manager.tmgmt.source')
      ->createInstance('locale');
    $reflection_plugin = new \ReflectionClass('\\Drupal\\tmgmt_locale\\Plugin\\tmgmt\\Source\\LocaleSource');
    $updateTranslation = $reflection_plugin
      ->getMethod('updateTranslation');
    $updateTranslation
      ->setAccessible(TRUE);
    $updateTranslation
      ->invoke($plugin, $locale_object->lid, 'de', 'de translation');

    // Create the new job and job item.
    $job = $this
      ->createJob('de', 'cs');
    $job
      ->save();
    $job
      ->addItem('locale', 'default', $locale_object->lid);
    $data = $job
      ->getData();
    $this
      ->assertEqual($data[1]['singular']['#text'], 'de translation');

    // Create new job item with a source language for which the translation
    // does not exit.
    $job = $this
      ->createJob('es', 'cs');
    $job
      ->save();
    try {
      $job
        ->addItem('locale', 'default', $locale_object->lid);
      $this
        ->fail('The job item should not be added as there is no translation for language "es"');
    } catch (\Exception $e) {
      $languages = \Drupal::languageManager()
        ->getLanguages();

      // @todo Job item id missing because it is not saved yet.
      $this
        ->assertEqual(t('Unable to load %language translation for the locale %id', array(
        '%language' => $languages['es']
          ->getName(),
        '%id' => $locale_object->lid,
      )), $e
        ->getMessage());
    }
  }

  /**
   * Verifies that strings that need escaping are correctly identified.
   */
  function testEscaping() {
    $lid = \Drupal::database()
      ->insert('locales_source')
      ->fields(array(
      'source' => '@place-holders need %to be !esc_aped.',
      'context' => '',
    ))
      ->execute();
    $job = $this
      ->createJob('en', 'de');
    $job->translator = $this->default_translator
      ->id();
    $job->settings = array();
    $job
      ->save();
    $item = $job
      ->addItem('locale', 'default', $lid);
    $data = $item
      ->getData();
    $expected_escape = array(
      0 => array(
        'string' => '@place-holders',
      ),
      20 => array(
        'string' => '%to',
      ),
      27 => array(
        'string' => '!esc_aped',
      ),
    );
    $this
      ->assertEqual($data['singular']['#escape'], $expected_escape);

    // Invalid patterns that should be ignored.
    $lid = \Drupal::database()
      ->insert('locales_source')
      ->fields(array(
      'source' => '@ % ! example',
      'context' => '',
    ))
      ->execute();
    $item = $job
      ->addItem('locale', 'default', $lid);
    $data = $item
      ->getData();
    $this
      ->assertTrue(empty($data[$lid]['#escape']));
  }

  /**
   * Tests that system behaves correctly with an non-existing locales.
   */
  function testInexistantSource() {

    // Create inexistant locale object.
    $locale_object = new \stdClass();
    $locale_object->lid = 0;

    // Create the job.
    $job = $this
      ->createJob();
    $job->translator = $this->default_translator
      ->id();
    $job->settings = array();
    $job
      ->save();

    // Create the job item.
    try {
      $job
        ->addItem('locale', 'default', $locale_object->lid);
      $this
        ->fail('Job item add with an inexistant locale.');
    } catch (\Exception $e) {
      $this
        ->pass('Exception thrown when trying to translate non-existing locale string');
    }

    // Try to translate a source string without translation from german to
    // spanish.
    $lid = \Drupal::database()
      ->insert('locales_source')
      ->fields(array(
      'source' => 'No translation',
      'context' => '',
    ))
      ->execute();
    $job = $this
      ->createJob('de', 'fr');
    $job->translator = $this->default_translator
      ->id();
    $job->settings = array();
    $job
      ->save();
    try {
      $job
        ->addItem('locale', 'default', $lid);
      $this
        ->fail('Job item add with an non-existing locale did not fail.');
    } catch (\Exception $e) {
      $this
        ->pass('Job item add with an non-existing locale did fail.');
    }
  }

  /**
   * Asserts a locale translation.
   *
   * @param int $lid
   *   The locale source id.
   * @param string $target_langcode
   *   The target language code.
   * @param string $expected_translation
   *   The expected translation.
   */
  public function assertTranslation($lid, $target_langcode, $expected_translation) {
    $actual_translation = \Drupal::database()
      ->query('SELECT * FROM {locales_target} WHERE lid = :lid AND language = :language', array(
      ':lid' => $lid,
      ':language' => $target_langcode,
    ))
      ->fetch();
    $this
      ->assertEqual($actual_translation->translation, $expected_translation);
    $this
      ->assertEqual($actual_translation->customized, LOCALE_CUSTOMIZED);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
LocaleSourceTest::$modules public static property Modules to enable. Overrides TMGMTKernelTestBase::$modules
LocaleSourceTest::assertTranslation public function Asserts a locale translation.
LocaleSourceTest::setUp function Overrides TMGMTKernelTestBase::setUp
LocaleSourceTest::testEscaping function Verifies that strings that need escaping are correctly identified.
LocaleSourceTest::testInexistantSource function Tests that system behaves correctly with an non-existing locales.
LocaleSourceTest::testRequestDataForSpecificLanguage function + * Test if the source is able to pull content in requested language. +
LocaleSourceTest::testSingularTerm function Tests translation of a locale singular term.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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.
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. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TMGMTKernelTestBase::$default_translator protected property A default translator using the test translator.
TMGMTKernelTestBase::addLanguage function Sets the proper environment.
TMGMTKernelTestBase::assertJobItemLangCodes function Asserts job item language codes.
TMGMTKernelTestBase::createJob protected function Creates, saves and returns a translation job.
TMGMTKernelTestBase::createTranslator function Creates, saves and returns a translator.