138 lines
4.1 KiB
PHP
138 lines
4.1 KiB
PHP
<?php
|
|
/**
|
|
* PHPCI - Continuous Integration for PHP
|
|
*
|
|
* @copyright Copyright 2014, Block 8 Limited.
|
|
* @license https://github.com/Block8/PHPCI/blob/master/LICENSE.md
|
|
* @link https://www.phptesting.org/
|
|
*/
|
|
|
|
namespace PHPCensor\Plugin;
|
|
|
|
use PHPCensor\Builder;
|
|
use PHPCensor\Model\Build;
|
|
use PHPCensor\Plugin;
|
|
|
|
/**
|
|
* Pdepend Plugin - Allows Pdepend report
|
|
* @author Johan van der Heide <info@japaveh.nl>
|
|
* @package PHPCI
|
|
* @subpackage Plugins
|
|
*/
|
|
class Pdepend implements Plugin
|
|
{
|
|
protected $args;
|
|
/**
|
|
* @var \PHPCI\Builder
|
|
*/
|
|
protected $phpci;
|
|
/**
|
|
* @var string Directory which needs to be scanned
|
|
*/
|
|
protected $directory;
|
|
/**
|
|
* @var string File where the summary.xml is stored
|
|
*/
|
|
protected $summary;
|
|
/**
|
|
* @var string File where the chart.svg is stored
|
|
*/
|
|
protected $chart;
|
|
/**
|
|
* @var string File where the pyramid.svg is stored
|
|
*/
|
|
protected $pyramid;
|
|
/**
|
|
* @var string Location on the server where the files are stored. Preferably in the webroot for inclusion
|
|
* in the readme.md of the repository
|
|
*/
|
|
protected $location;
|
|
|
|
/**
|
|
* Set up the plugin, configure options, etc.
|
|
* @param Builder $phpci
|
|
* @param Build $build
|
|
* @param array $options
|
|
*/
|
|
public function __construct(Builder $phpci, Build $build, array $options = [])
|
|
{
|
|
$this->phpci = $phpci;
|
|
$this->build = $build;
|
|
|
|
$this->directory = isset($options['directory']) ? $options['directory'] : $phpci->buildPath;
|
|
|
|
$title = $phpci->getBuildProjectTitle();
|
|
$this->summary = $title . '-summary.xml';
|
|
$this->pyramid = $title . '-pyramid.svg';
|
|
$this->chart = $title . '-chart.svg';
|
|
$this->location = $this->phpci->buildPath . '..' . DIRECTORY_SEPARATOR . 'pdepend';
|
|
|
|
$this->phpci->logDebug('Plugin options: ' . json_encode($options));
|
|
}
|
|
|
|
/**
|
|
* Runs Pdepend with the given criteria as arguments
|
|
*/
|
|
public function execute()
|
|
{
|
|
if (!file_exists($this->location)) {
|
|
mkdir($this->location);
|
|
}
|
|
if (!is_writable($this->location)) {
|
|
throw new \Exception(sprintf('The location %s is not writable or does not exist.', $this->location));
|
|
}
|
|
|
|
$pdepend = $this->phpci->findBinary('pdepend');
|
|
|
|
$cmd = $pdepend . ' --summary-xml="%s" --jdepend-chart="%s" --overview-pyramid="%s" %s "%s"';
|
|
|
|
$this->removeBuildArtifacts();
|
|
|
|
// If we need to ignore directories
|
|
if (count($this->phpci->ignore)) {
|
|
$ignore = ' --ignore=' . implode(',', $this->phpci->ignore);
|
|
} else {
|
|
$ignore = '';
|
|
}
|
|
|
|
$success = $this->phpci->executeCommand(
|
|
$cmd,
|
|
$this->location . DIRECTORY_SEPARATOR . $this->summary,
|
|
$this->location . DIRECTORY_SEPARATOR . $this->chart,
|
|
$this->location . DIRECTORY_SEPARATOR . $this->pyramid,
|
|
$ignore,
|
|
$this->directory
|
|
);
|
|
|
|
$config = $this->phpci->getSystemConfig('php-censor');
|
|
|
|
if ($success) {
|
|
$this->phpci->logSuccess(
|
|
sprintf(
|
|
"Pdepend successful. You can use %s\n, ![Chart](%s \"Pdepend Chart\")\n
|
|
and ![Pyramid](%s \"Pdepend Pyramid\")\n
|
|
for inclusion in the readme.md file",
|
|
$config['url'] . '/build/pdepend/' . $this->summary,
|
|
$config['url'] . '/build/pdepend/' . $this->chart,
|
|
$config['url'] . '/build/pdepend/' . $this->pyramid
|
|
)
|
|
);
|
|
}
|
|
|
|
return $success;
|
|
}
|
|
|
|
/**
|
|
* Remove files created from previous builds
|
|
*/
|
|
protected function removeBuildArtifacts()
|
|
{
|
|
//Remove the created files first
|
|
foreach ([$this->summary, $this->chart, $this->pyramid] as $file) {
|
|
if (file_exists($this->location . DIRECTORY_SEPARATOR . $file)) {
|
|
unlink($this->location . DIRECTORY_SEPARATOR . $file);
|
|
}
|
|
}
|
|
}
|
|
}
|