fileProvider = $this->prophesize(FileProvider::class);
}
/**
* @return void
*/
public function testLoadShouldParseXmlBaselineToPhpArray()
{
$baselineFilePath = 'baseline.xml';
$this->fileProvider->fileExists($baselineFilePath)->willReturn(true);
$this->fileProvider->getContents($baselineFilePath)->willReturn(
'
foo
bar
foo
bar
'
);
$expectedParsedBaseline = [
'sample/sample-file.php' => [
'MixedAssignment' => ['o' => 2, 's' => ['foo', 'bar']],
'InvalidReturnStatement' => ['o' => 1, 's' => []],
],
'sample/sample-file2.php' => [
'PossiblyUnusedMethod' => ['o' => 2, 's' => ['foo', 'bar']],
],
];
$this->assertSame(
$expectedParsedBaseline,
ErrorBaseline::read($this->fileProvider->reveal(), $baselineFilePath)
);
}
/**
* @return void
*/
public function testLoadShouldThrowExceptionWhenFilesAreNotDefinedInBaselineFile()
{
$this->expectException(ConfigException::class);
$baselineFile = 'baseline.xml';
$this->fileProvider->fileExists($baselineFile)->willReturn(true);
$this->fileProvider->getContents($baselineFile)->willReturn(
'
'
);
ErrorBaseline::read($this->fileProvider->reveal(), $baselineFile);
}
/**
* @return void
*/
public function testLoadShouldThrowExceptionWhenBaselineFileDoesNotExist()
{
$this->expectException(ConfigException::class);
$baselineFile = 'baseline.xml';
$this->fileProvider->fileExists($baselineFile)->willReturn(false);
ErrorBaseline::read($this->fileProvider->reveal(), $baselineFile);
}
/**
* @return void
*/
public function testCountTotalIssuesShouldReturnCorrectNumber()
{
$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);
}
/**
* @return void
*/
public function testCreateShouldAggregateIssuesPerFile()
{
$baselineFile = 'baseline.xml';
$documentContent = null;
$this->fileProvider->setContents(
$baselineFile,
Argument::that(function (string $document) use (&$documentContent): bool {
$documentContent = $document;
return true;
})
)->willReturn(null);
ErrorBaseline::create($this->fileProvider->reveal(), $baselineFile, [
[
'file_name' => 'sample/sample-file.php',
'type' => 'MixedAssignment',
'severity' => 'error',
'selected_text' => 'foo',
],
[
'file_name' => 'sample\sample-file.php',
'type' => 'MixedAssignment',
'severity' => 'error',
'selected_text' => 'bar',
],
[
'file_name' => 'sample/sample-file.php',
'type' => 'MixedAssignment',
'severity' => 'error',
'selected_text' => 'bat',
],
[
'file_name' => 'sample\sample-file.php',
'type' => 'MixedOperand',
'severity' => 'error',
'selected_text' => 'bing',
],
[
'file_name' => 'sample/sample-file.php',
'type' => 'AssignmentToVoid',
'severity' => 'info',
'selected_text' => 'bong',
],
[
'file_name' => 'sample\sample-file.php',
'type' => 'CircularReference',
'severity' => 'suppress',
'selected_text' => 'birdy',
],
[
'file_name' => 'sample/sample-file2.php',
'type' => 'MixedAssignment',
'severity' => 'error',
'selected_text' => 'boardy',
],
[
'file_name' => 'sample\sample-file2.php',
'type' => 'MixedAssignment',
'severity' => 'error',
'selected_text' => 'bardy',
],
[
'file_name' => 'sample/sample-file2.php',
'type' => 'TypeCoercion',
'severity' => 'error',
'selected_text' => 'hardy' . "\n",
],
], false);
$baselineDocument = new \DOMDocument();
$baselineDocument->loadXML($documentContent, LIBXML_NOBLANKS);
/** @var \DOMElement[] $files */
$files = $baselineDocument->getElementsByTagName('files')[0]->childNodes;
$file1 = $files[0];
$file2 = $files[1];
$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', $file1Issues[0]->getAttribute('occurrences'));
$this->assertSame('MixedOperand', $file1Issues[1]->tagName);
$this->assertSame('1', $file1Issues[1]->getAttribute('occurrences'));
$this->assertSame('MixedAssignment', $file2Issues[0]->tagName);
$this->assertSame('2', $file2Issues[0]->getAttribute('occurrences'));
$this->assertSame('TypeCoercion', $file2Issues[1]->tagName);
$this->assertSame('1', $file2Issues[1]->getAttribute('occurrences'));
}
/**
* @return void
*/
public function testUpdateShouldRemoveExistingIssuesWithoutAddingNewOnes()
{
$baselineFile = 'baseline.xml';
$this->fileProvider->fileExists($baselineFile)->willReturn(true);
$this->fileProvider->getContents($baselineFile)->willReturn(
'
bar
bat
'
);
$this->fileProvider->setContents(Argument::cetera())->willReturn(null);
$newIssues = [
[
'file_name' => 'sample/sample-file.php',
'type' => 'MixedAssignment',
'severity' => 'error',
'selected_text' => 'foo',
],
[
'file_name' => 'sample/sample-file.php',
'type' => 'MixedAssignment',
'severity' => 'error',
'selected_text' => 'bar',
],
[
'file_name' => 'sample/sample-file.php',
'type' => 'MixedOperand',
'severity' => 'error',
'selected_text' => 'bat',
],
[
'file_name' => 'sample/sample-file.php',
'type' => 'MixedOperand',
'severity' => 'error',
'selected_text' => 'bam',
],
[
'file_name' => 'sample/sample-file2.php',
'type' => 'TypeCoercion',
'severity' => 'error',
'selected_text' => 'tar',
],
];
$remainingBaseline = ErrorBaseline::update(
$this->fileProvider->reveal(),
$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);
}
/**
* @return void
*/
public function testAddingACommentInBaselineDoesntTriggerNotice()
{
$baselineFilePath = 'baseline.xml';
$this->fileProvider->fileExists($baselineFilePath)->willReturn(true);
$this->fileProvider->getContents($baselineFilePath)->willReturn(
'
foo
bar
foo
bar
'
);
$expectedParsedBaseline = [
'sample/sample-file.php' => [
'MixedAssignment' => ['o' => 2, 's' => ['foo', 'bar']],
'InvalidReturnStatement' => ['o' => 1, 's' => []],
],
'sample/sample-file2.php' => [
'PossiblyUnusedMethod' => ['o' => 2, 's' => ['foo', 'bar']],
],
];
$this->assertSame(
$expectedParsedBaseline,
ErrorBaseline::read($this->fileProvider->reveal(), $baselineFilePath)
);
}
}