1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-14 02:07:37 +01:00
psalm/tests/LanguageServer/SymbolLookupTest.php
2022-02-18 17:29:09 +00:00

722 lines
23 KiB
PHP

<?php
namespace Psalm\Tests\LanguageServer;
use LanguageServerProtocol\Position;
use LanguageServerProtocol\Range;
use Psalm\Context;
use Psalm\Internal\Analyzer\FileAnalyzer;
use Psalm\Internal\Analyzer\ProjectAnalyzer;
use Psalm\Internal\LanguageServer\Codebase;
use Psalm\Internal\LanguageServer\Reference;
use Psalm\Internal\Provider\FakeFileProvider;
use Psalm\Internal\Provider\Providers;
use Psalm\Tests\Internal\Provider\FakeFileReferenceCacheProvider;
use Psalm\Tests\Internal\Provider\ParserInstanceCacheProvider;
use Psalm\Tests\Internal\Provider\ProjectCacheProvider;
use Psalm\Tests\TestCase;
use Psalm\Tests\TestConfig;
class SymbolLookupTest extends TestCase
{
/** @var Codebase */
protected $codebase;
public function setUp(): void
{
parent::setUp();
$this->file_provider = new FakeFileProvider();
$config = new TestConfig();
$providers = new Providers(
$this->file_provider,
new ParserInstanceCacheProvider(),
null,
null,
new FakeFileReferenceCacheProvider(),
new ProjectCacheProvider()
);
$this->codebase = new Codebase($config, $providers);
$this->project_analyzer = new ProjectAnalyzer(
$config,
$providers,
null,
[],
1,
null,
$this->codebase
);
$this->project_analyzer->setPhpVersion('7.3', 'tests');
$this->project_analyzer->getCodebase()->store_node_types = true;
}
public function testSimpleSymbolLookup(): void
{
$config = $this->codebase->config;
$config->globals['$my_global'] = 'string';
$this->addFile(
'somefile.php',
'<?php
namespace B;
const APPLE = "🍏";
class A {
/** @var int|null */
protected $a;
const BANANA = "🍌";
public function foo() : void {
$a = 1;
echo $a;
}
}
function bar() : int {
return 5;
}
function baz(int $a) : int {
return $a;
}
function qux(int $a, int $b) : int {
return $a + $b;
}
$_SERVER;'
);
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
$this->analyzeFile('somefile.php', new Context());
$range = new Range(new Position(1, 1), new Position(1, 1));
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'B\A::foo()',
$range
)
);
$this->assertNotNull($information);
$this->assertSame("public function foo(): void", $information->code);
$this->assertSame("B\A::foo", $information->title);
$this->assertNull($information->description);
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'B\A::$a',
$range
)
);
$this->assertNotNull($information);
$this->assertSame('protected int|null $a', $information->code);
$this->assertSame('B\A::$a', $information->title);
$this->assertSame('', $information->description);
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'B\bar()',
$range
)
);
$this->assertNotNull($information);
$this->assertSame('function B\bar(): int', $information->code);
$this->assertSame('b\bar', $information->title);
$this->assertNull($information->description);
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'B\A::BANANA',
$range
)
);
$this->assertNotNull($information);
$this->assertSame('public const BANANA = 🍌;', $information->code);
$this->assertSame('B\A::BANANA', $information->title);
$this->assertNull($information->description);
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'B\baz()',
$range
)
);
$this->assertNotNull($information);
$this->assertSame("function B\baz(\n int \$a\n): int", $information->code);
$this->assertSame('b\baz', $information->title);
$this->assertNull($information->description);
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'B\qux()',
$range
)
);
$this->assertNotNull($information);
$this->assertSame("function B\qux(\n int \$a,\n int \$b\n): int", $information->code);
$this->assertSame('b\qux', $information->title);
$this->assertNull($information->description);
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'$_SERVER',
$range
)
);
$this->assertNotNull($information);
$this->assertSame("array<array-key, mixed>", $information->code);
$this->assertSame('$_SERVER', $information->title);
$this->assertNull($information->description);
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'$my_global',
$range
)
);
$this->assertNotNull($information);
$this->assertSame("string", $information->code);
$this->assertSame('$my_global', $information->title);
$this->assertNull($information->description);
}
public function testSimpleSymbolLookupGlobalConst(): void
{
$this->addFile(
'somefile.php',
'<?php
define("BANANA", "🍌");
const APPLE = "🍏";'
);
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
$range = new Range(new Position(1, 1), new Position(1, 1));
$this->analyzeFile('somefile.php', new Context());
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'APPLE',
$range
)
);
$this->assertNotNull($information);
$this->assertSame("const APPLE string", $information->code);
$this->assertSame("APPLE", $information->title);
$this->assertNull($information->description);
$information = $this->codebase->getMarkupContentForSymbol(
new Reference(
'somefile.php',
'BANANA',
$range
)
);
$this->assertNotNull($information);
$this->assertSame("const BANANA string", $information->code);
$this->assertSame("BANANA", $information->title);
$this->assertNull($information->description);
}
public function testSimpleSymbolLocation(): void
{
$this->addFile(
'somefile.php',
'<?php
namespace B;
class A {
/** @var int|null */
protected $a;
const BANANA = "nana";
public function foo() : void {
$a = 1;
echo $a;
}
}
function bar() : int {
return 5;
}'
);
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
$this->analyzeFile('somefile.php', new Context());
$range = new Range(new Position(1, 1), new Position(1, 1));
$method_symbol_location = $this->codebase->getSymbolLocation(new Reference(
'somefile.php',
'B\A::foo()',
$range
));
$this->assertNotNull($method_symbol_location);
$this->assertSame(10, $method_symbol_location->getLineNumber());
$this->assertSame(37, $method_symbol_location->getColumn());
$property_symbol_location = $this->codebase->getSymbolLocation(new Reference(
'somefile.php',
'B\A::$a',
$range
));
$this->assertNotNull($property_symbol_location);
$this->assertSame(6, $property_symbol_location->getLineNumber());
$this->assertSame(31, $property_symbol_location->getColumn());
$constant_symbol_location = $this->codebase->getSymbolLocation(new Reference(
'somefile.php',
'B\A::BANANA',
$range
));
$this->assertNotNull($constant_symbol_location);
$this->assertSame(8, $constant_symbol_location->getLineNumber());
$this->assertSame(27, $constant_symbol_location->getColumn());
$function_symbol_location = $this->codebase->getSymbolLocation(new Reference(
'somefile.php',
'B\bar()',
$range
));
$this->assertNotNull($function_symbol_location);
$this->assertSame(16, $function_symbol_location->getLineNumber());
$this->assertSame(26, $function_symbol_location->getColumn());
$function_symbol_location = $this->codebase->getSymbolLocation(new Reference(
'somefile.php',
'257-259',
$range
));
$this->assertNotNull($function_symbol_location);
$this->assertSame(11, $function_symbol_location->getLineNumber());
$this->assertSame(25, $function_symbol_location->getColumn());
}
public function testSymbolLookupAfterAlteration(): void
{
$config = $this->codebase->config;
$config->throw_exception = false;
$this->addFile(
'somefile.php',
'<?php
namespace B;
class A {
/** @var int|null */
protected $a;
public function foo() : voi {
$a = 1;
$b = $this->a;
$c = $b;
echo $a;
}
public function bar() : void {
$a = 2;
echo $a;
}
}'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
$this->codebase->addTemporaryFileChanges(
'somefile.php',
'<?php
namespace B;
class A {
/** @var int|null */
protected $a;
public function foo() : void {
$a = 1;
$b = $this->a;
$c = $b;
echo $a;
}
public function bar() : void {
$a = 2;
echo $a;
}
}'
);
$this->codebase->reloadFiles($this->project_analyzer, ['somefile.php']);
$this->codebase->analyzer->analyzeFiles($this->project_analyzer, 1, false);
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(10, 30));
$this->assertNotNull($reference);
$this->assertSame('245-246:int|null', $reference->symbol);
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(12, 30));
$this->assertNotNull($reference);
$this->assertSame('213-214:1', $reference->symbol);
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(17, 30));
$this->assertNotNull($reference);
$this->assertSame('425-426:2', $reference->symbol);
}
public function testGetSymbolPositionMissingArg(): void
{
$config = $this->codebase->config;
$config->throw_exception = false;
$this->addFile(
'somefile.php',
'<?php
namespace B;
class A {
public function foo(int $i) : string {
return "hello";
}
public function bar() : void {
$this->foo();
}
}'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(9, 33));
$this->assertNotNull($reference);
$this->assertSame('B\A::foo()', $reference->symbol);
}
public function testGetSymbolPositionGlobalVariable(): void
{
$this->codebase->reportUnusedVariables();
$config = $this->codebase->config;
$config->throw_exception = false;
$config->globals['$my_global'] = 'string';
$this->addFile(
'somefile.php',
'<?php
function foo() : void {
global $my_global;
echo $my_global;
}'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(2, 31));
$this->assertNotNull($reference);
$this->assertSame('$my_global', $reference->symbol);
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(3, 28));
$this->assertNotNull($reference);
$this->assertSame('73-82:string', $reference->symbol);
}
public function testGetSymbolPositionNullableArg(): void
{
$config = $this->codebase->config;
$config->throw_exception = false;
$this->addFile(
'somefile.php',
'<?php
namespace B;
class AClass {
}
function B( ?AClass $class ) {
}'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(4, 33));
$this->assertNotNull($reference);
$this->assertSame('B\AClass', $reference->symbol);
}
public function testGetSymbolPositionMethodWrongReturnType(): void
{
$config = $this->codebase->config;
$config->throw_exception = false;
$this->addFile(
'somefile.php',
'<?php
namespace B;
class AClass {
/**
* @return Some
*/
protected function get_command() : AClass {
}
}
'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(6, 60));
$this->assertNotNull($reference);
$this->assertSame('B\AClass', $reference->symbol);
}
public function testGetSymbolPositionUseStatement(): void
{
$config = $this->codebase->config;
$config->throw_exception = false;
$this->addFile(
'somefile.php',
'<?php
namespace B;
use StreamWrapper;
'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(2, 25));
$this->assertNotNull($reference);
$this->assertSame('StreamWrapper', $reference->symbol);
}
public function testGetSymbolPositionRange(): void
{
$config = $this->codebase->config;
$config->throw_exception = false;
$this->addFile(
'somefile.php',
'<?php
namespace B;
function foo() : string {
}
$active_symbol = foo();'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
// This is focusing the $active_symbol variable, the LSP Range that is
// returned should also point to the same variable (that's where hover popovers will show)
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(6, 26));
$this->assertNotNull($reference);
$this->assertSame(16, $reference->range->start->character);
$this->assertSame(30, $reference->range->end->character);
}
public function testGetTypeInDocblock(): void
{
$config = $this->codebase->config;
$config->throw_exception = false;
$this->addFile(
'somefile.php',
'<?php
namespace B;
class A {
/** @var \Exception|null */
public $prop;
}'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
$reference = $this->codebase->getReferenceAtPosition('somefile.php', new Position(4, 35));
$this->assertNotNull($reference);
$this->assertSame('Exception', $reference->symbol);
}
/**
* @return array<int, array{0: Position, 1: ?string, 2: ?int, 3: ?int}>
*/
public function providerGetSignatureHelp(): array
{
return [
[new Position(5, 34), null, null, null],
[new Position(5, 35), 'B\A::foo', 0, 2],
[new Position(5, 36), null, null, null],
[new Position(6, 34), null, null, null],
[new Position(6, 35), 'B\A::foo', 0, 2],
[new Position(6, 40), 'B\A::foo', 0, 2],
[new Position(6, 41), 'B\A::foo', 1, 2],
[new Position(6, 47), 'B\A::foo', 1, 2],
[new Position(6, 48), null, null, null],
[new Position(7, 40), 'B\A::foo', 0, 2],
[new Position(7, 41), 'B\A::foo', 1, 2],
[new Position(7, 42), 'B\A::foo', 1, 2],
[new Position(8, 40), 'B\A::foo', 0, 2],
[new Position(8, 46), 'B\A::bar', 0, 1],
[new Position(8, 47), 'B\A::foo', 0, 2],
[new Position(10, 40), 'B\A::staticfoo', 0, 1],
// [new Position(12, 28), 'B\foo', 0, 1],
[new Position(14, 30), 'B\A::__construct', 0, 0],
[new Position(16, 31), 'strlen', 0, 1],
];
}
/**
* @dataProvider providerGetSignatureHelp
*/
public function testGetSignatureHelp(
Position $position,
?string $expected_symbol,
?int $expected_argument_number,
?int $expected_param_count
): void {
$config = $this->codebase->config;
$config->throw_exception = false;
$this->addFile(
'somefile.php',
'<?php
namespace B;
class A {
public function foo(string $a, array $b) {
$this->foo();
$this->foo("Foo", "Bar");
$this->foo("Foo", );
$this->foo($this->bar());
self::staticFoo();
foo();
new A();
strlen();
}
public function bar(string $a) {}
public static function staticFoo(string $a) {}
public function __construct() {}
}
function foo(string $a) {
}'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
$reference_location = $this->codebase->getFunctionArgumentAtPosition('somefile.php', $position);
if ($expected_symbol !== null) {
$this->assertNotNull($reference_location);
[$symbol, $argument_number] = $reference_location;
$this->assertSame($expected_symbol, $symbol);
$this->assertSame($expected_argument_number, $argument_number);
$symbol_information = $this->codebase->getSignatureInformation($reference_location[0]);
if ($expected_param_count === null) {
$this->assertNull($symbol_information);
} else {
$this->assertNotNull($symbol_information);
$this->assertNotNull($symbol_information->parameters);
$this->assertCount($expected_param_count, $symbol_information->parameters);
}
} else {
$this->assertNull($reference_location);
}
}
public function testGetSignatureHelpIncludesParamDescription(): void
{
$config = $this->codebase->config;
$config->throw_exception = false;
$this->addFile(
'somefile.php',
'<?php
namespace B;
/**
* @param string $a The first param, a.
*/
function foo(string $a) {
}
foo();'
);
$this->codebase->file_provider->openFile('somefile.php');
$this->codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());
$reference_location = $this->codebase->getFunctionArgumentAtPosition('somefile.php', new Position(7, 20));
$this->assertNotNull($reference_location);
$symbol_information = $this->codebase->getSignatureInformation($reference_location[0], 'somefile.php');
$this->assertNotNull($symbol_information);
$this->assertNotNull($symbol_information->parameters);
$this->assertEquals('The first param, a.', $symbol_information->parameters[0]->documentation);
}
}