You are here

Home » API reference » Lingotek Translation 3.6.x » LingotekInterfaceTranslationTest.php

class LingotekInterfaceTranslationTest in Lingotek Translation 3.6.x

Same name and namespace in other branches
  1. 4.0.x tests/src/Functional/LingotekInterfaceTranslationTest.php \Drupal\Tests\lingotek\Functional\LingotekInterfaceTranslationTest
  2. 3.2.x tests/src/Functional/LingotekInterfaceTranslationTest.php \Drupal\Tests\lingotek\Functional\LingotekInterfaceTranslationTest
  3. 3.3.x tests/src/Functional/LingotekInterfaceTranslationTest.php \Drupal\Tests\lingotek\Functional\LingotekInterfaceTranslationTest
  4. 3.4.x tests/src/Functional/LingotekInterfaceTranslationTest.php \Drupal\Tests\lingotek\Functional\LingotekInterfaceTranslationTest
  5. 3.5.x tests/src/Functional/LingotekInterfaceTranslationTest.php \Drupal\Tests\lingotek\Functional\LingotekInterfaceTranslationTest
  6. 3.7.x tests/src/Functional/LingotekInterfaceTranslationTest.php \Drupal\Tests\lingotek\Functional\LingotekInterfaceTranslationTest
  7. 3.8.x tests/src/Functional/LingotekInterfaceTranslationTest.php \Drupal\Tests\lingotek\Functional\LingotekInterfaceTranslationTest

Tests translating the user interface using the Lingotek form.

@group lingotek

Hierarchy

Expanded class hierarchy of LingotekInterfaceTranslationTest

File

tests/src/Functional/LingotekInterfaceTranslationTest.php, line 14

Namespace

Drupal\Tests\lingotek\Functional
View source 
class LingotekInterfaceTranslationTest extends LingotekTestBase {
  use LingotekInterfaceTranslationTestTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'block',
    'node',
    'potx',
    'lingotek_interface_translation_test',
    'frozenintime',
  ];

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

    // Place the actions and title block.
    $this
      ->drupalPlaceBlock('page_title_block', [
      'region' => 'content',
      'weight' => -5,
    ]);
    $this
      ->drupalPlaceBlock('local_tasks_block', [
      'region' => 'content',
      'weight' => -10,
    ]);
    \Drupal::state()
      ->set('lingotek.uploaded_content_type', 'interface-translation');

    // Add a language.
    ConfigurableLanguage::createFromLangcode('es')
      ->setThirdPartySetting('lingotek', 'locale', 'es_MX')
      ->save();
  }

  /**
   * Tests when potx is not present.
   */
  public function testInterfaceTranslationWithoutPotx() {
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalGet('/admin/modules');

    // Ensure the module is not enabled yet.
    $this
      ->assertSession()
      ->checkboxChecked('edit-modules-potx-enable');
    $this
      ->clickLink('Uninstall');

    // Post the form uninstalling the lingotek module.
    $edit = [
      'uninstall[potx]' => '1',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Uninstall');

    // We get an advice and we can confirm.
    $assert_session
      ->responseContains('The following modules will be completely uninstalled from your site, and <em>all data from these modules will be lost</em>!');
    $assert_session
      ->responseContains('Translation template extractor');
    $this
      ->drupalPostForm(NULL, [], 'Uninstall');
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('The <a href="https://www.drupal.org/project/potx">potx</a> module is required for interface translation with Lingotek');
  }

  /**
   * Tests that a node can be translated using the links on the management page.
   */
  public function testInterfaceTranslationUsingLinks() {

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek');
    $assert_session
      ->responseContains('lingotek_test');
    $assert_session
      ->responseContains('lingotek_interface_translation_test');
    $assert_session
      ->responseContains('stark');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink('core/profiles/testing');
    $this
      ->assertLingotekInterfaceTranslationUploadLink('core/themes/stark');
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);

    // And we cannot request yet a translation.
    $this
      ->assertNoLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component . '</em> uploaded successfully');
    $data = json_decode(\Drupal::state()
      ->get('lingotek.uploaded_content', '[]'), TRUE);
    $singularStrings = [
      'Test title for interface translation',
    ];
    $pluralStrings = [
      "This is a singular example<PLURAL>This is a plural @count example<CONTEXT>" => [
        "This is a singular example" => "This is a singular example",
        "This is a plural @count example" => "This is a plural @count example",
        "_context" => '',
      ],
    ];
    $contextStrings = [
      "This is test of context<CONTEXT>" => [
        "This is test of context" => "This is test of context",
        "_context" => '',
      ],
      "This is test of context<CONTEXT>multiple p" => [
        "This is test of context" => "This is test of context",
        "_context" => 'multiple p',
      ],
      "This is test of context<CONTEXT>multiple t" => [
        "This is test of context" => "This is test of context",
        "_context" => 'multiple t',
      ],
    ];
    foreach ($singularStrings as $singularString) {
      $singularStringWithContext = $singularString . '<CONTEXT>';
      $this
        ->assertTrue(isset($data[$singularStringWithContext]));
      $this
        ->assertSame($singularString, $data[$singularStringWithContext][$singularString]);
      $this
        ->assertSame('', $data[$singularStringWithContext]['_context']);
    }
    foreach ($pluralStrings as $key => $pluralData) {
      $this
        ->assertTrue(isset($data[$key]));
      $this
        ->assertSame('', $data[$key]['_context']);
      foreach ($pluralData as $pluralString => $pluralTranslatedString) {
        if ($pluralString !== '_context') {
          $this
            ->assertTrue(isset($data[$key][$pluralString]));
          $this
            ->assertSame($pluralTranslatedString, $data[$key][$pluralString]);
        }
      }
    }
    foreach ($contextStrings as $key => $contextData) {
      $this
        ->assertTrue(isset($data[$key]));
      foreach ($contextData as $contextString => $contextTranslatedString) {
        $this
          ->assertSame($contextData['_context'], $data[$key]['_context']);
        if ($contextString !== '_context') {
          $this
            ->assertTrue(isset($data[$key][$contextString]));
          $this
            ->assertSame($contextTranslatedString, $data[$key][$contextString]);
        }
      }
    }
    $this
      ->assertSame('en_US', \Drupal::state()
      ->get('lingotek.uploaded_locale'));

    // There is a link for checking status.
    $this
      ->assertLingotekInterfaceTranslationCheckSourceStatusLink($component);

    // And we can already request a translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('The import for <em class="placeholder">' . $component . '</em> is complete.');

    // Request the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $this
      ->clickLink('ES');
    $assert_session
      ->responseContains('Locale \'es_MX\' was added as a translation target for <em class="placeholder">' . $component . '</em>.');
    $this
      ->assertIdentical('es_MX', \Drupal::state()
      ->get('lingotek.added_target_locale'));

    // Check status of the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationCheckTargetStatusLink($component, 'es_MX');
    $this
      ->clickLink('ES');
    $this
      ->assertSame('es_MX', \Drupal::state()
      ->get('lingotek.checked_target_locale'));
    $assert_session
      ->responseContains('The es_MX translation for <em class="placeholder">' . $component . '</em> is ready for download.');

    // Download the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationDownloadLink($component, 'es_MX');
    $this
      ->clickLink('ES');
    $assert_session
      ->responseContains('The translation of <em class="placeholder">' . $component . '</em> into es_MX has been downloaded.');
    $this
      ->assertSame('es_MX', \Drupal::state()
      ->get('lingotek.downloaded_locale'));

    // Now the link is to the workbench, and it opens in a new tab.
    $this
      ->assertLingotekWorkbenchLink('es_MX', 'dummy-document-hash-id', 'ES');
    $this
      ->drupalGet('es/lingotek-interface-translation-test');
    $assert_session
      ->responseContains('Título de Prueba para Traducción de Interfaz');
    $assert_session
      ->responseContains('Este es un ejemplo en singular');
    $assert_session
      ->responseNotContains('This is test of context');
    $assert_session
      ->responseContains('Esto es una prueba de contexto');
    $assert_session
      ->responseContains('Esto es una pppprueba de contexto');
    $assert_session
      ->responseContains('Estttto es una prueba de conttttextttto');
    $this
      ->drupalGet('es/lingotek-interface-translation-test', [
      'query' => [
        'count' => 10,
      ],
    ]);
    $assert_session
      ->responseContains('Título de Prueba para Traducción de Interfaz');
    $assert_session
      ->responseContains('Este es un ejemplo en plural: 10');
    $assert_session
      ->responseNotContains('This is test of context');
    $assert_session
      ->responseContains('Esto es una prueba de contexto');
    $assert_session
      ->responseContains('Esto es una pppprueba de contexto');
    $assert_session
      ->responseContains('Estttto es una prueba de conttttextttto');
  }

  /**
   * Tests that a node can be translated using the links on the management page.
   */
  public function testClearInterfaceTranslationMetadata() {

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path1 = drupal_get_path('module', 'lingotek_interface_translation_test');
    $path2 = drupal_get_path('module', 'lingotek_test');
    $component1 = $path1;
    $component2 = $path2;
    $indexOfModuleLink1 = 2;
    $indexOfModuleLink2 = 3;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_test');
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component1);
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component2);

    // And we cannot request yet a translation.
    $this
      ->assertNoLingotekInterfaceTranslationRequestTranslationLink($component1, 'es_MX');
    $this
      ->assertNoLingotekInterfaceTranslationRequestTranslationLink($component2, 'es_MX');
    $this
      ->clickLink('EN', $indexOfModuleLink1);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component1 . '</em> uploaded successfully');
    $this
      ->clickLink('EN', $indexOfModuleLink2);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component2 . '</em> uploaded successfully');

    // There is a link for checking status.
    $this
      ->assertLingotekInterfaceTranslationCheckSourceStatusLink($component1);
    $this
      ->assertLingotekInterfaceTranslationCheckSourceStatusLink($component2);

    // And we can already request a translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component1, 'es_MX');
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component2, 'es_MX');
    $this
      ->clickLink('EN', $indexOfModuleLink1);
    $assert_session
      ->responseContains('The import for <em class="placeholder">' . $component1 . '</em> is complete.');

    // Request the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component1, 'es_MX');
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component2, 'es_MX');
    $this
      ->clickLink('ES');
    $assert_session
      ->responseContains('Locale \'es_MX\' was added as a translation target for <em class="placeholder">' . $component1 . '</em>.');
    $this
      ->drupalPostForm(NULL, [], 'Clear Lingotek interface translation metadata');
    $assert_session
      ->responseContains('This will remove the metadata stored about your Lingotek interface translations, so you will need to re-upload those in case you want to translate them.');
    $this
      ->drupalPostForm(NULL, [], 'Clear metadata');
    $assert_session
      ->responseContains('You have cleared the Lingotek metadata for interface translations.');

    // Download the Spanish translation.
    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component1);
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component2);

    // And we cannot request yet a translation.
    $this
      ->assertNoLingotekInterfaceTranslationRequestTranslationLink($component1, 'es_MX');
    $this
      ->assertNoLingotekInterfaceTranslationRequestTranslationLink($component2, 'es_MX');
  }

  /**
   * Tests that a node can be translated using the links on the management page.
   */
  public function testAddingLanguageAllowsRequesting() {
    $assert_session = $this
      ->assertSession();

    // We need translations first.
    $this
      ->testInterfaceTranslationUsingLinks();

    // Add a language.
    ConfigurableLanguage::createFromLangcode('ca')
      ->save();
    $this
      ->goToInterfaceTranslationManagementForm();

    // There is a link for requesting the Catalan translation.
    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component, 'ca_ES');
    $this
      ->clickLink('CA');
    $assert_session
      ->responseContains('Locale \'ca_ES\' was added as a translation target for <em class="placeholder">' . $component . '</em>.');
  }

  /**
   * Tests that a config can be translated using the links on the management page.
   */
  public function testFormWorksAfterRemovingLanguageWithStatuses() {
    $assert_session = $this
      ->assertSession();

    // We need a language added and requested.
    $this
      ->testAddingLanguageAllowsRequesting();

    // Delete a language.
    ConfigurableLanguage::load('es')
      ->delete();
    $this
      ->goToInterfaceTranslationManagementForm();

    // There is no link for the Spanish translation.
    $assert_session
      ->linkNotExists('ES');
    $assert_session
      ->linkExists('CA');
  }

  /**
   * Test that we handle errors in upload.
   */
  public function testUploadingWithAnError() {
    \Drupal::state()
      ->set('lingotek.must_error_in_upload', TRUE);

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);

    // Upload the document, which must fail.
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('The upload for <em class="placeholder">' . $component . '</em> failed. Please try again.');

    // Check the right class is added.
    $this
      ->assertSourceStatus('EN', Lingotek::STATUS_ERROR);

    /** @var \Drupal\lingotek\LingotekInterfaceTranslationServiceInterface $translation_service */
    $translation_service = \Drupal::service('lingotek.interface_translation');
    $source_status = $translation_service
      ->getSourceStatus($component);
    $this
      ->assertEqual(Lingotek::STATUS_ERROR, $source_status, 'The source upload has been marked as error.');
    $this
      ->assertEmpty($translation_service
      ->getLastUploaded($component));

    // I can still re-try the upload.
    \Drupal::state()
      ->set('lingotek.must_error_in_upload', FALSE);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component . '</em> uploaded successfully');
    drupal_flush_all_caches();
    $expected_time = \Drupal::time()
      ->getRequestTime();
    $this
      ->assertEquals($expected_time, $translation_service
      ->getLastUploaded($component));
  }

  /**
   * Test that we handle errors in upload.
   */
  public function testUploadingWithAPaymentRequiredError() {
    \Drupal::state()
      ->set('lingotek.must_payment_required_error_in_upload', TRUE);

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);

    // Upload the document, which must fail.
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('Community has been disabled. Please contact support@lingotek.com to re-enable your community.');

    // Check the right class is added.
    $this
      ->assertSourceStatus('EN', Lingotek::STATUS_ERROR);

    // Check the right class is added.
    $this
      ->assertSourceStatus('EN', Lingotek::STATUS_ERROR);

    /** @var \Drupal\lingotek\LingotekInterfaceTranslationServiceInterface $translation_service */
    $translation_service = \Drupal::service('lingotek.interface_translation');
    $source_status = $translation_service
      ->getSourceStatus($component);
    $this
      ->assertEqual(Lingotek::STATUS_ERROR, $source_status, 'The source upload has been marked as error.');

    // I can still re-try the upload.
    \Drupal::state()
      ->set('lingotek.must_payment_required_error_in_upload', FALSE);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component . '</em> uploaded successfully');
  }

  /**
   * Tests that we manage errors when using the request translation link.
   */
  public function testRequestTranslationWithAnError() {
    \Drupal::state()
      ->set('lingotek.must_error_in_request_translation', TRUE);

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component . '</em> uploaded successfully');

    // I can check current status.
    $this
      ->assertLingotekInterfaceTranslationCheckSourceStatusLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('The import for <em class="placeholder">' . $component . '</em> is complete.');

    // Request the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $this
      ->clickLink('ES');

    // We failed at requesting a translation, but we don't know what happened.
    // So we don't mark as error but keep it on request.
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_REQUEST);
    $assert_session
      ->responseContains('Requesting \'es_MX\' translation for <em class="placeholder">' . $component . '</em> failed. Please try again.');
  }

  /**
   * Tests that we manage errors when using the request translation link.
   */
  public function testRequestTranslationWithAPaymentRequiredError() {
    \Drupal::state()
      ->set('lingotek.must_payment_required_error_in_request_translation', TRUE);

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component . '</em> uploaded successfully');

    // I can check current status.
    $this
      ->assertLingotekInterfaceTranslationCheckSourceStatusLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('The import for <em class="placeholder">' . $component . '</em> is complete.');

    // Request the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $this
      ->clickLink('ES');
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_REQUEST);
    $assert_session
      ->responseContains('Community has been disabled. Please contact support@lingotek.com to re-enable your community.');
  }

  /**
   * Tests that we manage errors when using the request translation link.
   */
  public function testRequestTranslationWithADocumentArchivedError() {
    \Drupal::state()
      ->set('lingotek.must_document_archived_error_in_request_translation', TRUE);

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component . '</em> uploaded successfully');

    // I can check current status.
    $this
      ->assertLingotekInterfaceTranslationCheckSourceStatusLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('The import for <em class="placeholder">' . $component . '</em> is complete.');

    // Request the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $this
      ->clickLink('ES');

    // We cannot use ::assertSourceStatus, there are lots of untracked docs, but
    // checking the upload link should suffice.
    // $this->assertSourceStatus('EN', Lingotek::STATUS_UNTRACKED);
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->assertNoLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $assert_session
      ->responseContains('Document <em class="placeholder">' . $component . '</em> has been archived. Please upload again.');
  }

  /**
   * Tests that we manage errors when using the request translation link.
   */
  public function testRequestTranslationWithADocumentLockedError() {
    \Drupal::state()
      ->set('lingotek.must_document_locked_error_in_request_translation', TRUE);

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component . '</em> uploaded successfully');

    // Request the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $this
      ->clickLink('ES');
    $this
      ->assertSourceStatus('EN', Lingotek::STATUS_IMPORTING);
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_REQUEST);
    $assert_session
      ->responseContains('Document <em class="placeholder">' . $component . '</em> has a new version. The document id has been updated for all future interactions. Please try again.');
  }

  /**
   * Tests that we manage errors when using the check translation status link.
   */
  public function testCheckTranslationStatusWithAnError() {
    \Drupal::state()
      ->set('lingotek.must_error_in_check_target_status', TRUE);

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component . '</em> uploaded successfully');

    // Request the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $this
      ->clickLink('ES');
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_PENDING);

    // Check the status of the translation.
    $this
      ->clickLink('ES');

    // We failed at checking a translation, but we don't know what happened.
    // So we don't mark as error but keep it on request.
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_PENDING);
    $assert_session
      ->responseContains('The request for <em class="placeholder">' . $component . '</em> \'es_MX\' translation status failed. Please try again.');
  }

  /**
   * Tests that we manage errors when using the download translation link.
   */
  public function testDownloadTranslationWithAnError() {
    \Drupal::state()
      ->set('lingotek.must_error_in_download', TRUE);

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);
    $assert_session
      ->responseContains('<em class="placeholder">' . $component . '</em> uploaded successfully');

    // Request the Spanish translation.
    $this
      ->assertLingotekInterfaceTranslationRequestTranslationLink($component, 'es_MX');
    $this
      ->clickLink('ES');
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_PENDING);

    // Check the status of the translation.
    $this
      ->clickLink('ES');
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_READY);

    // Download translation.
    $this
      ->clickLink('ES');

    // We failed at downloading a translation. Mark as error.
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_ERROR);
    $assert_session
      ->responseContains('The \'es_MX\' translation download for <em class="placeholder">' . $component . '</em> failed. Please try again.');
  }

  /**
   * Tests that a node can be translated using the links on the management page.
   */
  public function testAutomatedNotificationInterfaceTranslation() {

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

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);

    /** @var \Drupal\lingotek\LingotekInterfaceTranslationServiceInterface $translation_service */
    $translation_service = \Drupal::service('lingotek.interface_translation');

    // Assert the content is importing.
    $this
      ->assertIdentical(Lingotek::STATUS_IMPORTING, $translation_service
      ->getSourceStatus($component));
    $this
      ->goToInterfaceTranslationManagementForm();

    // Simulate the notification of content successfully uploaded.
    $url = Url::fromRoute('lingotek.notify', [], [
      'query' => [
        'project_id' => 'test_project',
        'document_id' => 'dummy-document-hash-id',
        'complete' => 'false',
        'type' => 'document_uploaded',
        'progress' => '0',
      ],
    ])
      ->setAbsolute()
      ->toString();
    $request = $this->client
      ->post($url, [
      'cookies' => $this->cookies,
      'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
      ],
      'http_errors' => FALSE,
    ]);
    $response = json_decode($request
      ->getBody(), TRUE);
    $this
      ->verbose($request);
    $this
      ->assertIdentical([], $response['result']['request_translations'], 'No translations have been requested after notification automatically.');
    $this
      ->goToInterfaceTranslationManagementForm();

    // Assert the content is imported.
    $this
      ->assertIdentical(Lingotek::STATUS_CURRENT, $translation_service
      ->getSourceStatus($component));

    // Assert the target is ready for requesting.
    $this
      ->assertIdentical(Lingotek::STATUS_REQUEST, $translation_service
      ->getTargetStatus($component, 'es'));

    // Request Spanish manually.
    $this
      ->clickLink('ES');

    // Assert the target is pending.
    $this
      ->goToInterfaceTranslationManagementForm();
    $this
      ->assertIdentical(Lingotek::STATUS_PENDING, $translation_service
      ->getTargetStatus($component, 'es'));

    // Simulate the notification of content successfully translated.
    $url = Url::fromRoute('lingotek.notify', [], [
      'query' => [
        'project_id' => 'test_project',
        'document_id' => 'dummy-document-hash-id',
        'locale_code' => 'es-ES',
        'locale' => 'es_ES',
        'complete' => 'true',
        'type' => 'target',
        'progress' => '100',
      ],
    ])
      ->setAbsolute()
      ->toString();
    $request = $this->client
      ->post($url, [
      'cookies' => $this->cookies,
      'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
      ],
      'http_errors' => FALSE,
    ]);
    $response = json_decode($request
      ->getBody(), TRUE);
    $this
      ->verbose($request);
    $this
      ->assertFalse($response['result']['download'], 'No targets have been downloaded after notification automatically.');
    $this
      ->goToInterfaceTranslationManagementForm();
    $this
      ->assertIdentical(Lingotek::STATUS_READY, $translation_service
      ->getTargetStatus($component, 'es'));

    // Download Spanish manually.
    $this
      ->clickLink('ES');

    // Assert the target is downloaded.
    $this
      ->goToInterfaceTranslationManagementForm();
    $this
      ->assertIdentical(Lingotek::STATUS_CURRENT, $translation_service
      ->getTargetStatus($component, 'es'));
  }

  /**
   * Tests that a node can be translated using the links on the management page.
   */
  public function testAutomatedArchivedNotificationInterfaceTranslation() {

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

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);

    /** @var \Drupal\lingotek\LingotekInterfaceTranslationServiceInterface $translation_service */
    $translation_service = \Drupal::service('lingotek.interface_translation');

    // Assert the content is importing.
    $this
      ->assertIdentical(Lingotek::STATUS_IMPORTING, $translation_service
      ->getSourceStatus($component));
    $this
      ->goToInterfaceTranslationManagementForm();

    // Simulate the notification of content successfully uploaded.
    $url = Url::fromRoute('lingotek.notify', [], [
      'query' => [
        'project_id' => 'test_project',
        'document_id' => 'dummy-document-hash-id',
        'complete' => 'false',
        'type' => 'document_uploaded',
        'progress' => '0',
      ],
    ])
      ->setAbsolute()
      ->toString();
    $request = $this->client
      ->post($url, [
      'cookies' => $this->cookies,
      'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
      ],
      'http_errors' => FALSE,
    ]);
    $response = json_decode($request
      ->getBody(), TRUE);
    $this
      ->verbose($request);
    $this
      ->assertIdentical([], $response['result']['request_translations'], 'No translations have been requested after notification automatically.');
    $this
      ->goToInterfaceTranslationManagementForm();

    // Assert the content is imported.
    $this
      ->assertIdentical(Lingotek::STATUS_CURRENT, $translation_service
      ->getSourceStatus($component));

    // Assert the target is ready for requesting.
    $this
      ->assertIdentical(Lingotek::STATUS_REQUEST, $translation_service
      ->getTargetStatus($component, 'es'));

    // Request Spanish manually.
    $this
      ->clickLink('ES');

    // Assert the target is pending.
    $this
      ->goToInterfaceTranslationManagementForm();
    $this
      ->assertIdentical(Lingotek::STATUS_PENDING, $translation_service
      ->getTargetStatus($component, 'es'));

    // Simulate the notification of content successfully translated.
    $url = Url::fromRoute('lingotek.notify', [], [
      'query' => [
        'project_id' => 'test_project',
        'document_id' => 'dummy-document-hash-id',
        'locale_code' => 'es-ES',
        'locale' => 'es_ES',
        'complete' => 'true',
        'type' => 'document_archived',
        'progress' => '100',
      ],
    ])
      ->setAbsolute()
      ->toString();
    $request = $this->client
      ->post($url, [
      'cookies' => $this->cookies,
      'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
      ],
      'http_errors' => FALSE,
    ]);
    $response = json_decode($request
      ->getBody(), TRUE);
    $this
      ->verbose($request);
    $this
      ->assertEquals($response['messages'][0], "Document {$path} was archived in Lingotek.");
    $this
      ->goToInterfaceTranslationManagementForm();
    $this
      ->assertIdentical(Lingotek::STATUS_UNTRACKED, $translation_service
      ->getTargetStatus($component, 'es'));
  }

  /**
   * Tests that a node can be translated using the links on the management page.
   */
  public function testAutomatedCancelledNotificationInterfaceTranslation() {

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

    // In Drupal.org CI the module will be at modules/contrib/lingotek.
    // In my local that's modules/lingotek. We need to generate the path and not
    // hardcode it.
    $path = drupal_get_path('module', 'lingotek_interface_translation_test');
    $component = $path;
    $indexOfModuleLink = 2;
    $assert_session = $this
      ->assertSession();

    // Login as admin.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->goToInterfaceTranslationManagementForm();
    $assert_session
      ->responseContains('lingotek_interface_translation_test');

    // Clicking English must init the upload of content.
    $this
      ->assertLingotekInterfaceTranslationUploadLink($component);
    $this
      ->clickLink('EN', $indexOfModuleLink);

    /** @var \Drupal\lingotek\LingotekInterfaceTranslationServiceInterface $translation_service */
    $translation_service = \Drupal::service('lingotek.interface_translation');

    // Assert the content is importing.
    $this
      ->assertIdentical(Lingotek::STATUS_IMPORTING, $translation_service
      ->getSourceStatus($component));
    $this
      ->goToInterfaceTranslationManagementForm();

    // Simulate the notification of content successfully uploaded.
    $url = Url::fromRoute('lingotek.notify', [], [
      'query' => [
        'project_id' => 'test_project',
        'document_id' => 'dummy-document-hash-id',
        'complete' => 'false',
        'type' => 'document_uploaded',
        'progress' => '0',
      ],
    ])
      ->setAbsolute()
      ->toString();
    $request = $this->client
      ->post($url, [
      'cookies' => $this->cookies,
      'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
      ],
      'http_errors' => FALSE,
    ]);
    $response = json_decode($request
      ->getBody(), TRUE);
    $this
      ->verbose($request);
    $this
      ->assertIdentical([], $response['result']['request_translations'], 'No translations have been requested after notification automatically.');
    $this
      ->goToInterfaceTranslationManagementForm();

    // Assert the content is imported.
    $this
      ->assertIdentical(Lingotek::STATUS_CURRENT, $translation_service
      ->getSourceStatus($component));

    // Assert the target is ready for requesting.
    $this
      ->assertIdentical(Lingotek::STATUS_REQUEST, $translation_service
      ->getTargetStatus($component, 'es'));

    // Request Spanish manually.
    $this
      ->clickLink('ES');

    // Assert the target is pending.
    $this
      ->goToInterfaceTranslationManagementForm();
    $this
      ->assertIdentical(Lingotek::STATUS_PENDING, $translation_service
      ->getTargetStatus($component, 'es'));

    // Simulate the notification of content successfully translated.
    $url = Url::fromRoute('lingotek.notify', [], [
      'query' => [
        'project_id' => 'test_project',
        'document_id' => 'dummy-document-hash-id',
        'locale_code' => 'es-ES',
        'locale' => 'es_ES',
        'complete' => 'true',
        'type' => 'document_cancelled',
        'progress' => '100',
      ],
    ])
      ->setAbsolute()
      ->toString();
    $request = $this->client
      ->post($url, [
      'cookies' => $this->cookies,
      'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
      ],
      'http_errors' => FALSE,
    ]);
    $response = json_decode($request
      ->getBody(), TRUE);
    $this
      ->verbose($request);
    $this
      ->assertEquals($response['messages'][0], "Document {$path} cancelled in TMS.");
    $this
      ->goToInterfaceTranslationManagementForm();
    $this
      ->assertIdentical(Lingotek::STATUS_CANCELLED, $translation_service
      ->getTargetStatus($component, 'es'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
EntityDefinitionTestTrait::addBaseField protected function Adds a new base field to the 'entity_test_update' entity type.
EntityDefinitionTestTrait::addBaseFieldIndex protected function Adds a single-field index to the base field.
EntityDefinitionTestTrait::addBundleField protected function Adds a new bundle field to the 'entity_test_update' entity type.
EntityDefinitionTestTrait::addEntityIndex protected function Adds an index to the 'entity_test_update' entity type's base table.
EntityDefinitionTestTrait::addLongNameBaseField protected function Adds a long-named base field to the 'entity_test_update' entity type.
EntityDefinitionTestTrait::addRevisionableBaseField protected function Adds a new revisionable base field to the 'entity_test_update' entity type.
EntityDefinitionTestTrait::applyEntityUpdates protected function Applies all the detected valid changes.
EntityDefinitionTestTrait::deleteEntityType protected function Removes the entity type.
EntityDefinitionTestTrait::doEntityUpdate protected function Performs an entity type definition update.
EntityDefinitionTestTrait::doFieldUpdate protected function Performs a field storage definition update.
EntityDefinitionTestTrait::enableNewEntityType protected function Enables a new entity type definition.
EntityDefinitionTestTrait::getUpdatedEntityTypeDefinition protected function Returns an entity type definition, possibly updated to be rev or mul.
EntityDefinitionTestTrait::getUpdatedFieldStorageDefinitions protected function Returns the required rev / mul field definitions for an entity type.
EntityDefinitionTestTrait::makeBaseFieldEntityKey protected function Promotes a field to an entity key.
EntityDefinitionTestTrait::modifyBaseField protected function Modifies the new base field from 'string' to 'text'.
EntityDefinitionTestTrait::modifyBundleField protected function Modifies the new bundle field from 'string' to 'text'.
EntityDefinitionTestTrait::removeBaseField protected function Removes the new base field from the 'entity_test_update' entity type.
EntityDefinitionTestTrait::removeBaseFieldIndex protected function Removes the index added in addBaseFieldIndex().
EntityDefinitionTestTrait::removeBundleField protected function Removes the new bundle field from the 'entity_test_update' entity type.
EntityDefinitionTestTrait::removeEntityIndex protected function Removes the index added in addEntityIndex().
EntityDefinitionTestTrait::renameBaseTable protected function Renames the base table to 'entity_test_update_new'.
EntityDefinitionTestTrait::renameDataTable protected function Renames the data table to 'entity_test_update_data_new'.
EntityDefinitionTestTrait::renameRevisionBaseTable protected function Renames the revision table to 'entity_test_update_revision_new'.
EntityDefinitionTestTrait::renameRevisionDataTable protected function Renames the revision data table to 'entity_test_update_revision_data_new'.
EntityDefinitionTestTrait::resetEntityType protected function Resets the entity type definition.
EntityDefinitionTestTrait::updateEntityTypeToNotRevisionable protected function Updates the 'entity_test_update' entity type not revisionable.
EntityDefinitionTestTrait::updateEntityTypeToNotTranslatable protected function Updates the 'entity_test_update' entity type to not translatable.
EntityDefinitionTestTrait::updateEntityTypeToRevisionable protected function Updates the 'entity_test_update' entity type to revisionable.
EntityDefinitionTestTrait::updateEntityTypeToRevisionableAndTranslatable protected function Updates the 'entity_test_update' entity type to revisionable and translatable.
EntityDefinitionTestTrait::updateEntityTypeToTranslatable protected function Updates the 'entity_test_update' entity type to translatable.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 20
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
LingotekInterfaceTranslationTest::$modules public static property Modules to enable. Overrides LingotekTestBase::$modules
LingotekInterfaceTranslationTest::setUp protected function Overrides LingotekTestBase::setUp
LingotekInterfaceTranslationTest::testAddingLanguageAllowsRequesting public function Tests that a node can be translated using the links on the management page.
LingotekInterfaceTranslationTest::testAutomatedArchivedNotificationInterfaceTranslation public function Tests that a node can be translated using the links on the management page.
LingotekInterfaceTranslationTest::testAutomatedCancelledNotificationInterfaceTranslation public function Tests that a node can be translated using the links on the management page.
LingotekInterfaceTranslationTest::testAutomatedNotificationInterfaceTranslation public function Tests that a node can be translated using the links on the management page.
LingotekInterfaceTranslationTest::testCheckTranslationStatusWithAnError public function Tests that we manage errors when using the check translation status link.
LingotekInterfaceTranslationTest::testClearInterfaceTranslationMetadata public function Tests that a node can be translated using the links on the management page.
LingotekInterfaceTranslationTest::testDownloadTranslationWithAnError public function Tests that we manage errors when using the download translation link.
LingotekInterfaceTranslationTest::testFormWorksAfterRemovingLanguageWithStatuses public function Tests that a config can be translated using the links on the management page.
LingotekInterfaceTranslationTest::testInterfaceTranslationUsingLinks public function Tests that a node can be translated using the links on the management page.
LingotekInterfaceTranslationTest::testInterfaceTranslationWithoutPotx public function Tests when potx is not present.
LingotekInterfaceTranslationTest::testRequestTranslationWithADocumentArchivedError public function Tests that we manage errors when using the request translation link.
LingotekInterfaceTranslationTest::testRequestTranslationWithADocumentLockedError public function Tests that we manage errors when using the request translation link.
LingotekInterfaceTranslationTest::testRequestTranslationWithAnError public function Tests that we manage errors when using the request translation link.
LingotekInterfaceTranslationTest::testRequestTranslationWithAPaymentRequiredError public function Tests that we manage errors when using the request translation link.
LingotekInterfaceTranslationTest::testUploadingWithAnError public function Test that we handle errors in upload.
LingotekInterfaceTranslationTest::testUploadingWithAPaymentRequiredError public function Test that we handle errors in upload.
LingotekInterfaceTranslationTestTrait::assertLingotekInterfaceTranslationCheckSourceStatusLink protected function
LingotekInterfaceTranslationTestTrait::assertLingotekInterfaceTranslationCheckTargetStatusLink protected function
LingotekInterfaceTranslationTestTrait::assertLingotekInterfaceTranslationDownloadLink protected function
LingotekInterfaceTranslationTestTrait::assertLingotekInterfaceTranslationRequestTranslationLink protected function
LingotekInterfaceTranslationTestTrait::assertLingotekInterfaceTranslationUploadLink protected function
LingotekInterfaceTranslationTestTrait::assertNoLingotekInterfaceTranslationRequestTranslationLink protected function
LingotekInterfaceTranslationTestTrait::getDestination protected function
LingotekInterfaceTranslationTestTrait::getInterfaceTranslationFormUrl protected function
LingotekManagementTestTrait::assertLingotekCheckSourceStatusLink protected function Asserts there is a link for checking the content source status. 3
LingotekManagementTestTrait::assertLingotekCheckTargetStatusLink protected function Asserts there is a link for checking the translation status for a given locale.
LingotekManagementTestTrait::assertLingotekDownloadTargetLink protected function Asserts there is a link for downloading the translation for a given locale.
LingotekManagementTestTrait::assertLingotekRequestTranslationLink protected function Asserts there is a link for requesting translation for a given locale. 3
LingotekManagementTestTrait::assertLingotekUpdateLink protected function Asserts there is a link for updating the content.
LingotekManagementTestTrait::assertLingotekUploadLink protected function Asserts there is a link for uploading the content. 3
LingotekManagementTestTrait::assertLingotekWorkbenchLink protected function Asserts there is a link to the Lingotek workbench in a new tab.
LingotekManagementTestTrait::assertNoLingotekCheckSourceStatusLink protected function Asserts there is NOT a link for checking the content source status.
LingotekManagementTestTrait::assertNoLingotekCheckTargetStatusLink protected function Asserts there is NOT a link for checking the translation status for a given locale.
LingotekManagementTestTrait::assertNoLingotekDownloadTargetLink protected function Asserts there is NOT a link for downloading the translation for a given locale.
LingotekManagementTestTrait::assertNoLingotekRequestTranslationLink protected function Asserts there is NOT a link for requesting translation for a given locale.
LingotekManagementTestTrait::assertNoLingotekUploadLink protected function Asserts there is no link for uploading the content.
LingotekManagementTestTrait::getApplyActionsButtonLabel protected function
LingotekManagementTestTrait::getBulkOperationFormName protected function Gets the bulk operation form name for selection.
LingotekManagementTestTrait::getBulkOperationNameForAssignJobId protected function
LingotekManagementTestTrait::getBulkOperationNameForCancel protected function
LingotekManagementTestTrait::getBulkOperationNameForCancelTarget protected function
LingotekManagementTestTrait::getBulkOperationNameForCheckTranslation protected function
LingotekManagementTestTrait::getBulkOperationNameForCheckTranslations protected function
LingotekManagementTestTrait::getBulkOperationNameForCheckUpload protected function
LingotekManagementTestTrait::getBulkOperationNameForClearJobId protected function
LingotekManagementTestTrait::getBulkOperationNameForDeleteTranslation protected function
LingotekManagementTestTrait::getBulkOperationNameForDeleteTranslations protected function
LingotekManagementTestTrait::getBulkOperationNameForDownloadTranslation protected function
LingotekManagementTestTrait::getBulkOperationNameForDownloadTranslations protected function
LingotekManagementTestTrait::getBulkOperationNameForRequestTranslation protected function
LingotekManagementTestTrait::getBulkOperationNameForRequestTranslations protected function
LingotekManagementTestTrait::getBulkOperationNameForUpload protected function
LingotekManagementTestTrait::getBulkSelectionKey protected function Gets the bulk checkbox selection key in a table. 3
LingotekTestBase::$client protected property The cookie jar holding the testing session cookies for Guzzle requests.
LingotekTestBase::$cookies protected property The Guzzle HTTP client.
LingotekTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 4
LingotekTestBase::$translationManagerUser protected property Minimal Lingotek translation manager user.
LingotekTestBase::assertLinkToWorkbenchInNewTabInSinglePage Deprecated protected function Assert that there is a link to the workbench in a new tab.
LingotekTestBase::assertManagementFormProfile protected function Asserts a given index of the management table shows a given profile.
LingotekTestBase::assertNoConfigTargetError protected function Assert that a config target has not been marked as error.
LingotekTestBase::assertNoSourceStatus protected function Assert that a content source has not the given status.
LingotekTestBase::assertNoTargetError protected function Assert that a content target has not been marked as error.
LingotekTestBase::assertNoTargetStatus protected function Assert that a content target has not the given status.
LingotekTestBase::assertSourceStatus protected function Assert that a content source has the given status. 1
LingotekTestBase::assertSourceStatusStateCount protected function Asserts if there are a number of documents with a given status and language label as source.
LingotekTestBase::assertTargetStatus protected function Assert that a content target has the given status.
LingotekTestBase::assertUploadedDataFieldCount protected function Asserts if the uploaded data contains the expected number of fields.
LingotekTestBase::configureContentModeration protected function Configure content moderation.
LingotekTestBase::connectToLingotek protected function Connects to Lingotek.
LingotekTestBase::createImageField public function Create a new image field.
LingotekTestBase::createTranslationManagerUser protected function Creates a translation manager role and a user with the minimal Lingotek translation management permissions.
LingotekTestBase::editAsNewDraftNodeForm protected function
LingotekTestBase::editAsRequestReviewNodeForm protected function
LingotekTestBase::getContentBulkManagementFormUrl protected function Get the content bulk management url. 2
LingotekTestBase::getHttpClient protected function Obtain the HTTP client and set the cookies. Overrides BrowserTestBase::getHttpClient
LingotekTestBase::goToConfigBulkManagementForm protected function Go to the config bulk management form and filter one kind of configuration.
LingotekTestBase::goToContentBulkManagementForm protected function Go to the content bulk management form.
LingotekTestBase::goToInterfaceTranslationManagementForm protected function
LingotekTestBase::resetStorageCachesAndReloadNode protected function Resets node and metadata storage caches and reloads the node.
LingotekTestBase::saveAndArchiveNodeForm protected function
LingotekTestBase::saveAndKeepPublishedNodeForm protected function
LingotekTestBase::saveAndKeepPublishedThisTranslationNodeForm protected function
LingotekTestBase::saveAndPublishNodeForm protected function Create and publish a node.
LingotekTestBase::saveAndUnpublishNodeForm protected function
LingotekTestBase::saveAsNewDraftNodeForm protected function
LingotekTestBase::saveAsRequestReviewNodeForm protected function
LingotekTestBase::saveAsUnpublishedNodeForm protected function
LingotekTestBase::saveLingotekConfigTranslationSettings protected function Save Lingotek configuration translation settings.
LingotekTestBase::saveLingotekContentTranslationSettings protected function Save Lingotek content translation settings.
LingotekTestBase::saveLingotekContentTranslationSettingsForNodeTypes protected function Save Lingotek translation settings for node types.
LingotekTestBase::saveLingotekContentTranslationSettingsViaConfig protected function Save Lingotek content translation settings.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.