1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 16:59:45 +01:00
psalm/tests/CodebaseTest.php
Matthew Brown da42be175f Apply PHPCS fixes
Fixes #1880
2019-07-05 16:27:53 -04:00

203 lines
6.5 KiB
PHP

<?php
namespace Psalm\Tests;
use function array_values;
use function get_class;
use PhpParser\Node\Stmt\ClassLike;
use Psalm\Codebase;
use Psalm\Context;
use Psalm\FileManipulation;
use Psalm\FileSource;
use Psalm\Plugin\Hook\AfterClassLikeVisitInterface;
use Psalm\PluginRegistrationSocket;
use Psalm\Storage\ClassLikeStorage;
use Psalm\Tests\Internal\Provider\ClassLikeStorageInstanceCacheProvider;
use Psalm\Type;
class CodebaseTest extends TestCase
{
/** @var Codebase */
private $codebase;
/** @return void */
public function setUp() : void
{
parent::setUp();
$this->codebase = $this->project_analyzer->getCodebase();
}
/**
* @test
* @dataProvider typeContainments
*
* @return void
*/
public function isTypeContainedByType(string $input, string $container, bool $expected)
{
$input = Type::parseString($input);
$container = Type::parseString($container);
$this->assertSame(
$expected,
$this->codebase->isTypeContainedByType($input, $container),
'Expected ' . $input->getId() . ($expected ? ' ' : ' not ')
. 'to be contained in ' . $container->getId()
);
}
/** @return iterable<int,array{string,string,bool}> */
public function typeContainments()
{
yield ['int', 'int|string', true];
yield ['int|string', 'int', false];
// This fails with 'could not get class storage' :(
// yield ['RuntimeException', 'Exception', true];
// yield ['Exception', 'RuntimeException', false];
}
/**
* @test
* @dataProvider typeIntersections
*
* @return void
*/
public function canTypeBeContainedByType(string $input, string $container, bool $expected)
{
$input = Type::parseString($input);
$container = Type::parseString($container);
$this->assertSame(
$expected,
$this->codebase->canTypeBeContainedByType($input, $container),
'Expected ' . $input->getId() . ($expected ? ' ' : ' not ')
. 'to be contained in ' . $container->getId()
);
}
/** @return iterable<int,array{string,string,bool}> */
public function typeIntersections()
{
yield ['int', 'int|string', true];
yield ['int|string', 'int', true];
yield ['int|string', 'string|float', true];
yield ['int', 'string', false];
yield ['int|string', 'array|float', false];
}
/**
* @test
* @dataProvider iterableParams
*
* @param array{string,string} $expected
*
* @return void
*/
public function getKeyValueParamsForTraversableObject(string $input, array $expected)
{
list($input) = array_values(Type::parseString($input)->getTypes());
$expected_key_type = Type::parseString($expected[0]);
$expected_value_type = Type::parseString($expected[1]);
$actual = $this->codebase->getKeyValueParamsForTraversableObject($input);
$this->assertTrue(
$expected_key_type->equals($actual[0]),
'Expected ' . $input->getId() . ' to have ' . $expected_key_type
. ' but got ' . $actual[0]->getId()
);
$this->assertTrue(
$expected_value_type->equals($actual[1]),
'Expected ' . $input->getId() . ' to have ' . $expected_value_type
. ' but got ' . $actual[1]->getId()
);
}
/** @return iterable<int,array{string,array{string,string}}> */
public function iterableParams()
{
yield ['iterable<int,string>', ['int', 'string']];
yield ['iterable<int|string,bool|float>', ['int|string', 'bool|float']];
}
/**
* @test
*
* @return void
*/
public function customMetadataIsPersisted()
{
$this->addFile(
'somefile.php',
'<?php
class C {
/** @var string */
private $prop = "";
/** @return void */
public function m(int $_i = 1) {}
}
'
);
$hook = new class implements AfterClassLikeVisitInterface {
/**
* @param FileManipulation[] $file_replacements
*
* @return void
*/
public static function afterClassLikeVisit(
ClassLike $stmt,
ClassLikeStorage $storage,
FileSource $statements_source,
Codebase $codebase,
array &$file_replacements = []
) {
/** @var ClassLikeStorage $storage */
if ($storage->name === 'C') {
$storage->custom_metadata['a'] = 'b';
$storage->methods['m']->custom_metadata['c'] = 'd';
$storage->properties['prop']->custom_metadata['e'] = 'f';
$storage->methods['m']->params[0]->custom_metadata['g'] = 'h';
/** @var Codebase $codebase */
$codebase->file_storage_provider->get('somefile.php')->custom_metadata['i'] = 'j';
}
}
};
(new PluginRegistrationSocket($this->codebase->config, $this->codebase))
->registerHooksFromClass(get_class($hook));
$this->codebase->classlike_storage_provider->cache = new ClassLikeStorageInstanceCacheProvider;
$this->analyzeFile('somefile.php', new Context);
$this->codebase->classlike_storage_provider->remove('C');
$this->codebase->exhumeClassLikeStorage('C', 'somefile.php');
$class_storage = $this->codebase->classlike_storage_provider->get('C');
$file_storage = $this->codebase->file_storage_provider->get('somefile.php');
$this->assertSame('b', $class_storage->custom_metadata['a']);
$this->assertSame('d', $class_storage->methods['m']->custom_metadata['c']);
$this->assertSame('f', $class_storage->properties['prop']->custom_metadata['e']);
$this->assertSame('h', $class_storage->methods['m']->params[0]->custom_metadata['g']);
$this->assertSame('j', $file_storage->custom_metadata['i']);
}
/**
* @test
*
* @return void
*/
public function classExtendsRejectsUnpopulatedClasslikes()
{
$this->codebase->classlike_storage_provider->create('A');
$this->codebase->classlike_storage_provider->create('B');
$this->expectException(\Psalm\Exception\UnpopulatedClasslikeException::class);
$this->codebase->classExtends('A', 'B');
}
}