aboutsummaryrefslogtreecommitdiffstats
path: root/tests/lib/BackgroundJob/TestJob.php
diff options
context:
space:
mode:
Diffstat (limited to 'tests/lib/BackgroundJob/TestJob.php')
-rw-r--r--tests/lib/BackgroundJob/TestJob.php16
1 files changed, 10 insertions, 6 deletions
diff --git a/tests/lib/BackgroundJob/TestJob.php b/tests/lib/BackgroundJob/TestJob.php
index ea0634e63d9..ac18530ac7f 100644
--- a/tests/lib/BackgroundJob/TestJob.php
+++ b/tests/lib/BackgroundJob/TestJob.php
@@ -1,4 +1,5 @@
<?php
+
/**
* SPDX-FileCopyrightText: 2020-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
@@ -8,10 +9,10 @@
namespace Test\BackgroundJob;
use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\Job;
+use OCP\Server;
-class TestJob extends \OCP\BackgroundJob\Job {
- private $testCase;
-
+class TestJob extends Job {
/**
* @var callable $callback
*/
@@ -21,9 +22,12 @@ class TestJob extends \OCP\BackgroundJob\Job {
* @param JobTest $testCase
* @param callable $callback
*/
- public function __construct(?ITimeFactory $time = null, $testCase = null, $callback = null) {
- parent::__construct($time ?? \OCP\Server::get(ITimeFactory::class));
- $this->testCase = $testCase;
+ public function __construct(
+ ?ITimeFactory $time = null,
+ private $testCase = null,
+ $callback = null,
+ ) {
+ parent::__construct($time ?? Server::get(ITimeFactory::class));
$this->callback = $callback;
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-09 20:38:01 +0000
'#n128'>128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 
<?php
/**
 * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCA\Theming\Tests;

use OCA\Theming\ImageManager;
use OCA\Theming\Service\BackgroundService;
use OCP\Files\IAppData;
use OCP\Files\NotFoundException;
use OCP\Files\SimpleFS\ISimpleFile;
use OCP\Files\SimpleFS\ISimpleFolder;
use OCP\ICacheFactory;
use OCP\IConfig;
use OCP\ITempManager;
use OCP\IURLGenerator;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
use Test\TestCase;

class ImageManagerTest extends TestCase {
	/** @var IConfig|MockObject */
	protected $config;
	/** @var IAppData|MockObject */
	protected $appData;
	/** @var ImageManager */
	protected $imageManager;
	/** @var IURLGenerator|MockObject */
	private $urlGenerator;
	/** @var ICacheFactory|MockObject */
	private $cacheFactory;
	/** @var LoggerInterface|MockObject */
	private $logger;
	/** @var ITempManager|MockObject */
	private $tempManager;
	/** @var ISimpleFolder|MockObject */
	private $rootFolder;
	/** @var BackgroundService|MockObject */
	private $backgroundService;

	protected function setUp(): void {
		parent::setUp();
		$this->config = $this->createMock(IConfig::class);
		$this->appData = $this->createMock(IAppData::class);
		$this->urlGenerator = $this->createMock(IURLGenerator::class);
		$this->cacheFactory = $this->createMock(ICacheFactory::class);
		$this->logger = $this->createMock(LoggerInterface::class);
		$this->tempManager = $this->createMock(ITempManager::class);
		$this->rootFolder = $this->createMock(ISimpleFolder::class);
		$this->backgroundService = $this->createMock(BackgroundService::class);
		$this->imageManager = new ImageManager(
			$this->config,
			$this->appData,
			$this->urlGenerator,
			$this->cacheFactory,
			$this->logger,
			$this->tempManager,
			$this->backgroundService,
		);
		$this->appData
			->expects($this->any())
			->method('getFolder')
			->with('global')
			->willReturn($this->rootFolder);
	}

	private function checkImagick() {
		if (!extension_loaded('imagick')) {
			$this->markTestSkipped('Imagemagick is required for dynamic icon generation.');
		}
		$checkImagick = new \Imagick();
		if (empty($checkImagick->queryFormats('SVG'))) {
			$this->markTestSkipped('No SVG provider present.');
		}
		if (empty($checkImagick->queryFormats('PNG'))) {
			$this->markTestSkipped('No PNG provider present.');
		}
	}

	public function mockGetImage($key, $file) {
		/** @var MockObject $folder */
		$folder = $this->createMock(ISimpleFolder::class);
		if ($file === null) {
			$folder->expects($this->once())
				->method('getFile')
				->with('logo')
				->willThrowException(new NotFoundException());
		} else {
			$file->expects($this->once())
				->method('getContent')
				->willReturn(file_get_contents(__DIR__ . '/../../../tests/data/testimage.png'));
			$folder->expects($this->exactly(2))
				->method('fileExists')
				->withConsecutive(
					['logo'],
					['logo.png'],
				)->willReturnOnConsecutiveCalls(
					true,
					false,
				);
			$folder->expects($this->once())
				->method('getFile')
				->with('logo')
				->willReturn($file);
			$newFile = $this->createMock(ISimpleFile::class);
			$folder->expects($this->once())
				->method('newFile')
				->with('logo.png')
				->willReturn($newFile);
			$newFile->expects($this->once())
				->method('putContent');
			$this->rootFolder->expects($this->once())
				->method('getFolder')
				->with('images')
				->willReturn($folder);
		}
	}

	public function testGetImageUrl() {
		$this->checkImagick();
		$file = $this->createMock(ISimpleFile::class);
		$this->config->expects($this->exactly(2))
			->method('getAppValue')
			->withConsecutive(
				['theming', 'cachebuster', '0'],
				['theming', 'logoMime', '']
			)
			->willReturn(0);
		$this->urlGenerator->expects($this->once())
			->method('linkToRoute')
			->willReturn('url-to-image');
		$this->assertEquals('url-to-image?v=0', $this->imageManager->getImageUrl('logo', false));
	}

	public function testGetImageUrlDefault() {
		$this->config->expects($this->exactly(2))
			->method('getAppValue')
			->withConsecutive(
				['theming', 'cachebuster', '0'],
				['theming', 'logoMime', '']
			)
			->willReturnOnConsecutiveCalls(0, '');
		$this->urlGenerator->expects($this->once())
			->method('imagePath')
			->with('core', 'logo/logo.png')
			->willReturn('logo/logo.png');
		$this->assertEquals('logo/logo.png?v=0', $this->imageManager->getImageUrl('logo'));
	}

	public function testGetImageUrlAbsolute() {
		$this->checkImagick();
		$file = $this->createMock(ISimpleFile::class);
		$this->config->expects($this->exactly(2))
			->method('getAppValue')
			->withConsecutive(
				['theming', 'cachebuster', '0'],
				['theming', 'logoMime', '']
			)
			->willReturnOnConsecutiveCalls(0, 0);
		$this->urlGenerator->expects($this->any())
			->method('getAbsoluteUrl')
			->willReturn('url-to-image-absolute?v=0');
		$this->assertEquals('url-to-image-absolute?v=0', $this->imageManager->getImageUrlAbsolute('logo', false));
	}

	public function testGetImage() {
		$this->checkImagick();
		$this->config->expects($this->once())
			->method('getAppValue')->with('theming', 'logoMime', false)
			->willReturn('png');
		$file = $this->createMock(ISimpleFile::class);
		$this->mockGetImage('logo', $file);
		$this->assertEquals($file, $this->imageManager->getImage('logo', false));
	}


	public function testGetImageUnset() {
		$this->expectException(\OCP\Files\NotFoundException::class);

		$this->config->expects($this->once())
			->method('getAppValue')->with('theming', 'logoMime', false)
			->willReturn(false);
		$this->imageManager->getImage('logo');
	}

	public function testGetCacheFolder() {
		$folder = $this->createMock(ISimpleFolder::class);
		$this->config->expects($this->once())
			->method('getAppValue')
			->with('theming', 'cachebuster', '0')
			->willReturn('0');
		$this->rootFolder->expects($this->once())
			->method('getFolder')
			->with('0')
			->willReturn($folder);
		$this->assertEquals($folder, $this->imageManager->getCacheFolder());
	}
	public function testGetCacheFolderCreate() {
		$folder = $this->createMock(ISimpleFolder::class);
		$this->config->expects($this->exactly(2))
			->method('getAppValue')
			->with('theming', 'cachebuster', '0')
			->willReturn('0');
		$this->rootFolder->expects($this->exactly(2))
			->method('getFolder')
			->with('0')
			->willReturnOnConsecutiveCalls(
				$this->throwException(new NotFoundException()),
				$folder,
			);
		$this->rootFolder->expects($this->once())
			->method('newFolder')
			->with('0')
			->willReturn($folder);
		$this->rootFolder->expects($this->once())
			->method('getDirectoryListing')
			->willReturn([]);
		$this->assertEquals($folder, $this->imageManager->getCacheFolder());
	}

	public function testGetCachedImage() {
		$expected = $this->createMock(ISimpleFile::class);
		$folder = $this->setupCacheFolder();
		$folder->expects($this->once())
			->method('getFile')
			->with('filename')
			->willReturn($expected);
		$this->assertEquals($expected, $this->imageManager->getCachedImage('filename'));
	}


	public function testGetCachedImageNotFound() {
		$this->expectException(\OCP\Files\NotFoundException::class);

		$folder = $this->setupCacheFolder();
		$folder->expects($this->once())
			->method('getFile')
			->with('filename')
			->will($this->throwException(new \OCP\Files\NotFoundException()));
		$image = $this->imageManager->getCachedImage('filename');
	}

	public function testSetCachedImage() {
		$folder = $this->setupCacheFolder();
		$file = $this->createMock(ISimpleFile::class);
		$folder->expects($this->once())
			->method('fileExists')
			->with('filename')
			->willReturn(true);
		$folder->expects($this->once())
			->method('getFile')
			->with('filename')
			->willReturn($file);
		$file->expects($this->once())
			->method('putContent')
			->with('filecontent');
		$this->assertEquals($file, $this->imageManager->setCachedImage('filename', 'filecontent'));
	}

	public function testSetCachedImageCreate() {
		$folder = $this->setupCacheFolder();
		$file = $this->createMock(ISimpleFile::class);
		$folder->expects($this->once())
			->method('fileExists')
			->with('filename')
			->willReturn(false);
		$folder->expects($this->once())
			->method('newFile')
			->with('filename')
			->willReturn($file);
		$file->expects($this->once())
			->method('putContent')
			->with('filecontent');
		$this->assertEquals($file, $this->imageManager->setCachedImage('filename', 'filecontent'));
	}

	private function setupCacheFolder() {
		$folder = $this->createMock(ISimpleFolder::class);
		$this->config->expects($this->once())
			->method('getAppValue')
			->with('theming', 'cachebuster', '0')
			->willReturn('0');
		$this->rootFolder->expects($this->once())
			->method('getFolder')
			->with('0')
			->willReturn($folder);
		return $folder;
	}

	public function testCleanup() {
		$folders = [
			$this->createMock(ISimpleFolder::class),
			$this->createMock(ISimpleFolder::class),
			$this->createMock(ISimpleFolder::class)
		];
		foreach ($folders as $index => $folder) {
			$folder->expects($this->any())
				->method('getName')
				->willReturn("$index");
		}
		$folders[0]->expects($this->once())->method('delete');
		$folders[1]->expects($this->once())->method('delete');
		$folders[2]->expects($this->never())->method('delete');
		$this->config->expects($this->once())
			->method('getAppValue')
			->with('theming', 'cachebuster', '0')
			->willReturn('2');
		$this->rootFolder->expects($this->once())
			->method('getDirectoryListing')
			->willReturn($folders);
		$this->rootFolder->expects($this->once())
			->method('getFolder')
			->with('2')
			->willReturn($folders[2]);
		$this->imageManager->cleanup();
	}


	public function dataUpdateImage() {
		return [
			['background', __DIR__ . '/../../../tests/data/testimage.png', true, false],
			['background', __DIR__ . '/../../../tests/data/testimage.png', false, false],
			['background', __DIR__ . '/../../../tests/data/testimage.jpg', true, false],
			['background', __DIR__ . '/../../../tests/data/testimage.webp', true, false],
			['background', __DIR__ . '/../../../tests/data/testimage-large.jpg', true, true],
			['background', __DIR__ . '/../../../tests/data/testimage-wide.png', true, true],
			['logo', __DIR__ . '/../../../tests/data/testimagelarge.svg', true, false],
		];
	}

	/**
	 * @dataProvider dataUpdateImage
	 */
	public function testUpdateImage($key, $tmpFile, $folderExists, $shouldConvert) {
		$file = $this->createMock(ISimpleFile::class);
		$folder = $this->createMock(ISimpleFolder::class);
		$oldFile = $this->createMock(ISimpleFile::class);
		$folder->expects($this->any())
			->method('getFile')
			->willReturn($oldFile);

		if ($folderExists) {
			$this->rootFolder
				->expects($this->any())
				->method('getFolder')
				->with('images')
				->willReturn($folder);
		} else {
			$this->rootFolder
				->expects($this->any())
				->method('getFolder')
				->with('images')
				->willThrowException(new NotFoundException());
			$this->rootFolder
				->expects($this->any())
				->method('newFolder')
				->with('images')
				->willReturn($folder);
		}

		$folder->expects($this->once())
			->method('newFile')
			->with($key)
			->willReturn($file);

		if ($shouldConvert) {
			$this->tempManager->expects($this->once())
				->method('getTemporaryFile')
				->willReturn('/tmp/randomtempfile-theming');
		}

		$this->imageManager->updateImage($key, $tmpFile);
	}

	public function testUnsupportedImageType(): void {
		$this->expectException(\Exception::class);
		$this->expectExceptionMessage('Unsupported image type: text/plain');

		$file = $this->createMock(ISimpleFile::class);
		$folder = $this->createMock(ISimpleFolder::class);
		$oldFile = $this->createMock(ISimpleFile::class);

		$folder->expects($this->any())
			->method('getFile')
			->willReturn($oldFile);

		$this->rootFolder
			->expects($this->any())
			->method('getFolder')
			->with('images')
			->willReturn($folder);

		$folder->expects($this->once())
			->method('newFile')
			->with('favicon')
			->willReturn($file);

		$this->imageManager->updateImage('favicon', __DIR__ . '/../../../tests/data/lorem.txt');
	}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-09 20:38:01 +0000