WebformEntityTranslationTest.php in Webform 8.5

Namespace

Drupal\Tests\webform\Functional

File

tests/src/Functional/WebformEntityTranslationTest.php

<?php

namespace Drupal\Tests\webform\Functional;

use Drupal\Core\Serialization\Yaml;
use Drupal\webform\Entity\Webform;

/**
 * Tests for webform translation.
 *
 * @group webform
 */
class WebformEntityTranslationTest extends WebformBrowserTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'block',
    'webform',
    'webform_ui',
    'webform_test_translation',
  ];

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

    // Place blocks.
    $this
      ->placeBlocks();
  }

  /**
   * Tests webform translate.
   */
  public function testTranslate() {

    // Login admin user.
    $this
      ->drupalLogin($this->rootUser);

    // Set [site:name] to 'Test Website' and translate it into Spanish.
    $this
      ->drupalPostForm('/admin/config/system/site-information', [
      'site_name' => 'Test Website',
    ], 'Save configuration');
    $this
      ->drupalPostForm('/admin/config/system/site-information/translate/es/add', [
      'translation[config_names][system.site][name]' => 'Sitio web de prueba',
    ], 'Save translation');

    /** @var \Drupal\webform\WebformTranslationManagerInterface $translation_manager */
    $translation_manager = \Drupal::service('webform.translation_manager');
    $webform = Webform::load('test_translation');
    $elements_raw = \Drupal::config('webform.webform.test_translation')
      ->get('elements');
    $elements = Yaml::decode($elements_raw);

    // Check translate tab.
    $this
      ->drupalGet('/admin/structure/webform/manage/test_translation');
    $this
      ->assertRaw('>Translate<');

    // Check translations.
    $this
      ->drupalGet('/admin/structure/webform/manage/test_translation/translate');
    $this
      ->assertRaw('<a href="' . base_path() . 'webform/test_translation"><strong>English (original)</strong></a>');
    $this
      ->assertRaw('<a href="' . base_path() . 'es/webform/test_translation" hreflang="es">Spanish</a>');
    $this
      ->assertNoRaw('<a href="' . base_path() . 'fr/webform/test_translation" hreflang="fr">French</a>');
    $this
      ->assertRaw('<a href="' . base_path() . 'admin/structure/webform/manage/test_translation/translate/es/edit">Edit</a>');

    // Check Spanish translation.
    $this
      ->drupalGet('/admin/structure/webform/manage/test_translation/translate/es/edit');
    $this
      ->assertFieldByName('translation[config_names][webform.webform.test_translation][title]', 'Prueba: Traducción');
    $this
      ->assertField('translation[config_names][webform.webform.test_translation][elements]');

    // Check form builder is not translated.
    $this
      ->drupalGet('/es/admin/structure/webform/manage/test_translation');
    $this
      ->assertLink('Text field');
    $this
      ->assertNoLink('Campo de texto');

    // Check form builder is not translated when reset.
    $this
      ->drupalPostForm('/es/admin/structure/webform/manage/test_translation', [], 'Reset');
    $this
      ->assertLink('Text field');
    $this
      ->assertNoLink('Campo de texto');

    // Check element edit form is not translated.
    $this
      ->drupalGet('/es/admin/structure/webform/manage/test_translation/element/textfield/edit');
    $this
      ->assertFieldByName('properties[title]', 'Text field');
    $this
      ->assertNoFieldByName('properties[title]', 'Campo de texto');

    // Check translated webform options.
    $this
      ->drupalGet('/es/webform/test_translation');
    $this
      ->assertRaw('<label for="edit-textfield">Campo de texto</label>');
    $this
      ->assertRaw('<option value="1">Uno</option>');
    $this
      ->assertRaw('<option value="4">Las cuatro</option>');

    // Check translated webform custom composite.
    $this
      ->drupalGet('/es/webform/test_translation');
    $this
      ->assertRaw('<label>Compuesto</label>');
    $this
      ->assertRaw('<th class="composite-table--first_name webform-multiple-table--first_name">Nombre</th>');
    $this
      ->assertRaw('<th class="composite-table--last_name webform-multiple-table--last_name">Apellido</th>');
    $this
      ->assertRaw('<th class="composite-table--age webform-multiple-table--age">Edad</th>');
    $this
      ->assertRaw('<span class="field-suffix">años. antiguo</span>');

    // Check translated webform address.
    $this
      ->drupalGet('/es/webform/test_translation');
    $this
      ->assertRaw('<span class="visually-hidden fieldset-legend">Dirección</span>');
    $this
      ->assertRaw('<label for="edit-address-address">Dirección</label>');
    $this
      ->assertRaw('<label for="edit-address-address-2">Dirección 2</label>');
    $this
      ->assertRaw('<label for="edit-address-city">Ciudad / Pueblo</label>');
    $this
      ->assertRaw('<label for="edit-address-state-province">Estado / Provincia</label>');
    $this
      ->assertRaw('<label for="edit-address-postal-code">ZIP / Código Postal</label>');
    $this
      ->assertRaw('<label for="edit-address-country">Acciones de país</label>');

    // Check translated webform token.
    $this
      ->assertRaw('Site name: Sitio web de prueba');

    // Check that webform is not translated into French.
    $this
      ->drupalGet('/fr/webform/test_translation');
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');
    $this
      ->assertRaw('<option value="1">One</option>');
    $this
      ->assertRaw('<option value="4">Four</option>');
    $this
      ->assertRaw('Site name: Test Website');

    // Check that French config elements returns the default languages elements.
    // Please note: This behavior might change.
    $translation_element = $translation_manager
      ->getElements($webform, 'fr', TRUE);
    $this
      ->assertEqual($elements, $translation_element);

    // Translate [site:name] into French.
    $this
      ->drupalPostForm('/admin/config/system/site-information/translate/fr/add', [
      'translation[config_names][system.site][name]' => 'Site Web de test',
    ], 'Save translation');

    // Check default elements.
    $this
      ->drupalGet('/admin/structure/webform/manage/test_translation/translate/fr/add');
    $this
      ->assertRaw('<textarea lang="fr" data-drupal-selector="edit-translation-config-names-webformwebformtest-translation-elements" aria-describedby="edit-translation-config-names-webformwebformtest-translation-elements--description" class="js-webform-codemirror webform-codemirror yaml form-textarea" data-webform-codemirror-mode="text/x-yaml" id="edit-translation-config-names-webformwebformtest-translation-elements" name="translation[config_names][webform.webform.test_translation][elements]" rows="65" cols="60">variant:
  &#039;#title&#039;: Variant
textfield:
  &#039;#title&#039;: &#039;Text field&#039;
select_options:
  &#039;#title&#039;: &#039;Select (options)&#039;
select_custom:
  &#039;#title&#039;: &#039;Select (custom)&#039;
  &#039;#options&#039;:
    4: Four
    5: Five
    6: Six
  &#039;#other__option_label&#039;: &#039;Custom number…&#039;
details:
  &#039;#title&#039;: Details
markup:
  &#039;#markup&#039;: &#039;This is some HTML markup.&#039;
composite:
  &#039;#title&#039;: Composite
  &#039;#element&#039;:
    first_name:
      &#039;#title&#039;: &#039;First name&#039;
    last_name:
      &#039;#title&#039;: &#039;Last name&#039;
    age:
      &#039;#title&#039;: Age
      &#039;#field_suffix&#039;: &#039; yrs. old&#039;
address:
  &#039;#title&#039;: Address
  &#039;#address__title&#039;: Address
  &#039;#address_2__title&#039;: &#039;Address 2&#039;
  &#039;#city__title&#039;: City/Town
  &#039;#state_province__title&#039;: State/Province
  &#039;#postal_code__title&#039;: &#039;ZIP/Postal Code&#039;
  &#039;#country__title&#039;: Country
token:
  &#039;#title&#039;: &#039;Computed (token)&#039;
autocomplete_options:
  &#039;#title&#039;: &#039;Autocomplete (options)&#039;
autocomplete_custom:
  &#039;#title&#039;: &#039;Autocomplete (custom)&#039;
actions:
  &#039;#title&#039;: &#039;Submit button(s)&#039;
  &#039;#submit__label&#039;: &#039;Send message&#039;</textarea>
</div>');

    // Check customized maxlengths.
    $this
      ->assertCssSelect('input[name$="[title]"][maxlength=255]');
    $this
      ->assertCssSelect('input[name$="[submission_label]"]');
    $this
      ->assertNoCssSelect('input[name$="[submission_label]"][maxlength]');

    // Create French translation.
    $translation_elements = [
      'textfield' => [
        '#title' => 'French',
        '#custom' => 'custom',
      ],
      'custom' => [
        '#title' => 'Custom',
      ],
    ] + $elements;
    $edit = [
      'translation[config_names][webform.webform.test_translation][elements]' => Yaml::encode($translation_elements),
    ];
    $this
      ->drupalPostForm('/admin/structure/webform/manage/test_translation/translate/fr/add', $edit, 'Save translation');

    // Check French translation.
    $this
      ->drupalGet('/fr/webform/test_translation');
    $this
      ->assertRaw('<label for="edit-textfield">French</label>');
    $this
      ->assertRaw('Site name: Site Web de test');

    // Check translations.
    $this
      ->drupalGet('/admin/structure/webform/manage/test_translation/translate');
    $this
      ->assertRaw('<a href="' . base_path() . 'webform/test_translation"><strong>English (original)</strong></a>');
    $this
      ->assertRaw('<a href="' . base_path() . 'es/webform/test_translation" hreflang="es">Spanish</a>');
    $this
      ->assertRaw('<a href="' . base_path() . 'fr/webform/test_translation" hreflang="fr">French</a>');

    // Check French config elements only contains translated properties and
    // custom properties are removed.
    $translation_element = $translation_manager
      ->getElements($webform, 'fr', TRUE);
    $this
      ->assertEqual([
      'textfield' => [
        '#title' => 'French',
      ],
    ], $translation_element);

    /**************************************************************************/

    // Submissions.

    /**************************************************************************/

    // Check English table headers are not translated.
    $this
      ->drupalGet('/admin/structure/webform/manage/test_translation/results/submissions');
    $this
      ->assertRaw('>Text field<');
    $this
      ->assertRaw('>Select (options)<');
    $this
      ->assertRaw('>Select (custom)<');
    $this
      ->assertRaw('>Composite<');

    // Check Spanish table headers are translated.
    $this
      ->drupalGet('/es/admin/structure/webform/manage/test_translation/results/submissions');
    $this
      ->assertRaw('>Campo de texto<');
    $this
      ->assertRaw('>Seleccione (opciones)<');
    $this
      ->assertRaw('>Seleccione (personalizado)<');
    $this
      ->assertRaw('>Compuesto<');

    // Create translated submissions.
    $this
      ->drupalPostForm('/webform/test_translation', [
      'textfield' => 'English Submission',
    ], 'Send message');
    $this
      ->drupalPostForm('/es/webform/test_translation', [
      'textfield' => 'Spanish Submission',
    ], 'Enviar mensaje');
    $this
      ->drupalPostForm('/fr/webform/test_translation', [
      'textfield' => 'French Submission',
    ], 'Send message');

    // Check computed token is NOT translated for each language because only
    // one language can be loaded for a config translation.
    $this
      ->drupalGet('/admin/structure/webform/manage/test_translation/results/submissions');
    $this
      ->assertRaw('Site name: Test Website');
    $this
      ->assertNoRaw('Site name: Sitio web de prueba');
    $this
      ->assertNoRaw('Site name: Sitio web de prueba');

    /**************************************************************************/

    // Site wide language.

    /**************************************************************************/

    // Make sure the site language is English (en).
    \Drupal::configFactory()
      ->getEditable('system.site')
      ->set('default_langcode', 'en')
      ->save();
    drupal_flush_all_caches();
    $language_manager = \Drupal::languageManager();
    $this
      ->drupalGet('/webform/test_translation', [
      'language' => $language_manager
        ->getLanguage('en'),
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');

    // Check Spanish translation.
    $this
      ->drupalGet('/webform/test_translation', [
      'language' => $language_manager
        ->getLanguage('es'),
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Campo de texto</label>');

    // Check French translation.
    $this
      ->drupalGet('/webform/test_translation', [
      'language' => $language_manager
        ->getLanguage('fr'),
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">French</label>');

    // Change site language to French (fr).
    \Drupal::configFactory()
      ->getEditable('system.site')
      ->set('default_langcode', 'fr')
      ->save();

    // Check English translation.
    $this
      ->drupalGet('/webform/test_translation', [
      'language' => $language_manager
        ->getLanguage('en'),
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');

    // Check Spanish translation.
    $this
      ->drupalGet('/webform/test_translation', [
      'language' => $language_manager
        ->getLanguage('es'),
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Campo de texto</label>');

    // Check French translation.
    $this
      ->drupalGet('/webform/test_translation', [
      'language' => $language_manager
        ->getLanguage('fr'),
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">French</label>');

    /**************************************************************************/

    // Make sure the site language is English (en).
    \Drupal::configFactory()
      ->getEditable('system.site')
      ->set('default_langcode', 'en')
      ->save();
    drupal_flush_all_caches();

    // Duplicate translated webform.
    $edit = [
      'title' => 'DUPLICATE',
      'id' => 'duplicate',
    ];
    $this
      ->drupalPostForm('/admin/structure/webform/manage/test_translation/duplicate', $edit, 'Save');

    // Check duplicate English translation.
    $this
      ->drupalGet('/webform/duplicate', [
      'language' => $language_manager
        ->getLanguage('en'),
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');

    // Check duplicate Spanish translation.
    $this
      ->drupalGet('/webform/duplicate', [
      'language' => $language_manager
        ->getLanguage('es'),
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Campo de texto</label>');

    // Check duplicate French translation.
    $this
      ->drupalGet('/webform/duplicate', [
      'language' => $language_manager
        ->getLanguage('fr'),
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">French</label>');
  }

  /**
   * Tests webform translate variants.
   */
  public function testTranslateVariants() {

    // Check English webform.
    $this
      ->drupalGet('/webform/test_translation');
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Select (options)</label>');

    // Check English webform with test variant.
    $this
      ->drupalGet('/webform/test_translation', [
      'query' => [
        'variant' => 'test',
      ],
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Text field - Variant</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Select (options)</label>');

    // Check Spanish webform.
    $this
      ->drupalGet('/es/webform/test_translation');
    $this
      ->assertRaw('<label for="edit-textfield">Campo de texto</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Seleccione (opciones)</label>');

    // Check Spanish webform with test variant.
    $this
      ->drupalGet('/es/webform/test_translation', [
      'query' => [
        'variant' => 'test',
      ],
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Campo de texto - Variante</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Seleccione (opciones)</label>');

    // Check French (not translated) webform.
    $this
      ->drupalGet('/fr/webform/test_translation');
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Select (options)</label>');

    // Check French (not translated) webform with test variant.
    $this
      ->drupalGet('/fr/webform/test_translation', [
      'query' => [
        'variant' => 'test',
      ],
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Text field - Variant</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Select (options)</label>');

    // Remove variant element and variants.

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = Webform::load('test_translation');
    $variants = $webform
      ->getVariants();
    foreach ($variants as $variant) {
      $webform
        ->deleteWebformVariant($variant);
    }
    $webform
      ->deleteElement('variant');
    $webform
      ->save();

    // Check English webform.
    $this
      ->drupalGet('/webform/test_translation');
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Select (options)</label>');

    // Check English webform with test variant.
    $this
      ->drupalGet('/webform/test_translation', [
      'query' => [
        'variant' => 'test',
      ],
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Select (options)</label>');

    // Check Spanish webform.
    $this
      ->drupalGet('/es/webform/test_translation');
    $this
      ->assertRaw('<label for="edit-textfield">Campo de texto</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Seleccione (opciones)</label>');

    // Check Spanish webform with test variant.
    $this
      ->drupalGet('/es/webform/test_translation', [
      'query' => [
        'variant' => 'test',
      ],
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Campo de texto</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Seleccione (opciones)</label>');

    // Check French (not translated) webform.
    $this
      ->drupalGet('/fr/webform/test_translation');
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Select (options)</label>');

    // Check French (not translated) webform with test variant.
    $this
      ->drupalGet('/fr/webform/test_translation', [
      'query' => [
        'variant' => 'test',
      ],
    ]);
    $this
      ->assertRaw('<label for="edit-textfield">Text field</label>');
    $this
      ->assertRaw('<label for="edit-select-options">Select (options)</label>');
  }

}

Classes

Name	Description
WebformEntityTranslationTest	Tests for webform translation.