Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-cron/Test/Unit/Observer/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Cron\Test\Unit\Observer;
use Exception;
use Magento\Cron\Model\Config;
use Magento\Cron\Model\DeadlockRetrierInterface;
use Magento\Cron\Model\ResourceModel\Schedule as ScheduleResourceModel;
use Magento\Cron\Model\ResourceModel\Schedule\Collection as ScheduleCollection;
use Magento\Cron\Model\Schedule;
use Magento\Cron\Model\ScheduleFactory;
use Magento\Cron\Observer\ProcessCronQueueObserver;
use Magento\Cron\Test\Unit\Model\CronJobException;
use Magento\Framework\App\CacheInterface;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\Console\Request as ConsoleRequest;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\App\State;
use Magento\Framework\App\State as AppState;
use Magento\Framework\DataObject;
use Magento\Framework\DB\Adapter\AdapterInterface;
use Magento\Framework\Event\ManagerInterface;
use Magento\Framework\Event\Observer;
use Magento\Framework\Lock\LockManagerInterface;
use Magento\Framework\Model\AbstractModel;
use Magento\Framework\Process\PhpExecutableFinderFactory;
use Magento\Framework\Profiler\Driver\Standard\Stat;
use Magento\Framework\Profiler\Driver\Standard\StatFactory;
use Magento\Framework\ShellInterface;
use Magento\Framework\Stdlib\DateTime\DateTime;
use Magento\Store\Model\ScopeInterface;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;
use Symfony\Component\Process\PhpExecutableFinder;
use TypeError;
/**
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.TooManyFields)
*/
class ProcessCronQueueObserverTest extends TestCase
{
/**
* @var ProcessCronQueueObserver
*/
private $cronQueueObserver;
/**
* @var ObjectManager|MockObject
*/
private $objectManagerMock;
/**
* @var CacheInterface|MockObject
*/
private $cacheMock;
/**
* @var Config|MockObject
*/
private $configMock;
/**
* @var ScheduleFactory|MockObject
*/
private $scheduleFactoryMock;
/**
* @var ScopeConfigInterface|MockObject
*/
private $scopeConfigMock;
/**
* @var ConsoleRequest|MockObject
*/
private $consoleRequestMock;
/**
* @var ShellInterface|MockObject
*/
private $shellMock;
/**
* @var ScheduleCollection|MockObject
*/
private $scheduleCollectionMock;
/**
* @var DateTime|MockObject
*/
private $dateTimeMock;
/**
* @var Observer|MockObject
*/
private $observerMock;
/**
* @var LoggerInterface|MockObject
*/
private $loggerMock;
/**
* @var AppState|MockObject
*/
private $appStateMock;
/**
* @var LockManagerInterface|MockObject
*/
private $lockManagerMock;
/**
* @var ScheduleResourceModel|MockObject
*/
private $scheduleResourceMock;
/**
* @var ManagerInterface|MockObject
*/
private $eventManager;
/**
* @var DeadlockRetrierInterface|MockObject
*/
private $retrierMock;
/**
* @var MockObject|Stat
*/
private $stat;
/**
* @var StatFactory|MockObject
*/
private $statFactory;
/**
* @var int
*/
protected $time = 1501538400;
/**
* @inheritdoc
*/
protected function setUp(): void
{
$this->objectManagerMock = $this->getMockBuilder(ObjectManager::class)
->disableOriginalConstructor()
->getMock();
$this->cacheMock = $this->getMockForAbstractClass(CacheInterface::class);
$this->configMock = $this->getMockBuilder(Config::class)
->disableOriginalConstructor()
->getMock();
$this->scopeConfigMock = $this->getMockBuilder(
ScopeConfigInterface::class
)->disableOriginalConstructor()
->getMock();
$this->scheduleCollectionMock = $this->getMockBuilder(ScheduleCollection::class)
->onlyMethods(['addFieldToFilter', 'load', '__wakeup'])->disableOriginalConstructor()
->getMock();
$this->scheduleCollectionMock->expects($this->any())->method('addFieldToFilter')->willReturnSelf();
$this->scheduleCollectionMock->expects($this->any())->method('load')->willReturnSelf();
$this->scheduleFactoryMock = $this->getMockBuilder(ScheduleFactory::class)
->onlyMethods(['create'])->disableOriginalConstructor()
->getMock();
$this->consoleRequestMock = $this->getMockBuilder(
ConsoleRequest::class
)->disableOriginalConstructor()
->getMock();
$this->shellMock = $this->getMockBuilder(ShellInterface::class)
->disableOriginalConstructor()
->onlyMethods(['execute'])->getMock();
$this->loggerMock = $this->getMockForAbstractClass(LoggerInterface::class);
$this->appStateMock = $this->getMockBuilder(AppState::class)
->disableOriginalConstructor()
->getMock();
$this->lockManagerMock = $this->getMockBuilder(LockManagerInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->lockManagerMock->method('lock')->willReturn(true);
$this->lockManagerMock->method('unlock')->willReturn(true);
$this->observerMock = $this->createMock(Observer::class);
$this->eventManager = $this->createMock(ManagerInterface::class);
$this->dateTimeMock = $this->getMockBuilder(DateTime::class)
->disableOriginalConstructor()
->getMock();
$this->dateTimeMock->expects($this->any())->method('gmtTimestamp')->willReturn($this->time);
$phpExecutableFinder = $this->createMock(PhpExecutableFinder::class);
$phpExecutableFinder->expects($this->any())->method('find')->willReturn('php');
$phpExecutableFinderFactory = $this->createMock(PhpExecutableFinderFactory::class);
$phpExecutableFinderFactory->expects($this->any())->method('create')->willReturn($phpExecutableFinder);
$this->scheduleResourceMock = $this->getMockBuilder(ScheduleResourceModel::class)
->disableOriginalConstructor()
->getMock();
$this->statFactory = $this->getMockBuilder(StatFactory::class)
->onlyMethods(['create'])
->disableOriginalConstructor()
->getMock();
$this->stat = $this->getMockBuilder(Stat::class)
->disableOriginalConstructor()
->getMock();
$this->statFactory->expects($this->any())->method('create')->willReturn($this->stat);
$this->retrierMock = $this->getMockForAbstractClass(DeadlockRetrierInterface::class);
$this->cronQueueObserver = new ProcessCronQueueObserver(
$this->objectManagerMock,
$this->scheduleFactoryMock,
$this->cacheMock,
$this->configMock,
$this->scopeConfigMock,
$this->consoleRequestMock,
$this->shellMock,
$this->dateTimeMock,
$phpExecutableFinderFactory,
$this->loggerMock,
$this->appStateMock,
$this->statFactory,
$this->lockManagerMock,
$this->eventManager,
$this->retrierMock
);
}
/**
* Test case for not existed cron jobs in files but in data base is presented.
*
* @return void
*/
public function testDispatchNoJobConfig(): void
{
$this->eventManager->expects($this->never())->method('dispatch');
$lastRun = $this->time + 10000000;
$this->cacheMock->expects($this->atLeastOnce())->method('load')->willReturn($lastRun);
$this->scopeConfigMock->expects($this->atLeastOnce())->method('getValue')->willReturn(0);
$this->configMock->expects(
$this->atLeastOnce()
)->method(
'getJobs'
)->willReturn(
['test_job1' => ['test_data']]
);
$schedule = $this->getMockBuilder(Schedule::class)
->addMethods(['getJobCode'])
->onlyMethods(['__wakeup'])
->disableOriginalConstructor()
->getMock();
$schedule->expects($this->atLeastOnce())
->method('getJobCode')
->willReturn('not_existed_job_code');
$this->scheduleCollectionMock->addItem($schedule);
$scheduleMock = $this->getMockBuilder(
Schedule::class
)->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->atLeastOnce())
->method('getCollection')
->willReturn($this->scheduleCollectionMock);
$this->scheduleFactoryMock->expects($this->atLeastOnce())
->method('create')
->willReturn($scheduleMock);
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* Test case checks if some job can't be locked.
*
* @return void
*/
public function testDispatchCanNotLock(): void
{
$lastRun = $this->time + 10000000;
$this->eventManager->expects($this->never())->method('dispatch');
$this->cacheMock->expects($this->any())->method('load')->willReturn($lastRun);
$this->scopeConfigMock->expects($this->any())
->method('getValue')->willReturn(0);
$this->consoleRequestMock->expects($this->any())
->method('getParam')->willReturn('test_group');
$dateScheduledAt = date('Y-m-d H:i:s', $this->time - 86400);
$schedule = $this->getMockBuilder(Schedule::class)
->onlyMethods(['tryLockJob', '__wakeup', 'save', 'getResource'])
->addMethods(['getJobCode', 'getScheduledAt', 'setFinishedAt'])->disableOriginalConstructor()
->getMock();
$schedule->expects($this->any())->method('getJobCode')->willReturn('test_job1');
$schedule->expects($this->atLeastOnce())->method('getScheduledAt')->willReturn($dateScheduledAt);
$schedule->expects($this->exactly(5))->method('tryLockJob')->willReturn(false);
$schedule->expects($this->never())->method('setFinishedAt');
$schedule->expects($this->never())->method('getResource')->willReturn($this->scheduleResourceMock);
$connectionMock = $this->getMockForAbstractClass(AdapterInterface::class);
$this->scheduleResourceMock->expects($this->never())
->method('getConnection')
->willReturn($connectionMock);
$this->retrierMock->expects($this->never())
->method('execute')
->willReturnCallback(
function ($callback) {
return $callback();
}
);
$abstractModel = $this->createMock(AbstractModel::class);
$schedule->expects($this->any())->method('save')->willReturn($abstractModel);
$this->scheduleCollectionMock->addItem($schedule);
$this->configMock->expects($this->exactly(2))
->method('getJobs')
->willReturn(['test_group' => ['test_job1' => ['test_data']]]);
$scheduleMock = $this->getMockBuilder(Schedule::class)
->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->any())
->method('getCollection')->willReturn($this->scheduleCollectionMock);
$scheduleMock->expects($this->any())
->method('getResource')->willReturn($this->scheduleResourceMock);
$this->scheduleFactoryMock->expects($this->atLeastOnce())
->method('create')
->willReturn($scheduleMock);
$this->loggerMock->expects($this->once())
->method('warning')
->with('Could not acquire lock for cron job: test_job1');
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* Test case catch exception if too late for schedule.
*
* @return void
*/
public function testDispatchExceptionTooLate(): void
{
$exceptionMessage = 'Cron Job test_job1 is missed at 2017-07-30 15:00:00';
$jobCode = 'test_job1';
$lastRun = $this->time + 10000000;
$this->eventManager->expects($this->never())->method('dispatch');
$this->cacheMock->expects($this->any())->method('load')->willReturn($lastRun);
$this->scopeConfigMock->expects($this->any())->method('getValue')->willReturn(0);
$this->consoleRequestMock->expects($this->any())->method('getParam')->willReturn('test_group');
$dateScheduledAt = date('Y-m-d H:i:s', $this->time - 86400);
$schedule = $this->getMockBuilder(Schedule::class)
->onlyMethods(['tryLockJob', 'save', '__wakeup', 'getResource'])
->addMethods(
[
'getJobCode',
'getScheduledAt',
'setStatus',
'setMessages',
'getStatus',
'getMessages',
'getScheduleId'
]
)->disableOriginalConstructor()
->getMock();
$schedule->expects($this->atLeastOnce())->method('getJobCode')->willReturn($jobCode);
$schedule->expects($this->atLeastOnce())->method('getScheduledAt')->willReturn($dateScheduledAt);
$schedule->expects($this->once())->method('tryLockJob')->willReturn(true);
$schedule->expects(
$this->any()
)->method(
'setStatus'
)->with(
Schedule::STATUS_MISSED
)->willReturnSelf();
$schedule->expects($this->once())->method('setMessages')->with($exceptionMessage);
$schedule->expects($this->atLeastOnce())->method('getStatus')->willReturn(Schedule::STATUS_MISSED);
$schedule->expects($this->atLeastOnce())->method('getMessages')->willReturn($exceptionMessage);
$schedule->expects($this->once())->method('save');
$schedule->expects($this->once())->method('getResource')->willReturn($this->scheduleResourceMock);
$connectionMock = $this->getMockForAbstractClass(AdapterInterface::class);
$this->scheduleResourceMock->expects($this->once())
->method('getConnection')
->willReturn($connectionMock);
$this->retrierMock->expects($this->once())
->method('execute')
->willReturnCallback(
function ($callback) {
return $callback();
}
);
$this->appStateMock->expects($this->once())->method('getMode')->willReturn(State::MODE_DEVELOPER);
$this->loggerMock->expects($this->once())->method('info')
->with('Cron Job test_job1 is missed at 2017-07-30 15:00:00');
$this->scheduleCollectionMock->addItem($schedule);
$this->configMock->expects(
$this->exactly(2)
)->method(
'getJobs'
)->willReturn(
['test_group' => ['test_job1' => ['test_data']]]
);
$scheduleMock = $this->getMockBuilder(Schedule::class)
->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->any())
->method('getCollection')->willReturn($this->scheduleCollectionMock);
$scheduleMock->expects($this->any())
->method('getResource')->willReturn($this->scheduleResourceMock);
$this->scheduleFactoryMock->expects($this->atLeastOnce())
->method('create')->willReturn($scheduleMock);
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* Test case catch exception if callback not exist.
*
* @return void
*/
public function testDispatchExceptionNoCallback(): void
{
$jobName = 'test_job1';
$exceptionMessage = 'No callbacks found for cron job ' . $jobName;
$exception = new Exception($exceptionMessage);
$this->eventManager->expects($this->never())->method('dispatch');
$dateScheduledAt = date('Y-m-d H:i:s', $this->time - 86400);
$schedule = $this->getMockBuilder(Schedule::class)
->onlyMethods(['tryLockJob', 'save', '__wakeup', 'getResource'])
->addMethods(['getJobCode', 'getScheduledAt', 'setStatus', 'setMessages', 'getStatus'])
->disableOriginalConstructor()
->getMock();
$schedule->expects($this->any())->method('getJobCode')->willReturn('test_job1');
$schedule->expects($this->once())->method('getScheduledAt')->willReturn($dateScheduledAt);
$schedule->expects($this->once())->method('tryLockJob')->willReturn(true);
$schedule->expects(
$this->once()
)->method(
'setStatus'
)->with(
Schedule::STATUS_ERROR
)->willReturnSelf();
$schedule->expects($this->once())->method('setMessages')->with($exceptionMessage);
$schedule->expects($this->any())->method('getStatus')->willReturn(Schedule::STATUS_ERROR);
$schedule->expects($this->once())->method('save');
$schedule->expects($this->once())->method('getResource')->willReturn($this->scheduleResourceMock);
$connectionMock = $this->getMockForAbstractClass(AdapterInterface::class);
$this->scheduleResourceMock->expects($this->once())
->method('getConnection')
->willReturn($connectionMock);
$this->retrierMock->expects($this->once())
->method('execute')
->willReturnCallback(
function ($callback) {
return $callback();
}
);
$this->consoleRequestMock->expects($this->any())
->method('getParam')->willReturn('test_group');
$this->scheduleCollectionMock->addItem($schedule);
$this->loggerMock->expects($this->once())->method('critical')->with($exception);
$jobConfig = ['test_group' => [$jobName => ['instance' => 'Some_Class']]];
$this->configMock->expects($this->exactly(2))
->method('getJobs')->willReturn($jobConfig);
$lastRun = $this->time + 10000000;
$this->cacheMock->expects($this->any())->method('load')->willReturn($lastRun);
$this->scopeConfigMock->expects($this->any())
->method('getValue')
->willReturn($this->time + 86400);
$scheduleMock = $this->getMockBuilder(
Schedule::class
)->disableOriginalConstructor()->getMock();
$scheduleMock->expects($this->any())->method('getCollection')->willReturn($this->scheduleCollectionMock);
$scheduleMock->expects($this->any())->method('getResource')->willReturn($this->scheduleResourceMock);
$this->scheduleFactoryMock->expects($this->once())->method('create')->willReturn($scheduleMock);
$scheduleMock = $this->getMockBuilder(Schedule::class)
->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->any())
->method('getCollection')->willReturn($this->scheduleCollectionMock);
$scheduleMock->expects($this->any())
->method('getResource')->willReturn($this->scheduleResourceMock);
$this->scheduleFactoryMock->expects($this->once())
->method('create')->willReturn($scheduleMock);
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* Test case catch exception if callback is not callable or throws exception.
*
* @param string $cronJobType
* @param mixed $cronJobObject
* @param string $exceptionMessage
* @param int $saveCalls
* @param int $dispatchCalls
* @param Exception $exception
*
* @return void
* @dataProvider dispatchExceptionInCallbackDataProvider
*/
public function testDispatchExceptionInCallback(
$cronJobType,
$cronJobObject,
$exceptionMessage,
$saveCalls,
$dispatchCalls,
$exception
): void {
$jobConfig = [
'test_group' => [
'test_job1' => ['instance' => $cronJobType, 'method' => 'execute']
],
];
$this->eventManager->expects($this->exactly($dispatchCalls))
->method('dispatch')
->with('cron_job_run', ['job_name' => 'cron/test_group/test_job1']);
$this->consoleRequestMock->expects($this->any())
->method('getParam')->willReturn('test_group');
$dateScheduledAt = date('Y-m-d H:i:s', $this->time - 86400);
$schedule = $this->getMockBuilder(Schedule::class)
->onlyMethods(['tryLockJob', 'save', '__wakeup', 'getResource'])
->addMethods(['getJobCode', 'getScheduledAt', 'setStatus', 'setMessages', 'getStatus'])
->disableOriginalConstructor()
->getMock();
$schedule->expects($this->any())->method('getJobCode')->willReturn('test_job1');
$schedule->expects($this->once())->method('getScheduledAt')->willReturn($dateScheduledAt);
$schedule->expects($this->once())->method('tryLockJob')->willReturn(true);
$schedule->expects($this->once())
->method('setStatus')
->with(Schedule::STATUS_ERROR)->willReturnSelf();
$schedule->expects($this->once())->method('setMessages')->with($exceptionMessage);
$schedule->expects($this->any())->method('getStatus')->willReturn(Schedule::STATUS_ERROR);
$schedule->expects($this->exactly($saveCalls))->method('save');
$schedule->expects($this->exactly($saveCalls))->method('getResource')->willReturn($this->scheduleResourceMock);
$connectionMock = $this->getMockForAbstractClass(AdapterInterface::class);
$this->scheduleResourceMock->expects($this->exactly($saveCalls))
->method('getConnection')
->willReturn($connectionMock);
$this->retrierMock->expects($this->exactly($saveCalls))
->method('execute')
->willReturnCallback(
function ($callback) {
return $callback();
}
);
$this->loggerMock->expects($this->once())->method('critical')->with($exception);
$this->scheduleCollectionMock->addItem($schedule);
$this->configMock->expects($this->exactly(2))->method('getJobs')->willReturn($jobConfig);
$lastRun = $this->time + 10000000;
$this->cacheMock->expects($this->any())->method('load')->willReturn($lastRun);
$this->scopeConfigMock->expects($this->any())
->method('getValue')
->willReturn($this->time + 86400);
$scheduleMock = $this->getMockBuilder(Schedule::class)
->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->any())
->method('getCollection')->willReturn($this->scheduleCollectionMock);
$scheduleMock->expects($this->any())
->method('getResource')->willReturn($this->scheduleResourceMock);
$this->scheduleFactoryMock->expects($this->once())
->method('create')->willReturn($scheduleMock);
$this->objectManagerMock
->expects($this->once())
->method('create')
->with($cronJobType)
->willReturn($cronJobObject);
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* @return array
*/
public function dispatchExceptionInCallbackDataProvider(): array
{
$throwable = new TypeError('Description of TypeError');
return [
'non-callable callback' => [
'Not_Existed_Class',
'',
'Invalid callback: Not_Existed_Class::execute can\'t be called',
1,
0,
new Exception('Invalid callback: Not_Existed_Class::execute can\'t be called')
],
'exception in execution' => [
'CronJobException',
new CronJobException(),
'Test exception',
2,
1,
new Exception('Test exception')
],
'throwable in execution' => [
'CronJobException',
new CronJobException(
$throwable
),
'Error when running a cron job: Description of TypeError',
2,
1,
new \RuntimeException(
'Error when running a cron job: Description of TypeError',
0,
$throwable
)
],
];
}
/**
* Test case, successfully run job.
*
* @return void
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
public function testDispatchRunJob(): void
{
$jobConfig = [
'test_group' => ['test_job1' => ['instance' => 'CronJob', 'method' => 'execute']]
];
$this->consoleRequestMock->expects($this->any())->method('getParam')->willReturn('test_group');
$this->eventManager->expects($this->once())
->method('dispatch')
->with('cron_job_run', ['job_name' => 'cron/test_group/test_job1']);
$dateScheduledAt = date('Y-m-d H:i:s', $this->time - 86400);
$scheduleMethods = [
'getJobCode',
'tryLockJob',
'getScheduledAt',
'save',
'setStatus',
'setMessages',
'setExecutedAt',
'setFinishedAt',
'__wakeup',
'getResource'
];
/** @var Schedule|MockObject $schedule */
$schedule = $this->getMockBuilder(
Schedule::class
)->setMethods(
$scheduleMethods
)->disableOriginalConstructor()
->getMock();
$schedule->expects($this->any())->method('getJobCode')->willReturn('test_job1');
$schedule->expects($this->atLeastOnce())->method('getScheduledAt')->willReturn($dateScheduledAt);
$schedule->expects($this->atLeastOnce())->method('tryLockJob')->willReturn(true);
$schedule->expects($this->any())->method('setFinishedAt')->willReturnSelf();
$schedule->expects($this->exactly(2))->method('getResource')->willReturn($this->scheduleResourceMock);
$connectionMock = $this->getMockForAbstractClass(AdapterInterface::class);
$this->scheduleResourceMock->expects($this->exactly(2))
->method('getConnection')
->willReturn($connectionMock);
$this->retrierMock->expects($this->exactly(2))
->method('execute')
->willReturnCallback(
function ($callback) {
return $callback();
}
);
// cron start to execute some job
$schedule->expects($this->any())->method('setExecutedAt')->willReturnSelf();
$schedule->expects($this->atLeastOnce())->method('save');
// cron end execute some job
$schedule->expects(
$this->atLeastOnce()
)->method(
'setStatus'
)->with(
Schedule::STATUS_SUCCESS
)->willReturnSelf();
$schedule->method('save');
$this->scheduleCollectionMock->addItem($schedule);
$this->configMock->expects($this->exactly(2))->method('getJobs')->willReturn($jobConfig);
$lastRun = $this->time + 10000000;
$this->cacheMock->expects($this->any())->method('load')->willReturn($lastRun);
$this->scopeConfigMock->expects($this->any())
->method('getValue')
->willReturn($this->time + 86400);
$scheduleMock = $this->getMockBuilder(
Schedule::class
)->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->any())
->method('getCollection')->willReturn($this->scheduleCollectionMock);
$scheduleMock->expects($this->any())
->method('getResource')->willReturn($this->scheduleResourceMock);
$this->scheduleFactoryMock->expects($this->once())
->method('create')->willReturn($scheduleMock);
$testCronJob = $this->getMockBuilder('CronJob')
->setMethods(['execute'])->getMock();
$testCronJob->expects($this->atLeastOnce())->method('execute')->with($schedule);
$this->objectManagerMock->expects($this->once())
->method('create')
->with('CronJob')
->willReturn($testCronJob);
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* Testing _generate(), iterate over saved cron jobs.
*
* @return void
*/
public function testDispatchNotGenerate(): void
{
$jobConfig = [
'test_group' => ['test_job1' => ['instance' => 'CronJob', 'method' => 'execute']]
];
$this->eventManager->expects($this->never())->method('dispatch');
$this->configMock
->method('getJobs')
->willReturnOnConsecutiveCalls($jobConfig, ['test_group' => []], $jobConfig, $jobConfig);
$this->consoleRequestMock->expects($this->any())
->method('getParam')->willReturn('test_group');
$this->cacheMock
->method('load')
->withConsecutive(
[ProcessCronQueueObserver::CACHE_KEY_LAST_HISTORY_CLEANUP_AT . 'test_group'],
[ProcessCronQueueObserver::CACHE_KEY_LAST_SCHEDULE_GENERATE_AT . 'test_group']
)
->willReturnOnConsecutiveCalls($this->time + 10000000, $this->time - 10000000);
$this->scopeConfigMock->expects($this->any())->method('getValue')->willReturn(0);
$schedule = $this->getMockBuilder(Schedule::class)
->onlyMethods(['__wakeup'])
->addMethods(['getJobCode', 'getScheduledAt'])
->disableOriginalConstructor()
->getMock();
$schedule->expects($this->any())->method('getJobCode')->willReturn('job_code1');
$schedule->expects($this->once())->method('getScheduledAt')->willReturn('* * * * *');
$this->scheduleCollectionMock->addItem(new DataObject());
$this->scheduleCollectionMock->addItem($schedule);
$this->cacheMock->expects($this->any())->method('save');
$scheduleMock = $this->getMockBuilder(
Schedule::class
)->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->any())
->method('getCollection')->willReturn($this->scheduleCollectionMock);
$this->scheduleFactoryMock->expects($this->any())->method('create')->willReturn($scheduleMock);
$this->scheduleFactoryMock->expects($this->any())->method('create')->willReturn($schedule);
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* Testing _generate(), iterate over saved cron jobs and generate jobs.
*
* @return void
*/
public function testDispatchGenerate(): void
{
$jobConfig = [
'default' => [
'test_job1' => [
'instance' => 'CronJob',
'method' => 'execute'
],
],
];
$jobs = [
'default' => [
'job1' => ['config_path' => 'test/path'],
'job2' => ['schedule' => ''],
'job3' => ['schedule' => '* * * * *']
],
];
$this->eventManager->expects($this->never())->method('dispatch');
$this->configMock
->method('getJobs')
->willReturnOnConsecutiveCalls($jobConfig, $jobs, $jobs, $jobs);
$this->consoleRequestMock->expects($this->any())->method('getParam')->willReturn('default');
$this->cacheMock
->method('load')
->withConsecutive(
[ProcessCronQueueObserver::CACHE_KEY_LAST_HISTORY_CLEANUP_AT . 'default'],
[ProcessCronQueueObserver::CACHE_KEY_LAST_SCHEDULE_GENERATE_AT . 'default']
)
->willReturnOnConsecutiveCalls($this->time + 10000000, $this->time - 10000000);
$this->scopeConfigMock->expects($this->any())->method('getValue')->willReturnMap(
[
[
'system/cron/default/schedule_generate_every',
ScopeInterface::SCOPE_STORE,
null,
0
],
[
'system/cron/default/schedule_ahead_for',
ScopeInterface::SCOPE_STORE,
null,
2
]
]
);
$schedule = $this->getMockBuilder(Schedule::class)
->onlyMethods(['save', 'trySchedule', 'getCollection', 'getResource'])
->addMethods(['getJobCode', 'getScheduledAt', 'unsScheduleId'])
->disableOriginalConstructor()
->getMock();
$schedule->expects($this->any())->method('getJobCode')->willReturn('job_code1');
$schedule->expects($this->once())->method('getScheduledAt')->willReturn('* * * * *');
$schedule->expects($this->any())->method('unsScheduleId')->willReturnSelf();
$schedule->expects($this->any())->method('trySchedule')->willReturnSelf();
$schedule->expects($this->any())->method('getCollection')->willReturn($this->scheduleCollectionMock);
$schedule->expects($this->atLeastOnce())->method('save')->willReturnSelf();
$schedule->expects($this->any())->method('getResource')->willReturn($this->scheduleResourceMock);
$this->scheduleCollectionMock->addItem(new DataObject());
$this->scheduleCollectionMock->addItem($schedule);
$this->cacheMock->expects($this->any())->method('save');
$this->scheduleFactoryMock->expects($this->any())->method('create')->willReturn($schedule);
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* Test case without saved cron jobs in data base.
*
* @return void
*/
public function testDispatchCleanup(): void
{
$jobConfig = [
'test_group' => ['test_job1' => ['instance' => 'CronJob', 'method' => 'execute']]
];
$this->eventManager->expects($this->never())->method('dispatch');
$dateExecutedAt = date('Y-m-d H:i:s', $this->time - 86400);
$schedule = $this->getMockBuilder(Schedule::class)
->disableOriginalConstructor()
->onlyMethods(['delete', '__wakeup'])
->addMethods(['getExecutedAt', 'getStatus'])->getMock();
$schedule->expects($this->any())->method('getExecutedAt')->willReturn($dateExecutedAt);
$schedule->expects($this->any())->method('getStatus')->willReturn('success');
$this->consoleRequestMock->expects($this->any())
->method('getParam')->willReturn('test_group');
$this->scheduleCollectionMock->addItem($schedule);
$this->configMock->expects($this->atLeastOnce())->method('getJobs')->willReturn($jobConfig);
$this->cacheMock
->method('load')
->willReturnOnConsecutiveCalls($this->time + 10000000, $this->time - 10000000);
$this->scopeConfigMock->expects($this->any())
->method('getValue')->willReturn(0);
$scheduleMock = $this->getMockBuilder(
Schedule::class
)->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->any())
->method('getCollection')->willReturn($this->scheduleCollectionMock);
$this->scheduleFactoryMock
->method('create')
->willReturn($scheduleMock);
$collection = $this->getMockBuilder(ScheduleCollection::class)
->onlyMethods(['addFieldToFilter', 'load', '__wakeup'])
->disableOriginalConstructor()
->getMock();
$collection->expects($this->any())
->method('addFieldToFilter')->willReturnSelf();
$collection->expects($this->any())
->method('load')->willReturnSelf();
$collection->addItem($schedule);
$scheduleMock = $this->getMockBuilder(Schedule::class)
->onlyMethods(['getCollection', 'getResource'])
->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->any())
->method('getCollection')->willReturn($collection);
$scheduleMock->expects($this->any())
->method('getResource')->willReturn($this->scheduleResourceMock);
$this->scheduleFactoryMock->expects($this->any())
->method('create')->willReturn($scheduleMock);
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* @return void
*/
public function testMissedJobsCleanedInTime(): void
{
$tableName = 'cron_schedule';
$this->eventManager->expects($this->never())->method('dispatch');
/* 1. Initialize dependencies of _cleanup() method which is called first */
$scheduleMock = $this->getMockBuilder(
Schedule::class
)->disableOriginalConstructor()
->getMock();
$scheduleMock->expects($this->any())
->method('getCollection')->willReturn($this->scheduleCollectionMock);
/* 2. Initialize dependencies of _generate() method which is called second */
$jobConfig = [
'test_group' => ['test_job1' => ['instance' => 'CronJob', 'method' => 'execute']]
];
//get configuration value CACHE_KEY_LAST_HISTORY_CLEANUP_AT in the "_generate()"
$this->cacheMock
->method('load')
->willReturnOnConsecutiveCalls($this->time - 10000000, $this->time + 10000000);
$this->scheduleFactoryMock
->method('create')
->willReturn($scheduleMock);
$this->configMock->expects($this->atLeastOnce())
->method('getJobs')->willReturn($jobConfig);
$this->scopeConfigMock->expects($this->any())
->method('getValue')
->willReturnMap(
[
['system/cron/test_group/use_separate_process', 0],
['system/cron/test_group/history_cleanup_every', 10],
['system/cron/test_group/schedule_lifetime', 2 * 24 * 60],
['system/cron/test_group/history_success_lifetime', 0],
['system/cron/test_group/history_failure_lifetime', 0],
['system/cron/test_group/schedule_generate_every', 0]
]
);
$this->scheduleCollectionMock->expects($this->any())->method('addFieldToFilter')->willReturnSelf();
$this->scheduleCollectionMock->expects($this->any())->method('load')->willReturnSelf();
$scheduleMock->expects($this->any())->method('getCollection')->willReturn($this->scheduleCollectionMock);
$scheduleMock->expects($this->exactly(10))->method('getResource')->willReturn($this->scheduleResourceMock);
$this->scheduleFactoryMock->expects($this->exactly(11))->method('create')->willReturn($scheduleMock);
$connectionMock = $this->prepareConnectionMock($tableName);
$this->scheduleResourceMock->expects($this->exactly(6))
->method('getTable')
->with($tableName)
->willReturn($tableName);
$this->scheduleResourceMock->expects($this->exactly(15))
->method('getConnection')
->willReturn($connectionMock);
$this->retrierMock->expects($this->exactly(5))
->method('execute')
->willReturnCallback(
function ($callback) {
return $callback();
}
);
$this->cronQueueObserver->execute($this->observerMock);
}
/**
* @param string $tableName
*
* @return AdapterInterface|MockObject
*/
private function prepareConnectionMock(string $tableName): AdapterInterface
{
$connectionMock = $this->getMockForAbstractClass(AdapterInterface::class);
$connectionMock->expects($this->exactly(5))
->method('delete')
->withConsecutive(
[
$tableName,
['status = ?' => 'pending', 'job_code in (?)' => ['test_job1']]
],
[
$tableName,
['status = ?' => 'success', 'job_code in (?)' => ['test_job1'], 'scheduled_at < ?' => null]
],
[
$tableName,
['status = ?' => 'missed', 'job_code in (?)' => ['test_job1'], 'scheduled_at < ?' => null]
],
[
$tableName,
['status = ?' => 'error', 'job_code in (?)' => ['test_job1'], 'scheduled_at < ?' => null]
],
[
$tableName,
['status = ?' => 'pending', 'job_code in (?)' => ['test_job1'], 'scheduled_at < ?' => null]
]
)
->willReturn(1);
$connectionMock->expects($this->any())
->method('quoteInto')
->withConsecutive(
['status = ?', Schedule::STATUS_RUNNING],
['job_code IN (?)', ['test_job1']]
)
->willReturnOnConsecutiveCalls(
"status = 'running'",
"job_code IN ('test_job1')"
);
$connectionMock->expects($this->once())
->method('update')
->with(
$tableName,
['status' => 'error', 'messages' => 'Time out'],
[
"status = 'running'",
"job_code IN ('test_job1')",
'scheduled_at < UTC_TIMESTAMP() - INTERVAL 1 DAY'
]
)
->willReturn(0);
return $connectionMock;
}
}