ContentTrait.php

<?php

declare(strict_types=1);

namespace DrevOps\BehatSteps;

use Behat\Gherkin\Node\TableNode;

/**
 * Trait ContentTrait.
 *
 * Content-related steps.
 *
 * @package DrevOps\BehatSteps
 */
trait ContentTrait {

  /**
   * Delete content type.
   *
   * @code
   * Given no "article" content type
   * @endcode
   *
   * @Given no :type content type
   */
  public function contentRemoveContentType(string $type): void {
    $content_type_entity = \Drupal::entityTypeManager()->getStorage('node_type')->load($type);
    if ($content_type_entity) {
      $content_type_entity->delete();
    }
  }

  /**
   * Navigate to page with specified type and title.
   *
   * @code
   * When I visit "article" "Test article"
   * @endcode
   *
   * @When I visit :type :title
   */
  public function contentVisitPageWithTitle(string $type, string $title): void {
    $nids = $this->contentLoadMultiple($type, [
      'title' => $title,
    ]);

    if (empty($nids)) {
      throw new \RuntimeException(sprintf('Unable to find %s page "%s"', $type, $title));
    }

    ksort($nids);

    $nid = end($nids);
    $path = $this->locatePath('/node/' . $nid);
    print $path;
    $this->getSession()->visit($path);
  }

  /**
   * Navigate to edit page with specified type and title.
   *
   * @code
   * When I edit "article" "Test article"
   * @endcode
   *
   * @When I edit :type :title
   */
  public function contentEditPageWithTitle(string $type, string $title): void {
    $nids = $this->contentLoadMultiple($type, [
      'title' => $title,
    ]);

    if (empty($nids)) {
      throw new \RuntimeException(sprintf('Unable to find %s page "%s"', $type, $title));
    }

    $nid = current($nids);
    $path = $this->locatePath('/node/' . $nid) . '/edit';
    print $path;
    $this->getSession()->visit($path);
  }

  /**
   * Navigate to delete page with specified type and title.
   *
   * @When I delete :type :title
   */
  public function contentDeletePageWithTitle(string $type, string $title): void {
    $nids = $this->contentLoadMultiple($type, [
      'title' => $title,
    ]);

    if (empty($nids)) {
      throw new \RuntimeException(sprintf('Unable to find %s page "%s"', $type, $title));
    }

    $nid = current($nids);
    $path = $this->locatePath('/node/' . $nid) . '/delete';
    print $path;
    $this->getSession()->visit($path);
  }

  /**
   * Remove content defined by provided properties.
   *
   * @code
   * Given no "article" content:
   * | title                |
   * | Test article         |
   * | Another test article |
   * @endcode
   *
   * @Given /^no ([a-zA-z0-9_-]+) content:$/
   */
  public function contentDelete(string $type, TableNode $nodesTable): void {
    foreach ($nodesTable->getHash() as $nodeHash) {
      $nids = $this->contentLoadMultiple($type, $nodeHash);

      $controller = \Drupal::entityTypeManager()->getStorage('node');
      $entities = $controller->loadMultiple($nids);
      $controller->delete($entities);
    }
  }

  /**
   * Change moderation state of a content with specified title.
   *
   * @code
   * When the moderation state of "article" "Test article" changes from "draft" to "published"
   * @endcode
   *
   * @When the moderation state of :type :title changes from :old_state to :new_state
   */
  public function contentModeratePageWithTitle(string $type, string $title, string $old_state, string $new_state): void {
    $nodes = \Drupal::entityTypeManager()
      ->getStorage('node')
      ->loadByProperties([
        'title' => $title,
        'type' => $type,
      ]);

    if (empty($nodes)) {
      throw new \Exception(sprintf('Unable to find %s page "%s"', $type, $title));
    }

    /** @var \Drupal\node\Entity\Node $node */
    $node = current($nodes);
    $current_old_state = $node->get('moderation_state')->first()->getString();
    if ($current_old_state != $old_state) {
      throw new \Exception(sprintf('The current state "%s" is different from "%s"', $current_old_state, $old_state));
    }

    $node->set('moderation_state', $new_state);
    $node->save();
  }

  /**
   * Visit scheduled-transition page for node with title.
   *
   * @When I visit :type :title scheduled transitions
   */
  public function contentVisitScheduledTransitionsPageWithTitle(string $type, string $title): void {
    $nids = $this->contentLoadMultiple($type, [
      'title' => $title,
    ]);

    if (empty($nids)) {
      throw new \RuntimeException(sprintf('Unable to find %s page "%s"', $type, $title));
    }

    $nid = current($nids);
    $path = $this->locatePath('/node/' . $nid) . '/scheduled-transitions';
    print $path;
    $this->getSession()->visit($path);
  }

  /**
   * Load multiple nodes with specified type and conditions.
   *
   * @param string $type
   *   The node type.
   * @param array<string, mixed> $conditions
   *   Conditions keyed by field names.
   *
   * @return array<int, string>
   *   Array of node ids.
   */
  protected function contentLoadMultiple(string $type, array $conditions = []): array {
    $query = \Drupal::entityQuery('node')
      ->accessCheck(FALSE)
      ->condition('type', $type);

    foreach ($conditions as $k => $v) {
      $and = $query->andConditionGroup();
      $and->condition($k, $v);
      $query->condition($and);
    }

    return $query->execute();
  }

}