331 lines
6.0 KiB
PHP
331 lines
6.0 KiB
PHP
<?php declare(strict_types=1);
|
|
if ( ! function_exists('glob_recursive'))
|
|
{
|
|
// Does not support flag GLOB_BRACE
|
|
function glob_recursive($pattern, $flags = 0)
|
|
{
|
|
$files = glob($pattern, $flags);
|
|
|
|
foreach (glob(dirname($pattern).'/*', GLOB_ONLYDIR|GLOB_NOSORT) as $dir)
|
|
{
|
|
$files = array_merge($files, glob_recursive($dir.'/'.basename($pattern), $flags));
|
|
}
|
|
|
|
return $files;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This is project's console commands configuration for Robo task runner.
|
|
*
|
|
* @see http://robo.li/
|
|
*/
|
|
class RoboFile extends \Robo\Tasks {
|
|
|
|
/**
|
|
* Directories used by analysis tools
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $taskDirs = [
|
|
'build/logs',
|
|
'build/pdepend',
|
|
'build/phpdox',
|
|
];
|
|
|
|
/**
|
|
* Directories to remove with the clean task
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $cleanDirs = [
|
|
'coverage',
|
|
'docs',
|
|
'phpdoc',
|
|
'build/logs',
|
|
'build/phpdox',
|
|
'build/pdepend'
|
|
];
|
|
|
|
|
|
/**
|
|
* Do static analysis tasks
|
|
*/
|
|
public function analyze()
|
|
{
|
|
$this->prepare();
|
|
$this->lint();
|
|
$this->phploc(TRUE);
|
|
$this->phpcs(TRUE);
|
|
$this->dependencyReport();
|
|
$this->phpcpdReport();
|
|
}
|
|
|
|
/**
|
|
* Run all tests, generate coverage, generate docs, generate code statistics
|
|
*/
|
|
public function build()
|
|
{
|
|
$this->analyze();
|
|
$this->coverage();
|
|
$this->docs();
|
|
}
|
|
|
|
/**
|
|
* Cleanup temporary files
|
|
*/
|
|
public function clean()
|
|
{
|
|
$cleanFiles = [
|
|
'build/humbug.json',
|
|
'build/humbug-log.txt',
|
|
];
|
|
array_map(function ($file) {
|
|
@unlink($file);
|
|
}, $cleanFiles);
|
|
|
|
// So the task doesn't complain,
|
|
// make any 'missing' dirs to cleanup
|
|
array_map(function ($dir) {
|
|
if ( ! is_dir($dir))
|
|
{
|
|
`mkdir -p {$dir}`;
|
|
}
|
|
}, $this->cleanDirs);
|
|
|
|
$this->_cleanDir($this->cleanDirs);
|
|
$this->_deleteDir($this->cleanDirs);
|
|
}
|
|
|
|
/**
|
|
* Run unit tests and generate coverage reports
|
|
*/
|
|
public function coverage()
|
|
{
|
|
$this->taskPhpUnit()
|
|
->configFile('build/phpunit.xml')
|
|
->printed(true)
|
|
->run();
|
|
}
|
|
|
|
/**
|
|
* Generate documentation with phpdox
|
|
*/
|
|
public function docs()
|
|
{
|
|
$cmd_parts = [
|
|
'phpdoc'
|
|
];
|
|
$this->_run($cmd_parts, ' && ');
|
|
}
|
|
|
|
/**
|
|
* Verify that source files are valid
|
|
*/
|
|
public function lint()
|
|
{
|
|
$files = $this->getAllSourceFiles();
|
|
|
|
$chunks = array_chunk($files, (int)`getconf _NPROCESSORS_ONLN`);
|
|
|
|
foreach($chunks as $chunk)
|
|
{
|
|
$this->parallelLint($chunk);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Run mutation tests with humbug
|
|
*
|
|
* @param bool $stats - if true, generates stats rather than running mutation tests
|
|
*/
|
|
public function mutate($stats = FALSE)
|
|
{
|
|
$test_parts = [
|
|
'vendor/bin/humbug'
|
|
];
|
|
|
|
$stat_parts = [
|
|
'vendor/bin/humbug',
|
|
'--skip-killed=yes',
|
|
'-v',
|
|
'./build/humbug.json'
|
|
];
|
|
|
|
$cmd_parts = ($stats) ? $stat_parts : $test_parts;
|
|
$this->_run($cmd_parts);
|
|
}
|
|
|
|
/**
|
|
* Run the phpcs tool
|
|
*
|
|
* @param bool $report - if true, generates reports instead of direct output
|
|
*/
|
|
public function phpcs($report = FALSE)
|
|
{
|
|
$dir = __DIR__;
|
|
|
|
$report_cmd_parts = [
|
|
'vendor/bin/phpcs',
|
|
"--standard=./build/CodeIgniter",
|
|
"--report-checkstyle=./build/logs/phpcs.xml",
|
|
];
|
|
|
|
$normal_cmd_parts = [
|
|
'vendor/bin/phpcs',
|
|
"--standard=./build/CodeIgniter",
|
|
];
|
|
|
|
$cmd_parts = ($report) ? $report_cmd_parts : $normal_cmd_parts;
|
|
|
|
$this->_run($cmd_parts);
|
|
}
|
|
|
|
/**
|
|
* Run the phploc tool
|
|
*
|
|
* @param bool $report - if true, generates reports instead of direct output
|
|
*/
|
|
public function phploc($report = FALSE)
|
|
{
|
|
// Command for generating reports
|
|
$report_cmd_parts = [
|
|
'vendor/bin/phploc',
|
|
'--count-tests',
|
|
'--log-csv=build/logs/phploc.csv',
|
|
'--log-xml=build/logs/phploc.xml',
|
|
'src',
|
|
'tests'
|
|
];
|
|
|
|
// Command for generating direct output
|
|
$normal_cmd_parts = [
|
|
'vendor/bin/phploc',
|
|
'--count-tests',
|
|
'src',
|
|
'tests'
|
|
];
|
|
|
|
$cmd_parts = ($report) ? $report_cmd_parts : $normal_cmd_parts;
|
|
|
|
$this->_run($cmd_parts);
|
|
}
|
|
|
|
/**
|
|
* Create temporary directories
|
|
*/
|
|
public function prepare()
|
|
{
|
|
array_map([$this, '_mkdir'], $this->taskDirs);
|
|
}
|
|
|
|
/**
|
|
* Lint php files and run unit tests
|
|
*/
|
|
public function test()
|
|
{
|
|
$this->lint();
|
|
$this->taskPHPUnit()
|
|
->configFile('phpunit.xml')
|
|
->printed(true)
|
|
->run();
|
|
$this->_run(["php tests/index.php"]);
|
|
}
|
|
|
|
/**
|
|
* Watches for file updates, and automatically runs appropriate actions
|
|
*/
|
|
public function watch()
|
|
{
|
|
$this->taskWatch()
|
|
->monitor('composer.json', function() {
|
|
$this->taskComposerUpdate()->run();
|
|
})
|
|
->monitor('src', function () {
|
|
$this->taskExec('test')->run();
|
|
})
|
|
->monitor('tests', function () {
|
|
$this->taskExec('test')->run();
|
|
})
|
|
->run();
|
|
}
|
|
|
|
/**
|
|
* Create pdepend reports
|
|
*/
|
|
protected function dependencyReport()
|
|
{
|
|
$cmd_parts = [
|
|
'vendor/bin/pdepend',
|
|
'--jdepend-xml=build/logs/jdepend.xml',
|
|
'--jdepend-chart=build/pdepend/dependencies.svg',
|
|
'--overview-pyramid=build/pdepend/overview-pyramid.svg',
|
|
'src'
|
|
];
|
|
$this->_run($cmd_parts);
|
|
}
|
|
|
|
/**
|
|
* Get the total list of source files, including tests
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getAllSourceFiles()
|
|
{
|
|
$files = array_merge(
|
|
glob_recursive('build/*.php'),
|
|
glob_recursive('src/*.php'),
|
|
glob_recursive('tests/*.php'),
|
|
glob('*.php')
|
|
);
|
|
|
|
sort($files);
|
|
|
|
return $files;
|
|
}
|
|
|
|
/**
|
|
* Run php's linter in one parallel task for the passed chunk
|
|
*
|
|
* @param array $chunk
|
|
*/
|
|
protected function parallelLint(array $chunk)
|
|
{
|
|
$task = $this->taskParallelExec()
|
|
->timeout(5)
|
|
->printed(FALSE);
|
|
|
|
foreach($chunk as $file)
|
|
{
|
|
$task = $task->process("php -l {$file}");
|
|
}
|
|
|
|
$task->run();
|
|
}
|
|
|
|
/**
|
|
* Generate copy paste detector report
|
|
*/
|
|
protected function phpcpdReport()
|
|
{
|
|
$cmd_parts = [
|
|
'vendor/bin/phpcpd',
|
|
'--log-pmd build/logs/pmd-cpd.xml',
|
|
'src'
|
|
];
|
|
$this->_run($cmd_parts);
|
|
}
|
|
|
|
/**
|
|
* Shortcut for joining an array of command arguments
|
|
* and then running it
|
|
*
|
|
* @param array $cmd_parts - command arguments
|
|
* @param string $join_on - what to join the command arguments with
|
|
*/
|
|
protected function _run(array $cmd_parts, $join_on = ' ')
|
|
{
|
|
$this->taskExec(implode($join_on, $cmd_parts))->run();
|
|
}
|
|
} |