deblan/phpci
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Fixing some formatting issues

Browse source
This commit is contained in:
meadsteve 2013-10-26 16:25:34 +01:00
parent 8c88581021
commit b943c07f87
3 changed files with 153 additions and 139 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

223
PHPCI/Builder.php
View file

@ -1,11 +1,11 @@
<?php <?php
/** /**
* PHPCI - Continuous Integration for PHP * PHPCI - Continuous Integration for PHP
* *
* @copyright Copyright 2013, Block 8 Limited. * @copyright Copyright 2013, Block 8 Limited.
* @license https://github.com/Block8/PHPCI/blob/master/LICENSE.md * @license https://github.com/Block8/PHPCI/blob/master/LICENSE.md
* @link http://www.phptesting.org/ * @link http://www.phptesting.org/
*/ */
namespace PHPCI; namespace PHPCI;
@ -17,54 +17,54 @@ use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel; use Psr\Log\LogLevel;
/** /**
* PHPCI Build Runner * PHPCI Build Runner
* @author Dan Cryer <dan@block8.co.uk> * @author Dan Cryer <dan@block8.co.uk>
*/ */
class Builder implements LoggerAwareInterface class Builder implements LoggerAwareInterface
{ {
/** /**
* @var string * @var string
*/ */
public $buildPath; public $buildPath;
/** /**
* @var string[] * @var string[]
*/ */
public $ignore = array(); public $ignore = array();
/** /**
* @var string * @var string
*/ */
protected $ciDir; protected $ciDir;
/** /**
* @var string * @var string
*/ */
protected $directory; protected $directory;
/** /**
* @var bool * @var bool
*/ */
protected $success = true; protected $success = true;
/** /**
* @var bool * @var bool
*/ */
protected $verbose = true; protected $verbose = true;
/** /**
* @var \PHPCI\Model\Build * @var \PHPCI\Model\Build
*/ */
protected $build; protected $build;
/** /**
* @var LoggerInterface * @var LoggerInterface
*/ */
protected $logger; protected $logger;
/** /**
* @var array * @var array
*/ */
protected $config; protected $config;
/** /**
@ -73,7 +73,7 @@ class Builder implements LoggerAwareInterface
protected $lastOutput; protected $lastOutput;
/** /**
* An array of key => value pairs that will be used for * An array of key => value pairs that will be used for
* interpolation and environment variables * interpolation and environment variables
* @var array * @var array
* @see setInterpolationVars() * @see setInterpolationVars()
@ -91,32 +91,32 @@ class Builder implements LoggerAwareInterface
public $quiet = false; public $quiet = false;
/** /**
* Set up the builder. * Set up the builder.
* @param \PHPCI\Model\Build $build * @param \PHPCI\Model\Build $build
* @param LoggerInterface $logger * @param LoggerInterface $logger
*/ */
public function __construct(Build $build, $logger = null) public function __construct(Build $build, $logger = null)
{ {
if ($logger) { if ($logger) {
$this->setLogger($logger); $this->setLogger($logger);
} }
$this->build = $build; $this->build = $build;
$this->store = Store\Factory::getStore('Build'); $this->store = Store\Factory::getStore('Build');
} }
/** /**
* Set the config array, as read from phpci.yml * Set the config array, as read from phpci.yml
* @param array * @param array
*/ */
public function setConfigArray(array $config) public function setConfigArray(array $config)
{ {
$this->config = $config; $this->config = $config;
} }
/** /**
* Access a variable from the phpci.yml file. * Access a variable from the phpci.yml file.
* @param string * @param string
*/ */
public function getConfig($key) public function getConfig($key)
{ {
$rtn = null; $rtn = null;
@ -147,8 +147,8 @@ class Builder implements LoggerAwareInterface
} }
/** /**
* Run the active build. * Run the active build.
*/ */
public function execute() public function execute()
{ {
// Update the build in the database, ping any external services. // Update the build in the database, ping any external services.
@ -183,7 +183,7 @@ class Builder implements LoggerAwareInterface
$this->logFailure($ex->getMessage()); $this->logFailure($ex->getMessage());
$this->build->setStatus(3); $this->build->setStatus(3);
} }
// Clean up: // Clean up:
$this->log('Removing build.'); $this->log('Removing build.');
shell_exec(sprintf('rm -Rf "%s"', $this->buildPath)); shell_exec(sprintf('rm -Rf "%s"', $this->buildPath));
@ -195,8 +195,8 @@ class Builder implements LoggerAwareInterface
} }
/** /**
* Used by this class, and plugins, to execute shell commands. * Used by this class, and plugins, to execute shell commands.
*/ */
public function executeCommand() public function executeCommand()
{ {
$command = call_user_func_array('sprintf', func_get_args()); $command = call_user_func_array('sprintf', func_get_args());
@ -230,45 +230,45 @@ class Builder implements LoggerAwareInterface
return implode(PHP_EOL, $this->lastOutput); return implode(PHP_EOL, $this->lastOutput);
} }
/** /**
* Add an entry to the build log. * Add an entry to the build log.
* @param string|string[] $message * @param string|string[] $message
* @param string $level * @param string $level
* @param mixed[] $context * @param mixed[] $context
*/ */
public function log($message, $level = LogLevel::INFO, $context = array()) public function log($message, $level = LogLevel::INFO, $context = array())
{ {
// Skip if no logger has been loaded. // Skip if no logger has been loaded.
if (!$this->logger) { if (!$this->logger) {
return; return;
} }
if (!is_array($message)) { if (!is_array($message)) {
$message = array($message); $message = array($message);
} }
foreach ($message as $item) { foreach ($message as $item) {
$this->logger->log($level, $item, $context); $this->logger->log($level, $item, $context);
} }
} }
/** /**
* Add a success-coloured message to the log. * Add a success-coloured message to the log.
* @param string * @param string
*/ */
public function logSuccess($message) public function logSuccess($message)
{ {
$this->log("\033[0;32m" . $message . "\033[0m"); $this->log("\033[0;32m" . $message . "\033[0m");
} }
/** /**
* Add a failure-coloured message to the log. * Add a failure-coloured message to the log.
* @param string * @param string
*/ */
public function logFailure($message) public function logFailure($message)
{ {
$this->log("\033[0;31m" . $message . "\033[0m"); $this->log("\033[0;31m" . $message . "\033[0m");
} }
/** /**
* Replace every occurance of the interpolation vars in the given string * Replace every occurance of the interpolation vars in the given string
* Example: "This is build %PHPCI_BUILD%" => "This is build 182" * Example: "This is build %PHPCI_BUILD%" => "This is build 182"
@ -283,7 +283,7 @@ class Builder implements LoggerAwareInterface
} }
/** /**
* Sets the variables that will be used for interpolation. This must be run * Sets the variables that will be used for interpolation. This must be run
* from setupBuild() because prior to that, we don't know the buildPath * from setupBuild() because prior to that, we don't know the buildPath
*/ */
protected function setInterpolationVars() protected function setInterpolationVars()
@ -293,9 +293,11 @@ class Builder implements LoggerAwareInterface
$this->interpolation_vars['%COMMIT%'] = $this->build->getCommitId(); $this->interpolation_vars['%COMMIT%'] = $this->build->getCommitId();
$this->interpolation_vars['%PROJECT%'] = $this->build->getProjectId(); $this->interpolation_vars['%PROJECT%'] = $this->build->getProjectId();
$this->interpolation_vars['%BUILD%'] = $this->build->getId(); $this->interpolation_vars['%BUILD%'] = $this->build->getId();
$this->interpolation_vars['%PROJECT_TITLE%'] = $this->getBuildProjectTitle(); $this->interpolation_vars['%PROJECT_TITLE%'] = $this->getBuildProjectTitle(
);
$this->interpolation_vars['%BUILD_PATH%'] = $this->buildPath; $this->interpolation_vars['%BUILD_PATH%'] = $this->buildPath;
$this->interpolation_vars['%BUILD_URI%'] = PHPCI_URL . "build/view/" . $this->build->getId(); $this->interpolation_vars['%BUILD_URI%'] = PHPCI_URL . "build/view/" . $this->build->getId(
);
$this->interpolation_vars['%PHPCI_COMMIT%'] = $this->interpolation_vars['%COMMIT%']; $this->interpolation_vars['%PHPCI_COMMIT%'] = $this->interpolation_vars['%COMMIT%'];
$this->interpolation_vars['%PHPCI_PROJECT%'] = $this->interpolation_vars['%PROJECT%']; $this->interpolation_vars['%PHPCI_PROJECT%'] = $this->interpolation_vars['%PROJECT%'];
$this->interpolation_vars['%PHPCI_BUILD%'] = $this->interpolation_vars['%BUILD%']; $this->interpolation_vars['%PHPCI_BUILD%'] = $this->interpolation_vars['%BUILD%'];
@ -304,25 +306,28 @@ class Builder implements LoggerAwareInterface
$this->interpolation_vars['%PHPCI_BUILD_URI%'] = $this->interpolation_vars['%BUILD_URI%']; $this->interpolation_vars['%PHPCI_BUILD_URI%'] = $this->interpolation_vars['%BUILD_URI%'];
putenv('PHPCI=1'); putenv('PHPCI=1');
putenv('PHPCI_COMMIT='.$this->interpolation_vars['%COMMIT%']); putenv('PHPCI_COMMIT=' . $this->interpolation_vars['%COMMIT%']);
putenv('PHPCI_PROJECT='.$this->interpolation_vars['%PROJECT%']); putenv('PHPCI_PROJECT=' . $this->interpolation_vars['%PROJECT%']);
putenv('PHPCI_BUILD='.$this->interpolation_vars['%BUILD%']); putenv('PHPCI_BUILD=' . $this->interpolation_vars['%BUILD%']);
putenv('PHPCI_PROJECT_TITLE='.$this->interpolation_vars['%PROJECT_TITLE%']); putenv(
putenv('PHPCI_BUILD_PATH='.$this->interpolation_vars['%BUILD_PATH%']); 'PHPCI_PROJECT_TITLE=' . $this->interpolation_vars['%PROJECT_TITLE%']
putenv('PHPCI_BUILD_URI='.$this->interpolation_vars['%BUILD_URI%']); );
putenv('PHPCI_BUILD_PATH=' . $this->interpolation_vars['%BUILD_PATH%']);
putenv('PHPCI_BUILD_URI=' . $this->interpolation_vars['%BUILD_URI%']);
} }
/** /**
* Set up a working copy of the project for building. * Set up a working copy of the project for building.
*/ */
protected function setupBuild() protected function setupBuild()
{ {
$buildId = 'project' . $this->build->getProject()->getId() . '-build' . $this->build->getId(); $buildId = 'project' . $this->build->getProject()->getId(
$this->ciDir = dirname(__FILE__) . '/../'; ) . '-build' . $this->build->getId();
$this->buildPath = $this->ciDir . 'build/' . $buildId . '/'; $this->ciDir = dirname(__FILE__) . '/../';
$this->buildPath = $this->ciDir . 'build/' . $buildId . '/';
$this->setInterpolationVars(); $this->setInterpolationVars();
// Create a working copy of the project: // Create a working copy of the project:
if (!$this->build->createWorkingCopy($this, $this->buildPath)) { if (!$this->build->createWorkingCopy($this, $this->buildPath)) {
throw new \Exception('Could not create a working copy.'); throw new \Exception('Could not create a working copy.');
@ -343,12 +348,16 @@ class Builder implements LoggerAwareInterface
} }
/** /**
* Execute a the appropriate set of plugins for a given build stage. * Execute a the appropriate set of plugins for a given build stage.
*/ */
protected function executePlugins($stage) protected function executePlugins($stage)
{ {
// Ignore any stages for which we don't have plugins set: // Ignore any stages for which we don't have plugins set:
if (!array_key_exists($stage, $this->config) || !is_array($this->config[$stage])) { if (!array_key_exists(
$stage,
$this->config
) || !is_array($this->config[$stage])
) {
return; return;
} }
@ -444,22 +453,24 @@ class Builder implements LoggerAwareInterface
return null; return null;
} }
/** /**
* Sets a logger instance on the object * Sets a logger instance on the object
* *
* @param LoggerInterface $logger * @param LoggerInterface $logger
* @return null * @return null
*/ */
public function setLogger(LoggerInterface $logger) { public function setLogger(LoggerInterface $logger)
$this->logger = $logger; {
} $this->logger = $logger;
}
/** /**
* returns the logger attached to this builder. * returns the logger attached to this builder.
* *
* @return LoggerInterface * @return LoggerInterface
*/ */
public function getLogger() { public function getLogger()
return $this->logger; {
} return $this->logger;
}
} }

38
PHPCI/Helper/BuildDBLogHandler.php
View file

@ -9,25 +9,27 @@ use PHPCI\Model\Build;
class BuildDBLogHandler extends AbstractProcessingHandler class BuildDBLogHandler extends AbstractProcessingHandler
{ {
/** /**
* @var Build * @var Build
*/ */
protected $build; protected $build;
protected $logValue; protected $logValue;
function __construct(Build $build, function __construct(
$level = LogLevel::INFO, Build $build,
$bubble = true) $level = LogLevel::INFO,
{ $bubble = true
parent::__construct($level, $bubble); ) {
$this->build = $build; parent::__construct($level, $bubble);
// We want to add to any existing saved log information. $this->build = $build;
$this->logValue = $build->getLog(); // We want to add to any existing saved log information.
} $this->logValue = $build->getLog();
}
protected function write(array $record) { protected function write(array $record)
$this->logValue .= (string) $record['formatted']; {
$this->build->setLog($this->logValue); $this->logValue .= (string)$record['formatted'];
} $this->build->setLog($this->logValue);
}
} }

31
PHPCI/Helper/OutputLogHandler.php
View file

@ -9,24 +9,25 @@ use Symfony\Component\Console\Output\OutputInterface;
class OutputLogHandler extends AbstractProcessingHandler class OutputLogHandler extends AbstractProcessingHandler
{ {
/** /**
* @var OutputInterface * @var OutputInterface
*/ */
protected $output; protected $output;
function __construct(OutputInterface $output, function __construct(
$level = LogLevel::INFO, OutputInterface $output,
$bubble = true) $level = LogLevel::INFO,
{ $bubble = true
parent::__construct($level, $bubble); ) {
$this->output = $output; parent::__construct($level, $bubble);
} $this->output = $output;
}
protected function write(array $record) protected function write(array $record)
{ {
$this->output->writeln((string) $record['formatted']); $this->output->writeln((string)$record['formatted']);
} }
} }