You are here

Home » API reference » Translation Management Tool 8 » PluginsTest.php

class PluginsTest in Translation Management Tool 8

Tests interaction between core and the plugins.

@group tmgmt

Hierarchy

Expanded class hierarchy of PluginsTest

File

tests/src/Kernel/PluginsTest.php, line 12

Namespace

Drupal\Tests\tmgmt\Kernel
View source 
class PluginsTest extends TMGMTKernelTestBase {

  /**
   * {@inheritdoc}
   */
  function setUp() : void {
    parent::setUp();
    \Drupal::service('router.builder')
      ->rebuild();
  }
  function createJobWithItems($action = 'translate') {
    $job = parent::createJob();
    for ($i = 1; $i < 3; $i++) {
      if ($i == 3) {

        // Explicitly define the data for the third item.
        $data['data'] = array(
          'dummy' => array(
            'deep_nesting' => array(
              '#text' => 'Stored data',
            ),
          ),
        );
        $job
          ->addItem('test_source', 'test', $i, array(
          $data,
        ));
      }
      $job
        ->addItem('test_source', 'test', $i);
    }

    // Manually specify the translator for now.
    $job->translator = $this->default_translator
      ->id();
    $job->settings = array(
      'action' => $action,
    );
    return $job;
  }
  function testBasicWorkflow() {

    // Submit a translation job.
    $submit_job = $this
      ->createJobWithItems('submit');
    $submit_job
      ->requestTranslation();
    $submit_job = Job::load($submit_job
      ->id());
    $this
      ->assertTrue($submit_job
      ->isActive());
    $messages = $submit_job
      ->getMessages();
    $last_message = end($messages);
    $this
      ->assertEqual('Test submit.', $last_message->message->value);

    // Translate a job.
    $translate_job = $this
      ->createJobWithItems('translate');
    $translate_job
      ->requestTranslation();
    $translate_job = Job::load($translate_job
      ->id());
    foreach ($translate_job
      ->getItems() as $job_item) {
      $this
        ->assertTrue($job_item
        ->isNeedsReview());
    }
    $messages = $translate_job
      ->getMessages();

    // array_values() results in numeric keys, which is necessary for list.
    list($debug, $translated, $needs_review) = array_values($messages);
    $this
      ->assertEqual('Test translator called.', $debug->message->value);
    $this
      ->assertEqual('debug', $debug->type->value);
    $this
      ->assertEqual('Test translation created.', $translated->message->value);
    $this
      ->assertEqual('status', $translated->type->value);

    // The third message is specific to a job item and has different state
    // constants.
    $this
      ->assertEqual('The translation of <a href=":source_url">@source</a> to @language is finished and can now be <a href=":review_url">reviewed</a>.', $needs_review->message->value);
    $this
      ->assertEqual('status', $needs_review->type->value);
    $i = 1;
    foreach ($translate_job
      ->getItems() as $item) {

      // Check the translated text.
      if ($i != 3) {
        $expected_text = 'de(de-ch): Text for job item with type ' . $item
          ->getItemType() . ' and id ' . $item
          ->getItemId() . '.';
      }
      else {

        // The third item has an explicitly stored data value.
        $expected_text = 'de(de-ch): Stored data';
      }
      $item_data = $item
        ->getData();
      $this
        ->assertEqual($expected_text, $item_data['dummy']['deep_nesting']['#translation']['#text']);
      $i++;
    }
    foreach ($translate_job
      ->getItems() as $job_item) {
      $job_item
        ->acceptTranslation();
    }

    // @todo Accepting does not result in messages on the job anymore.
    // Update once there are job item messages.

    /*
        $messages = $translate_job->getMessages();
        $last_message = end($messages);
        $this->assertEqual('Job accepted', $last_message->message->value);
        $this->assertEqual('status', $last_message->type);*/

    // Check if the translations have been "saved".
    foreach ($translate_job
      ->getItems() as $item) {
      $this
        ->assertNotEmpty(\Drupal::state()
        ->get('tmgmt_test_saved_translation_' . $item
        ->getItemType() . '_' . $item
        ->getItemId(), FALSE));
    }

    // A rejected job.
    $reject_job = $this
      ->createJobWithItems('reject');
    $reject_job
      ->requestTranslation();

    // Still rejected.
    $this
      ->assertTrue($reject_job
      ->isRejected());
    $messages = $reject_job
      ->getMessages();
    $last_message = end($messages);
    $this
      ->assertEqual('This is not supported.', $last_message->message->value);
    $this
      ->assertEqual('error', $last_message
      ->getType());

    // A failing job.
    $failing_job = $this
      ->createJobWithItems('fail');
    $failing_job
      ->requestTranslation();

    // Still new.
    $this
      ->assertTrue($failing_job
      ->isUnprocessed());
    $messages = $failing_job
      ->getMessages();
    $last_message = end($messages);
    $this
      ->assertEqual('Service not reachable.', $last_message->message->value);
    $this
      ->assertEqual('error', $last_message
      ->getType());
  }

  /**
   * Tests escaping and unescaping text.
   */
  function testEscaping() {
    $plugin = $this->default_translator
      ->getPlugin();
    $tests = array(
      array(
        'item' => array(
          '#text' => 'no escaping',
        ),
        'expected' => 'no escaping',
      ),
      array(
        'item' => array(
          '#text' => 'single placeholder',
          '#escape' => array(
            7 => array(
              'string' => 'placeholder',
            ),
          ),
        ),
        'expected' => 'single [[[placeholder]]]',
      ),
      array(
        'item' => array(
          '#text' => 'two placeholder, the second placeholder',
          '#escape' => array(
            4 => array(
              'string' => 'placeholder',
            ),
            28 => array(
              'string' => 'placeholder',
            ),
          ),
        ),
        'expected' => 'two [[[placeholder]]], the second [[[placeholder]]]',
      ),
      array(
        'item' => array(
          '#text' => 'something, something else',
          '#escape' => array(
            0 => array(
              'string' => 'something',
            ),
            21 => array(
              'string' => 'else',
            ),
          ),
        ),
        'expected' => '[[[something]]], something [[[else]]]',
      ),
      array(
        'item' => array(
          '#text' => 'something, something else',
          '#escape' => array(
            21 => array(
              'string' => 'else',
            ),
            11 => array(
              'string' => 'something',
            ),
          ),
        ),
        'expected' => 'something, [[[something]]] [[[else]]]',
      ),
    );
    foreach ($tests as $test) {
      $escaped = $plugin
        ->escapeText($test['item']);

      // Assert that the string was escaped as expected.
      $this
        ->assertEqual($escaped, $test['expected']);

      // Assert that the string is the same as the original when unescaped.
      $this
        ->assertEqual($plugin
        ->unescapeText($escaped), $test['item']['#text']);
    }
  }

  /**
   * Tests language matching.
   */
  public function testLanguageMatching() {

    // Exact match.
    $language = 'en';
    $remote_languages = [
      'en-GB-London' => 'English (London - United Kingdom)',
      'en' => 'English',
    ];
    $matching_language = \Drupal::service('tmgmt.language_matcher')
      ->getMatchingLangcode($language, $remote_languages);
    $this
      ->assertEquals('en', $matching_language);
    $language = 'en-US';
    $remote_languages = [
      'en-GB' => 'English (United Kingdom)',
      'en-US' => 'English (United States)',
    ];
    $matching_language = \Drupal::service('tmgmt.language_matcher')
      ->getMatchingLangcode($language, $remote_languages);
    $this
      ->assertEquals('en-US', $matching_language);
    $language = 'en-GB-London';
    $remote_languages = [
      'en-GB' => 'English (United Kingdom)',
      'en-GB-London' => 'English (London - United Kingdom)',
    ];
    $matching_language = \Drupal::service('tmgmt.language_matcher')
      ->getMatchingLangcode($language, $remote_languages);
    $this
      ->assertEquals('en-GB-London', $matching_language);

    // Partial match.
    $language = 'en';
    $remote_languages = [
      'en-GB' => 'English (United Kingdom)',
      'en-US' => 'English (United States)',
    ];
    $matching_language = \Drupal::service('tmgmt.language_matcher')
      ->getMatchingLangcode($language, $remote_languages);
    $this
      ->assertEquals('en-GB', $matching_language);
    $language = 'en-GB';
    $remote_languages = [
      'en' => 'English',
      'en-US' => 'English (United States)',
    ];
    $matching_language = \Drupal::service('tmgmt.language_matcher')
      ->getMatchingLangcode($language, $remote_languages);
    $this
      ->assertEquals('en', $matching_language);
    $language = 'en';
    $remote_languages = [
      'en-GB-London' => 'English (London - United Kingdom)',
      'en-GB' => 'English (United Kingdom)',
    ];
    $matching_language = \Drupal::service('tmgmt.language_matcher')
      ->getMatchingLangcode($language, $remote_languages);
    $this
      ->assertEquals('en-GB', $matching_language);

    // No match.
    $language = 'en';
    $remote_languages = [
      'es' => 'Spanish',
    ];
    $matching_language = \Drupal::service('tmgmt.language_matcher')
      ->getMatchingLangcode($language, $remote_languages);
    $this
      ->assertEquals('en', $matching_language);
    $language = 'en';
    $remote_languages = [];
    $matching_language = \Drupal::service('tmgmt.language_matcher')
      ->getMatchingLangcode($language, $remote_languages);
    $this
      ->assertEquals('en', $matching_language);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
PluginsTest::createJobWithItems function
PluginsTest::setUp function Overrides TMGMTKernelTestBase::setUp
PluginsTest::testBasicWorkflow function
PluginsTest::testEscaping function Tests escaping and unescaping text.
PluginsTest::testLanguageMatching public function Tests language matching.
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.
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.
TMGMTKernelTestBase::$default_translator protected property A default translator using the test translator.
TMGMTKernelTestBase::$modules public static property Modules to enable. Overrides KernelTestBase::$modules 4
TMGMTKernelTestBase::addLanguage function Sets the proper environment.
TMGMTKernelTestBase::assertJobItemLangCodes function Asserts job item language codes.
TMGMTKernelTestBase::createJob protected function Creates, saves and returns a translation job.
TMGMTKernelTestBase::createTranslator function Creates, saves and returns a translator.