1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-13 09:47:29 +01:00
psalm/tests/Traits/ValidCodeAnalysisTestTrait.php
2023-10-19 14:00:20 +02:00

121 lines
3.5 KiB
PHP

<?php
namespace Psalm\Tests\Traits;
use Psalm\Config;
use Psalm\Context;
use function str_replace;
use function strlen;
use function strpos;
use function strtoupper;
use function substr;
use function version_compare;
use const PHP_OS;
use const PHP_VERSION;
use const PHP_VERSION_ID;
trait ValidCodeAnalysisTestTrait
{
/**
* @return iterable<
* string,
* array{
* code: string,
* assertions?: array<string, string>,
* ignored_issues?: list<string>,
* php_version?: string,
* }
* >
*/
abstract public function providerValidCodeParse(): iterable;
/**
* @dataProvider providerValidCodeParse
* @param array<string, string> $assertions
* @param list<string> $ignored_issues
* @small
*/
public function testValidCode(
string $code,
array $assertions = [],
array $ignored_issues = [],
string $php_version = '7.4'
): void {
$test_name = $this->getTestName();
if (strpos($test_name, 'PHP80-') !== false) {
if (version_compare(PHP_VERSION, '8.0.0', '<')) {
$this->markTestSkipped('Test case requires PHP 8.0.');
}
} elseif (strpos($test_name, 'PHP81-') !== false) {
if (version_compare(PHP_VERSION, '8.1.0', '<')) {
$this->markTestSkipped('Test case requires PHP 8.1.');
}
} elseif (strpos($test_name, 'SKIPPED-') !== false) {
$this->markTestSkipped('Skipped due to a bug.');
}
// sanity check - do we have a PHP tag?
if (strpos($code, '<?php') === false) {
$this->fail('Test case must have a <?php tag');
}
foreach ($ignored_issues as $issue_name) {
Config::getInstance()->setCustomErrorLevel($issue_name, Config::REPORT_SUPPRESS);
}
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
$code = str_replace("\n", "\r\n", $code);
}
$context = new Context();
$this->project_analyzer->setPhpVersion($php_version, 'tests');
$codebase = $this->project_analyzer->getCodebase();
$codebase->enterServerMode();
$codebase->config->visitPreloadedStubFiles($codebase);
// avoid MethodSignatureMismatch for __unserialize/() when extending DateTime
if (PHP_VERSION_ID >= 8_02_00) {
$this->addStubFile(
'stubOne.phpstub',
'<?php
namespace {
interface DateTimeInterface {
public function __unserialize(mixed[] $data) {}
}
}
',
);
}
$file_path = self::$src_dir_path . 'somefile.php';
$this->addFile($file_path, $code);
$this->analyzeFile($file_path, $context);
$actual_vars = [];
foreach ($assertions as $var => $_) {
$exact = false;
if ($var && strpos($var, '===') === strlen($var) - 3) {
$var = substr($var, 0, -3);
$exact = true;
}
if (isset($context->vars_in_scope[$var])) {
$value = $context->vars_in_scope[$var]->getId($exact);
if ($exact) {
$actual_vars[$var . '==='] = $value;
} else {
$actual_vars[$var] = $value;
}
}
}
$this->assertSame($assertions, $actual_vars);
}
}