nextcloud-server/tests/lib/BackgroundJob/JobTest.php

<?php
/**
 * Copyright (c) 2013 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\ILogger;

class JobTest extends \Test\TestCase {
	private $run = false;
	private ITimeFactory $timeFactory;

	protected function setUp(): void {
		parent::setUp();
		$this->run = false;
		$this->timeFactory = \OC::$server->get(ITimeFactory::class);
	}

	public function testRemoveAfterException() {
		$jobList = new DummyJobList();
		$e = new \Exception();
		$job = new TestJob($this->timeFactory, $this, function () use ($e) {
			throw $e;
		});
		$jobList->add($job);

		$logger = $this->getMockBuilder(ILogger::class)
			->disableOriginalConstructor()
			->getMock();
		$logger->expects($this->once())
			->method('error');

		$this->assertCount(1, $jobList->getAll());
		$job->execute($jobList, $logger);
		$this->assertTrue($this->run);
		$this->assertCount(1, $jobList->getAll());
	}

	public function testRemoveAfterError() {
		$jobList = new DummyJobList();
		$job = new TestJob($this->timeFactory, $this, function () {
			$test = null;
			$test->someMethod();
		});
		$jobList->add($job);

		$logger = $this->getMockBuilder(ILogger::class)
			->disableOriginalConstructor()
			->getMock();
		$logger->expects($this->once())
			->method('error');

		$this->assertCount(1, $jobList->getAll());
		$job->execute($jobList, $logger);
		$this->assertTrue($this->run);
		$this->assertCount(1, $jobList->getAll());
	}

	public function testDisallowParallelRunsWithNoOtherJobs() {
		$jobList = new DummyJobList();
		$job = new TestJob($this->timeFactory, $this, function () {
		});
		$job->setAllowParallelRuns(false);
		$jobList->add($job);

		$jobList->setHasReservedJob(null, false);
		$jobList->setHasReservedJob(TestJob::class, false);
		$job->start($jobList);
		$this->assertTrue($this->run);
	}

	public function testAllowParallelRunsWithNoOtherJobs() {
		$jobList = new DummyJobList();
		$job = new TestJob($this->timeFactory, $this, function () {
		});
		$job->setAllowParallelRuns(true);
		$jobList->add($job);

		$jobList->setHasReservedJob(null, false);
		$jobList->setHasReservedJob(TestJob::class, false);
		$job->start($jobList);
		$this->assertTrue($this->run);
	}

	public function testAllowParallelRunsWithOtherJobs() {
		$jobList = new DummyJobList();
		$job = new TestJob($this->timeFactory, $this, function () {
		});
		$job->setAllowParallelRuns(true);
		$jobList->add($job);

		$jobList->setHasReservedJob(null, true);
		$jobList->setHasReservedJob(TestJob::class, true);
		$job->start($jobList);
		$this->assertTrue($this->run);
	}

	public function testDisallowParallelRunsWithOtherJobs() {
		$jobList = new DummyJobList();
		$job = new TestJob($this->timeFactory, $this, function () {
		});
		$job->setAllowParallelRuns(false);
		$jobList->add($job);

		$jobList->setHasReservedJob(null, true);
		$jobList->setHasReservedJob(TestJob::class, true);
		$job->start($jobList);
		$this->assertFalse($this->run);
	}

	public function markRun() {
		$this->run = true;
	}
}