<?php declare(strict_types = 1);

namespace PHPStan\Testing;

use PHPStan\Analyser\Error;

use PHPStan\Command\AnalysisResult;

use PHPStan\Command\ErrorsConsoleStyle;

use PHPStan\Command\Output;

use PHPStan\Command\Symfony\SymfonyOutput;

use PHPStan\Command\Symfony\SymfonyStyle;

use PHPStan\ShouldNotHappenException;

use Symfony\Component\Console\Input\StringInput;

use Symfony\Component\Console\Output\StreamOutput;

use function array_map;

use function array_slice;

use function explode;

use function fopen;

use function implode;

use function in_array;

use function is_int;

use function range;

use function rewind;

use function rtrim;

use function stream_get_contents;

abstract class ErrorFormatterTestCase extends PHPStanTestCase

{

protected const DIRECTORY_PATH = '/data/folder/with space/and unicode 😃/project';

private const KIND_DECORATED = 'decorated';

private const KIND_PLAIN = 'plain';

private const KIND_VERBOSE = '+verbose';

private const KIND_NOT_VERBOSE = '+not-verbose';

/** @var array<string, StreamOutput> */

private array $outputStream = [];

/** @var array<string, Output> */

private array $output = [];

private function getOutputStream(bool $decorated = false, bool $verbose = false): StreamOutput

{

$kind = $decorated ? self::KIND_DECORATED : self::KIND_PLAIN;

$kind .= $verbose ? self::KIND_VERBOSE : self::KIND_NOT_VERBOSE;

if (!isset($this->outputStream[$kind])) {

$resource = fopen('php://memory', 'w', false);

if ($resource === false) {

throw new ShouldNotHappenException();

}

$verbosity = $verbose ? StreamOutput::VERBOSITY_VERBOSE : StreamOutput::VERBOSITY_NORMAL;

$this->outputStream[$kind] = new StreamOutput($resource, $verbosity, $decorated);

}

return $this->outputStream[$kind];

}

protected function getOutput(bool $decorated = false, bool $verbose = false): Output

{

$kind = $decorated ? self::KIND_DECORATED : self::KIND_PLAIN;

$kind .= $verbose ? self::KIND_VERBOSE : self::KIND_NOT_VERBOSE;

if (!isset($this->output[$kind])) {

$outputStream = $this->getOutputStream($decorated, $verbose);

$errorConsoleStyle = new ErrorsConsoleStyle(new StringInput(''), $outputStream);

$this->output[$kind] = new SymfonyOutput($outputStream, new SymfonyStyle($errorConsoleStyle));

}

return $this->output[$kind];

}

protected function getOutputContent(bool $decorated = false, bool $verbose = false): string

{

rewind($this->getOutputStream($decorated, $verbose)->getStream());

$contents = stream_get_contents($this->getOutputStream($decorated, $verbose)->getStream());

return $this->rtrimMultiline($contents);

}

/**

* @param array{int, int}|int $numFileErrors

*/

protected function getAnalysisResult(array|int $numFileErrors, int $numGenericErrors): AnalysisResult

{

if (is_int($numFileErrors)) {

$offsetFileErrors = 0;

} else {

[$offsetFileErrors, $numFileErrors] = $numFileErrors;

}

if (!in_array($numFileErrors, range(0, 7), true) ||

!in_array($offsetFileErrors, range(0, 7), true) ||

!in_array($numGenericErrors, range(0, 2), true)

) {

throw new ShouldNotHappenException();

}

$fileErrors = array_slice([

new Error('Foo', self::DIRECTORY_PATH . '/folder with unicode 😃/file name with "spaces" and unicode 😃.php', 4),

new Error('Foo<Bar>', self::DIRECTORY_PATH . '/foo.php', 1),

new Error("Bar\nBar2", self::DIRECTORY_PATH . '/foo.php', 5, tip: 'a tip'),

new Error("Bar\nBar2", self::DIRECTORY_PATH . '/folder with unicode 😃/file name with "spaces" and unicode 😃.php', 2),

new Error("Bar\nBar2", self::DIRECTORY_PATH . '/foo.php', null),

new Error('Foobar\\Buz', self::DIRECTORY_PATH . '/foo.php', 5, tip: 'a tip', identifier: 'foobar.buz'),

new Error('Error with @param or @phpstan-param and class@anonymous in the message.', self::DIRECTORY_PATH . '/bar.php', 5),

], $offsetFileErrors, $numFileErrors);

$genericErrors = array_slice([

'first generic error',

'second generic<error>',

], 0, $numGenericErrors);

return new AnalysisResult(

$fileErrors,

$genericErrors,

[],

[],

[],

false,

null,

true,

0,

false,

[],

);

}

private function rtrimMultiline(string $output): string

{

$result = array_map(static fn (string $line): string => rtrim($line, " \r\n"), explode("\n", $output));

return implode("\n", $result);

}

}