11f087a239
- Reformat the error output. - Display collapsed trace in the Information tab widget. - Handle incomplete tests in the results. - Unit tests for all new classes. - Display raw phpunit output.
208 lines
6.3 KiB
PHP
208 lines
6.3 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 PHPCI\Plugin;
|
|
|
|
use PHPCI;
|
|
use PHPCI\Builder;
|
|
use PHPCI\Helper\Lang;
|
|
use PHPCI\Model\Build;
|
|
use PHPCI\Model\BuildError;
|
|
use PHPCI\Plugin\Option\PhpUnitOptions;
|
|
use PHPCI\Plugin\Util\PhpUnitResult;
|
|
|
|
/**
|
|
* PHP Unit Plugin V2 - Extends the functionality of the original PHP Unit plugin
|
|
*
|
|
* @author Pablo Tejada <pablo@ptejada.com>
|
|
* @package PHPCI
|
|
* @subpackage Plugins
|
|
*/
|
|
class PhpUnitV2 implements PHPCI\Plugin, PHPCI\ZeroConfigPlugin
|
|
{
|
|
protected $phpci;
|
|
protected $build;
|
|
|
|
/** @var string[] Raw options from the PHPCI config file */
|
|
protected $options = array();
|
|
|
|
/**
|
|
* Standard Constructor
|
|
* $options['config'] Path to a PHPUnit XML configuration file.
|
|
* $options['run_from'] The directory where the phpunit command will run from when using 'config'.
|
|
* $options['coverage'] Value for the --coverage-html command line flag.
|
|
* $options['directory'] Optional directory or list of directories to run PHPUnit on.
|
|
* $options['args'] Command line args (in string format) to pass to PHP Unit
|
|
*
|
|
* @param Builder $phpci
|
|
* @param Build $build
|
|
* @param string[] $options
|
|
*/
|
|
public function __construct(Builder $phpci, Build $build, array $options = array())
|
|
{
|
|
$this->phpci = $phpci;
|
|
$this->build = $build;
|
|
$this->options = new PhpUnitOptions($options);
|
|
}
|
|
|
|
/**
|
|
* Check if the plugin can be executed without any configurations
|
|
*
|
|
* @param $stage
|
|
* @param Builder $builder
|
|
* @param Build $build
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function canExecute($stage, Builder $builder, Build $build)
|
|
{
|
|
if ($stage == 'test' && !is_null(PhpUnitOptions::findConfigFile($build->getBuildPath()))) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Runs PHP Unit tests in a specified directory, optionally using specified config file(s).
|
|
*/
|
|
public function execute()
|
|
{
|
|
$xmlConfigFiles = $this->options->getConfigFiles($this->build->getBuildPath());
|
|
$directories = $this->options->getDirectories();
|
|
if (empty($xmlConfigFiles) && empty($directories)) {
|
|
$this->phpci->logFailure(Lang::get('phpunit_fail_init'));
|
|
return false;
|
|
}
|
|
|
|
$success = array();
|
|
|
|
// Run any directories
|
|
if (!empty($directories)) {
|
|
foreach ($directories as $directory) {
|
|
$success[] = $this->runDir($directory);
|
|
}
|
|
} else {
|
|
// Run any config files
|
|
if (!empty($xmlConfigFiles)) {
|
|
foreach ($xmlConfigFiles as $configFile) {
|
|
$success[] = $this->runConfigFile($configFile);
|
|
}
|
|
}
|
|
}
|
|
|
|
return !in_array(false, $success);
|
|
}
|
|
|
|
/**
|
|
* Run the PHPUnit tests in a specific directory or array of directories.
|
|
*
|
|
* @param $directory
|
|
*
|
|
* @return bool|mixed
|
|
*/
|
|
protected function runDir($directory)
|
|
{
|
|
$options = clone $this->options;
|
|
|
|
$buildPath = $this->build->getBuildPath() . DIRECTORY_SEPARATOR;
|
|
|
|
$currentPath = getcwd();
|
|
// Change the directory
|
|
chdir($buildPath);
|
|
|
|
// Save the results into a json file
|
|
$jsonFile = tempnam(dirname($buildPath), 'jLog_');
|
|
$options->addArgument('log-json', $jsonFile);
|
|
|
|
// Removes any current configurations files
|
|
$options->removeArgument('configuration');
|
|
|
|
$arguments = $this->phpci->interpolate($options->buildArgumentString());
|
|
$cmd = $this->phpci->findBinary('phpunit') . ' %s "%s"';
|
|
$success = $this->phpci->executeCommand($cmd, $arguments, $directory);
|
|
|
|
// Change to che original path
|
|
chdir($currentPath);
|
|
|
|
$this->processResults($jsonFile);
|
|
|
|
return $success;
|
|
}
|
|
|
|
/**
|
|
* Run the tests defined in a PHPUnit config file.
|
|
*
|
|
* @param $configFile
|
|
*
|
|
* @return bool|mixed
|
|
*/
|
|
protected function runConfigFile($configFile)
|
|
{
|
|
$options = clone $this->options;
|
|
$runFrom = $options->getRunFrom();
|
|
|
|
$buildPath = $this->build->getBuildPath() . DIRECTORY_SEPARATOR;
|
|
if ($runFrom) {
|
|
$originalPath = getcwd();
|
|
// Change the directory
|
|
chdir($buildPath . $runFrom);
|
|
}
|
|
|
|
// Save the results into a json file
|
|
$jsonFile = tempnam($this->phpci->buildPath, 'jLog_');
|
|
$options->addArgument('log-json', $jsonFile);
|
|
|
|
// Removes any current configurations files
|
|
$options->removeArgument('configuration');
|
|
// Only the add the configuration file been passed
|
|
$options->addArgument('configuration', $buildPath . $configFile);
|
|
|
|
$arguments = $this->phpci->interpolate($options->buildArgumentString());
|
|
$cmd = $this->phpci->findBinary('phpunit') . ' %s %s';
|
|
$success = $this->phpci->executeCommand($cmd, $arguments, $options->getTestsPath());
|
|
|
|
if (!empty($originalPath)) {
|
|
// Change to che original path
|
|
chdir($originalPath);
|
|
}
|
|
|
|
$this->processResults($jsonFile);
|
|
|
|
return $success;
|
|
}
|
|
|
|
/**
|
|
* Saves the test results
|
|
*
|
|
* @param string $jsonFile
|
|
*
|
|
* @throws \Exception If the failed to parse the JSON file
|
|
*/
|
|
protected function processResults($jsonFile)
|
|
{
|
|
if (is_file($jsonFile)) {
|
|
$parser = new PhpUnitResult($jsonFile, $this->build->getBuildPath());
|
|
|
|
$this->build->storeMeta('phpunit-data', $parser->parse()->getResults());
|
|
$this->build->storeMeta('phpunit-errors', $parser->getFailures());
|
|
|
|
foreach ($parser->getErrors() as $error) {
|
|
$severity = $error['severity'] == $parser::SEVERITY_ERROR ? BuildError::SEVERITY_CRITICAL : BuildError::SEVERITY_HIGH;
|
|
$this->build->reportError(
|
|
$this->phpci, 'php_unit', $error['message'], $severity, $error['file'], $error['line']
|
|
);
|
|
}
|
|
|
|
} else {
|
|
throw new \Exception('JSON output file does not exist: ' . $jsonFile);
|
|
}
|
|
}
|
|
}
|