1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 16:59:45 +01:00
psalm/tests/JsonOutputTest.php
2022-12-18 13:20:31 -06:00

154 lines
5.2 KiB
PHP

<?php
namespace Psalm\Tests;
use Psalm\Context;
use Psalm\Internal\Analyzer\ProjectAnalyzer;
use Psalm\Internal\Provider\FakeFileProvider;
use Psalm\Internal\Provider\Providers;
use Psalm\Internal\RuntimeCaches;
use Psalm\IssueBuffer;
use Psalm\Report;
use Psalm\Report\ReportOptions;
use Psalm\Tests\Internal\Provider\FakeParserCacheProvider;
use function substr;
class JsonOutputTest extends TestCase
{
public function setUp(): void
{
// `TestCase::setUp()` creates its own ProjectAnalyzer and Config instance, but we don't want to do that in this
// case, so don't run a `parent::setUp()` call here.
RuntimeCaches::clearAll();
$this->file_provider = new FakeFileProvider();
$config = new TestConfig();
$config->throw_exception = false;
$stdout_report_options = new ReportOptions();
$stdout_report_options->format = Report::TYPE_JSON;
$this->project_analyzer = new ProjectAnalyzer(
$config,
new Providers(
$this->file_provider,
new FakeParserCacheProvider(),
),
$stdout_report_options,
);
$this->project_analyzer->getCodebase()->reportUnusedCode();
}
/**
* @dataProvider providerTestJsonOutputErrors
*/
public function testJsonOutputErrors(
string $code,
int $error_count,
string $message,
int $line_number,
string $error
): void {
$this->addFile('somefile.php', $code);
$this->analyzeFile('somefile.php', new Context());
$all_issue_data = IssueBuffer::getIssuesData()['somefile.php'];
$this->assertCount($error_count, $all_issue_data);
$issue_data = $all_issue_data[0];
$this->assertSame('somefile.php', $issue_data->file_path);
$this->assertSame('error', $issue_data->severity);
$this->assertSame($message, $issue_data->message);
$this->assertSame($line_number, $issue_data->line_from);
$this->assertSame(
$error,
substr($code, $issue_data->from, $issue_data->to - $issue_data->from),
);
}
/**
* @return array<string,array{code:string,error_count:int,message:string,line:int,error:string}>
*/
public function providerTestJsonOutputErrors(): array
{
return [
'returnTypeError' => [
'code' => '<?php
function fooFoo(int $a): string {
return $a + 1;
}',
'error_count' => 2,
'message' => "The inferred type 'int' does not match the declared return type 'string' for fooFoo",
'line' => 3,
'error' => '$a + 1',
],
'undefinedVar' => [
'code' => '<?php
function fooFoo(int $a): int {
return $b + 1;
}',
'error_count' => 5,
'message' => 'Cannot find referenced variable $b',
'line' => 3,
'error' => '$b',
],
'unknownParamClass' => [
'code' => '<?php
function fooFoo(Badger\Bodger $a): Badger\Bodger {
return $a;
}',
'error_count' => 3,
'message' => 'Class, interface or enum named Badger\\Bodger does not exist',
'line' => 2,
'error' => 'Badger\\Bodger',
],
'missingReturnType' => [
'code' => '<?php
function fooFoo() {
return "hello";
}',
'error_count' => 1,
'message' => "Method fooFoo does not have a return type, expecting 'hello'",
'line' => 2,
'error' => 'fooFoo',
],
'wrongMultilineReturnType' => [
'code' => '<?php
/**
* @return int
*/
function fooFoo() {
return "hello";
}',
'error_count' => 2,
'message' => "The inferred type ''hello'' does not match the declared return type 'int' for fooFoo",
'line' => 6,
'error' => '"hello"',
],
'assertCancelsMixedAssignment' => [
'code' => '<?php
$a = $_GET["hello"];
assert(is_string($a));
if (is_string($a)) {}',
'error_count' => 1,
'message' => 'Docblock-defined type string for $a is always string',
'line' => 4,
'error' => 'is_string($a)',
],
'singleIssueForTypeDifference' => [
'code' => '<?php
function fooFoo(?string $a, ?string $b): void {
if ($a || $b) {
if ($a || $b) {}
}
}',
'error_count' => 1,
'message' => 'Operand of type non-falsy-string is always truthy',
'line' => 4,
'error' => '$b',
],
];
}
}