GlobalTradingTechnologies / workflow-extensions-bundle

Tests/Schedule/ActionSchedulerTest.php

<?php
/**
 * This file is part of the Global Trading Technologies Ltd workflow-extension-bundle package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * (c) fduch <alex.medwedew@gmail.com>
 * @date   09.08.16
 */

namespace Gtt\Bundle\WorkflowExtensionsBundle\Tests\Schedule;

use Carbon\Carbon;
use Doctrine\Common\Persistence\ObjectManager;
use Gtt\Bundle\WorkflowExtensionsBundle\Command\ExecuteActionCommand;
use Gtt\Bundle\WorkflowExtensionsBundle\Entity\Repository\ScheduledJobRepository;
use Gtt\Bundle\WorkflowExtensionsBundle\Entity\ScheduledJob;
use Gtt\Bundle\WorkflowExtensionsBundle\Schedule\ActionScheduler;
use Gtt\Bundle\WorkflowExtensionsBundle\Schedule\ValueObject\ScheduledAction;
use Gtt\Bundle\WorkflowExtensionsBundle\WorkflowContext;
use JMS\JobQueueBundle\Entity\Job;
use Psr\Log\LoggerInterface;
use Symfony\Component\Workflow\Workflow;

class ActionSchedulerTest extends \PHPUnit_Framework_TestCase
{
    public function tearDown()
    {
        parent::tearDown();
        Carbon::setTestNow();
    }

    /**
     * @dataProvider scheduledActionProvider
     */
    public function testSchedulerSchedulesCorrectJob(ScheduledAction $action, $alreadyScheduled)
    {
        /** @var WorkflowContext $workflowContext */
        list($workflowContext, $repository, $em) = $this->setupSchedulerContext();

        Carbon::setTestNow(Carbon::now());
        $now             = Carbon::now();

        $executeJobAfter = clone $now;
        $executeJobAfter->add($action->getOffset());

        if ($action->isReschedulable()) {
            if ($alreadyScheduled) {
                // expecting rescheduling
                $actionJob    = new Job('command', ['--some' => 'args']);
                $scheduledJob = new ScheduledJob($actionJob);

                $expectedActionJob = clone $actionJob;
                $expectedActionJob->setExecuteAfter($executeJobAfter);

                $repository->expects(self::once())->method('findScheduledJobToReschedule')->willReturn($scheduledJob);
                $em->expects(self::once())->method('persist')->with(self::equalTo($expectedActionJob));
            } else {

This code seems to be duplicated across your project.

                // expecting the new one
                $repository->expects(self::once())->method('findScheduledJobToReschedule')->willReturn(null);
                $this->configureEmToExpectNewJobCreation($em, $action, $workflowContext, $executeJobAfter);
            }
        } else {

This code seems to be duplicated across your project.

            // non-reschedulable action - expecting creation of the new job
            $repository->expects(self::never())->method('findScheduledJobToReschedule')->willReturn(null);
            $this->configureEmToExpectNewJobCreation($em, $action, $workflowContext, $executeJobAfter);
        }

        $scheduler = new ActionScheduler($em, $this->getMock(LoggerInterface::class));
        $scheduler->scheduleAction($workflowContext, $action);
    }

    public function scheduledActionProvider()
    {
        return [
            [new ScheduledAction('a1', [], 'PT1S'), true],
            [new ScheduledAction('a1', [], 'PT1S'), false],
            [new ScheduledAction('a1', [], 'PT1S', true), true],
            [new ScheduledAction('a1', [], 'PT1S', true), false]
        ];
    }

    private function configureEmToExpectNewJobCreation(ObjectManager $em, ScheduledAction $action, WorkflowContext $workflowContext, \DateTime $executeJobAfter)
    {
        $expectedActionJob = new Job(
            ExecuteActionCommand::COMMAND_NAME,
            [
                '--action='       . $action->getName(),
                '--arguments='    . json_encode($action->getArguments()),
                '--workflow='     . $workflowContext->getWorkflow()->getName(),
                '--subjectClass=' . get_class($workflowContext->getSubject()),
                '--subjectId='    . $workflowContext->getSubjectId()
            ]
        );

        $expectedActionJob->setExecuteAfter($executeJobAfter);

        /** @var $em \PHPUnit_Framework_MockObject_MockObject|ObjectManager */
        $em->expects(self::exactly(2))->method('persist')->withConsecutive(

The method expects does only exist in PHPUnit_Framework_MockObject_MockObject, but not in Doctrine\Common\Persistence\ObjectManager.

            self::equalTo($expectedActionJob),
            self::equalTo(new ScheduledJob($expectedActionJob, $action->isReschedulable()))
        );
    }

    /**
     * @return array
     */
    private function setupSchedulerContext()
    {
        $subject = new \StdClass();
        $subjectId = '1';

        $workflow = $this->getMockBuilder(Workflow::class)->disableOriginalConstructor()->getMock();
        $workflow->expects(self::any())->method('getName')->willReturn('w1');

        $workflowContext = new WorkflowContext($workflow, $subject, $subjectId);

        $repository = $this->getMockBuilder(ScheduledJobRepository::class)->disableOriginalConstructor()->getMock();

        $em = $this->getMockBuilder(ObjectManager::class)->disableOriginalConstructor()->getMock();
        $em->expects(self::once())->method('getRepository')->with(ScheduledJob::class)->willReturn($repository);

        return [$workflowContext, $repository, $em];
    }
}