tmgmt_extension_suit-8.x-3.4/tests/src/Functional/TmgmtExtensionSuitTestBase.php

<?php

namespace Drupal\Tests\tmgmt_extension_suit\Functional;

use Drupal;
use Drupal\Core\Database\Database;
use Drupal\Core\Database\SchemaObjectExistsException;
use Drupal\Core\Queue\DatabaseQueue;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Tests\tmgmt\Functional\TMGMTTestBase;
use Drupal\tmgmt\Entity\JobItem;

/**
 * Basic class for tmgmt extension module.
 */
abstract class TmgmtExtensionSuitTestBase extends TMGMTTestBase {
  use StringTranslationTrait;

  /**
   * Logged in user.
   *
   * @var \Drupal\user\UserInterface
   */
  private $userForTranslations;

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'tmgmt',
    'tmgmt_demo',
    'tmgmt_extension_suit_test',
    'tmgmt_extension_suit'
  ];

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

    $this->userForTranslations = $this->loginAsAdmin([
      'edit any translatable_node content',
      'translate any entity'
    ]);

    // Create queue table (it doesn't exist for simpletests somehow).
    $uploadQueue = new DatabaseQueue('tmgmt_extension_suit_upload', Database::getConnection());
    $database_schema = Drupal::database()->schema();

    try {
      if (!$database_schema->tableExists('queue')) {
        $schema_definition = $uploadQueue->schemaDefinition();
        $database_schema->createTable('queue', $schema_definition);
      }
    }
    catch (SchemaObjectExistsException $e) {
    }
  }

  /**
   * Check if checkbox is checked.
   *
   * @param string $id
   *   Field id.
   *
   * @return bool
   *   TRUE if checked FALSE otherwise.
   */
  protected function isFieldChecked($id) {
    $elements = $this->xpath('//input[@id=:id]', [':id' => $id]);

    return isset($elements[0]) && !empty($elements[0]['checked']);
  }

  /**
   * Requests nodes for translation.
   *
   * @param array $nids
   *   Node ids.
   * @param string $targetLanguage
   *   Target locale.
   * @param int $jobId
   *   Job id.
   * @param string $translator
   *   Translator id.
   */
  protected function requestTranslation(array $nids, $targetLanguage, $jobId, $translator = 'tes_local_test') {
    // Request nodes for translation.
    $data = [];

    foreach ($nids as $nid) {
      $data["items[$nid]"] = "item[$nid]";
    }

    $this->drupalGet('admin/tmgmt/sources');
    $this->submitForm($data, $this->t('Request translation')->render());

    $data = [
      'label[0][value]' => 'Test job',
      'target_language' => $targetLanguage,
      'translator' => $translator,
    ];
    $this->drupalGet("admin/tmgmt/jobs/$jobId");
    $this->submitForm($data, $this->t('Submit to provider')->render());
  }

  /**
   * Requests nodes for translation in a batch.
   *
   * @param array $nids
   *   Node ids.
   * @param array $targetLanguages
   *   Target locale.
   * @param string $provider
   *   Provider type.
   * @param array $settings
   *   Provider settings.
   *
   * @throws \Exception
   */
  protected function requestBulkTranslation(array $nids, array $targetLanguages, $provider = 'tes_local_test', array $settings = []) {
    // Request nodes for translation.
    $data = [];

    foreach ($nids as $nid) {
      $data["items[$nid]"] = "item[$nid]";
    }

    $this->drupalGet('admin/tmgmt/sources');
    $this->submitForm($data, $this->t('Request translation in a batch')->render());

    if (!empty($targetLanguages)) {
      $new_data = [];

      foreach ($targetLanguages as $targetLanguage) {
        $new_data["target_language[$targetLanguage]"] = $targetLanguage;
      }

      $new_data['translator'] = $provider;

      foreach ($settings as $setting => $value) {
        $new_data[$setting] = $value;
      }

      $this->submitForm($new_data, $this->t('Request translation')->render());
    }
  }

  /**
   * Returns user.
   *
   * @return \Drupal\user\UserInterface
   *   User object.
   */
  protected function getUserForTranslations() {
    return $this->userForTranslations;
  }

  /**
   * Translates job items (marks as "needs review").
   *
   * @param array $jobItemIds
   *   Job item ids.
   */
  protected function translateJobItems(array $jobItemIds) {
    foreach ($jobItemIds as $jobItemId) {
      $jobItem = JobItem::load($jobItemId);
      $jobItem->setState(JobItem::STATE_REVIEW);
      $jobItem->save();
    }
  }

  /**
   * Returns job item hash by node id and job id.
   *
   * @param int $nid
   *   Node id.
   * @param int $jobId
   *   Job id.
   *
   * @return bool|string
   *   Returns hash.
   */
  protected function getNodeHash($nid, $jobId) {
    $hashQuery = Drupal::database()->select('tmgmt_job_item', 'tji');
    $hashQuery->join('tmgmt_job', 'tj', 'tj.tjid = tji.tjid');
    $hash = $hashQuery->condition('tj.tjid', $jobId)
      ->condition('tji.item_id', $nid)
      ->fields('tji', [
        'tjid',
        'tes_source_content_hash',
      ])
      ->execute()
      ->fetchAllKeyed();

    return $hash ? reset($hash) : FALSE;
  }

  /**
   * Returns amount of items in a given queue.
   *
   * @param string $queueName
   *   Queue name.
   *
   * @return int|mixed
   *   Returns number of queue items in a given queue.
   */
  protected function getCountOfItemsInQueue($queueName) {
    return Drupal::database()->select('queue', 'q')
      ->condition('q.name', $queueName)
      ->countQuery()
      ->execute()
      ->fetchField();
  }

  /**
   * Checks if job was added to a queue.
   *
   * @param string $queue
   *   Queue name.
   * @param int $jobId
   *   Job id.
   *
   * @return mixed
   *   Returns flag whether item is in the queue or not.
   */
  protected function isItemAddedToQueue($queue, $jobId) {
    $length = mb_strlen($jobId);

    return Drupal::database()->select('queue', 'q')
      ->condition('q.name', $queue)
      ->condition('q.data', "a:1:{s:4:\"tjid\";s:{$length}:\"{$jobId}\";}")
      ->countQuery()
      ->execute()
      ->fetchField();
  }

}