mirror of
https://github.com/danog/psalm.git
synced 2024-11-27 04:45:20 +01:00
565 lines
18 KiB
PHP
565 lines
18 KiB
PHP
<?php
|
|
|
|
namespace Psalm\Tests;
|
|
|
|
use DOMDocument;
|
|
use DOMElement;
|
|
use Mockery;
|
|
use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
|
|
use Mockery\MockInterface;
|
|
use Psalm\ErrorBaseline;
|
|
use Psalm\Exception\ConfigException;
|
|
use Psalm\Internal\Analyzer\IssueData;
|
|
use Psalm\Internal\Provider\FileProvider;
|
|
use Psalm\Internal\RuntimeCaches;
|
|
|
|
use function count;
|
|
|
|
use const LIBXML_NOBLANKS;
|
|
|
|
class ErrorBaselineTest extends TestCase
|
|
{
|
|
use MockeryPHPUnitIntegration;
|
|
|
|
/** @var FileProvider&MockInterface */
|
|
private $fileProvider;
|
|
|
|
public function setUp(): void
|
|
{
|
|
RuntimeCaches::clearAll();
|
|
$this->fileProvider = Mockery::mock(FileProvider::class);
|
|
}
|
|
|
|
public function testLoadShouldParseXmlBaselineToPhpArray(): void
|
|
{
|
|
$baselineFilePath = 'baseline.xml';
|
|
|
|
$this->fileProvider->allows()->fileExists($baselineFilePath)->andReturns(true);
|
|
$this->fileProvider->allows()->getContents($baselineFilePath)->andReturns(
|
|
'<?xml version="1.0" encoding="UTF-8"?>
|
|
<files>
|
|
<file src="sample/sample-file.php">
|
|
<MixedAssignment>
|
|
<code>foo</code>
|
|
<code>bar</code>
|
|
</MixedAssignment>
|
|
</file>
|
|
<file src="sample\sample-file2.php">
|
|
<PossiblyUnusedMethod>
|
|
<code>foo</code>
|
|
<code>bar</code>
|
|
</PossiblyUnusedMethod>
|
|
</file>
|
|
</files>',
|
|
);
|
|
|
|
$expectedParsedBaseline = [
|
|
'sample/sample-file.php' => [
|
|
'MixedAssignment' => ['o' => 2, 's' => ['foo', 'bar']],
|
|
],
|
|
'sample/sample-file2.php' => [
|
|
'PossiblyUnusedMethod' => ['o' => 2, 's' => ['foo', 'bar']],
|
|
],
|
|
];
|
|
|
|
$this->assertSame(
|
|
$expectedParsedBaseline,
|
|
ErrorBaseline::read($this->fileProvider, $baselineFilePath),
|
|
);
|
|
}
|
|
|
|
public function testLoadShouldIgnoreLineEndingsInIssueSnippet(): void
|
|
{
|
|
$baselineFilePath = 'baseline.xml';
|
|
|
|
$this->fileProvider->allows()->fileExists($baselineFilePath)->andReturns(true);
|
|
$this->fileProvider->allows()->getContents($baselineFilePath)->andReturns(
|
|
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>
|
|
<files>
|
|
<file src=\"sample/sample-file.php\">
|
|
<MixedAssignment>
|
|
<code>foo\r</code>
|
|
</MixedAssignment>
|
|
</file>
|
|
</files>",
|
|
);
|
|
|
|
$expectedParsedBaseline = [
|
|
'sample/sample-file.php' => [
|
|
'MixedAssignment' => ['o' => 1, 's' => ['foo']],
|
|
],
|
|
];
|
|
|
|
$this->assertSame(
|
|
$expectedParsedBaseline,
|
|
ErrorBaseline::read($this->fileProvider, $baselineFilePath),
|
|
);
|
|
}
|
|
|
|
public function testShouldIgnoreCarriageReturnInMultilineSnippets(): void
|
|
{
|
|
$baselineFilePath = 'baseline.xml';
|
|
|
|
$this->fileProvider->allows()->fileExists($baselineFilePath)->andReturns(true);
|
|
$this->fileProvider->allows()->getContents($baselineFilePath)->andReturns(
|
|
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>
|
|
<files>
|
|
<file src=\"sample/sample-file.php\">
|
|
<MixedAssignment>
|
|
<code>
|
|
foo
|
|
bar
|
|
</code>
|
|
</MixedAssignment>
|
|
</file>
|
|
</files>",
|
|
);
|
|
|
|
$expectedParsedBaseline = [
|
|
'sample/sample-file.php' => [
|
|
'MixedAssignment' => ['o' => 1, 's' => ["foo\nbar"]],
|
|
],
|
|
];
|
|
|
|
$this->assertSame(
|
|
$expectedParsedBaseline,
|
|
ErrorBaseline::read($this->fileProvider, $baselineFilePath),
|
|
);
|
|
}
|
|
|
|
public function testLoadShouldThrowExceptionWhenFilesAreNotDefinedInBaselineFile(): void
|
|
{
|
|
$this->expectException(ConfigException::class);
|
|
|
|
$baselineFile = 'baseline.xml';
|
|
|
|
$this->fileProvider->allows()->fileExists($baselineFile)->andReturns(true);
|
|
$this->fileProvider->allows()->getContents($baselineFile)->andReturns(
|
|
'<?xml version="1.0" encoding="UTF-8"?>
|
|
<other>
|
|
</other>
|
|
',
|
|
);
|
|
|
|
ErrorBaseline::read($this->fileProvider, $baselineFile);
|
|
}
|
|
|
|
public function testLoadShouldThrowExceptionWhenBaselineFileDoesNotExist(): void
|
|
{
|
|
$this->expectException(ConfigException::class);
|
|
|
|
$baselineFile = 'baseline.xml';
|
|
|
|
$this->fileProvider->expects()->fileExists($baselineFile)->andReturns(false);
|
|
|
|
ErrorBaseline::read($this->fileProvider, $baselineFile);
|
|
}
|
|
|
|
public function testCountTotalIssuesShouldReturnCorrectNumber(): void
|
|
{
|
|
$existingIssues = [
|
|
'sample/sample-file.php' => [
|
|
'MixedAssignment' => ['o' => 2, 's' => ['bar']],
|
|
'MixedOperand' => ['o' => 2, 's' => []],
|
|
],
|
|
'sample/sample-file2.php' => [
|
|
'TypeCoercion' => ['o' => 1, 's' => []],
|
|
],
|
|
];
|
|
|
|
$totalIssues = ErrorBaseline::countTotalIssues($existingIssues);
|
|
|
|
$this->assertSame($totalIssues, 5);
|
|
}
|
|
|
|
public function testCreateShouldAggregateIssuesPerFile(): void
|
|
{
|
|
$baselineFile = 'baseline.xml';
|
|
|
|
$this->fileProvider = Mockery::spy(FileProvider::class);
|
|
|
|
|
|
ErrorBaseline::create(
|
|
$this->fileProvider,
|
|
$baselineFile,
|
|
[
|
|
'sample/sample-file.php' => [
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedAssignment',
|
|
'Message',
|
|
'sample/sample-file.php',
|
|
'sample/sample-file.php',
|
|
'foo',
|
|
'foo',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedAssignment',
|
|
'Message',
|
|
'sample/sample-file.php',
|
|
'sample/sample-file.php',
|
|
'bar',
|
|
'bar',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedAssignment',
|
|
'Message',
|
|
'sample/sample-file.php',
|
|
'sample/sample-file.php',
|
|
'bat',
|
|
'bat',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedOperand',
|
|
'Message',
|
|
'sample/sample-file.php',
|
|
'sample/sample-file.php',
|
|
'bing',
|
|
'bing',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
new IssueData(
|
|
'info',
|
|
0,
|
|
0,
|
|
'AssignmentToVoid',
|
|
'Message',
|
|
'sample/sample-file.php',
|
|
'sample/sample-file.php',
|
|
'bong',
|
|
'bong',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
],
|
|
'sample/sample-file2.php' => [
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedAssignment',
|
|
'Message',
|
|
'sample/sample-file2.php',
|
|
'sample/sample-file2.php',
|
|
'boardy',
|
|
'boardy',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedAssignment',
|
|
'Message',
|
|
'sample/sample-file2.php',
|
|
'sample/sample-file2.php',
|
|
'bardy',
|
|
'bardy',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'TypeCoercion',
|
|
'Message',
|
|
'sample/sample-file2.php',
|
|
'sample/sample-file2.php',
|
|
'hardy' . "\n",
|
|
'hardy' . "\n",
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
],
|
|
],
|
|
false,
|
|
);
|
|
|
|
$this->fileProvider->shouldHaveReceived()
|
|
->setContents(
|
|
$baselineFile,
|
|
Mockery::on(function (string $document): bool {
|
|
$baselineDocument = new DOMDocument();
|
|
$baselineDocument->loadXML($document, LIBXML_NOBLANKS);
|
|
|
|
/** @var DOMElement[] $files */
|
|
$files = $baselineDocument->getElementsByTagName('files')[0]->childNodes;
|
|
|
|
[$file1, $file2] = $files;
|
|
|
|
$this->assertSame('sample/sample-file.php', $file1->getAttribute('src'));
|
|
$this->assertSame('sample/sample-file2.php', $file2->getAttribute('src'));
|
|
|
|
/** @var DOMElement[] $file1Issues */
|
|
$file1Issues = $file1->childNodes;
|
|
/** @var DOMElement[] $file2Issues */
|
|
$file2Issues = $file2->childNodes;
|
|
|
|
$this->assertSame('MixedAssignment', $file1Issues[0]->tagName);
|
|
$this->assertSame(
|
|
3,
|
|
count($file1Issues[0]->getElementsByTagName('code')),
|
|
'MixedAssignment should have occured 3 times',
|
|
);
|
|
$this->assertSame('MixedOperand', $file1Issues[1]->tagName);
|
|
$this->assertSame(
|
|
1,
|
|
count($file1Issues[1]->getElementsByTagName('code')),
|
|
'MixedOperand should have occured 1 time',
|
|
);
|
|
|
|
$this->assertSame('MixedAssignment', $file2Issues[0]->tagName);
|
|
$this->assertSame(
|
|
2,
|
|
count($file2Issues[0]->getElementsByTagName('code')),
|
|
'MixedAssignment should have occured 2 times',
|
|
);
|
|
$this->assertSame('TypeCoercion', $file2Issues[1]->tagName);
|
|
$this->assertSame(
|
|
1,
|
|
count($file2Issues[1]->getElementsByTagName('code')),
|
|
'TypeCoercion should have occured 1 time',
|
|
);
|
|
|
|
return true;
|
|
}),
|
|
);
|
|
}
|
|
|
|
public function testUpdateShouldRemoveExistingIssuesWithoutAddingNewOnes(): void
|
|
{
|
|
$baselineFile = 'baseline.xml';
|
|
|
|
$this->fileProvider->allows()->fileExists($baselineFile)->andReturns(true);
|
|
$this->fileProvider->allows()->getContents($baselineFile)->andReturns(
|
|
'<?xml version="1.0" encoding="UTF-8"?>
|
|
<files>
|
|
<file src="sample/sample-file.php">
|
|
<MixedAssignment occurrences="3">
|
|
<code>bar</code>
|
|
<code>bat</code>
|
|
</MixedAssignment>
|
|
<MixedOperand>
|
|
<code>Test</code>
|
|
</MixedOperand>
|
|
</file>
|
|
<file src="sample/sample-file2.php">
|
|
<MixedAssignment>
|
|
<code>bar</code>
|
|
<code>baz</code>
|
|
</MixedAssignment>
|
|
<TypeCoercion>
|
|
<code>bar</code>
|
|
</TypeCoercion>
|
|
</file>
|
|
<file src="sample/sample-file3.php">
|
|
<MixedAssignment occurrences="1"/>
|
|
</file>
|
|
</files>',
|
|
);
|
|
|
|
$this->fileProvider->allows()->setContents(Mockery::andAnyOtherArgs());
|
|
|
|
$newIssues = [
|
|
'sample/sample-file.php' => [
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedAssignment',
|
|
'Message',
|
|
'sample/sample-file.php',
|
|
'sample/sample-file.php',
|
|
'foo',
|
|
'foo',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedAssignment',
|
|
'Message',
|
|
'sample/sample-file.php',
|
|
'sample/sample-file.php',
|
|
'bar',
|
|
'bar',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedOperand',
|
|
'Message',
|
|
'sample/sample-file.php',
|
|
'sample/sample-file.php',
|
|
'bat',
|
|
'bat',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'MixedOperand',
|
|
'Message',
|
|
'sample/sample-file.php',
|
|
'sample/sample-file.php',
|
|
'bam',
|
|
'bam',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
],
|
|
'sample/sample-file2.php' => [
|
|
new IssueData(
|
|
IssueData::SEVERITY_ERROR,
|
|
0,
|
|
0,
|
|
'TypeCoercion',
|
|
'Message',
|
|
'sample/sample-file2.php',
|
|
'sample/sample-file2.php',
|
|
'tar',
|
|
'tar',
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
),
|
|
],
|
|
];
|
|
|
|
$remainingBaseline = ErrorBaseline::update(
|
|
$this->fileProvider,
|
|
$baselineFile,
|
|
$newIssues,
|
|
false,
|
|
);
|
|
|
|
$this->assertSame([
|
|
'sample/sample-file.php' => [
|
|
'MixedAssignment' => ['o' => 2, 's' => ['bar']],
|
|
'MixedOperand' => ['o' => 1, 's' => []],
|
|
],
|
|
'sample/sample-file2.php' => [
|
|
'TypeCoercion' => ['o' => 1, 's' => []],
|
|
],
|
|
], $remainingBaseline);
|
|
}
|
|
|
|
public function testAddingACommentInBaselineDoesntTriggerNotice(): void
|
|
{
|
|
$baselineFilePath = 'baseline.xml';
|
|
|
|
$this->fileProvider->allows()->fileExists($baselineFilePath)->andReturns(true);
|
|
$this->fileProvider->allows()->getContents($baselineFilePath)->andReturns(
|
|
'<?xml version="1.0" encoding="UTF-8"?>
|
|
<files>
|
|
<file src="sample/sample-file.php">
|
|
<!-- here is a comment ! //-->
|
|
<MixedAssignment>
|
|
<code>foo</code>
|
|
<code>bar</code>
|
|
</MixedAssignment>
|
|
</file>
|
|
<!-- And another one ! //-->
|
|
<file src="sample\sample-file2.php">
|
|
<PossiblyUnusedMethod>
|
|
<code>foo</code>
|
|
<code>bar</code>
|
|
</PossiblyUnusedMethod>
|
|
</file>
|
|
</files>',
|
|
);
|
|
|
|
$expectedParsedBaseline = [
|
|
'sample/sample-file.php' => [
|
|
'MixedAssignment' => ['o' => 2, 's' => ['foo', 'bar']],
|
|
],
|
|
'sample/sample-file2.php' => [
|
|
'PossiblyUnusedMethod' => ['o' => 2, 's' => ['foo', 'bar']],
|
|
],
|
|
];
|
|
|
|
$this->assertSame(
|
|
$expectedParsedBaseline,
|
|
ErrorBaseline::read($this->fileProvider, $baselineFilePath),
|
|
);
|
|
}
|
|
}
|