You are here

Home » API reference » TMGMT Translator Smartling 8.3 » TranslationProgressCalculatorTest.php

class TranslationProgressCalculatorTest in TMGMT Translator Smartling 8.3

Tests for progress calculator.

@group tmgmt_smartling

Hierarchy

Expanded class hierarchy of TranslationProgressCalculatorTest

File

tests/src/Kernel/TranslationProgressCalculatorTest.php, line 13

Namespace

Drupal\Tests\tmgmt_smartling\Kernel
View source 
class TranslationProgressCalculatorTest extends KernelTestBase {

  /**
   * Tests calculate.
   *
   * @param $auto_authorize
   * @param $test_data
   * @param $logger_called_times
   * @param $result
   *
   * @throws \Exception
   * @dataProvider providerTestCalculate
   */
  public function testCalculate($auto_authorize, $test_data, $logger_called_times, $result) {
    $logger_mock = $this
      ->getMockBuilder('\\Drupal\\Core\\Logger\\LoggerChannel')
      ->setMethods([
      "warning",
    ])
      ->disableOriginalConstructor()
      ->getMock();
    $logger_mock
      ->expects($this
      ->exactly($logger_called_times))
      ->method("warning")
      ->with(t("Translation progress in dashboard 100% but for the connector progress = @percentage%.", [
      "@percentage" => $result,
    ]));
    $calculator = new TranslationProgressCalculator($logger_mock);
    $this
      ->assertEquals($calculator
      ->calculate($test_data, $auto_authorize), $result);
  }

  /**
   * Tests calculate: invalid data.
   *
   * @expectedException \InvalidArgumentException
   * @expectedExceptionMessage Invalid input data: {"totalStringCount":0}
   */
  public function testCalculateInvalidData() {
    $logger_mock = $this
      ->getMockBuilder('\\Drupal\\Core\\Logger\\LoggerChannel')
      ->setMethods(NULL)
      ->disableOriginalConstructor()
      ->getMock();
    $calculator = new TranslationProgressCalculator($logger_mock);
    $calculator
      ->calculate([
      "totalStringCount" => 0,
    ]);
  }

  /**
   * Tests validate.
   *
   * @param $test_data
   * @param $result
   *
   * @dataProvider providerTestValidate
   */
  public function testValidate($test_data, $result) {
    $logger_mock = $this
      ->getMockBuilder('\\Drupal\\Core\\Logger\\LoggerChannel')
      ->setMethods(NULL)
      ->disableOriginalConstructor()
      ->getMock();
    $calculator = new TranslationProgressCalculator($logger_mock);
    $this
      ->assertEquals($calculator
      ->isValid($test_data), $result);
  }

  /**
   * Data provider for self::testCalculate().
   */
  public function providerTestCalculate() {

    // The formula was tested on following set and was compared with dashboard.
    // Progress = 0%, 4 strings are ready for translation but translator
    // didn't start yet.
    $cases[] = [
      "auto_authorize" => TRUE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 4,
        "completedStringCount" => 0,
        "excludedStringCount" => 1,
      ],
      "logger_called" => 0,
      "result" => 0,
    ];

    // Progress = 55%, it's common case.
    $cases[] = [
      "auto_authorize" => TRUE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 4,
        "completedStringCount" => 5,
        "excludedStringCount" => 1,
      ],
      "logger_called" => 0,
      "result" => 55,
    ];

    // Progress = 100%, looks like only 5 strings were authorized. There can
    // be a problem that user could forget about 4 strings and we will not let
    // him know. As a result, the file will be downloaded with 5 translated and
    // 4 original strings.
    $cases[] = [
      "auto_authorize" => TRUE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 0,
        "completedStringCount" => 5,
        "excludedStringCount" => 1,
      ],
      "logger_called" => 0,
      "result" => 100,
    ];

    // Progress = 0%, file was uploaded without authorization. User will do
    // this later or will add file to job.
    $cases[] = [
      "auto_authorize" => TRUE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 0,
        "completedStringCount" => 0,
        "excludedStringCount" => 0,
      ],
      "logger_called" => 0,
      "result" => 0,
    ];

    // Progress = 100%, nothing to translate, user excluded all content.
    $cases[] = [
      "auto_authorize" => TRUE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 0,
        "completedStringCount" => 0,
        "excludedStringCount" => 10,
      ],
      "logger_called" => 0,
      "result" => 100,
    ];

    // The new formula which takes unauthorized strings into account.
    // The translation progress will be different than on "Files" tab in
    // dashboard. Progress = 55%, it's common case.
    $cases[] = [
      "auto_authorize" => FALSE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 4,
        "completedStringCount" => 5,
        "excludedStringCount" => 1,
      ],
      "logger_called" => 0,
      "result" => 55,
    ];

    // Progress = 55%, 2 strings are still in progress but user also has 2
    // unauthorized strings which we also use in formula.
    $cases[] = [
      "auto_authorize" => FALSE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 2,
        "completedStringCount" => 5,
        "excludedStringCount" => 1,
      ],
      "logger_called" => 1,
      "result" => 55,
    ];

    // Progress = 55%, 5 strings were authorized and already translated.
    // Dashboard shows 100% but we still treat file as untranslated.
    $cases[] = [
      "auto_authorize" => FALSE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 0,
        "completedStringCount" => 5,
        "excludedStringCount" => 1,
      ],
      "logger_called" => 1,
      "result" => 55,
    ];

    // Progress = 0%, file was uploaded without authorization. User will do
    // this later or will add file to job.
    $cases[] = [
      "auto_authorize" => FALSE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 0,
        "completedStringCount" => 0,
        "excludedStringCount" => 0,
      ],
      "logger_called" => 1,
      "result" => 0,
    ];

    // Progress = 100%, nothing to translate, user excluded all content.
    $cases[] = [
      "auto_authorize" => FALSE,
      "data" => [
        "totalStringCount" => 10,
        "authorizedStringCount" => 0,
        "completedStringCount" => 0,
        "excludedStringCount" => 10,
      ],
      "logger_called" => 0,
      "result" => 100,
    ];
    return $cases;
  }

  /**
   * Data provider for self::testValidate().
   */
  public function providerTestValidate() {
    $cases[] = [
      "data" => [
        "totalStringCount" => 0,
        "authorizedStringCount" => 0,
        "completedStringCount" => 0,
        "excludedStringCount" => 0,
      ],
      "result" => TRUE,
    ];
    $cases[] = [
      "data" => [
        "authorizedStringCount" => 0,
        "completedStringCount" => 0,
        "excludedStringCount" => 0,
      ],
      "result" => FALSE,
    ];
    $cases[] = [
      "data" => [
        "totalStringCount" => 0,
        "completedStringCount" => 0,
        "excludedStringCount" => 0,
      ],
      "result" => FALSE,
    ];
    $cases[] = [
      "data" => [
        "totalStringCount" => 0,
        "authorizedStringCount" => 0,
        "excludedStringCount" => 0,
      ],
      "result" => FALSE,
    ];
    $cases[] = [
      "data" => [
        "totalStringCount" => 0,
        "authorizedStringCount" => 0,
        "completedStringCount" => 0,
      ],
      "result" => FALSE,
    ];
    return $cases;
  }

}

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::$modules protected static property Modules to enable. 464
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::setUp protected function 347
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.
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.
TranslationProgressCalculatorTest::providerTestCalculate public function Data provider for self::testCalculate().
TranslationProgressCalculatorTest::providerTestValidate public function Data provider for self::testValidate().
TranslationProgressCalculatorTest::testCalculate public function Tests calculate.
TranslationProgressCalculatorTest::testCalculateInvalidData public function Tests calculate: invalid data.
TranslationProgressCalculatorTest::testValidate public function Tests validate.