ScheduledTransitionTest.php in Lightning Workflow 8.2

Namespace

Drupal\Tests\lightning_scheduler\Functional

File

modules/lightning_scheduler/tests/src/Functional/ScheduledTransitionTest.php

<?php

namespace Drupal\Tests\lightning_scheduler\Functional;

use Drupal\Component\Serialization\Json;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\Traits\Core\CronRunTrait;
use Drupal\workflows\Entity\Workflow;

/**
 * @group lightning
 * @group lightning_workflow
 * @group lightning_scheduler
 */
class ScheduledTransitionTest extends BrowserTestBase {
  use CronRunTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'lightning_scheduler',
    'node',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);

    // Due to a known core bug, rebuilding the node access table will break the
    // entity query in TransitionManager::getTransitionable(). The workaround is
    // for the query to specifically disable access checking, which it should be
    // doing anyway because transitions need to be processed irrespective of
    // user access.
    // @see https://www.drupal.org/project/drupal/issues/2823957
    node_access_rebuild();
    $workflow = Workflow::load('editorial');

    /** @var \Drupal\content_moderation\Plugin\WorkflowType\ContentModerationInterface $plugin */
    $plugin = $workflow
      ->getTypePlugin();
    $plugin
      ->addEntityTypeAndBundle('node', 'page');
    $workflow
      ->save();
    $account = $this
      ->drupalCreateUser([
      'create page content',
      'edit own page content',
      'view own unpublished content',
      'view latest version',
      'use editorial transition create_new_draft',
      'use editorial transition publish',
      'use editorial transition archive',
      'use editorial transition archived_draft',
      'schedule editorial transition publish',
      'schedule editorial transition archive',
    ]);
    $this
      ->drupalLogin($account);
    $account
      ->set('timezone', 'America/New_York')
      ->save();
    $this
      ->config('system.date')
      ->set('timezone.default', 'America/New_York')
      ->save();
    date_default_timezone_set('UTC');
  }

  /**
   * Data provider for testSingleTransition().
   *
   * @return array
   *   The scenarios to test.
   */
  public function providerSingleTransition() {
    return [
      'draft to published in future' => [
        10,
        'published',
        'Published',
      ],
      'draft to archived in future' => [
        10,
        'archived',
        'Draft',
      ],
      'draft to published in past' => [
        -10,
        'published',
        'Published',
      ],
      'draft to archived in past' => [
        -10,
        'archived',
        'Draft',
      ],
    ];
  }

  /**
   * Tests a single scheduled workflow state transition.
   *
   * @param int $offset
   *   How many seconds in the past or future to schedule the transition. If
   *   negative, the transition will be in the past.
   * @param string $to_state
   *   The workflow state to transition to.
   * @param string $expected_state_label
   *   The label of the workflow state that is expected after the transition is
   *   executed.
   *
   * @dataProvider providerSingleTransition
   */
  public function testSingleTransition($offset, $to_state, $expected_state_label) {
    $assert = $this
      ->assertSession();
    $this
      ->drupalGet('/node/add/page');
    $assert
      ->statusCodeEquals(200);
    $transitions = Json::encode([
      [
        'when' => date('c', time() + $offset),
        'state' => $to_state,
      ],
    ]);
    $assert
      ->fieldExists('Title')
      ->setValue('Schedule This');
    $field = $assert
      ->elementExists('css', 'input[name="moderation_state[0][scheduled_transitions][data]"]');
    $field
      ->setValue($transitions);
    $assert
      ->buttonExists('Save')
      ->press();
    $assert
      ->addressMatches('/^\\/node\\/[0-9]+$/');
    $edit_url = $this
      ->getUrl() . '/edit';
    if ($offset > 0) {
      sleep($offset + 2);
    }
    $this
      ->cronRun();
    $this
      ->drupalGet($edit_url);
    $assert
      ->statusCodeEquals(200);
    $assert
      ->pageTextContains("Current state {$expected_state_label}");
  }

  /**
   * Tests scheduling a series of valid transitions in the future.
   */
  public function testFutureSequence() {
    $assert = $this
      ->assertSession();
    $this
      ->drupalGet('/node/add/page');
    $assert
      ->statusCodeEquals(200);
    $transitions = Json::encode([
      [
        'when' => date('c', time() + 10),
        'state' => 'published',
      ],
      [
        'when' => date('c', time() + 20),
        'state' => 'archived',
      ],
    ]);
    $assert
      ->fieldExists('Title')
      ->setValue('Schedule This');
    $field = $assert
      ->elementExists('css', 'input[name="moderation_state[0][scheduled_transitions][data]"]');
    $field
      ->setValue($transitions);
    $assert
      ->buttonExists('Save')
      ->press();
    $assert
      ->addressMatches('/^\\/node\\/[0-9]+$/');
    $edit_url = $this
      ->getUrl() . '/edit';
    sleep(12);
    $this
      ->cronRun();
    sleep(12);
    $this
      ->cronRun();
    $this
      ->drupalGet($edit_url);
    $assert
      ->statusCodeEquals(200);
    $assert
      ->pageTextContains("Current state Archived");
  }

  /**
   * Tests that a sequence that works in the future may not work in the past.
   *
   * @depends testFutureSequence
   */
  public function testInvalidPastSequence() {
    $assert = $this
      ->assertSession();
    $this
      ->drupalGet('/node/add/page');
    $assert
      ->statusCodeEquals(200);
    $transitions = Json::encode([
      [
        'when' => date('c', time() - 20),
        'state' => 'published',
      ],
      [
        'when' => date('c', time() - 10),
        'state' => 'archived',
      ],
    ]);
    $assert
      ->fieldExists('Title')
      ->setValue('Schedule This');
    $field = $assert
      ->elementExists('css', 'input[name="moderation_state[0][scheduled_transitions][data]"]');
    $field
      ->setValue($transitions);
    $assert
      ->buttonExists('Save')
      ->press();
    $assert
      ->addressMatches('/^\\/node\\/[0-9]+$/');
    $edit_url = $this
      ->getUrl() . '/edit';
    $this
      ->cronRun();
    $this
      ->drupalGet($edit_url);
    $assert
      ->statusCodeEquals(200);
    $assert
      ->pageTextContains("Current state Draft");
  }

  /**
   * Tests that scheduled transitions work correctly with pending revisions.
   *
   * @depends testSingleTransition
   */
  public function testSingleTransitionWithPendingRevision() {
    $assert = $this
      ->assertSession();
    $this
      ->drupalGet('/node/add/page');
    $assert
      ->statusCodeEquals(200);
    $assert
      ->fieldExists('Title')
      ->setValue('Schedule This');
    $assert
      ->fieldExists('moderation_state[0][state]')
      ->selectOption('Published');
    $assert
      ->buttonExists('Save')
      ->press();
    $assert
      ->addressMatches('/^\\/node\\/[0-9]+$/');
    $edit_url = $this
      ->getUrl() . '/edit';
    $this
      ->drupalGet($edit_url);
    $assert
      ->fieldExists('Title')
      ->setValue('MC Hammer');
    $assert
      ->fieldExists('moderation_state[0][state]')
      ->selectOption('Draft');
    $transitions = Json::encode([
      [
        'when' => date('c', time() + 10),
        'state' => 'published',
      ],
    ]);
    $field = $assert
      ->elementExists('css', 'input[name="moderation_state[0][scheduled_transitions][data]"]');
    $field
      ->setValue($transitions);
    $assert
      ->buttonExists('Save')
      ->press();
    sleep(12);
    $this
      ->cronRun();
    $this
      ->drupalGet($edit_url);
    $assert
      ->statusCodeEquals(200);
    $assert
      ->fieldValueEquals('Title', 'MC Hammer');
  }

}

Classes

Name	Description
ScheduledTransitionTest	@group lightning @group lightning_workflow @group lightning_scheduler