222 lines
6.5 KiB
PHP
222 lines
6.5 KiB
PHP
<?php
|
|
|
|
namespace Typo3Update\Tests;
|
|
|
|
/*
|
|
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.de>
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
* 02110-1301, USA.
|
|
*/
|
|
|
|
use PHPUnit\Framework\TestCase;
|
|
use Symfony\Component\Finder\Finder;
|
|
use Symfony\Component\Finder\SplFileInfo;
|
|
|
|
/**
|
|
* Will test all sniffs where fixtures are available.
|
|
*
|
|
* To add a test, just create the necessary fixture folder structure with files.
|
|
*/
|
|
class SniffsTest extends TestCase
|
|
{
|
|
/**
|
|
* Get all fixtures for sniffs.
|
|
*
|
|
* Execute each sniff based on found fixtures and compare result.
|
|
*
|
|
* @test
|
|
*/
|
|
public function sniffs()
|
|
{
|
|
$finder = new Finder();
|
|
$finder->in(
|
|
__DIR__
|
|
. DIRECTORY_SEPARATOR . 'Fixtures'
|
|
. DIRECTORY_SEPARATOR . 'Standards'
|
|
. DIRECTORY_SEPARATOR . 'Typo3Update'
|
|
. DIRECTORY_SEPARATOR . 'Sniffs'
|
|
);
|
|
|
|
foreach ($finder->directories()->name('*Sniff') as $folder) {
|
|
$this->executeSniff($folder);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Execute phpunit assertion for sniff based on $folder.
|
|
*
|
|
* @param SplFileInfo $folder
|
|
* @return void
|
|
*/
|
|
protected function executeSniff(SplFileInfo $folder)
|
|
{
|
|
$this->assertEquals(
|
|
$this->getExpectedJsonOutput($folder),
|
|
$this->getOutput($folder, 'json')['output'],
|
|
'Checking Sniff "' . $this->getSniffByFolder($folder) . '"'
|
|
. ' did not produce expected output for input file '
|
|
. $this->getInputFile($folder)
|
|
. ' called: ' . $this->getPhpcsCall($folder, 'json')
|
|
);
|
|
|
|
try {
|
|
$this->assertEquals(
|
|
$this->getExpectedDiffOutput($folder),
|
|
$this->getOutput($folder, 'diff')['output'],
|
|
'Fixing Sniff "' . $this->getSniffByFolder($folder) . '"'
|
|
. ' did not produce expected diff for input file '
|
|
. $this->getInputFile($folder)
|
|
. ' called: ' . $this->getPhpcsCall($folder, 'diff')
|
|
);
|
|
} catch (FileNotFoundException $e) {
|
|
// Ok, ignore, we don't have an diff.
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get expected json output for comparison.
|
|
*
|
|
* @param SplFileInfo $folder
|
|
* @return array
|
|
*/
|
|
protected function getExpectedJsonOutput(SplFileInfo $folder)
|
|
{
|
|
return json_decode(
|
|
file_get_contents($folder->getRealPath() . DIRECTORY_SEPARATOR . 'Expected.json'),
|
|
true
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns absolute file path to diff file containing expected output.
|
|
*
|
|
* @param SplFileInfo $folder
|
|
* @return string
|
|
*
|
|
* @throws FileNotFoundException
|
|
*/
|
|
protected function getExpectedDiffOutput(SplFileInfo $folder)
|
|
{
|
|
$file = $folder->getRealPath() . DIRECTORY_SEPARATOR . 'Expected.diff';
|
|
if (!is_file($file)) {
|
|
throw new FileNotFoundException('File does not exist.', 1491469621);
|
|
}
|
|
|
|
return file_get_contents($file);
|
|
}
|
|
|
|
/**
|
|
* Returns PHPCS Sniff name for given folder.
|
|
*
|
|
* @param SplFileInfo $folder
|
|
* @return string
|
|
*/
|
|
protected function getSniffByFolder(SplFileInfo $folder)
|
|
{
|
|
$folderParts = explode(DIRECTORY_SEPARATOR, $folder->getPath());
|
|
|
|
return array_slice($folderParts, -3)[0]
|
|
. '.' . array_slice($folderParts, -1)[0]
|
|
. '.' . substr($folder->getFilename(), 0, -5);
|
|
}
|
|
|
|
/**
|
|
* Returns file to use as input for phpcs.
|
|
*
|
|
* @param SplFileInfo $folder
|
|
* @return string
|
|
*/
|
|
protected function getInputFile(SplFileInfo $folder)
|
|
{
|
|
return $folder->getRealPath() . DIRECTORY_SEPARATOR . 'InputFileForIssues.php';
|
|
}
|
|
|
|
/**
|
|
* Build cli call for phpcs.
|
|
*
|
|
* @param SplFileInfo $folder
|
|
* @param string $report Defined the report format to use for output.
|
|
* @return string
|
|
*/
|
|
protected function getPhpcsCall(SplFileInfo $folder, $report)
|
|
{
|
|
$bin = './vendor/bin/phpcs';
|
|
$arguments = '--sniffs=' . $this->getSniffByFolder($folder)
|
|
. ' --report=' . $report
|
|
. ' --runtime-set mappingFile '
|
|
. __DIR__ . DIRECTORY_SEPARATOR . 'Fixtures' . DIRECTORY_SEPARATOR . 'LegacyClassnames.php'
|
|
. ' '
|
|
. $this->getInputFile($folder)
|
|
;
|
|
|
|
return $bin . ' ' . $arguments;
|
|
}
|
|
|
|
/**
|
|
* Executes phpcs for sniff based on $folder and returns the generated output.
|
|
*
|
|
* @param SplFileInfo $folder
|
|
* @param string $report Defined the report format to use for output.
|
|
* @return array
|
|
*/
|
|
protected function getOutput(SplFileInfo $folder, $report)
|
|
{
|
|
$output = '';
|
|
$returnValue;
|
|
exec($this->getPhpcsCall($folder, $report), $output, $returnValue);
|
|
|
|
if ($report === 'json') {
|
|
$output = $this->prepareJsonOutput($output);
|
|
} if ($report === 'diff') {
|
|
$output = $this->prepareDiffOutput($output);
|
|
}
|
|
|
|
return [
|
|
'output' => $output,
|
|
'returnValue' => $returnValue,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Prepare phpcs output for comparison.
|
|
*
|
|
* @param array $output
|
|
* @return array
|
|
*/
|
|
protected function prepareJsonOutput(array $output)
|
|
{
|
|
$preparedOutput = json_decode($output[0], true);
|
|
|
|
foreach (array_keys($preparedOutput['files']) as $fileName) {
|
|
$newKey = basename($fileName);
|
|
$preparedOutput['files'][$newKey] = $preparedOutput['files'][$fileName];
|
|
unset($preparedOutput['files'][$fileName]);
|
|
}
|
|
|
|
return $preparedOutput;
|
|
}
|
|
|
|
/**
|
|
* Prepare phpcs output for comparison.
|
|
*
|
|
* @param array $output
|
|
* @return string
|
|
*/
|
|
protected function prepareDiffOutput(array $output)
|
|
{
|
|
return implode("\n", $output);
|
|
}
|
|
}
|