2016-12-08 04:38:57 +01:00
|
|
|
<?php
|
|
|
|
namespace Psalm\Tests;
|
|
|
|
|
|
|
|
use Psalm\Checker\FileChecker;
|
|
|
|
use Psalm\Checker\ProjectChecker;
|
|
|
|
use Psalm\IssueBuffer;
|
|
|
|
|
2017-04-25 05:45:02 +02:00
|
|
|
class JsonOutputTest extends TestCase
|
2016-12-08 04:38:57 +01:00
|
|
|
{
|
2017-01-13 20:07:23 +01:00
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
2016-12-08 04:38:57 +01:00
|
|
|
public function setUp()
|
|
|
|
{
|
2017-04-25 05:45:02 +02:00
|
|
|
// `TestCase::setUp()` creates its own ProjectChecker and Config instance, but we don't want to do that in this
|
|
|
|
// case, so don't run a `parent::setUp()` call here.
|
2016-12-08 04:38:57 +01:00
|
|
|
FileChecker::clearCache();
|
2017-07-25 22:11:02 +02:00
|
|
|
$this->file_provider = new Provider\FakeFileProvider();
|
|
|
|
|
|
|
|
$this->project_checker = new \Psalm\Checker\ProjectChecker(
|
|
|
|
$this->file_provider,
|
2017-10-15 17:57:44 +02:00
|
|
|
new Provider\FakeParserCacheProvider(),
|
2017-07-25 22:11:02 +02:00
|
|
|
false,
|
|
|
|
true,
|
|
|
|
ProjectChecker::TYPE_JSON
|
|
|
|
);
|
2017-02-01 01:22:05 +01:00
|
|
|
|
|
|
|
$config = new TestConfig();
|
|
|
|
$config->throw_exception = false;
|
|
|
|
$config->stop_on_first_error = false;
|
|
|
|
$this->project_checker->setConfig($config);
|
2016-12-08 04:38:57 +01:00
|
|
|
}
|
|
|
|
|
2017-01-13 20:07:23 +01:00
|
|
|
/**
|
2017-04-25 05:45:02 +02:00
|
|
|
* @dataProvider providerTestJsonOutputErrors
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2017-04-25 05:45:02 +02:00
|
|
|
* @param string $code
|
|
|
|
* @param string $message
|
2017-05-27 02:16:18 +02:00
|
|
|
* @param int $line_number
|
2017-04-25 05:45:02 +02:00
|
|
|
* @param string $error
|
2017-05-27 02:16:18 +02:00
|
|
|
*
|
2017-01-13 20:07:23 +01:00
|
|
|
* @return void
|
|
|
|
*/
|
2017-04-25 05:45:02 +02:00
|
|
|
public function testJsonOutputErrors($code, $message, $line_number, $error)
|
2016-12-08 04:38:57 +01:00
|
|
|
{
|
2017-07-25 22:11:02 +02:00
|
|
|
$this->addFile('somefile.php', $code);
|
2016-12-08 21:57:18 +01:00
|
|
|
|
2017-01-02 21:31:18 +01:00
|
|
|
$file_checker = new FileChecker('somefile.php', $this->project_checker);
|
2017-01-07 21:09:47 +01:00
|
|
|
$file_checker->visitAndAnalyzeMethods();
|
2017-07-25 22:11:02 +02:00
|
|
|
$issue_data = IssueBuffer::getIssuesData()[0];
|
2016-12-08 22:23:07 +01:00
|
|
|
|
|
|
|
$this->assertSame('somefile.php', $issue_data['file_path']);
|
2017-07-25 22:11:02 +02:00
|
|
|
$this->assertSame('error', $issue_data['severity']);
|
2017-04-25 05:45:02 +02:00
|
|
|
$this->assertSame($message, $issue_data['message']);
|
|
|
|
$this->assertSame($line_number, $issue_data['line_number']);
|
2016-12-08 22:23:07 +01:00
|
|
|
$this->assertSame(
|
2017-04-25 05:45:02 +02:00
|
|
|
$error,
|
|
|
|
substr($code, $issue_data['from'], $issue_data['to'] - $issue_data['from'])
|
2017-01-02 05:30:59 +01:00
|
|
|
);
|
|
|
|
}
|
2017-01-16 05:18:26 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function testJsonOutputForGetPsalmDotOrg()
|
|
|
|
{
|
|
|
|
$file_contents = '<?php
|
|
|
|
function psalmCanVerify(int $your_code) : ?string {
|
|
|
|
return $as_you . "type";
|
|
|
|
}
|
|
|
|
|
|
|
|
// and it supports PHP 5.4 - 7.1
|
|
|
|
echo CHANGE_ME;
|
|
|
|
|
|
|
|
if (rand(0, 100) > 10) {
|
|
|
|
$a = 5;
|
|
|
|
} else {
|
|
|
|
//$a = 2;
|
|
|
|
}
|
|
|
|
|
|
|
|
echo $a;';
|
|
|
|
|
2017-07-25 22:11:02 +02:00
|
|
|
$this->addFile(
|
2017-01-16 05:18:26 +01:00
|
|
|
'somefile.php',
|
|
|
|
$file_contents
|
|
|
|
);
|
|
|
|
|
|
|
|
$file_checker = new FileChecker('somefile.php', $this->project_checker);
|
|
|
|
$file_checker->visitAndAnalyzeMethods();
|
2017-07-25 22:11:02 +02:00
|
|
|
$issue_data = IssueBuffer::getIssuesData();
|
2017-05-27 02:05:57 +02:00
|
|
|
$this->assertSame(
|
2017-01-16 05:18:26 +01:00
|
|
|
[
|
|
|
|
[
|
2017-07-25 22:11:02 +02:00
|
|
|
'severity' => 'error',
|
2017-01-16 05:18:26 +01:00
|
|
|
'line_number' => 7,
|
2017-07-25 22:11:02 +02:00
|
|
|
'type' => 'UndefinedConstant',
|
2017-01-16 05:18:26 +01:00
|
|
|
'message' => 'Const CHANGE_ME is not defined',
|
|
|
|
'file_name' => 'somefile.php',
|
|
|
|
'file_path' => 'somefile.php',
|
|
|
|
'snippet' => 'echo CHANGE_ME;',
|
|
|
|
'from' => 126,
|
|
|
|
'to' => 135,
|
2017-07-25 22:11:02 +02:00
|
|
|
'snippet_from' => 121,
|
|
|
|
'snippet_to' => 136,
|
|
|
|
'column' => 6,
|
2017-01-16 05:18:26 +01:00
|
|
|
],
|
|
|
|
[
|
2017-07-25 22:11:02 +02:00
|
|
|
'severity' => 'error',
|
2017-01-16 05:18:26 +01:00
|
|
|
'line_number' => 15,
|
2017-07-25 22:11:02 +02:00
|
|
|
'type' => 'PossiblyUndefinedVariable',
|
2017-01-16 05:18:26 +01:00
|
|
|
'message' => 'Possibly undefined variable $a, first seen on line 10',
|
|
|
|
'file_name' => 'somefile.php',
|
|
|
|
'file_path' => 'somefile.php',
|
|
|
|
'snippet' => 'echo $a',
|
|
|
|
'from' => 202,
|
|
|
|
'to' => 204,
|
2017-07-25 22:11:02 +02:00
|
|
|
'snippet_from' => 197,
|
|
|
|
'snippet_to' => 204,
|
|
|
|
'column' => 6,
|
2017-01-16 05:18:26 +01:00
|
|
|
],
|
|
|
|
[
|
2017-07-25 22:11:02 +02:00
|
|
|
'severity' => 'error',
|
2017-01-16 05:18:26 +01:00
|
|
|
'line_number' => 3,
|
2017-07-25 22:11:02 +02:00
|
|
|
'type' => 'UndefinedVariable',
|
2017-01-16 05:18:26 +01:00
|
|
|
'message' => 'Cannot find referenced variable $as_you',
|
|
|
|
'file_name' => 'somefile.php',
|
|
|
|
'file_path' => 'somefile.php',
|
|
|
|
'snippet' => ' return $as_you . "type";',
|
|
|
|
'from' => 67,
|
|
|
|
'to' => 74,
|
2017-07-25 22:11:02 +02:00
|
|
|
'snippet_from' => 58,
|
|
|
|
'snippet_to' => 84,
|
|
|
|
'column' => 10,
|
2017-01-16 05:18:26 +01:00
|
|
|
],
|
|
|
|
[
|
2017-07-25 22:11:02 +02:00
|
|
|
'severity' => 'error',
|
2017-01-16 05:18:26 +01:00
|
|
|
'line_number' => 2,
|
2017-07-25 22:11:02 +02:00
|
|
|
'type' => 'MixedInferredReturnType',
|
2017-01-16 05:18:26 +01:00
|
|
|
'message' => 'Could not verify return type \'string|null\' for psalmCanVerify',
|
|
|
|
'file_name' => 'somefile.php',
|
|
|
|
'file_path' => 'somefile.php',
|
|
|
|
'snippet' => 'function psalmCanVerify(int $your_code) : ?string {
|
|
|
|
return $as_you . "type";
|
|
|
|
}',
|
|
|
|
'from' => 48,
|
|
|
|
'to' => 55,
|
2017-07-25 22:11:02 +02:00
|
|
|
'snippet_from' => 6,
|
|
|
|
'snippet_to' => 86,
|
|
|
|
'column' => 43,
|
2017-01-16 05:18:26 +01:00
|
|
|
],
|
|
|
|
],
|
|
|
|
$issue_data
|
|
|
|
);
|
|
|
|
}
|
2017-04-25 05:45:02 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function providerTestJsonOutputErrors()
|
|
|
|
{
|
|
|
|
return [
|
|
|
|
'returnTypeError' => [
|
|
|
|
'<?php
|
|
|
|
function fooFoo(int $a) : string {
|
|
|
|
return $a + 1;
|
|
|
|
}',
|
|
|
|
'message' => "The declared return type 'string' for fooFoo is incorrect, got 'int'",
|
|
|
|
'line' => 2,
|
2017-05-27 02:05:57 +02:00
|
|
|
'error' => 'string',
|
2017-04-25 05:45:02 +02:00
|
|
|
],
|
|
|
|
'undefinedVar' => [
|
|
|
|
'<?php
|
|
|
|
function fooFoo(int $a) : int {
|
|
|
|
return $b + 1;
|
|
|
|
}',
|
|
|
|
'message' => 'Cannot find referenced variable $b',
|
|
|
|
'line' => 3,
|
2017-05-27 02:05:57 +02:00
|
|
|
'error' => '$b',
|
2017-04-25 05:45:02 +02:00
|
|
|
],
|
|
|
|
'unknownParamClass' => [
|
|
|
|
'<?php
|
|
|
|
function fooFoo(Badger\Bodger $a) : Badger\Bodger {
|
|
|
|
return $a;
|
|
|
|
}',
|
|
|
|
'message' => 'Class or interface Badger\\Bodger does not exist',
|
|
|
|
'line' => 2,
|
2017-05-27 02:05:57 +02:00
|
|
|
'error' => 'Badger\\Bodger',
|
2017-04-25 05:45:02 +02:00
|
|
|
],
|
|
|
|
'missingReturnType' => [
|
|
|
|
'<?php
|
|
|
|
function fooFoo() {
|
|
|
|
return "hello";
|
|
|
|
}',
|
|
|
|
'message' => 'Method fooFoo does not have a return type, expecting string',
|
|
|
|
'line' => 2,
|
2017-05-27 02:05:57 +02:00
|
|
|
'error' => 'function fooFoo() {',
|
2017-04-25 05:45:02 +02:00
|
|
|
],
|
|
|
|
'wrongMultilineReturnType' => [
|
|
|
|
'<?php
|
|
|
|
/**
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
function fooFoo() {
|
|
|
|
return "hello";
|
|
|
|
}',
|
|
|
|
'message' => 'The declared return type \'int\' for fooFoo is incorrect, got \'string\'',
|
|
|
|
'line' => 3,
|
2017-05-27 02:05:57 +02:00
|
|
|
'error' => '@return int',
|
2017-04-25 05:45:02 +02:00
|
|
|
],
|
|
|
|
'wrongSingleLineReturnType' => [
|
|
|
|
'<?php
|
|
|
|
/** @return int */
|
|
|
|
function fooFoo() {
|
|
|
|
return "hello";
|
|
|
|
}',
|
|
|
|
'message' => 'The declared return type \'int\' for fooFoo is incorrect, got \'string\'',
|
|
|
|
'line' => 2,
|
2017-05-27 02:05:57 +02:00
|
|
|
'error' => '@return int',
|
|
|
|
],
|
2017-04-25 05:45:02 +02:00
|
|
|
];
|
|
|
|
}
|
2016-12-08 04:38:57 +01:00
|
|
|
}
|