nextcloud-server/tests/lib/Repair/Owncloud/CleanPreviewsBackgroundJobTest.php

<?php
/**
 * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace Test\Repair\Owncloud;

use OC\Repair\Owncloud\CleanPreviewsBackgroundJob;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\IJobList;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
use OCP\IUserManager;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
use Test\TestCase;

class CleanPreviewsBackgroundJobTest extends TestCase {

	private IRootFolder&MockObject $rootFolder;
	private LoggerInterface&MockObject $logger;
	private IJobList&MockObject $jobList;
	private ITimeFactory&MockObject $timeFactory;
	private IUserManager&MockObject $userManager;
	private CleanPreviewsBackgroundJob $job;

	public function setUp(): void {
		parent::setUp();

		$this->rootFolder = $this->createMock(IRootFolder::class);
		$this->logger = $this->createMock(LoggerInterface::class);
		$this->jobList = $this->createMock(IJobList::class);
		$this->timeFactory = $this->createMock(ITimeFactory::class);
		$this->userManager = $this->createMock(IUserManager::class);

		$this->userManager->expects($this->any())->method('userExists')->willReturn(true);

		$this->job = new CleanPreviewsBackgroundJob(
			$this->rootFolder,
			$this->logger,
			$this->jobList,
			$this->timeFactory,
			$this->userManager
		);
	}

	public function testCleanupPreviewsUnfinished(): void {
		$userFolder = $this->createMock(Folder::class);
		$userRoot = $this->createMock(Folder::class);
		$thumbnailFolder = $this->createMock(Folder::class);

		$this->rootFolder->method('getUserFolder')
			->with($this->equalTo('myuid'))
			->willReturn($userFolder);

		$userFolder->method('getParent')->willReturn($userRoot);

		$userRoot->method('get')
			->with($this->equalTo('thumbnails'))
			->willReturn($thumbnailFolder);

		$previewFolder1 = $this->createMock(Folder::class);

		$previewFolder1->expects($this->once())
			->method('delete');

		$thumbnailFolder->method('getDirectoryListing')
			->willReturn([$previewFolder1]);
		$thumbnailFolder->expects($this->never())
			->method('delete');

		$this->timeFactory->method('getTime')
			->will($this->onConsecutiveCalls(100, 200));

		$this->jobList->expects($this->once())
			->method('add')
			->with(
				$this->equalTo(CleanPreviewsBackgroundJob::class),
				$this->equalTo(['uid' => 'myuid'])
			);

		$loggerCalls = [];
		$this->logger->expects($this->exactly(2))
			->method('info')
			->willReturnCallback(function () use (&$loggerCalls) {
				$loggerCalls[] = func_get_args();
			});

		$this->job->run(['uid' => 'myuid']);
		self::assertEquals([
			['Started preview cleanup for myuid', []],
			['New preview cleanup scheduled for myuid', []],
		], $loggerCalls);
	}

	public function testCleanupPreviewsFinished(): void {
		$userFolder = $this->createMock(Folder::class);
		$userRoot = $this->createMock(Folder::class);
		$thumbnailFolder = $this->createMock(Folder::class);

		$this->rootFolder->method('getUserFolder')
			->with($this->equalTo('myuid'))
			->willReturn($userFolder);

		$userFolder->method('getParent')->willReturn($userRoot);

		$userRoot->method('get')
			->with($this->equalTo('thumbnails'))
			->willReturn($thumbnailFolder);

		$previewFolder1 = $this->createMock(Folder::class);

		$previewFolder1->expects($this->once())
			->method('delete');

		$thumbnailFolder->method('getDirectoryListing')
			->willReturn([$previewFolder1]);

		$this->timeFactory->method('getTime')
			->will($this->onConsecutiveCalls(100, 101));

		$this->jobList->expects($this->never())
			->method('add');

		$loggerCalls = [];
		$this->logger->expects($this->exactly(2))
			->method('info')
			->willReturnCallback(function () use (&$loggerCalls) {
				$loggerCalls[] = func_get_args();
			});

		$thumbnailFolder->expects($this->once())
			->method('delete');

		$this->job->run(['uid' => 'myuid']);
		self::assertEquals([
			['Started preview cleanup for myuid', []],
			['Preview cleanup done for myuid', []],
		], $loggerCalls);
	}


	public function testNoUserFolder(): void {
		$this->rootFolder->method('getUserFolder')
			->with($this->equalTo('myuid'))
			->willThrowException(new NotFoundException());

		$loggerCalls = [];
		$this->logger->expects($this->exactly(2))
			->method('info')
			->willReturnCallback(function () use (&$loggerCalls) {
				$loggerCalls[] = func_get_args();
			});

		$this->job->run(['uid' => 'myuid']);
		self::assertEquals([
			['Started preview cleanup for myuid', []],
			['Preview cleanup done for myuid', []],
		], $loggerCalls);
	}

	public function testNoThumbnailFolder(): void {
		$userFolder = $this->createMock(Folder::class);
		$userRoot = $this->createMock(Folder::class);

		$this->rootFolder->method('getUserFolder')
			->with($this->equalTo('myuid'))
			->willReturn($userFolder);

		$userFolder->method('getParent')->willReturn($userRoot);

		$userRoot->method('get')
			->with($this->equalTo('thumbnails'))
			->willThrowException(new NotFoundException());

		$loggerCalls = [];
		$this->logger->expects($this->exactly(2))
			->method('info')
			->willReturnCallback(function () use (&$loggerCalls) {
				$loggerCalls[] = func_get_args();
			});

		$this->job->run(['uid' => 'myuid']);
		self::assertEquals([
			['Started preview cleanup for myuid', []],
			['Preview cleanup done for myuid', []],
		], $loggerCalls);
	}

	public function testNotPermittedToDelete(): void {
		$userFolder = $this->createMock(Folder::class);
		$userRoot = $this->createMock(Folder::class);
		$thumbnailFolder = $this->createMock(Folder::class);

		$this->rootFolder->method('getUserFolder')
			->with($this->equalTo('myuid'))
			->willReturn($userFolder);

		$userFolder->method('getParent')->willReturn($userRoot);

		$userRoot->method('get')
			->with($this->equalTo('thumbnails'))
			->willReturn($thumbnailFolder);

		$previewFolder1 = $this->createMock(Folder::class);

		$previewFolder1->expects($this->once())
			->method('delete')
			->willThrowException(new NotPermittedException());

		$thumbnailFolder->method('getDirectoryListing')
			->willReturn([$previewFolder1]);

		$this->timeFactory->method('getTime')
			->will($this->onConsecutiveCalls(100, 101));

		$this->jobList->expects($this->never())
			->method('add');

		$thumbnailFolder->expects($this->once())
			->method('delete')
			->willThrowException(new NotPermittedException());

		$loggerCalls = [];
		$this->logger->expects($this->exactly(2))
			->method('info')
			->willReturnCallback(function () use (&$loggerCalls) {
				$loggerCalls[] = func_get_args();
			});

		$this->job->run(['uid' => 'myuid']);
		self::assertEquals([
			['Started preview cleanup for myuid', []],
			['Preview cleanup done for myuid', []],
		], $loggerCalls);
	}
}