You are here

Home » API reference » TMGMT Translator Smartling 8.4 » UploadFlowTest.php

class UploadFlowTest in TMGMT Translator Smartling 8.4

Same name and namespace in other branches
  1. 8.3 tests/src/Kernel/UploadFlowTest.php \Drupal\Tests\tmgmt_smartling\Kernel\UploadFlowTest

Tests file upload flow.

@group tmgmt_smartling

Hierarchy

Expanded class hierarchy of UploadFlowTest

File

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

Namespace

Drupal\Tests\tmgmt_smartling\Kernel
View source 
class UploadFlowTest extends SmartlingTestBase {

  /**
   * Asserts upload parameters.
   *
   * @param $subject
   * @return bool
   */
  public function assertUploadParameters($subject) {
    $params = $subject
      ->exportToArray();
    return $params['authorize'] == 0 && preg_match('/^{"client":"drupal-tmgmt-connector","version":"(\\d+\\.x-\\d+\\.\\d+|\\d+\\.x-\\d+\\.x-dev|unknown)"}$/', $params['smartling.client_lib_id']) && $params['localeIdsToAuthorize'][0] == 'de' && $params['smartling.translate_paths'] == 'html/body/div/div, html/body/div/span' && $params['smartling.string_format_paths'] == 'html : html/body/div/div, @default : html/body/div/span' && $params['smartling.variants_enabled'] == TRUE && $params['smartling.source_key_paths'] == 'html/body/div/{div.sl-variant}, html/body/div/{span.sl-variant}' && $params['smartling.character_limit_paths'] == 'html/body/div/limit' && $params['smartling.placeholder_format_custom'] == '(@|%|!)[\\w-]+' && $params['smartling.include_translatable_attributes'] == 'title, alt' && $params['smartling.exclude_translatable_attributes'] == '' && $params['smartling.force_block_for_tags'] == '';
  }

  /**
   * Upload success flow with batch execution.
   */
  public function testRequestTranslationSuccessFlowExecute() {
    $translate_job = $this
      ->createJobWithItems([
      'batch_uid' => 'uid',
      'batch_execute_on_job' => 1,
    ]);
    $this->translationRequestManagerMock
      ->expects($this
      ->once())
      ->method('upsertTranslationRequest')
      ->with($translate_job)
      ->willReturn([
      'translationRequestUid' => 'test',
    ]);
    $this->translationRequestManagerMock
      ->expects($this
      ->never())
      ->method('commitError');
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('getApi')
      ->with('batch')
      ->willReturn($this->batchApiMock);
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('createAuditLogRecord')
      ->with($translate_job, NULL, \Drupal::currentUser(), CreateRecordParameters::ACTION_TYPE_UPLOAD);
    $this->batchApiMock
      ->expects($this
      ->once())
      ->method('uploadBatchFile')
      ->with('public://tmgmt_sources/JobID1_en_de.xml', 'JobID1_en_de.xml', 'xml', 'uid', $this
      ->callback([
      $this,
      'assertUploadParameters',
    ]));
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('executeBatch')
      ->with('uid');
    $this->translationRequestManagerMock
      ->expects($this
      ->once())
      ->method('commitSuccessfulUpload')
      ->with($translate_job)
      ->willReturn(FALSE);
    $this->apiWrapperMock
      ->expects($this
      ->at(2))
      ->method('createFirebaseRecord')
      ->with('tmgmt_smartling', 'notifications', 10, [
      "message" => 'File uploaded. Job id: 1, file name: JobID1_en_de.xml.',
      "type" => "status",
    ]);
    $this->apiWrapperMock
      ->expects($this
      ->at(4))
      ->method('createFirebaseRecord')
      ->with('tmgmt_smartling', 'notifications', 10, [
      "message" => "Finished: content is in the job. You may need to wait a few seconds before content is authorized (if you checked 'authorize' checkbox).",
      "type" => "status",
    ]);
    $this->apiWrapperMock
      ->expects($this
      ->at(5))
      ->method('createFirebaseRecord')
      ->with('tmgmt_smartling', 'notifications', 10, [
      "message" => "Can't update submitted date for translation request. See logs for more info.",
      "type" => "warning",
    ]);
    $translate_job
      ->requestTranslation();
  }

  /**
   * Upload success flow without batch execution.
   */
  public function testRequestTranslationSuccessFlowDoNotExecute() {
    $translate_job = $this
      ->createJobWithItems([
      'batch_uid' => 'uid',
      'batch_execute_on_job' => 2,
    ]);
    $this->translationRequestManagerMock
      ->expects($this
      ->once())
      ->method('upsertTranslationRequest')
      ->with($translate_job)
      ->willReturn([
      'translationRequestUid' => 'test',
    ]);
    $this->translationRequestManagerMock
      ->expects($this
      ->never())
      ->method('commitError');
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('getApi')
      ->with('batch')
      ->willReturn($this->batchApiMock);
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('createAuditLogRecord')
      ->with($translate_job, NULL, \Drupal::currentUser(), CreateRecordParameters::ACTION_TYPE_UPLOAD);
    $this->batchApiMock
      ->expects($this
      ->once())
      ->method('uploadBatchFile')
      ->with('public://tmgmt_sources/JobID1_en_de.xml', 'JobID1_en_de.xml', 'xml', 'uid', $this
      ->callback([
      $this,
      'assertUploadParameters',
    ]));
    $this->apiWrapperMock
      ->expects($this
      ->never())
      ->method('executeBatch')
      ->with('uid');
    $this->translationRequestManagerMock
      ->expects($this
      ->once())
      ->method('commitSuccessfulUpload')
      ->with($translate_job)
      ->willReturn(TRUE);
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('createFirebaseRecord')
      ->with('tmgmt_smartling', 'notifications', 10, [
      "message" => 'File uploaded. Job id: 1, file name: JobID1_en_de.xml.',
      "type" => "status",
    ]);
    $translate_job
      ->requestTranslation();
  }

  /**
   * Upload fail flow: no batch uid.
   */
  public function testRequestTranslationFailFlowNoBatchUid() {
    $this->translationRequestManagerMock
      ->expects($this
      ->never())
      ->method('upsertTranslationRequest');
    $this->translationRequestManagerMock
      ->expects($this
      ->never())
      ->method('commitError');
    $translate_job = $this
      ->createJobWithItems([]);
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('createAuditLogRecord')
      ->with($translate_job, NULL, \Drupal::currentUser(), CreateRecordParameters::ACTION_TYPE_UPLOAD);
    $this->apiWrapperMock
      ->expects($this
      ->never())
      ->method('getApi');
    $this->batchApiMock
      ->expects($this
      ->never())
      ->method('uploadBatchFile');
    $this->apiWrapperMock
      ->expects($this
      ->never())
      ->method('executeBatch');
    $this->translationRequestManagerMock
      ->expects($this
      ->never())
      ->method('commitSuccessfulUpload');
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('createFirebaseRecord')
      ->with('tmgmt_smartling', 'notifications', 10, [
      "message" => "File JobID1_en_de.xml (job id = 1) wasn't uploaded. Please see logs for more info.",
      "type" => "error",
    ]);
    $translate_job
      ->requestTranslation();
  }

  /**
   * Upload fail flow: translation request upsert failed.
   */
  public function testRequestTranslationFailFlowTranslationRequestUpsertFailed() {
    $translate_job = $this
      ->createJobWithItems([
      'batch_uid' => 'uid',
      'batch_execute_on_job' => 1,
    ]);
    $this->translationRequestManagerMock
      ->expects($this
      ->once())
      ->method('upsertTranslationRequest')
      ->with($translate_job)
      ->willReturn(FALSE);
    $this->translationRequestManagerMock
      ->expects($this
      ->never())
      ->method('commitError');
    $this->apiWrapperMock
      ->expects($this
      ->never())
      ->method('getApi');
    $this->batchApiMock
      ->expects($this
      ->never())
      ->method('uploadBatchFile');
    $this->apiWrapperMock
      ->expects($this
      ->never())
      ->method('executeBatch');
    $this->translationRequestManagerMock
      ->expects($this
      ->never())
      ->method('commitSuccessfulUpload');
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('createFirebaseRecord')
      ->with('tmgmt_smartling', 'notifications', 10, [
      "message" => "Can't upsert translation request. File JobID1_en_de.xml (job id = 1) wasn't uploaded. Please see logs for more info.",
      "type" => "error",
    ]);
    $translate_job
      ->requestTranslation();
  }

  /**
   * Upload fail flow: error while uploading.
   */
  public function testRequestTranslationFailFlowErrorWhileUploading() {
    $exception = new \Exception("Test");
    $translation_request = [
      'translationRequestUid' => 'test',
    ];
    $translate_job = $this
      ->createJobWithItems([
      'batch_uid' => 'uid',
      'batch_execute_on_job' => 1,
    ]);
    $this->translationRequestManagerMock
      ->expects($this
      ->once())
      ->method('upsertTranslationRequest')
      ->with($translate_job)
      ->willReturn($translation_request);
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('getApi')
      ->with('batch')
      ->willReturn($this->batchApiMock);
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('createAuditLogRecord')
      ->with($translate_job, NULL, \Drupal::currentUser(), CreateRecordParameters::ACTION_TYPE_UPLOAD);
    $this->apiWrapperMock
      ->expects($this
      ->once())
      ->method('executeBatch')
      ->with('uid')
      ->will($this
      ->throwException($exception));
    $this->translationRequestManagerMock
      ->expects($this
      ->never())
      ->method('commitSuccessfulUpload');
    $this->apiWrapperMock
      ->expects($this
      ->at(2))
      ->method('createFirebaseRecord')
      ->with('tmgmt_smartling', 'notifications', 10, [
      "message" => 'File uploaded. Job id: 1, file name: JobID1_en_de.xml.',
      "type" => "status",
    ]);
    $this->apiWrapperMock
      ->expects($this
      ->at(4))
      ->method('createFirebaseRecord')
      ->with('tmgmt_smartling', 'notifications', 10, [
      "message" => 'Error while uploading public://tmgmt_sources/JobID1_en_de.xml. Please see logs for more info.',
      "type" => "error",
    ]);
    $this->translationRequestManagerMock
      ->expects($this
      ->once())
      ->method('commitError')
      ->with($translate_job, $translation_request, $exception);
    $translate_job
      ->requestTranslation();
  }

}

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::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.
SmartlingTestBase::$apiWrapperMock protected property
SmartlingTestBase::$batchApiMock protected property
SmartlingTestBase::$fileApiMock protected property
SmartlingTestBase::$loggerMock protected property
SmartlingTestBase::$modules public static property Modules to enable. Overrides TMGMTKernelTestBase::$modules 1
SmartlingTestBase::$pluginMock protected property
SmartlingTestBase::$translationRequestManagerMock protected property
SmartlingTestBase::createJobWithItems protected function Creates a job.
SmartlingTestBase::invokeMethod protected function Invokes private or protected method.
SmartlingTestBase::setUp public function Overrides TMGMTKernelTestBase::setUp
SmartlingTestBase::tearDown protected function Overrides KernelTestBase::tearDown
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::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.
UploadFlowTest::assertUploadParameters public function Asserts upload parameters.
UploadFlowTest::testRequestTranslationFailFlowErrorWhileUploading public function Upload fail flow: error while uploading.
UploadFlowTest::testRequestTranslationFailFlowNoBatchUid public function Upload fail flow: no batch uid.
UploadFlowTest::testRequestTranslationFailFlowTranslationRequestUpsertFailed public function Upload fail flow: translation request upsert failed.
UploadFlowTest::testRequestTranslationSuccessFlowDoNotExecute public function Upload success flow without batch execution.
UploadFlowTest::testRequestTranslationSuccessFlowExecute public function Upload success flow with batch execution.