LevelsTestCase.php

<?php declare(strict_types = 1);

namespace PHPStan\Testing;

use Nette\Utils\Json;
use Nette\Utils\JsonException;
use PHPStan\File\FileHelper;
use PHPStan\File\FileWriter;
use PHPStan\ShouldNotHappenException;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\TestCase;
use function array_merge;
use function count;
use function escapeshellarg;
use function escapeshellcmd;
use function exec;
use function implode;
use function method_exists;
use function range;
use function sprintf;
use function unlink;
use const DIRECTORY_SEPARATOR;
use const PHP_BINARY;

/** @api */
abstract class LevelsTestCase extends TestCase
{

	/**
	 * @return array<array<string>>
	 */
	abstract public function dataTopics(): array;

	abstract public function getDataPath(): string;

	abstract public function getPhpStanExecutablePath(): string;

	abstract public function getPhpStanConfigPath(): ?string;

	protected function getResultSuffix(): string
	{
		return '';
	}

	protected function shouldAutoloadAnalysedFile(): bool
	{
		return true;
	}

	/**
	 * @dataProvider dataTopics
	 */
	public function testLevels(
		string $topic,
	): void
	{
		$file = sprintf('%s' . DIRECTORY_SEPARATOR . '%s.php', $this->getDataPath(), $topic);
		$command = escapeshellcmd($this->getPhpStanExecutablePath());
		$configPath = $this->getPhpStanConfigPath();
		$fileHelper = new FileHelper(__DIR__ . '/../..');

		$previousMessages = [];

		$exceptions = [];

		exec(sprintf('%s %s clear-result-cache %s 2>&1', escapeshellarg(PHP_BINARY), $command, $configPath !== null ? '--configuration ' . escapeshellarg($configPath) : ''), $clearResultCacheOutputLines, $clearResultCacheExitCode);
		if ($clearResultCacheExitCode !== 0) {
			throw new ShouldNotHappenException('Could not clear result cache: ' . implode("\n", $clearResultCacheOutputLines));
		}

		foreach (range(0, 9) as $level) {
			unset($outputLines);
			exec(sprintf('%s %s analyse --no-progress --error-format=prettyJson --level=%d %s %s %s', escapeshellarg(PHP_BINARY), $command, $level, $configPath !== null ? '--configuration ' . escapeshellarg($configPath) : '', $this->shouldAutoloadAnalysedFile() ? sprintf('--autoload-file %s', escapeshellarg($file)) : '', escapeshellarg($file)), $outputLines);

			$output = implode("\n", $outputLines);

			try {
				$actualJson = Json::decode($output, Json::FORCE_ARRAY);
			} catch (JsonException) {
				throw new JsonException(sprintf('Cannot decode: %s', $output));
			}
			if (count($actualJson['files']) > 0) {
				$normalizedFilePath = $fileHelper->normalizePath($file);
				if (!isset($actualJson['files'][$normalizedFilePath])) {
					$messagesBeforeDiffing = [];
				} else {
					$messagesBeforeDiffing = $actualJson['files'][$normalizedFilePath]['messages'];
				}

				foreach ($this->getAdditionalAnalysedFiles() as $additionalAnalysedFile) {
					$normalizedAdditionalFilePath = $fileHelper->normalizePath($additionalAnalysedFile);
					if (!isset($actualJson['files'][$normalizedAdditionalFilePath])) {
						continue;
					}

					$messagesBeforeDiffing = array_merge($messagesBeforeDiffing, $actualJson['files'][$normalizedAdditionalFilePath]['messages']);
				}
			} else {
				$messagesBeforeDiffing = [];
			}

			$messages = [];
			foreach ($messagesBeforeDiffing as $message) {
				foreach ($previousMessages as $lastMessage) {
					if (
						$message['message'] === $lastMessage['message']
						&& $message['line'] === $lastMessage['line']
					) {
						continue 2;
					}
				}

				unset($message['tip']);

				$messages[] = $message;
			}

			$missingMessages = [];
			foreach ($previousMessages as $previousMessage) {
				foreach ($messagesBeforeDiffing as $message) {
					if (
						$previousMessage['message'] === $message['message']
						&& $previousMessage['line'] === $message['line']
					) {
						continue 2;
					}
				}

				unset($previousMessage['tip']);

				$missingMessages[] = $previousMessage;
			}

			$previousMessages = array_merge($previousMessages, $messages);
			$expectedJsonFile = sprintf('%s/%s-%d%s.json', $this->getDataPath(), $topic, $level, $this->getResultSuffix());

			$exception = $this->compareFiles($expectedJsonFile, $messages);
			if ($exception !== null) {
				$exceptions[] = $exception;
			}

			$expectedJsonMissingFile = sprintf('%s/%s-%d-missing%s.json', $this->getDataPath(), $topic, $level, $this->getResultSuffix());
			$exception = $this->compareFiles($expectedJsonMissingFile, $missingMessages);
			if ($exception === null) {
				continue;
			}

			$exceptions[] = $exception;
		}

		if (count($exceptions) > 0) {
			throw $exceptions[0];
		}
	}

	/**
	 * @return string[]
	 */
	public function getAdditionalAnalysedFiles(): array
	{
		return [];
	}

	/**
	 * @param string[] $expectedMessages
	 */
	private function compareFiles(string $expectedJsonFile, array $expectedMessages): ?AssertionFailedError
	{
		if (count($expectedMessages) === 0) {
			try {
				self::assertFileDoesNotExist($expectedJsonFile);
				return null;
			} catch (AssertionFailedError $e) {
				unlink($expectedJsonFile);
				return $e;
			}
		}

		$actualOutput = Json::encode($expectedMessages, Json::PRETTY);

		try {
			$this->assertJsonStringEqualsJsonFile(
				$expectedJsonFile,
				$actualOutput,
			);
		} catch (AssertionFailedError $e) {
			FileWriter::write($expectedJsonFile, $actualOutput);
			return $e;
		}

		return null;
	}

	public static function assertFileDoesNotExist(string $filename, string $message = ''): void
	{
		if (!method_exists(parent::class, 'assertFileDoesNotExist')) {
			parent::assertFileNotExists($filename, $message);
			return;
		}

		parent::assertFileDoesNotExist($filename, $message);
	}

}