Basic Locale Source tests.
@group tmgmt
Expanded class hierarchy of LocaleSourceTest
class LocaleSourceTest extends TMGMTKernelTestBase {
/**
* Modules to enable.
*
* @var array
*/
protected 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();
$npath = \Drupal::service('extension.list.module')
->getPath('tmgmt_locale');
$file->uri = \Drupal::service('file_system')
->realpath($npath . '/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
->assertEquals($locale_object->lid, $item1
->getItemId(), 'Locale Strings object correctly saved');
$this
->assertEquals('Locale', $item1
->getSourceType());
$this
->assertEquals('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
->assertEquals('Locale', $item1
->getSourceType());
$this
->assertEquals($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
->assertEquals('de translation', $data[1]['singular']['#text']);
// 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
->assertEquals(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
->assertEquals($expected_escape, $data['singular']['#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) {
// 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) {
// 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
->assertEquals($expected_translation, $actual_translation->translation);
$this
->assertEquals(LOCALE_CUSTOMIZED, $actual_translation->customized);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
LocaleSourceTest:: |
protected static | property |
Modules to enable. Overrides TMGMTKernelTestBase:: |
|
LocaleSourceTest:: |
public | function | Asserts a locale translation. | |
LocaleSourceTest:: |
function |
Overrides TMGMTKernelTestBase:: |
||
LocaleSourceTest:: |
function | Verifies that strings that need escaping are correctly identified. | ||
LocaleSourceTest:: |
function | Tests that system behaves correctly with an non-existing locales. | ||
LocaleSourceTest:: |
function | + * Test if the source is able to pull content in requested language. + | ||
LocaleSourceTest:: |
function | Tests translation of a locale singular term. | ||
TMGMTKernelTestBase:: |
protected | property | A default translator using the test translator. | |
TMGMTKernelTestBase:: |
function | Sets the proper environment. | ||
TMGMTKernelTestBase:: |
function | Asserts job item language codes. | ||
TMGMTKernelTestBase:: |
protected | function | Creates, saves and returns a translation job. | |
TMGMTKernelTestBase:: |
function | Creates, saves and returns a translator. |