You are here

class LingotekNodeNotificationCallbackQueueWorkerTest in Lingotek Translation 8.2

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

Tests translating a node using the notification callback with a queue worker.

@group lingotek @group legacy

Hierarchy

Expanded class hierarchy of LingotekNodeNotificationCallbackQueueWorkerTest

File

tests/src/Functional/LingotekNodeNotificationCallbackQueueWorkerTest.php, line 22

Namespace

Drupal\Tests\lingotek\Functional
View source
class LingotekNodeNotificationCallbackQueueWorkerTest extends LingotekTestBase {

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = [
    'block',
    'node',
  ];

  /**
   * @var \Drupal\node\NodeInterface
   */
  protected $node;
  protected function setUp() {
    parent::setUp();

    // Place the actions and title block.
    $this
      ->drupalPlaceBlock('page_title_block', [
      'region' => 'header',
      'weight' => -5,
    ]);
    $this
      ->drupalPlaceBlock('local_tasks_block', [
      'region' => 'header',
      'weight' => -10,
    ]);

    // Create Article node types.
    $this
      ->drupalCreateContentType([
      'type' => 'article',
      'name' => 'Article',
    ]);

    // Add a language.
    ConfigurableLanguage::createFromLangcode('es')
      ->save();

    // Enable translation for the current entity type and ensure the change is
    // picked up.
    ContentLanguageSettings::loadByEntityTypeBundle('node', 'article')
      ->setLanguageAlterable(TRUE)
      ->save();
    \Drupal::service('content_translation.manager')
      ->setEnabled('node', 'article', TRUE);
    drupal_static_reset();
    \Drupal::entityTypeManager()
      ->clearCachedDefinitions();
    $this
      ->applyEntityUpdates();

    // Rebuild the container so that the new languages are picked up by services
    // that hold a list of languages.
    $this
      ->rebuildContainer();
    $this
      ->saveLingotekContentTranslationSettingsForNodeTypes();
    $profile = LingotekProfile::create([
      'id' => 'automatic_worker',
      'label' => 'Custom profile',
      'auto_upload' => TRUE,
      'auto_request' => TRUE,
      'auto_download' => TRUE,
      'auto_download_worker' => TRUE,
    ]);
    $profile
      ->save();
  }

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

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

    // Create a node.
    $edit = [];
    $edit['title[0][value]'] = 'Llamas are cool';
    $edit['body[0][value]'] = 'Llamas are very cool';
    $edit['langcode[0][value]'] = 'en';
    $edit['lingotek_translation_management[lingotek_translation_profile]'] = 'automatic_worker';
    $this
      ->saveAndPublishNodeForm($edit);

    /** @var \Drupal\node\NodeInterface $node */
    $node = Node::load(1);

    /** @var \Drupal\lingotek\LingotekContentTranslationServiceInterface $content_translation_service */
    $content_translation_service = \Drupal::service('lingotek.content_translation');

    // Assert the content is importing.
    $this
      ->assertIdentical(Lingotek::STATUS_IMPORTING, $content_translation_service
      ->getSourceStatus($node));
    $this
      ->goToContentBulkManagementForm();

    // 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([
      'es',
    ], $response['result']['request_translations'], 'Spanish language has been requested after notification automatically.');
    $this
      ->goToContentBulkManagementForm();
    $node = $this
      ->resetStorageCachesAndReloadNode();

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

    // Assert the target is pending.
    $this
      ->assertIdentical(Lingotek::STATUS_PENDING, $content_translation_service
      ->getTargetStatus($node, 'es'));
    $this
      ->goToContentBulkManagementForm();

    // 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
      ->assertTrue($response['result']['download_queued'], 'Spanish language has been queued after notification automatically.');
    $this
      ->goToContentBulkManagementForm();
    $node = $this
      ->resetStorageCachesAndReloadNode();

    // Assert the target is ready, but was not downloaded.
    $this
      ->assertIdentical(Lingotek::STATUS_READY, $content_translation_service
      ->getTargetStatus($node, 'es'));
    $this
      ->goToContentBulkManagementForm();
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_READY);

    // Run cron.
    $this->container
      ->get('cron')
      ->run();
    $this
      ->goToContentBulkManagementForm();
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_CURRENT);
  }

  /**
   * Testing handling several notifications in a row.
   */
  public function testNotificationsInARow() {
    ConfigurableLanguage::createFromLangcode('it')
      ->save();
    ConfigurableLanguage::createFromLangcode('ca')
      ->save();
    ConfigurableLanguage::createFromLangcode('hu')
      ->save();
    ConfigurableLanguage::createFromLangcode('de')
      ->save();

    // Create a node.
    $edit = [];
    $edit['title[0][value]'] = 'Llamas are cool';
    $edit['body[0][value]'] = 'Llamas are very cool';
    $edit['langcode[0][value]'] = 'en';
    $edit['lingotek_translation_management[lingotek_translation_profile]'] = 'automatic_worker';
    $this
      ->saveAndPublishNodeForm($edit);
    $this
      ->goToContentBulkManagementForm();

    // Upload the node.
    $this
      ->clickLink('EN');
    $this
      ->assertText('The import for node Llamas are cool is complete.');

    // Request languages.
    $languages = [
      'DE' => 'de_DE',
      'ES' => 'es_ES',
      'HU' => 'hu_HU',
      'IT' => 'it_IT',
      'CA' => 'ca_ES',
    ];
    foreach ($languages as $langcode => $locale) {
      $this
        ->clickLink($langcode);
      $this
        ->assertText(new FormattableMarkup("Locale '@locale' was added as a translation target for node Llamas are cool.", [
        '@locale' => $locale,
      ]));
    }

    /** @var \GuzzleHttp\Promise\PromiseInterface[] $requests */
    $requests = [];
    foreach ($languages as $langcode => $locale) {
      $url = Url::fromRoute('lingotek.notify', [], [
        'query' => [
          'project_id' => 'test_project',
          'document_id' => 'dummy-document-hash-id',
          'locale_code' => str_replace('_', '-', $locale),
          'locale' => $locale,
          'complete' => 'true',
          'type' => 'target',
          'progress' => '100',
        ],
      ])
        ->setAbsolute()
        ->toString();
      $requests[] = \Drupal::httpClient()
        ->postAsync($url);
    }
    $count = 0;

    // We wait for the requests to finish.
    foreach ($requests as $request) {
      try {
        $request
          ->then(function ($response) use ($request) {
          $message = new TranslatableMarkup('FULFILLED. Got a response with status %status and body: %body', [
            '%status' => $response
              ->getStatusCode(),
            '%body' => (string) $response
              ->getBody(TRUE),
          ]);
          $this
            ->verbose($message);
        }, function ($response) use ($request) {
          $message = new TranslatableMarkup('REJECTED. Got a response with status %status and body: %body', [
            '%status' => $response
              ->getStatusCode(),
            '%body' => (string) $response
              ->getBody(TRUE),
          ]);
          $this
            ->verbose($message);
        });
      } catch (\Exception $error) {
        $count++;
      }
    }
    foreach ($requests as $request) {
      $request
        ->wait(TRUE);
    }

    // Go to the bulk node management page.
    $this
      ->goToContentBulkManagementForm();

    // All the links are ready.
    $current_links = $this
      ->xpath("//a[contains(@class,'language-icon') and contains(@class, 'target-ready')]");
    $this
      ->assertEqual(count($current_links), count($languages) - $count, new FormattableMarkup('Various languages (@var) are ready.', [
      '@var' => count($languages) - $count,
    ]));
    $this
      ->assertTrue(TRUE, new FormattableMarkup('@count target languages failed, but error where given back so the TMS can retry.', [
      '@count' => $count,
    ]));
    $this
      ->assertEqual(5, count($current_links), new FormattableMarkup('All languages (@var) are ready.', [
      '@var' => count($current_links),
    ]));

    // Run cron.
    $this->container
      ->get('cron')
      ->run();
    $this
      ->goToContentBulkManagementForm();
    $current_links = $this
      ->xpath("//a[contains(@class,'language-icon') and contains(@class, 'target-current')]");
    $this
      ->assertEqual(count($current_links), count($languages) - $count, new FormattableMarkup('Various languages (@var) are current.', [
      '@var' => count($languages) - $count,
    ]));
    $this
      ->assertTrue(TRUE, new FormattableMarkup('@count target languages failed, but error where given back so the TMS can retry.', [
      '@count' => $count,
    ]));
    $this
      ->assertEqual(5, count($current_links), new FormattableMarkup('All languages (@var) are current.', [
      '@var' => count($current_links),
    ]));
  }

  /**
   * Test that a notification with a failure in download responded with an error.
   */
  public function testAutomatedNotificationNodeTranslationWithError() {

    // Add an additional language.
    ConfigurableLanguage::createFromLangcode('it')
      ->save();

    // Create a node.
    $edit = [];
    $edit['title[0][value]'] = 'Llamas are cool';
    $edit['body[0][value]'] = 'Llamas are very cool';
    $edit['langcode[0][value]'] = 'en';
    $edit['lingotek_translation_management[lingotek_translation_profile]'] = 'automatic_worker';
    $this
      ->saveAndPublishNodeForm($edit);

    // 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,
    ]);

    // 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
      ->assertTrue($response['result']['download_queued'], 'Spanish language has been queued after notification automatically.');
    $this
      ->assertEqual('Download for target es_ES in document dummy-document-hash-id has been queued.', $response['messages'][0]);

    // Go to the bulk node management page.
    $this
      ->goToContentBulkManagementForm();

    // All the links are pending until cron runs.
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_READY);

    // Run cron.
    $this->container
      ->get('cron')
      ->run();
    $this
      ->goToContentBulkManagementForm();
    $this
      ->assertTargetStatus('ES', Lingotek::STATUS_CURRENT);

    // We ensure it fails.
    \Drupal::state()
      ->set('lingotek.must_error_in_download', TRUE);

    // 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' => 'it-IT',
        'locale' => 'it_IT',
        '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
      ->assertTrue($response['result']['download_queued'], 'Italian language has been queued after notification automatically.');
    $this
      ->assertEqual('Download for target it_IT in document dummy-document-hash-id has been queued.', $response['messages'][0]);
    $url = Url::fromRoute('lingotek.notify', [], [
      'query' => [
        'project_id' => 'test_project',
        'document_id' => 'dummy-document-hash-id',
        'locale_code' => 'it-IT',
        'locale' => 'it_IT',
        'complete' => 'true',
        'type' => 'target',
        'progress' => '100',
      ],
    ])
      ->setAbsolute()
      ->toString();
    $request = \Drupal::httpClient()
      ->postAsync($url);
    try {
      $response = $request
        ->wait();
    } catch (ServerException $exception) {
      if ($exception
        ->getCode() === Response::HTTP_SERVICE_UNAVAILABLE) {
        $this
          ->fail('The request returned a 503 status code.');
      }
      else {
        $this
          ->fail('The request fail with an unexpected status code.');
      }
    }
    $this
      ->verbose(var_export($response, TRUE));

    // Run cron.
    $this->container
      ->get('cron')
      ->run();
    $this
      ->goToContentBulkManagementForm();

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

    // Try to re-download the Italian translation.
    $this
      ->clickLink('IT');
    $this
      ->assertText('The download for node Llamas are cool failed. Please try again.');

    // Check that the Target Status is Error
    $node = Node::load(1);
    $content_translation_service = \Drupal::service('lingotek.content_translation');
    $this
      ->assertIdentical(Lingotek::STATUS_ERROR, $content_translation_service
      ->getTargetStatus($node, 'it'));
  }

  /**
   * Resets node and metadata storage caches and reloads the node.
   *
   * @return \Drupal\node\NodeInterface
   *   The node.
   */
  protected function resetStorageCachesAndReloadNode() {

    /** @var \Drupal\node\NodeStorageInterface $node_storage */
    $node_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('node');

    /** @var \Drupal\Core\Entity\EntityStorageInterface; $metadata_storage */
    $metadata_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('lingotek_content_metadata');

    // The node and the metadata caches need to be reset before reload.
    $metadata_storage
      ->resetCache([
      1,
    ]);
    $node_storage
      ->resetCache([
      1,
    ]);

    /** @var \Drupal\node\NodeInterface $node */
    $node = $node_storage
      ->load(1);
    return $node;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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::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
BrowserTestBase::$minkDefaultDriverClass protected property 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
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.
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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. 23
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.
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::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::getBulkOperationNameForDisassociate Deprecated 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
LingotekNodeNotificationCallbackQueueWorkerTest::$modules public static property Modules to install. Overrides LingotekTestBase::$modules
LingotekNodeNotificationCallbackQueueWorkerTest::$node protected property
LingotekNodeNotificationCallbackQueueWorkerTest::resetStorageCachesAndReloadNode protected function Resets node and metadata storage caches and reloads the node.
LingotekNodeNotificationCallbackQueueWorkerTest::setUp protected function Overrides LingotekTestBase::setUp
LingotekNodeNotificationCallbackQueueWorkerTest::testAutomatedNotificationNodeTranslation public function Tests that a node can be translated using the links on the management page.
LingotekNodeNotificationCallbackQueueWorkerTest::testAutomatedNotificationNodeTranslationWithError public function Test that a notification with a failure in download responded with an error.
LingotekNodeNotificationCallbackQueueWorkerTest::testNotificationsInARow public function Testing handling several notifications in a row.
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 6
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::createEditorialWorkflow Deprecated protected function Creates the editorial workflow.
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::getDestination protected function 4
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::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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 3
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. 2
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. 2
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 a 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::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
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 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::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.