add better log to technitial debt, trying to fix runtime path bug
This commit is contained in:
Pélisset Vincent
Dmitry Khomutov
parent
0a0ab660b8
commit
2b4fe8a384
|
|
@ -9,191 +9,251 @@ use PHPCensor\Plugin;
|
|||
use PHPCensor\ZeroConfigPluginInterface;
|
||||
|
||||
/**
|
||||
* Technical Debt Plugin - Checks for existence of "TODO", "FIXME", etc.
|
||||
*
|
||||
* @author James Inman <james@jamesinman.co.uk>
|
||||
*/
|
||||
* Technical Debt Plugin - Checks for existence of "TODO", "FIXME", etc.
|
||||
*
|
||||
* @author James Inman <james@jamesinman.co.uk>
|
||||
*/
|
||||
class TechnicalDebt extends Plugin implements ZeroConfigPluginInterface
|
||||
{
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected $suffixes;
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected $suffixes;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $directory;
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $directory;
|
||||
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
protected $allowed_errors;
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
protected $allowed_errors;
|
||||
|
||||
/**
|
||||
* @var array - paths to ignore
|
||||
*/
|
||||
protected $ignore;
|
||||
/**
|
||||
* @var array - paths to ignore
|
||||
*/
|
||||
protected $ignore;
|
||||
|
||||
/**
|
||||
* @var array - terms to search for
|
||||
*/
|
||||
protected $searches;
|
||||
/**
|
||||
* @var array - terms to search for
|
||||
*/
|
||||
protected $searches;
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public static function pluginName()
|
||||
{
|
||||
return 'technical_debt';
|
||||
public $displayLog = [];
|
||||
public $counterForDotPerLine = 0;
|
||||
public $lineNumber = 0;
|
||||
public $counterForFileAnalysed = 0;
|
||||
public $counterForTotalNumberOfFile = 0;
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public static function pluginName()
|
||||
{
|
||||
return 'technical_debt';
|
||||
}
|
||||
/**
|
||||
* Build a
|
||||
* @param string $string
|
||||
* @return [type] [description]
|
||||
*/
|
||||
protected function buildLogString($char){
|
||||
if (isset($this->displayLog[$this->lineNumber])){
|
||||
$this->displayLog[$this->lineNumber].= $char;
|
||||
}else{
|
||||
$this->displayLog[$this->lineNumber] = $char;
|
||||
}
|
||||
$this->counterForDotPerLine++;
|
||||
$this->counterForFileAnalysed++;
|
||||
if ($this->counterForDotPerLine>61){
|
||||
$this->counterForDotPerLine=0;
|
||||
$this->lineNumber++;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Build a
|
||||
* @param string $string
|
||||
* @return [type] [description]
|
||||
*/
|
||||
protected function returnResult(){
|
||||
$string='';
|
||||
$nb=0;
|
||||
foreach ($this->displayLog as $id => $uneLigne){
|
||||
$nb+=strlen($uneLigne);
|
||||
$string.=str_pad($uneLigne,62, ' ', STR_PAD_RIGHT);;
|
||||
$string.=str_pad($nb,7, ' ', STR_PAD_LEFT);
|
||||
$string.="/".$this->counterForFileAnalysed." (".round($nb*100/$this->counterForFileAnalysed,2)."%)\n";
|
||||
}
|
||||
$string.= "Checked $nb files\n";
|
||||
return $string;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function __construct(Builder $builder, Build $build, array $options = [])
|
||||
{
|
||||
parent::__construct($builder, $build, $options);
|
||||
|
||||
$this->suffixes = ['php'];
|
||||
$this->directory = $this->builder->buildPath;
|
||||
$this->ignore = $this->builder->ignore;
|
||||
$this->allowed_errors = 0;
|
||||
$this->searches = ['TODO', 'FIXME', 'TO DO', 'FIX ME'];
|
||||
|
||||
if (!empty($options['suffixes']) && is_array($options['suffixes'])) {
|
||||
$this->suffixes = $options['suffixes'];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function __construct(Builder $builder, Build $build, array $options = [])
|
||||
{
|
||||
parent::__construct($builder, $build, $options);
|
||||
|
||||
$this->suffixes = ['php'];
|
||||
$this->directory = $this->builder->buildPath;
|
||||
$this->ignore = $this->builder->ignore;
|
||||
$this->allowed_errors = 0;
|
||||
$this->searches = ['TODO', 'FIXME', 'TO DO', 'FIX ME'];
|
||||
|
||||
if (!empty($options['suffixes']) && is_array($options['suffixes'])) {
|
||||
$this->suffixes = $options['suffixes'];
|
||||
}
|
||||
|
||||
if (!empty($options['searches']) && is_array($options['searches'])) {
|
||||
$this->searches = $options['searches'];
|
||||
}
|
||||
|
||||
if (isset($options['zero_config']) && $options['zero_config']) {
|
||||
$this->allowed_errors = -1;
|
||||
}
|
||||
|
||||
$this->setOptions($options);
|
||||
if (!empty($options['searches']) && is_array($options['searches'])) {
|
||||
$this->searches = $options['searches'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle this plugin's options.
|
||||
*
|
||||
* @param $options
|
||||
*/
|
||||
protected function setOptions($options)
|
||||
{
|
||||
foreach (['directory', 'ignore', 'allowed_errors'] as $key) {
|
||||
if (array_key_exists($key, $options)) {
|
||||
$this->{$key} = $options[$key];
|
||||
if (isset($options['zero_config']) && $options['zero_config']) {
|
||||
$this->allowed_errors = -1;
|
||||
}
|
||||
|
||||
$this->setOptions($options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle this plugin's options.
|
||||
*
|
||||
* @param $options
|
||||
*/
|
||||
protected function setOptions($options)
|
||||
{
|
||||
foreach (['directory', 'ignore', 'allowed_errors'] as $key) {
|
||||
if (array_key_exists($key, $options)) {
|
||||
$this->{$key} = $options[$key];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if this plugin can be executed.
|
||||
*
|
||||
* @param string $stage
|
||||
* @param Builder $builder
|
||||
* @param Build $build
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public static function canExecute($stage, Builder $builder, Build $build)
|
||||
{
|
||||
if ($stage == Build::STAGE_TEST) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs the plugin
|
||||
*/
|
||||
public function execute()
|
||||
{
|
||||
$success = true;
|
||||
$errorCount = $this->getErrorList();
|
||||
|
||||
$this->builder->log($this->returnResult()."Found $errorCount instances of " . implode(', ', $this->searches));
|
||||
|
||||
$this->build->storeMeta('technical_debt-warnings', $errorCount);
|
||||
|
||||
if ($this->allowed_errors !== -1 && $errorCount > $this->allowed_errors) {
|
||||
$success = false;
|
||||
}
|
||||
|
||||
return $success;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the number and list of errors returned from the search
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
protected function getErrorList()
|
||||
{
|
||||
$iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->directory));
|
||||
|
||||
$this->builder->logDebug("Ignored path: ".json_encode($this->ignore,true));
|
||||
$errorCount = 0;
|
||||
$this->counterForTotalNumberOfFile = count($iterator);
|
||||
/** @var \SplFileInfo $file */
|
||||
foreach ($iterator as $file) {
|
||||
$filePath = $file->getRealPath();
|
||||
$relativePath = (string)$file->getPathname();
|
||||
$extension = $file->getExtension();
|
||||
|
||||
$ignored = false;
|
||||
foreach ($this->suffixes as $suffix) {
|
||||
if ($suffix !== $extension) {
|
||||
$ignored = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($this->ignore as $ignore) {
|
||||
if ('/' === $ignore{0}) {
|
||||
if (0 === strpos($relativePath, $ignore)) {
|
||||
$ignored = true;
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
|
||||
if (false !== strpos($relativePath, $ignore)) {
|
||||
$this->builder->logDebug(
|
||||
"\n=================================\n".
|
||||
'$relativePath='.var_export($relativePath,true)."\n".
|
||||
'$filePath ='.var_export($filePath,true)."\n".
|
||||
'$ignore ='.var_export($ignore,true)."\n".
|
||||
"strpos :".var_export(strpos($relativePath,$ignore),true)."\n".
|
||||
"strstr :".var_export(strstr($relativePath, $ignore),true)."\n".
|
||||
'ignored 2');
|
||||
$ignored = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if this plugin can be executed.
|
||||
*
|
||||
* @param string $stage
|
||||
* @param Builder $builder
|
||||
* @param Build $build
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public static function canExecute($stage, Builder $builder, Build $build)
|
||||
{
|
||||
if ($stage == Build::STAGE_TEST) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs the plugin
|
||||
*/
|
||||
public function execute()
|
||||
{
|
||||
$success = true;
|
||||
$errorCount = $this->getErrorList();
|
||||
|
||||
$this->builder->log("Found $errorCount instances of " . implode(', ', $this->searches));
|
||||
|
||||
$this->build->storeMeta('technical_debt-warnings', $errorCount);
|
||||
|
||||
if ($this->allowed_errors !== -1 && $errorCount > $this->allowed_errors) {
|
||||
$success = false;
|
||||
if ($ignored) {
|
||||
$this->buildLogString('I'); //Remove it when bug fixed
|
||||
}
|
||||
else{
|
||||
$handle = fopen($filePath, "r");
|
||||
$lineNumber = 1;
|
||||
while (false === feof($handle)) {
|
||||
$line = fgets($handle);
|
||||
$found=false;
|
||||
foreach ($this->searches as $search) {
|
||||
if ($technicalDeptLine = trim(strstr($line, $search))) {
|
||||
$fileName = str_replace($this->directory, '', $filePath);
|
||||
|
||||
return $success;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the number and list of errors returned from the search
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
protected function getErrorList()
|
||||
{
|
||||
$iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->directory));
|
||||
|
||||
$errorCount = 0;
|
||||
|
||||
/** @var \SplFileInfo $file */
|
||||
foreach ($iterator as $file) {
|
||||
$filePath = $file->getRealPath();
|
||||
$extension = $file->getExtension();
|
||||
|
||||
$ignored = false;
|
||||
foreach ($this->suffixes as $suffix) {
|
||||
if ($suffix !== $extension) {
|
||||
$ignored = true;
|
||||
break;
|
||||
}
|
||||
$this->build->reportError(
|
||||
$this->builder,
|
||||
'technical_debt',
|
||||
$technicalDeptLine,
|
||||
PHPCensor\Model\BuildError::SEVERITY_LOW,
|
||||
$fileName,
|
||||
$lineNumber
|
||||
);
|
||||
$found=true;
|
||||
$errorCount++;
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($this->ignore as $ignore) {
|
||||
if ('/' === $ignore{0}) {
|
||||
if (0 === strpos($filePath, $ignore)) {
|
||||
$ignored = true;
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
if (false !== strpos($filePath, $ignore)) {
|
||||
$ignored = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!$ignored) {
|
||||
$handle = fopen($filePath, "r");
|
||||
$lineNumber = 1;
|
||||
while (false === feof($handle)) {
|
||||
$line = fgets($handle);
|
||||
|
||||
foreach ($this->searches as $search) {
|
||||
if ($technicalDeptLine = trim(strstr($line, $search))) {
|
||||
$fileName = str_replace($this->directory, '', $filePath);
|
||||
|
||||
$this->build->reportError(
|
||||
$this->builder,
|
||||
'technical_debt',
|
||||
$technicalDeptLine,
|
||||
PHPCensor\Model\BuildError::SEVERITY_LOW,
|
||||
$fileName,
|
||||
$lineNumber
|
||||
);
|
||||
|
||||
$errorCount++;
|
||||
}
|
||||
}
|
||||
|
||||
$lineNumber++;
|
||||
}
|
||||
fclose ($handle);
|
||||
if ($found===true){
|
||||
$this->buildLogString('X');
|
||||
}else
|
||||
{
|
||||
$this->buildLogString('.');
|
||||
}
|
||||
$lineNumber++;
|
||||
}
|
||||
fclose ($handle);
|
||||
}
|
||||
}
|
||||
|
||||
return $errorCount;
|
||||
return $errorCount;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue