Updated Drupal to 8.6. This goes with the following updates because it's possible...
[yaffs-website] / web / core / modules / system / tests / src / Functional / Theme / TwigTransTest.php
diff --git a/web/core/modules/system/tests/src/Functional/Theme/TwigTransTest.php b/web/core/modules/system/tests/src/Functional/Theme/TwigTransTest.php
new file mode 100644 (file)
index 0000000..aeafe7a
--- /dev/null
@@ -0,0 +1,299 @@
+<?php
+
+namespace Drupal\Tests\system\Functional\Theme;
+
+use Drupal\Core\Language\LanguageInterface;
+use Drupal\Tests\BrowserTestBase;
+
+/**
+ * Tests Twig "trans" tags.
+ *
+ * @group Theme
+ */
+class TwigTransTest extends BrowserTestBase {
+
+  /**
+   * Modules to enable.
+   *
+   * @var array
+   */
+  public static $modules = [
+    'theme_test',
+    'twig_theme_test',
+    'locale',
+    'language',
+  ];
+
+  /**
+   * An administrative user for testing.
+   *
+   * @var \Drupal\user\Entity\User
+   */
+  protected $adminUser;
+
+  /**
+   * Custom languages.
+   *
+   * @var array
+   */
+  protected $languages = [
+    'xx' => 'Lolspeak',
+    'zz' => 'Lolspeak2',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    // Setup test_theme.
+    \Drupal::service('theme_handler')->install(['test_theme']);
+    $this->config('system.theme')->set('default', 'test_theme')->save();
+
+    // Create and log in as admin.
+    $this->adminUser = $this->drupalCreateUser([
+      'administer languages',
+      'access administration pages',
+      'administer site configuration',
+      'translate interface',
+    ]);
+    $this->drupalLogin($this->adminUser);
+
+    // Install languages.
+    $this->installLanguages();
+
+    // Assign Lolspeak (xx) to be the default language.
+    $this->config('system.site')->set('default_langcode', 'xx')->save();
+    $this->rebuildContainer();
+
+    // Check that lolspeak is the default language for the site.
+    $this->assertEqual(\Drupal::languageManager()->getDefaultLanguage()->getId(), 'xx', 'Lolspeak is the default language');
+  }
+
+  /**
+   * Test Twig "trans" tags.
+   */
+  public function testTwigTransTags() {
+    // Run this once without and once with Twig debug because trans can work
+    // differently depending on that setting.
+    $this->drupalGet('twig-theme-test/trans', ['language' => \Drupal::languageManager()->getLanguage('xx')]);
+    $this->assertTwigTransTags();
+
+    // Enable debug, rebuild the service container, and clear all caches.
+    $parameters = $this->container->getParameter('twig.config');
+    $parameters['debug'] = TRUE;
+    $this->setContainerParameter('twig.config', $parameters);
+    $this->rebuildContainer();
+    $this->resetAll();
+
+    $this->drupalGet('twig-theme-test/trans', ['language' => \Drupal::languageManager()->getLanguage('xx')]);
+    $this->assertTwigTransTags();
+  }
+
+  /**
+   * Test empty Twig "trans" tags.
+   */
+  public function testEmptyTwigTransTags() {
+    $elements = [
+      '#type' => 'inline_template',
+      '#template' => '{% trans %}{% endtrans %}',
+    ];
+    /** @var \Drupal\Core\Render\RendererInterface $renderer */
+    $renderer = \Drupal::service('renderer');
+
+    try {
+      $renderer->renderPlain($elements);
+
+      $this->fail('{% trans %}{% endtrans %} did not throw an exception.');
+    }
+    catch (\Twig_Error_Syntax $e) {
+      $this->assertTrue(strstr($e->getMessage(), '{% trans %} tag cannot be empty'), '{% trans %}{% endtrans %} threw the expected exception.');
+    }
+    catch (\Exception $e) {
+      $this->fail('{% trans %}{% endtrans %} threw an unexpected exception.');
+    }
+  }
+
+  /**
+   * Asserts Twig trans tags.
+   */
+  protected function assertTwigTransTags() {
+    $this->assertText(
+      'OH HAI SUNZ',
+      '{% trans "Hello sun." %} was successfully translated.'
+    );
+
+    $this->assertText(
+      'O HAI SUNZZZZZZZ',
+      '{% trans "Hello sun." with {"context": "Lolspeak"} %} was successfully translated.'
+    );
+
+    $this->assertText(
+      'O HERRO ERRRF.',
+      '{{ "Hello Earth."|trans }} was successfully translated.'
+    );
+
+    $this->assertText(
+      'OH HAI TEH MUUN',
+      '{% trans %}Hello moon.{% endtrans %} was successfully translated.'
+    );
+
+    $this->assertText(
+      'O HAI STARRRRR',
+      '{% trans %} with {% plural count = 1 %} was successfully translated.'
+    );
+
+    $this->assertText(
+      'O HAI 2 STARZZZZ',
+      '{% trans %} with {% plural count = 2 %} was successfully translated.'
+    );
+
+    $this->assertRaw(
+      'ESCAPEE: &amp;&quot;&lt;&gt;',
+      '{{ token }} was successfully translated and prefixed with "@".'
+    );
+
+    $this->assertRaw(
+      'PLAYSHOLDR: <em class="placeholder">&amp;&quot;&lt;&gt;</em>',
+      '{{ token|placeholder }} was successfully translated and prefixed with "%".'
+    );
+
+    $this->assertRaw(
+      'DIS complex token HAZ LENGTH OV: 3. IT CONTAYNZ: <em class="placeholder">12345</em> AN &amp;&quot;&lt;&gt;.',
+      '{{ complex.tokens }} were successfully translated with appropriate prefixes.'
+    );
+
+    $this->assertText(
+      'I have context.',
+      '{% trans %} with a context only msgid was excluded from translation.'
+    );
+
+    $this->assertText(
+      'I HAZ KONTEX.',
+      '{% trans with {"context": "Lolspeak"} %} was successfully translated with context.'
+    );
+
+    $this->assertText(
+      'O HAI NU TXT.',
+      '{% trans with {"langcode": "zz"} %} was successfully translated in specified language.'
+    );
+
+    $this->assertText(
+      'O HAI NU TXTZZZZ.',
+      '{% trans with {"context": "Lolspeak", "langcode": "zz"} %} was successfully translated with context in specified language.'
+    );
+    // Makes sure https://www.drupal.org/node/2489024 doesn't happen without
+    // twig debug.
+    $this->assertNoText(pi(), 'Running php code inside a Twig trans is not possible.');
+  }
+
+  /**
+   * Helper function: install languages.
+   */
+  protected function installLanguages() {
+    foreach ($this->languages as $langcode => $name) {
+      // Generate custom .po contents for the language.
+      $contents = $this->poFileContents($langcode);
+      if ($contents) {
+        // Add test language for translation testing.
+        $edit = [
+          'predefined_langcode' => 'custom',
+          'langcode' => $langcode,
+          'label' => $name,
+          'direction' => LanguageInterface::DIRECTION_LTR,
+        ];
+
+        // Install the language in Drupal.
+        $this->drupalPostForm('admin/config/regional/language/add', $edit, t('Add custom language'));
+        $this->assertRaw('"edit-languages-' . $langcode . '-weight"', 'Language code found.');
+
+        // Import the custom .po contents for the language.
+        $filename = \Drupal::service('file_system')->tempnam('temporary://', "po_") . '.po';
+        file_put_contents($filename, $contents);
+        $options = [
+          'files[file]' => $filename,
+          'langcode' => $langcode,
+          'customized' => TRUE,
+        ];
+        $this->drupalPostForm('admin/config/regional/translate/import', $options, t('Import'));
+        drupal_unlink($filename);
+      }
+    }
+    $this->container->get('language_manager')->reset();
+  }
+
+  /**
+   * Generate a custom .po file for a specific test language.
+   *
+   * @param string $langcode
+   *   The langcode of the specified language.
+   *
+   * @return string|false
+   *   The .po contents for the specified language or FALSE if none exists.
+   */
+  protected function poFileContents($langcode) {
+    if ($langcode === 'xx') {
+      return <<< EOF
+msgid ""
+msgstr ""
+"Project-Id-Version: Drupal 8\\n"
+"MIME-Version: 1.0\\n"
+"Content-Type: text/plain; charset=UTF-8\\n"
+"Content-Transfer-Encoding: 8bit\\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\\n"
+
+msgid "Hello sun."
+msgstr "OH HAI SUNZ"
+
+msgctxt "Lolspeak"
+msgid "Hello sun."
+msgstr "O HAI SUNZZZZZZZ"
+
+msgid "Hello Earth."
+msgstr "O HERRO ERRRF."
+
+msgid "Hello moon."
+msgstr "OH HAI TEH MUUN"
+
+msgid "Hello star."
+msgid_plural "Hello @count stars."
+msgstr[0] "O HAI STARRRRR"
+msgstr[1] "O HAI @count STARZZZZ"
+
+msgid "Escaped: @string"
+msgstr "ESCAPEE: @string"
+
+msgid "Placeholder: %string"
+msgstr "PLAYSHOLDR: %string"
+
+msgid "This @token.name has a length of: @count. It contains: %token.numbers and @token.bad_text."
+msgstr "DIS @token.name HAZ LENGTH OV: @count. IT CONTAYNZ: %token.numbers AN @token.bad_text."
+
+msgctxt "Lolspeak"
+msgid "I have context."
+msgstr "I HAZ KONTEX."
+EOF;
+    }
+    elseif ($langcode === 'zz') {
+      return <<< EOF
+msgid ""
+msgstr ""
+"Project-Id-Version: Drupal 8\\n"
+"MIME-Version: 1.0\\n"
+"Content-Type: text/plain; charset=UTF-8\\n"
+"Content-Transfer-Encoding: 8bit\\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\\n"
+
+msgid "Hello new text."
+msgstr "O HAI NU TXT."
+
+msgctxt "Lolspeak"
+msgid "Hello new text."
+msgstr "O HAI NU TXTZZZZ."
+EOF;
+    }
+    return FALSE;
+  }
+
+}