LanguageFormTest.php in Lingotek Translation 3.4.x

Namespace

Drupal\Tests\lingotek\Functional\Form

File

tests/src/Functional/Form/LanguageFormTest.php

<?php

namespace Drupal\Tests\lingotek\Functional\Form;

use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\Tests\BrowserTestBase;

/**
 * Test the Drupal language form alters.
 *
 * @group lingotek
 */
class LanguageFormTest extends BrowserTestBase {

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

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'lingotek',
    'lingotek_test',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();

    // User to add and remove language.
    $admin_user = $this
      ->drupalCreateUser([
      'administer languages',
      'access administration pages',
    ]);
    $this
      ->drupalLogin($admin_user);
  }

  /**
   * Tests adding a defined language has the right locale.
   */
  public function testAddingLanguage() {

    // Enable import of translations. By default this is disabled for automated
    // tests.
    $this
      ->config('locale.settings')
      ->set('translation.import_enabled', TRUE)
      ->save();
    $this
      ->drupalGet('admin/config/regional/language/add');
    $edit = [
      'predefined_langcode' => 'de',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Add language');

    // Click on edit for German.
    $this
      ->clickLink('Edit', 1);

    // Assert that the locale is correct.
    $this
      ->assertFieldByName('lingotek_locale', 'de-DE', 'The Lingotek locale is set correctly.');
  }

  /**
   * Tests editing a defined language has the right locale.
   */
  public function testEditingLanguage() {
    ConfigurableLanguage::createFromLangcode('de')
      ->save();
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for German.
    $this
      ->clickLink('Edit', 1);

    // Assert that the locale is correct.
    $this
      ->assertFieldByName('lingotek_locale', 'de-DE', 'The Lingotek locale is set correctly.');
    $this
      ->drupalPostForm(NULL, [
      'name' => 'German (Germany)',
    ], 'Save language');
    $this
      ->assertText('German (Germany)');
  }

  /**
   * Tests editing a defined language has the right locale.
   */
  public function testEditingLanguageWith401() {

    // This is a hack for avoiding writing different lingotek endpoint mocks.
    \Drupal::state()
      ->set('lingotek.locales_error', TRUE);
    ConfigurableLanguage::createFromLangcode('de')
      ->save();
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for German.
    $this
      ->clickLink('Edit', 1);

    // Assert that the locale is correct.
    $this
      ->assertFieldByName('lingotek_locale', 'de-DE', 'The Lingotek locale is set correctly.');
    $this
      ->drupalPostForm(NULL, [
      'name' => 'German (Germany)',
    ], 'Save language');
    $this
      ->assertText('German (Germany)');
    $this
      ->assertText("The Lingotek locale has not been validated.");
  }

  /**
   * Tests adding a custom language with a custom locale.
   */
  public function testAddingCustomLanguage() {

    // Check that there is a select for locales.
    $this
      ->drupalGet('admin/config/regional/language/add');
    $this
      ->assertField('lingotek_locale', 'There is a field for adding the Lingotek locale.');

    // Assert that the locale is empty.
    $this
      ->assertFieldByName('lingotek_locale', '', 'The Lingotek locale is empty by default.');

    // The Lingotek locale is enabled by default.
    $this
      ->getSession()
      ->getPage()
      ->hasUncheckedField('lingotek_disabled');
    $edit = [
      'predefined_langcode' => 'custom',
      'langcode' => 'es-DE',
      'label' => 'Spanish (Germany)',
      'direction' => 'ltr',
      'lingotek_locale' => 'es-ES',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Add custom language');
    $this
      ->assertText('The language Spanish (Germany) has been created and can now be used.');

    // Ensure the language is created and with the right locale.
    $language = ConfigurableLanguage::load('es-DE');
    $this
      ->assertEqual('es_ES', $language
      ->getThirdPartySetting('lingotek', 'locale'), 'The Lingotek locale has been saved successfully.');

    // Ensure the locale and langcode are correctly mapped.

    /** @var LanguageLocaleMapperInterface $locale_mapper */
    $locale_mapper = \Drupal::service('lingotek.language_locale_mapper');
    $this
      ->assertEqual('es_ES', $locale_mapper
      ->getLocaleForLangcode('es-DE'), 'The language locale mapper correctly guesses the locale.');
    $this
      ->assertEqual('es-DE', $locale_mapper
      ->getConfigurableLanguageForLocale('es_ES')
      ->getId(), 'The language locale mapper correctly guesses the langcode.');
  }

  /**
   * Tests disabling for Lingotek a custom language that was enabled.
   */
  public function testDisablingCustomLanguage() {
    $this
      ->testAddingCustomLanguage();

    // Check that there is a select for locales.
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for Spanish (Germany).
    $this
      ->clickLink('Edit', 1);

    // The Lingotek locale is enabled by default.
    $this
      ->getSession()
      ->getPage()
      ->hasUncheckedField('lingotek_disabled');
    $edit = [
      'lingotek_disabled' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save language');

    // Ensure the language is disabled.
    $language = ConfigurableLanguage::load('es-DE');
    $this
      ->assertTrue($language
      ->getThirdPartySetting('lingotek', 'disabled'), 'The Lingotek locale has been disabled successfully.');

    // Check that there is a select for locales.
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for Spanish (Germany).
    $this
      ->clickLink('Edit', 1);
    $this
      ->getSession()
      ->getPage()
      ->hasCheckedField('lingotek_disabled');
  }

  /**
   * Tests enabling for Lingotek a custom language that was disabled.
   */
  public function testEnablingCustomLanguage() {
    ConfigurableLanguage::create([
      'id' => 'de-at',
      'label' => 'German (AT)',
    ])
      ->setThirdPartySetting('lingotek', 'disabled', TRUE)
      ->save();

    // Check that there is a select for locales.
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for German (AT).
    $this
      ->clickLink('Edit', 1);

    // The Lingotek locale is enabled by default.
    $this
      ->getSession()
      ->getPage()
      ->hasCheckedField('lingotek_disabled');
    $edit = [
      'lingotek_disabled' => FALSE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save language');

    // Ensure the language is disabled.
    $language = ConfigurableLanguage::load('de-at');
    $this
      ->assertFalse($language
      ->getThirdPartySetting('lingotek', 'disabled'), 'The Lingotek locale has been enabled successfully.');

    // Check that there is a select for locales.
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for German (AT).
    $this
      ->clickLink('Edit', 1);
    $this
      ->getSession()
      ->getPage()
      ->hasUncheckedField('lingotek_disabled');
  }

  /**
   * Tests editing a custom language with a custom locale.
   */
  public function testEditingCustomLanguage() {
    ConfigurableLanguage::create([
      'id' => 'de-at',
      'label' => 'German (AT)',
    ])
      ->save();
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for German (AT).
    $this
      ->clickLink('Edit', 1);

    // Assert that the locale is correct.
    $this
      ->assertFieldByName('lingotek_locale', 'de-AT', 'The Lingotek locale is set to the right language.');

    // Edit the locale.
    $edit = [
      'lingotek_locale' => 'de-DE',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save language');

    // Click again on edit for German (AT).
    $this
      ->clickLink('Edit', 1);

    // Assert that the locale is correct.
    $this
      ->assertFieldByName('lingotek_locale', 'de-DE', 'The Lingotek locale is set to the right language after editing.');
  }

  /**
   * Tests editing a custom language with a custom locale.
   */
  public function testEditingCustomLanguageWithWrongLocale() {
    ConfigurableLanguage::create([
      'id' => 'de-at',
      'label' => 'German (AT)',
    ])
      ->save();
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for German (AT).
    $this
      ->clickLink('Edit', 1);

    // Assert that the locale is correct.
    $this
      ->assertFieldByName('lingotek_locale', 'de-AT', 'The Lingotek locale is set to the right language.');

    // Edit the locale.
    $edit = [
      'lingotek_locale' => 'de-IN',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save language');
    $this
      ->assertText('The Lingotek locale de-IN does not exist.');
  }

  /**
   * Tests editing a custom language with a custom locale.
   */
  public function testEditingCustomLanguageWithUnderscoredLocale() {
    ConfigurableLanguage::create([
      'id' => 'de-at',
      'label' => 'German (AT)',
    ])
      ->save();
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for German (AT).
    $this
      ->clickLink('Edit', 1);

    // Assert that the locale is correct.
    $this
      ->assertFieldByName('lingotek_locale', 'de-AT', 'The Lingotek locale is set to the right language.');

    // Edit the locale.
    $edit = [
      'lingotek_locale' => 'de_AT',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save language');

    // Click on edit for German (AT).
    $this
      ->clickLink('Edit', 1);

    // Assert that the locale is correct.
    $this
      ->assertFieldByName('lingotek_locale', 'de-AT', 'The Lingotek locale is set to the right language.');
  }

  /**
   * Tests autocomplete on language locales.
   */
  public function testAutocompleteLocale() {
    $page = $this
      ->getSession()
      ->getPage();

    // Check that there is a select for locales.
    ConfigurableLanguage::createFromLangcode('de')
      ->save();
    $this
      ->drupalGet('/admin/config/regional/language');

    // Click on edit for German.
    $this
      ->clickLink('Edit', 1);

    // Make sure that the autocomplete library is added.
    $this
      ->assertRaw('core/misc/autocomplete.js');

    // Assert that the locale is correct.
    $this
      ->assertFieldByName('lingotek_locale', 'de-DE', 'The Lingotek locale is set correctly.');

    // Check the autocomplete route.
    $result = $this
      ->xpath('//input[@name="lingotek_locale" and contains(@data-autocomplete-path, "admin/lingotek/supported-locales-autocomplete")]');
    $target_url = $this
      ->getAbsoluteUrl($result[0]
      ->getAttribute('data-autocomplete-path'));
    $this
      ->drupalGet($target_url, [
      'query' => [
        'q' => 'de',
      ],
    ]);
    $result = json_decode($page
      ->getContent(), TRUE);
    $this
      ->assertEquals($result[0]['value'], 'de-AT');
    $this
      ->assertEquals($result[0]['label'], 'German (Austria) (de-AT) [matched: Code: <em class="placeholder">de-AT</em>]');
    $this
      ->assertEquals($result[1]['value'], 'de-DE');
    $this
      ->assertEquals($result[1]['label'], 'German (Germany) (de-DE) [matched: Code: <em class="placeholder">de-DE</em>]');
  }

}

Classes

Name	Description
LanguageFormTest	Test the Drupal language form alters.