class TaskRunnerTest in Webform Scheduled Tasks 8.2

@coversDefaultClass \Drupal\webform_scheduled_tasks\TaskRunner @group webform_scheduled_tasks

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\webform_scheduled_tasks\Unit\TaskRunnerTest

File

tests/src/Unit/TaskRunnerTest.php, line 21

Namespace

Drupal\Tests\webform_scheduled_tasks\Unit

class TaskRunnerTest extends UnitTestCase {

  /**
   * The task runner.
   *
   * @var \Drupal\webform_scheduled_tasks\TaskRunnerInterface
   */
  protected $taskRunner;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->taskRunner = new TaskRunner($this
      ->prophesize(EntityTypeManagerInterface::class)
      ->reveal(), $this
      ->prophesize(TimeInterface::class)
      ->reveal());
  }

  /**
   * @covers ::executeTasks
   */
  public function testSuccessfulTaskExecuted() {
    $scheduled_task = $this
      ->createTestScheduledTask();
    $scheduled_task
      ->registerSuccessfulTask()
      ->shouldBeCalled();
    $scheduled_task
      ->incrementTaskRunDateByInterval()
      ->shouldBeCalled();
    $this->taskRunner
      ->executeTasks([
      $scheduled_task
        ->reveal(),
    ]);
  }

  /**
   * @covers ::executeTasks
   * @dataProvider haltScheduledTaskExceptionThrownTestCases
   */
  public function testHaltScheduledTaskExceptionThrown($exception) {
    $task = $this
      ->prophesize(TaskPluginInterface::class);
    $task
      ->executeTask(Argument::any(), Argument::any())
      ->willThrow($exception);
    $scheduled_task = $this
      ->createTestScheduledTask($task);

    // When a halt schedule exception is thrown, the task will be halted and a
    // fail will be registered.
    $scheduled_task
      ->registerFailedTask($exception)
      ->shouldBeCalled();
    $scheduled_task
      ->halt('An error was encountered when running the task: Failed to do something.')
      ->shouldBeCalled();
    $this->taskRunner
      ->executeTasks([
      $scheduled_task
        ->reveal(),
    ]);
  }

  /**
   * Test cases for ::testHaltScheduledTaskExceptionThrown.
   */
  public function haltScheduledTaskExceptionThrownTestCases() {
    return [
      'Retry exception' => [
        new HaltScheduledTaskException('Failed to do something.'),
      ],
      'Normal exception' => [
        new \Exception('Failed to do something.'),
      ],
    ];
  }

  /**
   * @covers ::executeTasks
   */
  public function testRetryScheduledTaskExceptionThrown() {
    $task = $this
      ->prophesize(TaskPluginInterface::class);
    $task
      ->executeTask(Argument::any(), Argument::any())
      ->willThrow(new RetryScheduledTaskException('Failed to do something.'));
    $scheduled_task = $this
      ->createTestScheduledTask($task);

    // When a retry exception is thrown, a fail will be registered but the task
    // date will be incremented and the task will not be halted.
    $scheduled_task
      ->registerFailedTask(Argument::any())
      ->shouldBeCalled();
    $scheduled_task
      ->incrementTaskRunDateByInterval()
      ->shouldBeCalled();
    $this->taskRunner
      ->executeTasks([
      $scheduled_task
        ->reveal(),
    ]);
  }

  /**
   * @covers ::executeTasks
   */
  public function testMultipleTasksRun() {
    $failing_task = $this
      ->prophesize(TaskPluginInterface::class);
    $failing_task
      ->executeTask(Argument::any(), Argument::any())
      ->willThrow(new \Exception('Failed!'));
    $failing_scheduled_task = $this
      ->createTestScheduledTask($failing_task);
    $failing_scheduled_task
      ->registerFailedTask(Argument::any())
      ->shouldBeCalled();
    $failing_scheduled_task
      ->halt(Argument::any())
      ->shouldBeCalled();
    $passing_scheduled_task = $this
      ->createTestScheduledTask();
    $passing_scheduled_task
      ->registerSuccessfulTask()
      ->shouldBeCalled();
    $passing_scheduled_task
      ->incrementTaskRunDateByInterval()
      ->shouldBeCalled();

    // One failed task should not impact the running of another.
    $this->taskRunner
      ->executeTasks([
      $failing_scheduled_task
        ->reveal(),
      $passing_scheduled_task
        ->reveal(),
    ]);
  }

  /**
   * Create a mock scheduled task to pass into the task runner.
   *
   * @param \Drupal\search_api\Task\TaskInterface|null $task
   *   (Optional) A mock task or NULL if a default one should be setup.
   * @param \Drupal\webform_scheduled_tasks\Plugin\WebformScheduledTasks\ResultSetPluginInterface|null $result_set
   *   (Optional) A mock result set or NULL if a default one should be setup.
   *
   * @return \Drupal\webform_scheduled_tasks\Entity\WebformScheduledTaskInterface
   *   A scheduled task entity.
   */
  protected function createTestScheduledTask($task = NULL, $result_set = NULL) {
    $iterator = new \ArrayIterator([]);
    $webform = $this
      ->prophesize(WebformInterface::class);
    if ($result_set === NULL) {
      $result_set = $this
        ->prophesize(ResultSetPluginInterface::class);
      $result_set
        ->getResultSet()
        ->willReturn($iterator);
    }
    if ($task === NULL) {
      $task = $this
        ->prophesize(TaskPluginInterface::class);
      $task
        ->executeTask($iterator)
        ->shouldBeCalled();
    }
    $scheduled_task = $this
      ->prophesize(WebformScheduledTaskInterface::class);
    $scheduled_task
      ->getTaskPlugin()
      ->willReturn($task
      ->reveal());
    $scheduled_task
      ->getResultSetPlugin()
      ->willReturn($result_set
      ->reveal());
    $scheduled_task
      ->getWebform()
      ->willReturn($webform
      ->reveal());
    return $scheduled_task;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
TaskRunnerTest::$taskRunner	protected	property	The task runner.
TaskRunnerTest::createTestScheduledTask	protected	function	Create a mock scheduled task to pass into the task runner.
TaskRunnerTest::haltScheduledTaskExceptionThrownTestCases	public	function	Test cases for ::testHaltScheduledTaskExceptionThrown.
TaskRunnerTest::setUp	protected	function	Overrides UnitTestCase::setUp
TaskRunnerTest::testHaltScheduledTaskExceptionThrown	public	function	@covers ::executeTasks @dataProvider haltScheduledTaskExceptionThrownTestCases
TaskRunnerTest::testMultipleTasksRun	public	function	@covers ::executeTasks
TaskRunnerTest::testRetryScheduledTaskExceptionThrown	public	function	@covers ::executeTasks
TaskRunnerTest::testSuccessfulTaskExecuted	public	function	@covers ::executeTasks
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.