1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-13 09:47:29 +01:00
psalm/tests/Cache/CacheTest.php

204 lines
6.6 KiB
PHP

<?php
declare(strict_types=1);
namespace Psalm\Tests\Cache;
use Psalm\Config;
use Psalm\Internal\Analyzer\IssueData;
use Psalm\Internal\Analyzer\ProjectAnalyzer;
use Psalm\Internal\IncludeCollector;
use Psalm\Internal\Provider\FakeFileProvider;
use Psalm\Internal\Provider\Providers;
use Psalm\Internal\RuntimeCaches;
use Psalm\IssueBuffer;
use Psalm\Tests\Internal\Provider\ClassLikeStorageInstanceCacheProvider;
use Psalm\Tests\Internal\Provider\FakeFileReferenceCacheProvider;
use Psalm\Tests\Internal\Provider\FileStorageInstanceCacheProvider;
use Psalm\Tests\Internal\Provider\ParserInstanceCacheProvider;
use Psalm\Tests\Internal\Provider\ProjectCacheProvider;
use Psalm\Tests\TestCase;
use function microtime;
use function str_replace;
use const DIRECTORY_SEPARATOR;
class CacheTest extends TestCase
{
public function setUp(): void
{
parent::setUp();
RuntimeCaches::clearAll();
}
public function tearDown(): void
{
RuntimeCaches::clearAll();
parent::tearDown();
}
/**
* @param array<string, list<IssueData>> $issue_data
* @return array<string, list<string>>
*/
private static function normalizeIssueData(array $issue_data): array
{
$return = [];
foreach ($issue_data as $issue_data_per_file) {
foreach ($issue_data_per_file as $one_issue_data) {
$file_name = str_replace(DIRECTORY_SEPARATOR, '/', $one_issue_data->file_name);
$return[$file_name][] = $one_issue_data->type . ': ' . $one_issue_data->message;
}
}
return $return;
}
/**
* @param list<array{
* files: array<string, string|null>,
* issues?: array<string, list<string>>,
* }> $interactions
* @dataProvider provideCacheInteractions
*/
public function testCacheInteractions(
array $interactions,
): void {
$config = Config::loadFromXML(
__DIR__ . DIRECTORY_SEPARATOR . 'test_base_dir',
<<<'XML'
<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
</projectFiles>
</psalm>
XML,
);
$config->setIncludeCollector(new IncludeCollector());
$file_provider = new FakeFileProvider();
$providers = new Providers(
$file_provider,
new ParserInstanceCacheProvider(),
new FileStorageInstanceCacheProvider(),
new ClassLikeStorageInstanceCacheProvider(),
new FakeFileReferenceCacheProvider(),
new ProjectCacheProvider(),
);
foreach ($interactions as $interaction) {
foreach ($interaction['files'] as $file_path => $file_contents) {
$file_path = $config->base_dir . str_replace('/', DIRECTORY_SEPARATOR, $file_path);
if ($file_contents === null) {
$file_provider->deleteFile($file_path);
} else {
$file_provider->registerFile($file_path, $file_contents);
}
}
RuntimeCaches::clearAll();
$start_time = microtime(true);
$project_analyzer = new ProjectAnalyzer($config, $providers);
$project_analyzer->check($config->base_dir, true);
$project_analyzer->finish($start_time, PSALM_VERSION);
$issues = self::normalizeIssueData(IssueBuffer::getIssuesData());
self::assertSame($interaction['issues'] ?? [], $issues);
}
}
/**
* @return iterable<string, list{
* list<array{
* files: array<string, string|null>,
* issues?: array<string, list<string>>,
* }>,
* }>
*/
public static function provideCacheInteractions(): iterable
{
yield 'deletedFileInvalidatesReferencingMethod' => [
[
[
'files' => [
'/src/A.php' => <<<'PHP'
<?php
class A {
public function do(B $b): void
{
$b->do();
}
}
PHP,
'/src/B.php' => <<<'PHP'
<?php
class B {
public function do(): void
{
echo 'B';
}
}
PHP,
],
],
[
'files' => [
'/src/B.php' => null,
],
'issues' => [
'/src/A.php' => [
'UndefinedClass: Class, interface or enum named B does not exist',
],
],
],
],
];
yield 'classPropertyTypeChangeInvalidatesReferencingMethod' => [
[
[
'files' => [
'/src/A.php' => <<<'PHP'
<?php
class A {
public function foo(B $b): int
{
return $b->value;
}
}
PHP,
'/src/B.php' => <<<'PHP'
<?php
class B {
public ?int $value = 0;
}
PHP,
],
'issues' => [
'/src/A.php' => [
"NullableReturnStatement: The declared return type 'int' for A::foo is not nullable, but the function returns 'int|null'",
"InvalidNullableReturnType: The declared return type 'int' for A::foo is not nullable, but 'int|null' contains null",
],
],
],
[
'files' => [
'/src/B.php' => <<<'PHP'
<?php
class B {
public int $value = 0;
}
PHP,
],
'issues' => [],
],
],
];
}
}