nextcloud/tests/lib/BackgroundJob/JobListTest.php

252 lines
6.3 KiB
PHP

<?php
/**
* Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace Test\BackgroundJob;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\IJob;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\IConfig;
use Test\TestCase;
/**
* Class JobList
*
* @group DB
* @package Test\BackgroundJob
*/
class JobListTest extends TestCase {
/** @var \OC\BackgroundJob\JobList */
protected $instance;
/** @var \OCP\IDBConnection */
protected $connection;
/** @var \OCP\IConfig|\PHPUnit_Framework_MockObject_MockObject */
protected $config;
/** @var \OCP\AppFramework\Utility\ITimeFactory|\PHPUnit_Framework_MockObject_MockObject */
protected $timeFactory;
protected function setUp() {
parent::setUp();
$this->connection = \OC::$server->getDatabaseConnection();
$this->clearJobsList();
$this->config = $this->createMock(IConfig::class);
$this->timeFactory = $this->createMock(ITimeFactory::class);
$this->instance = new \OC\BackgroundJob\JobList(
$this->connection,
$this->config,
$this->timeFactory
);
}
protected function clearJobsList() {
$query = $this->connection->getQueryBuilder();
$query->delete('jobs');
$query->execute();
}
protected function getAllSorted() {
$jobs = $this->instance->getAll();
usort($jobs, function (IJob $job1, IJob $job2) {
return $job1->getId() - $job2->getId();
});
return $jobs;
}
public function argumentProvider() {
return array(
array(null),
array(false),
array('foobar'),
array(12),
array(array(
'asd' => 5,
'foo' => 'bar'
))
);
}
/**
* @dataProvider argumentProvider
* @param $argument
*/
public function testAddRemove($argument) {
$existingJobs = $this->getAllSorted();
$job = new TestJob();
$this->instance->add($job, $argument);
$jobs = $this->getAllSorted();
$this->assertCount(count($existingJobs) + 1, $jobs);
$addedJob = $jobs[count($jobs) - 1];
$this->assertInstanceOf('\Test\BackgroundJob\TestJob', $addedJob);
$this->assertEquals($argument, $addedJob->getArgument());
$this->instance->remove($job, $argument);
$jobs = $this->getAllSorted();
$this->assertEquals($existingJobs, $jobs);
}
/**
* @dataProvider argumentProvider
* @param $argument
*/
public function testRemoveDifferentArgument($argument) {
$existingJobs = $this->getAllSorted();
$job = new TestJob();
$this->instance->add($job, $argument);
$jobs = $this->getAllSorted();
$this->instance->remove($job, 10);
$jobs2 = $this->getAllSorted();
$this->assertEquals($jobs, $jobs2);
$this->instance->remove($job, $argument);
$jobs = $this->getAllSorted();
$this->assertEquals($existingJobs, $jobs);
}
/**
* @dataProvider argumentProvider
* @param $argument
*/
public function testHas($argument) {
$job = new TestJob();
$this->assertFalse($this->instance->has($job, $argument));
$this->instance->add($job, $argument);
$this->assertTrue($this->instance->has($job, $argument));
$this->instance->remove($job, $argument);
$this->assertFalse($this->instance->has($job, $argument));
}
/**
* @dataProvider argumentProvider
* @param $argument
*/
public function testHasDifferentArgument($argument) {
$job = new TestJob();
$this->instance->add($job, $argument);
$this->assertFalse($this->instance->has($job, 10));
}
public function testGetLastJob() {
$this->config->expects($this->once())
->method('getAppValue')
->with('backgroundjob', 'lastjob', 0)
->will($this->returnValue(15));
$this->assertEquals(15, $this->instance->getLastJob());
}
protected function createTempJob($class, $argument, $reservedTime = 0, $lastChecked = 0) {
if ($lastChecked === 0) {
$lastChecked = time();
}
$query = $this->connection->getQueryBuilder();
$query->insert('jobs')
->values([
'class' => $query->createNamedParameter($class),
'argument' => $query->createNamedParameter($argument),
'last_run' => $query->createNamedParameter(0, IQueryBuilder::PARAM_INT),
'last_checked' => $query->createNamedParameter($lastChecked, IQueryBuilder::PARAM_INT),
'reserved_at' => $query->createNamedParameter($reservedTime, IQueryBuilder::PARAM_INT),
]);
$query->execute();
}
public function testGetNext() {
$job = new TestJob();
$this->createTempJob(get_class($job), 1, 0, 12345);
$this->createTempJob(get_class($job), 2, 0, 12346);
$jobs = $this->getAllSorted();
$savedJob1 = $jobs[0];
$this->timeFactory->expects($this->atLeastOnce())
->method('getTime')
->willReturn(123456789);
$nextJob = $this->instance->getNext();
$this->assertEquals($savedJob1, $nextJob);
}
public function testGetNextSkipReserved() {
$job = new TestJob();
$this->createTempJob(get_class($job), 1, 123456789, 12345);
$this->createTempJob(get_class($job), 2, 0, 12346);
$this->timeFactory->expects($this->atLeastOnce())
->method('getTime')
->willReturn(123456789);
$nextJob = $this->instance->getNext();
$this->assertEquals(get_class($job), get_class($nextJob));
$this->assertEquals(2, $nextJob->getArgument());
}
public function testGetNextSkipNonExisting() {
$job = new TestJob();
$this->createTempJob('\OC\Non\Existing\Class', 1, 0, 12345);
$this->createTempJob(get_class($job), 2, 0, 12346);
$this->timeFactory->expects($this->atLeastOnce())
->method('getTime')
->willReturn(123456789);
$nextJob = $this->instance->getNext();
$this->assertEquals(get_class($job), get_class($nextJob));
$this->assertEquals(2, $nextJob->getArgument());
}
/**
* @dataProvider argumentProvider
* @param $argument
*/
public function testGetById($argument) {
$job = new TestJob();
$this->instance->add($job, $argument);
$jobs = $this->getAllSorted();
$addedJob = $jobs[count($jobs) - 1];
$this->assertEquals($addedJob, $this->instance->getById($addedJob->getId()));
}
public function testSetLastRun() {
$job = new TestJob();
$this->instance->add($job);
$jobs = $this->getAllSorted();
$addedJob = $jobs[count($jobs) - 1];
$timeStart = time();
$this->instance->setLastRun($addedJob);
$timeEnd = time();
$addedJob = $this->instance->getById($addedJob->getId());
$this->assertGreaterThanOrEqual($timeStart, $addedJob->getLastRun());
$this->assertLessThanOrEqual($timeEnd, $addedJob->getLastRun());
}
}