php-qrcode/tests/Output/QROutputTestAbstract.php

<?php
/**
 * Class QROutputTestAbstract
 *
 * @created      24.12.2017
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2017 Smiley
 * @license      MIT
 */
declare(strict_types=1);

namespace chillerlan\QRCodeTest\Output;

use chillerlan\QRCode\{QRCode, QROptions};
use chillerlan\QRCode\Data\QRMatrix;
use chillerlan\QRCode\Output\{QRCodeOutputException, QROutputInterface};
use chillerlan\QRCodeTest\Traits\BuildDirTrait;
use chillerlan\Settings\SettingsContainerInterface;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\Attributes\{DataProvider, Test};
use ReflectionObject;

/**
 * Test abstract for the several (built-in) output modules,
 * should also be used to test custom output modules
 */
abstract class QROutputTestAbstract extends TestCase{
	use BuildDirTrait;

	protected SettingsContainerInterface|QROptions $options;
	protected QROutputInterface                    $outputInterface;
	protected QRMatrix                             $matrix;

	protected const buildDir = 'output-test';

	/**
	 * Attempts to create a directory under /.build and instances several required objects
	 */
	protected function setUp():void{
		$this->createBuildDir($this::buildDir);

		$this->options         = new QROptions;
		$this->matrix          = (new QRCode($this->options))->addByteSegment('testdata')->getQRMatrix();
		$this->outputInterface = $this->getOutputInterface($this->options, $this->matrix);
	}

	abstract protected function getOutputInterface(
		SettingsContainerInterface|QROptions $options,
		QRMatrix                             $matrix,
	):QROutputInterface;

	/**
	 * Tests if an exception is thrown when trying to write a cache file to an invalid destination
	 */
	#[Test]
	public function saveException():void{
		$this->expectException(QRCodeOutputException::class);
		$this->expectExceptionMessage('Cannot write data to cache file: /foo/bar.test');

		$this->outputInterface->dump('/foo/bar.test');
	}

	/**
	 * @phpstan-return array<string, array{0: mixed, 1: bool}>
	 */
	abstract public static function moduleValueProvider():array;

	#[Test]
	#[DataProvider('moduleValueProvider')]
	public function validateModuleValues(mixed $value, bool $expected):void{
		$this::assertSame($expected, $this->outputInterface::moduleValueIsValid($value));
	}

	/*
	 * additional, non-essential, potentially inaccurate coverage tests
	 */

	/**
	 * covers the module values settings
	 */
	#[Test]
	abstract public function setModuleValues():void;

	/**
	 * coverage of the built-in output modules
	 */
	#[Test]
	public function renderToCacheFile():void{
		$this->options->outputBase64 = false;
		$this->outputInterface       = $this->getOutputInterface($this->options, $this->matrix);
		// create the cache file
		$name        = (new ReflectionObject($this->outputInterface))->getShortName();
		$fileSubPath = $this::buildDir.'/test.output.'.$name;
		$data        = $this->outputInterface->dump($this->getBuildPath($fileSubPath));

		$this::assertSame($data, $this->getBuildFileContent($fileSubPath));
	}

}