silverstripe / deploynaut

code/model/DNTag.php

Indentation +51 added lines, -51 removed lines

@@ -5,66 +5,66 @@
 class DNTag extends ViewableData
 {
 
-    /**
-     * @var Gitonomy\Git\Reference\Tag
-     */
-    protected $tag = null;
+	/**
+	 * @var Gitonomy\Git\Reference\Tag
+	 */
+	protected $tag = null;
 
-    protected $project = null;
+	protected $project = null;
 
-    protected $data = null;
+	protected $data = null;
 
-    protected $name = null;
+	protected $name = null;
 
-    protected $references = null;
+	protected $references = null;
 
-    private static $casting = array(
-        'Name' => 'Text',
-        'SHA' => 'Text'
-    );
+	private static $casting = array(
+		'Name' => 'Text',
+		'SHA' => 'Text'
+	);
 
-    /**
-     * @param Tag $tag
-     * @param DNProject $project
-     * @param DNData $data
-     */
-    public function __construct(Tag $tag, DNProject $project, DNData $data)
-    {
-        $this->tag = $tag;
-        $this->project = $project;
-        $this->data = $data;
-    }
+	/**
+	 * @param Tag $tag
+	 * @param DNProject $project
+	 * @param DNData $data
+	 */
+	public function __construct(Tag $tag, DNProject $project, DNData $data)
+	{
+		$this->tag = $tag;
+		$this->project = $project;
+		$this->data = $data;
+	}
 
-    /**
-     * @return string
-     */
-    public function Name()
-    {
-        return htmlentities($this->tag->getName());
-    }
+	/**
+	 * @return string
+	 */
+	public function Name()
+	{
+		return htmlentities($this->tag->getName());
+	}
 
-    /**
-     * @return string
-     */
-    public function SHA()
-    {
-        return htmlentities($this->tag->getCommitHash());
-    }
+	/**
+	 * @return string
+	 */
+	public function SHA()
+	{
+		return htmlentities($this->tag->getCommitHash());
+	}
 
-    /**
-     * @return SS_Datetime
-     */
-    public function Created()
-    {
-        $created = $this->tag->getCommit()->getCommitterDate();
+	/**
+	 * @return SS_Datetime
+	 */
+	public function Created()
+	{
+		$created = $this->tag->getCommit()->getCommitterDate();
 
-        // gitonomy sets the time to UTC, so now we set the timezone to
-        // whatever PHP is set to (date.timezone). This will change in the future if each
-        // deploynaut user has their own timezone
-        $created->setTimezone(new DateTimeZone(date_default_timezone_get()));
+		// gitonomy sets the time to UTC, so now we set the timezone to
+		// whatever PHP is set to (date.timezone). This will change in the future if each
+		// deploynaut user has their own timezone
+		$created->setTimezone(new DateTimeZone(date_default_timezone_get()));
 
-        $d = new SS_Datetime();
-        $d->setValue($created->format('Y-m-d H:i:s'));
-        return $d;
-    }
+		$d = new SS_Datetime();
+		$d->setValue($created->format('Y-m-d H:i:s'));
+		return $d;
+	}
 }

code/model/GitonomyCache.php

Indentation +9 added lines, -9 removed lines

@@ -5,14 +5,14 @@
  */
 class GitonomyCache
 {
-    public static $cache = array();
+	public static $cache = array();
 
-    public static function getIncludingBranches($commit)
-    {
-        $cacheKey = 'getIncludingBranches-' . $commit->getRepository()->getPath() . '-' . $commit->gethash();
-        if (!isset(self::$cache[$cacheKey])) {
-            self::$cache[$cacheKey] = $commit->getIncludingBranches();
-        }
-        return self::$cache[$cacheKey];
-    }
+	public static function getIncludingBranches($commit)
+	{
+		$cacheKey = 'getIncludingBranches-' . $commit->getRepository()->getPath() . '-' . $commit->gethash();
+		if (!isset(self::$cache[$cacheKey])) {
+			self::$cache[$cacheKey] = $commit->getIncludingBranches();
+		}
+		return self::$cache[$cacheKey];
+	}
 }

code/model/Pipeline.php

Indentation +1079 added lines, -1079 removed lines

@@ -114,1083 +114,1083 @@
 class Pipeline extends DataObject implements PipelineData
 {
 
-    /**
-     * Messages
-     */
-    const ALERT_ABORT = 'Abort';
-    const ALERT_SUCCESS = 'Success';
-    const ALERT_FAILURE = 'Failure';
-    const ALERT_ROLLBACK_STARTED = 'RollbackStarted';
-    const ALERT_ROLLBACK_SUCCESS = 'RollbackSuccess';
-    const ALERT_ROLLBACK_FAILURE = 'RollbackFailure';
-
-    /**
-     * - Status: Current status of this Pipeline. Running means 'currently executing a {@link PipelineStep}'.
-     *           See the {@link PipelineControllerTask} class for why this is important.
-     * - SHA:    This is the Git SHA that the pipeline is acting on. This is passed into the {@link PipelineStep}
-     *           objects so that the steps know what to smoketest, deploy, etc.
-     *
-     * @var array
-     */
-    private static $db = array(
-        'Status' => 'Enum("Running,Complete,Failed,Aborted,Rollback,Queued", "Queued")',
-        'Config' => 'Text', // serialized array of configuration for this pipeline
-        'SHA' => 'Varchar(255)',
-        'DryRun' => 'Boolean', // Try if this deployment is a test dryrun
-        'LastMessageSent' => 'Varchar(255)' // ID of last message sent
-    );
-
-    /**
-     * - Author:      The {@link Member} object that started this pipeline running.
-     * - Environment: The {@link DNEnvironment} that this Pipeline is associated to.
-     * - CurrentStep: The current {@link PipelineStep} object that is keeping this pipeline alive. This should be
-     *                cleared when the last step is complete.
-     *
-     * @var array
-     */
-    private static $has_one = array(
-        'Author' => 'Member',
-        'Environment' => 'DNEnvironment',
-        'CurrentStep' => 'PipelineStep',
-        // to be used for rollbacks
-        "PreviousSnapshot" => "DNDataTransfer",
-        "PreviousDeployment" => 'DNDeployment',
-        "CurrentDeployment" => "DNDeployment",
-        "RollbackStep1" => "PipelineStep",
-        "RollbackStep2" => "PipelineStep"
-    );
-
-    /**
-     * - Steps: These are ordered by the `PipelineStep`.`Order` attribute.
-     *
-     * @var array
-     */
-    private static $has_many = array(
-        'Steps' => 'PipelineStep'
-    );
-
-    /**
-     * @var array
-     */
-    private static $summary_fields = array(
-        'ID' => 'ID',
-        'Status' => 'Status',
-        'SHA' => 'SHA',
-        'Author.Title' => 'Author',
-        'CurrentStep.Name' => 'Current Step',
-        'Created' => 'Created',
-        'LastEdited' => 'Last Updated'
-    );
-
-    /**
-     * @var string
-     */
-    private static $default_sort = '"Created" DESC';
-
-    /**
-     * @var array
-     */
-    private static $cast = array(
-        'RunningDescription' => 'HTMLText'
-    );
-
-    /**
-     * @config
-     * @var array
-     */
-    private static $dependencies = array(
-        'MessagingService' => '%$ConfirmationMessagingService'
-    );
-
-    /**
-     * Currently assigned messaging service
-     *
-     * @var ConfirmationMessagingService
-     */
-    private $messagingService = null;
-
-    /**
-     * @param ConfirmationMessagingService $service
-     */
-    public function setMessagingService(ConfirmationMessagingService $service)
-    {
-        $this->messagingService = $service;
-    }
-
-    /**
-     * @return ConfirmationMessagingService
-     */
-    public function getMessagingService()
-    {
-        return $this->messagingService;
-    }
-
-    public function __isset($property)
-    {
-        // Workaround fixed in https://github.com/silverstripe/silverstripe-framework/pull/3201
-        // Remove this once we update to a version of framework which supports this
-        if ($property === 'MessagingService') {
-            return !empty($this->messagingService);
-        }
-        return parent::__isset($property);
-    }
-
-    /**
-     * Retrieve message template replacements
-     *
-     * @return array
-     */
-    public function getReplacements()
-    {
-        // Get member who began this request
-        $author = $this->Author();
-        $environment = $this->Environment();
-        return array(
-            '<abortlink>' => Director::absoluteURL($this->Environment()->Link()),
-            '<pipelinelink>' => Director::absoluteURL($this->Link()),
-            '<requester>' => $author->Title,
-            '<requester-email>' => $author->Email,
-            '<environment>' => $environment->Name,
-            '<project>' => $environment->Project()->Name,
-            '<commitsha>' => $this->SHA
-        );
-    }
-
-    /**
-     * Title of this step
-     *
-     * @return string
-     */
-    public function getTitle()
-    {
-        return "Pipeline {$this->ID} (Status: {$this->Status})";
-    }
-
-    /**
-     * @param Member $member
-     */
-    public function canAbort($member = null)
-    {
-        // Owner can abort
-        $member = $member ?: Member::currentUser();
-        if (!$member) {
-            return false;
-        }
-        if ($member->ID == $this->AuthorID) {
-            return true;
-        }
-
-        // Check environment permission
-        return $this->Environment()->canAbort($member);
-    }
-
-    /**
-     * Get status of currently running step
-     *
-     * @return string Status description (html format)
-     */
-    public function getRunningDescription()
-    {
-        if (!$this->isActive()) {
-            return 'This pipeline is not currently running';
-        }
-        $result = '';
-        if ($step = $this->CurrentStep()) {
-            $result = $step->getRunningDescription();
-        }
-        return $result ?: 'This pipeline is currently running';
-    }
-
-    /**
-     * Get options for the currently running pipeline, if and only if it is currently running
-     *
-     * @return ArrayList List of items with a Link and Title attribute
-     */
-    public function RunningOptions()
-    {
-        if (!$this->isActive()) {
-            return null;
-        }
-        $actions = array();
-
-        // Let current step update the current list of options
-        if (($step = $this->CurrentStep()) && ($step->isRunning())) {
-            $actions = $step->allowedActions();
-        }
-        return new ArrayList($actions);
-    }
-
-    /**
-     * Get possible logs for the currently pipeline
-     *
-     * @return ArrayList List of logs with a Link and Title attribute
-     */
-    public function LogOptions()
-    {
-        if (!$this->isActive()) {
-            return null;
-        }
-
-        $logs = array();
-
-        $logs[] = array(
-            'ButtonText' => 'Pipeline Log',
-            'Link' => $this->Link()
-        );
-
-        if ($this->PreviousSnapshotID > 0) {
-            $logs[] = array(
-                'ButtonText' => 'Snapshot Log',
-                'Link' => $this->PreviousSnapshot()->Link()
-            );
-        }
-
-        if ($this->CurrentDeploymentID > 0) {
-            $logs[] = array(
-                'ButtonText' => 'Deployment Log',
-                'Link' => $this->CurrentDeployment()->Link()
-            );
-        }
-
-        // Get logs from rollback steps (only for RollbackSteps).
-        $rollbackSteps = array($this->RollbackStep1(), $this->RollbackStep2());
-        foreach ($rollbackSteps as $rollback) {
-            if ($rollback->exists() && $rollback->ClassName == 'RollbackStep') {
-                if ($rollback->RollbackDeploymentID > 0) {
-                    $logs[] = array(
-                        'ButtonText' => 'Rollback Log',
-                        'Link' => $rollback->RollbackDeployment()->Link()
-                    );
-                }
-
-                if ($rollback->RollbackDatabaseID > 0) {
-                    $logs[] = array(
-                        'ButtonText' => 'Rollback DB Log',
-                        'Link' => $rollback->RollbackDatabase()->Link()
-                    );
-                }
-            }
-        }
-
-        return new ArrayList($logs);
-    }
-
-    /**
-     * Cached of config merged with defaults
-     *
-     * @var array|null
-     */
-    protected $mergedConfig;
-
-    /**
-     * Get this pipeline configuration. If the configuration has been serialized
-     * and saved into the Config field, it'll use that. If that field is empty,
-     * it'll read the YAML file directly and return that instead.
-     *
-     * @return array
-     * @throws Exception
-     */
-    public function getConfigData()
-    {
-        // Lazy load if necessary
-        $data = null;
-        if (!$this->Config && ($data = $this->Environment()->loadPipelineConfig())) {
-            $this->Config = serialize($data);
-        }
-
-        // Merge with defaults
-        if ($this->Config) {
-            if (!$this->mergedConfig) {
-                $this->mergedConfig = $data ?: unserialize($this->Config);
-                if ($default = self::config()->default_config) {
-                    Config::merge_array_low_into_high($this->mergedConfig, $default);
-                }
-            }
-            return $this->mergedConfig;
-        }
-
-        // Fail if no data available
-        $path = $this->Environment()->getPipelineFilename();
-        throw new Exception(sprintf('YAML configuration for pipeline not found at path "%s"', $path));
-    }
-
-    public function setConfig($data)
-    {
-        $this->mergedConfig = null;
-        return parent::setField('Config', $data);
-    }
-
-    /**
-     * Retrieve the value of a specific config setting
-     *
-     * @param string $setting Settings
-     * @return mixed Value of setting, or null if not set
-     */
-    public function getConfigSetting($setting)
-    {
-        $source = $this->getConfigData();
-
-        foreach (func_get_args() as $setting) {
-            if (empty($source[$setting])) {
-                return null;
-            }
-            $source = $source[$setting];
-        }
-
-        return $source;
-    }
-
-    /**
-     * @return FieldList
-     */
-    public function getCMSFields()
-    {
-        $fields = new FieldList(new TabSet('Root'));
-
-        // Main fields
-        $fields->addFieldsToTab('Root.Main', array(
-            TextField::create('SHA')
-                ->setDescription('SHA of the commit this pipeline is running against')
-                ->performReadonlyTransformation(),
-            TextField::create('AuthorName', 'Author', ($author = $this->Author()) ? $author->Title : null)
-                ->setDescription('Person who initiated this pipeline')
-                ->performReadonlyTransformation(),
-            DropdownField::create('Status', 'Status', $this->dbObject('Status')->enumValues()),
-            DropdownField::create('CurrentStepID', 'Current Step', $this->Steps()->map('ID', 'TreeTitle')),
-            TextField::create(
-                'CurrentDeployment_Label',
-                'Current Deployment',
-                $this->CurrentDeployment()->getTitle()
-            )    ->setDescription('Deployment generated by this pipeline')
-                ->performReadonlyTransformation(),
-        ));
-
-        // Backup fields
-        $fields->addFieldsToTab('Root.Backups', array(
-            TextField::create(
-                'PreviousDeployment_Label',
-                'Previous Deployment',
-                $this->PreviousDeployment()->getTitle()
-            )    ->setDescription('Prior deployment to revert to if this pipeline fails')
-                ->performReadonlyTransformation(),
-            TextField::create(
-                'PreviousSnapshot_Label',
-                'Previous DB Snapshot',
-                $this->PreviousSnapshot()->getTitle()
-            )    ->setDescription('Database backup to revert to if this pipeline fails')
-                ->performReadonlyTransformation()
-        ));
-
-        if ($log = $this->LogContent()) {
-            $fields->addFieldToTab(
-                'Root.Main',
-                ToggleCompositeField::create(
-                    'PipelineLog',
-                    'Pipeline Log',
-                    LiteralField::create('LogText', nl2br(Convert::raw2xml($log)))
-                )
-            );
-        }
-
-        // Steps
-        $stepConfig = GridFieldConfig_RecordEditor::create();
-        $steps = GridField::create('Steps', 'Pipeline Steps', $this->Steps(), $stepConfig);
-        $fields->addFieldsToTab('Root.PipelineSteps', $steps);
-
-        return $fields;
-    }
-
-    /**
-     * Return a dependent {@link DNEnvironment} based on this pipeline's dependent environment configuration.
-     *
-     * @return DNEnvironment
-     */
-    public function getDependentEnvironment()
-    {
-        // dependent environment not available
-        $projectName = $this->getConfigSetting('PipelineConfig', 'DependsOnProject');
-        $environmentName = $this->getConfigSetting('PipelineConfig', 'DependsOnEnvironment');
-        if (empty($projectName) || empty($environmentName)) {
-            return null;
-        }
-
-        $project = DNProject::get()->filter('Name', $projectName)->first();
-        if (!($project && $project->exists())) {
-            throw new Exception(sprintf('Could not find dependent project "%s"', $projectName));
-        }
-
-        $environment = DNEnvironment::get()->filter(array(
-            'ProjectID' => $project->ID,
-            'Name' => $environmentName
-        ))->first();
-
-        if (!($environment && $environment->exists())) {
-            throw new Exception(sprintf(
-                'Could not find dependent environment "%s" in project "%s"',
-                $environmentName,
-                $projectName
-            ));
-        }
-
-        return $environment;
-    }
-
-    /**
-     * Generate a step from a name, config, and sort order
-     *
-     * @throws Exception
-     * @param string $name
-     * @param array $stepConfig
-     * @param int $order
-     * @return PipelineStep
-     */
-    protected function generateStep($name, $stepConfig, $order = 0)
-    {
-        $stepClass = isset($stepConfig['Class']) ? $stepConfig['Class'] : $stepConfig;
-
-        if (empty($stepClass)) {
-            throw new Exception(
-                sprintf('Missing or empty Class specifier for step "%s"', $name)
-            );
-        }
-
-        if (!is_subclass_of($stepClass, 'PipelineStep')) {
-            throw new Exception(
-                sprintf('%s is not a valid "Class" field name for step "%s"', var_export($stepClass, true), $name)
-            );
-        }
-
-        $step = $stepClass::create();
-        $step->Name = $name;
-        $step->PipelineID = $this->ID;
-        $step->Order = $order;
-        $step->Status = 'Queued';
-        $step->Config = serialize($stepConfig);
-        $step->write();
-
-        return $step;
-    }
-
-    /**
-     * Starts the pipeline process.
-     *
-     * Reads a YAML configuration from the linked {@link DNEnvironment}
-     * and builds the {@link PipelineStep} objects and runs them.
-     *
-     * Note that this method doesn't actually start any {@link PipelineStep} objects, that is handled by
-     * {@link self::checkPipelineStatus()}, and the daemon running the process.
-     *
-     * @throws LogicException
-     * @return boolean
-     */
-    public function start()
-    {
-        // Ensure there are no other running {@link Pipeline} objects for this {@link DNEnvironment}
-        // Requires that $this->EnvironmentID has been set
-        $env = $this->Environment();
-        if (!($env && $env->exists())) {
-            throw new LogicException("This pipeline needs a valid environment to run on.");
-        }
-
-        if ($env->HasCurrentPipeline()) {
-            throw new LogicException("You can only run one pipeline at a time on this environment.");
-        }
-
-        $this->write(); // ensure we've written this record first
-
-        // Instantiate steps.
-        foreach ($this->getConfigSetting('Steps') as $name => $stepConfig) {
-            $this->pushPipelineStep($name, $stepConfig);
-        }
-
-        $this->Status = 'Running';
-        $this->write();
-
-        $this->log('Started logging for this pipeline!');
-
-        return true;
-    }
-
-    /**
-     * Mark this Pipeline as completed.
-     */
-    public function markComplete()
-    {
-        $this->Status = "Complete";
-        $this->log("Pipeline completed successfully.");
-        $this->write();
-        // Some steps may pre-emptively send a success message before the pipeline itself has completed
-        if ($this->LastMessageSent !== self::ALERT_SUCCESS) {
-            $this->sendMessage(self::ALERT_SUCCESS);
-        }
-    }
-
-    /**
-     * @return bool true if this Pipeline has successfully completed all {@link PipelineStep} steps already.
-     */
-    public function isComplete()
-    {
-        return $this->Status == "Complete";
-    }
-
-    /**
-     * True if the pipeline is running but NOT doing a rollback
-     *
-     * @return bool
-     */
-    public function isRunning()
-    {
-        return $this->Status == "Running";
-    }
-
-    /**
-     * True if the pipeline is running or doing a rollback
-     *
-     * @return bool
-     */
-    public function isActive()
-    {
-        return $this->isRunning() || $this->isRollback();
-    }
-
-    /**
-     * Push a step to the end of a pipeline
-     *
-     * @param string $name
-     * @param array $stepConfig
-     * @return PipelineStep
-     */
-    private function pushPipelineStep($name, $stepConfig)
-    {
-        $lastStep = $this->Steps()->sort("Order DESC")->first();
-        $order = $lastStep ? $lastStep->Order + 1 : 1;
-        return $this->generateStep($name, $stepConfig, $order);
-    }
-
-    /**
-     * The rollback has finished - close the pipeline and send relevant messages.
-     */
-    protected function finaliseRollback()
-    {
-
-        // Figure out the status by inspecting specific rollback steps.
-        $success = true;
-        $rollback1 = $this->RollbackStep1();
-        $rollback2 = $this->RollbackStep2();
-        if (!empty($rollback1) && $rollback1->Status == 'Failed') {
-            $success = false;
-        }
-        if (!empty($rollback2) && $rollback2->Status == 'Failed') {
-            $success = false;
-        }
-
-        // Send messages.
-        if ($success) {
-            $this->log("Pipeline failed, but rollback completed successfully.");
-            $this->sendMessage(self::ALERT_ROLLBACK_SUCCESS);
-        } else {
-            $this->log("Pipeline failed, rollback failed.");
-            $this->sendMessage(self::ALERT_ROLLBACK_FAILURE);
-        }
-
-        // Finish off the pipeline - rollback will only be triggered on a failed pipeline.
-        $this->Status = 'Failed';
-        $this->write();
-    }
-
-    /**
-     * Initiate a rollback. Moves the pipeline to the 'Rollback' status.
-     */
-    protected function beginRollback()
-    {
-        $this->log("Beginning rollback...");
-        $this->sendMessage(self::ALERT_ROLLBACK_STARTED);
-
-        // Add rollback step.
-        $configRollback1 = $this->getConfigSetting('RollbackStep1');
-        $stepRollback1 = $this->pushPipelineStep('RollbackStep1', $configRollback1);
-        $this->RollbackStep1ID = $stepRollback1->ID;
-        $this->CurrentStepID = $stepRollback1->ID;
-        $this->Status = 'Rollback';
-
-        // Add smoke test step, if available, for later processing.
-        $configRollback2 = $this->getConfigSetting('RollbackStep2');
-        if ($configRollback2) {
-            $stepRollback2 = $this->pushPipelineStep('RollbackStep2', $configRollback2);
-            $this->RollbackStep2ID = $stepRollback2->ID;
-        }
-
-        $this->write();
-
-        $stepRollback1->start();
-    }
-
-    /**
-     * Check if pipeline currently permits a rollback.
-     * This could be influenced by both the current state and by the specific configuration.
-     *
-     * @return boolean
-     */
-    protected function canStartRollback()
-    {
-        // The rollback cannot run twice.
-        if ($this->isRollback()) {
-            return false;
-        }
-
-        // Rollbacks must be configured.
-        if (!$this->getConfigSetting('RollbackStep1')) {
-            return false;
-        }
-
-        // On dryrun let rollback run
-        if ($this->DryRun) {
-            return true;
-        }
-
-        // Pipeline must have ran a deployment to be able to rollback.
-        $deploy = $this->CurrentDeployment();
-        $previous = $this->PreviousDeployment();
-        if (!$deploy->exists() || !$previous->exists()) {
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * Notify Pipeline that a step has failed and failure processing should kick in. If rollback steps are present
-     * the pipeline will be put into 'Rollback' state. After rollback is complete, regardless of the rollback result,
-     * the pipeline will be failed.
-     *
-     * @param bool $notify Set to false to disable notifications for this failure
-     */
-    public function markFailed($notify = true)
-    {
-        // Abort all running or queued steps.
-        $steps = $this->Steps();
-        foreach ($steps as $step) {
-            if ($step->isQueued() || $step->isRunning()) {
-                $step->abort();
-            }
-        }
-
-        if ($this->canStartRollback()) {
-            $this->beginRollback();
-        } elseif ($this->isRollback()) {
-            $this->finaliseRollback();
-        } else {
-            // Not able to roll back - fail immediately.
-            $this->Status = 'Failed';
-            $this->log("Pipeline failed, not running rollback (not configured or not applicable yet).");
-            $this->write();
-            if ($notify) {
-                $this->sendMessage(self::ALERT_FAILURE);
-            }
-        }
-    }
-
-    /**
-     * @return bool true if this Pipeline failed to execute all {@link PipelineStep} steps successfully
-     */
-    public function isFailed()
-    {
-        return $this->Status == "Failed";
-    }
-
-    /**
-     * @return bool true if this Pipeline is rolling back.
-     */
-    public function isRollback()
-    {
-        return $this->Status == "Rollback";
-    }
-
-    /**
-     * Mark this Pipeline as aborted
-     */
-    public function markAborted()
-    {
-        $this->Status = 'Aborted';
-        $logMessage = sprintf(
-            "Pipeline processing aborted. %s (%s) aborted the pipeline",
-            Member::currentUser()->Name,
-            Member::currentUser()->Email
-        );
-        $this->log($logMessage);
-        $this->write();
-
-        // Abort all running or queued steps.
-        $steps = $this->Steps();
-        foreach ($steps as $step) {
-            if ($step->isQueued() || $step->isRunning()) {
-                $step->abort();
-            }
-        }
-
-        // Send notification to users about this event
-        $this->sendMessage(self::ALERT_ABORT);
-    }
-
-    /**
-     * Finds a message template for a given role and message
-     *
-     * @param string $messageID Message ID
-     * @return array Resulting array(subject, message)
-     */
-    protected function generateMessageTemplate($messageID)
-    {
-        $subject = $this->getConfigSetting('PipelineConfig', 'Subjects', $messageID);
-        $message = $this->getConfigSetting('PipelineConfig', 'Messages', $messageID);
-        $substitutions = $this->getReplacements();
-        return $this->injectMessageReplacements($message, $subject, $substitutions);
-    }
-
-    /**
-     * Substitute templated variables into the given message and subject
-     *
-     * @param string $message
-     * @param string $subject
-     * @param array $substitutions
-     * @return array Resulting array(subject, message)
-     */
-    public function injectMessageReplacements($message, $subject, $substitutions)
-    {
-        // Handle empty messages
-        if (empty($subject) && empty($message)) {
-            return array(null, null);
-        }
-
-        // Check if there's a role specific message
-        $subjectText = str_replace(
-            array_keys($substitutions),
-            array_values($substitutions),
-            $subject ?: $message
-        );
-        $messageText = str_replace(
-            array_keys($substitutions),
-            array_values($substitutions),
-            $message ?: $subject
-        );
-
-
-        return array($subjectText, $messageText);
-    }
-
-    /**
-     * Sends a specific message to all marked recipients, including the author of this pipeline
-     *
-     * @param string $messageID Message ID. One of 'Abort', 'Success', or 'Failure', or some custom message
-     * @return boolean|null True if successful
-     */
-    public function sendMessage($messageID)
-    {
-        // Check message, subject, and additional arguments to include
-        list($subject, $message) = $this->generateMessageTemplate($messageID);
-        if (empty($subject) || empty($message)) {
-            $this->log("Skipping sending message. None configured for $messageID");
-            return true;
-        }
-
-        // Save last sent message
-        $this->LastMessageSent = $messageID;
-        $this->write();
-
-        // Setup messaging arguments
-        $arguments = array_merge(
-            $this->getConfigSetting('PipelineConfig', 'ServiceArguments') ?: array(),
-            array('subject' => $subject)
-        );
-
-        // Send message to author
-        if ($author = $this->Author()) {
-            $this->log("Pipeline sending $messageID message to {$author->Email}");
-            $this->messagingService->sendMessage($this, $message, $author, $arguments);
-        } else {
-            $this->log("Skipping sending message to missing author");
-        }
-
-        // Get additional recipients
-        $recipients = $this->getConfigSetting('PipelineConfig', 'Recipients', $messageID);
-        if (empty($recipients)) {
-            $this->log("Skipping sending message to empty recipients");
-        } else {
-            $recipientsStr = is_array($recipients) ? implode(',', $recipients) : $recipients;
-            $this->log("Pipeline sending $messageID message to $recipientsStr");
-            $this->messagingService->sendMessage($this, $message, $recipients, $arguments);
-        }
-    }
-
-    /**
-     * @return bool true if this Pipeline has been aborted
-     */
-    public function isAborted()
-    {
-        return $this->Status === "Aborted";
-    }
-
-    /**
-     * This method should be called only by the {@link CheckPipelineStatus} controller. It iterates through all the
-     * {@link PipelineStep} objects associated with this Pipeline, and finds a place where the pipeline has stalled
-     * (where one step has completed, but the next one has yet to start). It will then start the next step if required.
-     *
-     * We check here whether the {@link PipelineStep} finished successfully, and will mark the Pipeline as Failed if
-     * the step failed, but this is only a fallback, and should not be relied upon. The individual {@link PipelineStep}
-     * should mark itself as failed and then call {@link Pipeline::markFailed()} directly.
-     *
-     * If the Pipeline has run out of steps, then it will mark the pipeline as completed.
-     */
-    public function checkPipelineStatus()
-    {
-        $message = "";
-
-        if (!$this->isActive()) {
-            $message = "Pipeline::checkPipelineStatus() should only be called on running or rolling back pipelines.";
-        }
-
-        if (!$this->ID || !$this->isInDB()) {
-            $message = "Pipeline::checkPipelineStatus() can only be called on pipelines already saved.";
-        }
-
-        $currentStep = ($this->CurrentStep() && $this->CurrentStep()->isInDB())
-            ? $this->CurrentStep()
-            : null;
-
-        if ($currentStep && $currentStep->PipelineID != $this->ID) {
-            $message = sprintf(
-                "The current step (#%d) has a pipeline ID (#%d) that doesn't match this pipeline's ID (#%d).",
-                $currentStep->ID,
-                $currentStep->PipelineID,
-                $this->ID
-            );
-        }
-
-        if ($message) {
-            $this->log($message);
-            throw new LogicException($message);
-        }
-
-        // Fallback check only: this shouldn't be called unless a {@link PipelineStep} has been implemented incorrectly
-        if ($currentStep && $currentStep->isFailed() && !$this->isFailed() && !$this->isRollback()) {
-            $this->log(sprintf("Marking pipeline step (#%d) as failed - this pipeline step needs to be amended to mark"
-                . " the pipeline (as well as itself) as failed to ensure consistency.",
-                $this->CurrentStep()->ID
-            ));
-
-            $this->markFailed();
-            return;
-        }
-
-        // If this is the first time the Pipeline is run, then we don't have a CurrentStep, so set it,
-        // start it running, and return
-        if (!$currentStep) {
-            $step = $this->Steps()->first();
-            $this->CurrentStepID = $step->ID;
-            $this->write();
-
-            $this->log("Starting first pipeline step...");
-            $step->start();
-        } elseif ($currentStep->isFinished()) {
-            // Sort through the list of {@link PipelineStep} objects to find the next step we need to start.
-            $this->log("Finding next step to execute...");
-            $nextStep = $this->findNextStep();
-
-            if (!$nextStep) {
-
-                // Special handling, since the main pipeline has already failed at this stage.
-                if ($this->isRollback()) {
-                    $this->finaliseRollback();
-                    return false;
-                }
-
-                // Double check for any steps that failed, but didn't notify the pipeline via markFailed.
-                $failedSteps = PipelineStep::get()->filter(array(
-                    'PipelineID' => $this->ID,
-                    'Status' => 'Failed'
-                ))->count();
-                if ($failedSteps) {
-                    $this->log('At least one of the steps has failed marking the pipeline as failed');
-                    $this->markFailed();
-                    return false;
-                }
-
-                // We've reached the end of this pipeline successfully!
-                $this->markComplete();
-                return;
-            } else {
-                $this->CurrentStepID = $nextStep->ID;
-                $this->write();
-                // Otherwise, kick off the next step
-                $this->log(sprintf("Found the next step (#%s), starting it now...", $nextStep->Name));
-                $nextStep->start();
-            }
-        // if the current step is failing run it again
-        } elseif ($step = $this->CurrentStep()) {
-            $step->start();
-        }
-    }
-
-    /**
-     * Finds the next {@link PipelineStep} that needs to execute. Relies on $this->CurrentStep() being a valid step.
-     *
-     * @return DataObject|null The next step in the pipeline, or null if none remain.
-     */
-    protected function findNextStep()
-    {
-        // otherwise get next step in chain
-        $currentStep = $this->CurrentStep();
-
-        return $this
-            ->Steps()
-            ->filter("Status", "Queued")
-            ->filter("Order:GreaterThanOrEqual", $currentStep->Order)
-            ->exclude("ID", $currentStep->ID)
-            ->sort("Order ASC")
-            ->first();
-    }
-
-    /**
-     * Finds the previous {@link PipelineStep} that executed. Relies on $this->CurrentStep() being a valid step.
-     *
-     * @return DataObject|null The previous step in the pipeline, or null if this is the first.
-     */
-    public function findPreviousStep()
-    {
-        // otherwise get previous step in chain
-        $currentStep = $this->CurrentStep();
-
-        return $this
-            ->Steps()
-            ->filter("Status", "Finished")
-            ->filter("Order:LessThanOrEqual", $currentStep->Order)
-            ->exclude("ID", $currentStep->ID)
-            ->sort("Order DESC")
-            ->first();
-    }
-
-    /**
-     * Write to a common log file. This log file will be the same regardless of how often this pipeline is re-created
-     * from the database. To this end, it needs to know the database ID of this pipeline instance, so that it can
-     * generate the correct filename to open.
-     *
-     * This also includes the calling class and method name that called ->log() in the first place, so we can trace
-     * back where it was written from.
-     *
-     * @param string $message The message to log
-     * @throws LogicException Thrown if we can't log yet because we don't know what to log to (no db record yet).
-     */
-    public function log($message = "")
-    {
-        $log = $this->getLogger();
-
-        // Taken from Debug::caller(), amended for our purposes to filter out the intermediate call to
-        // PipelineStep->log(), so that our log message shows where the log message was actually created from.
-        $bt = debug_backtrace();
-
-        $index = ($bt[1]['class'] == 'PipelineStep') ? 2 : 1;
-
-        $caller = $bt[$index];
-        $caller['line'] = $bt[($index - 1)]['line']; // Overwrite line and file to be the the line/file that actually
-        $caller['file'] = $bt[($index - 1)]['file']; // called the function, not where the function is defined.
-        // In case it wasn't called from a class
-        if (!isset($caller['class'])) {
-            $caller['class'] = '';
-        }
-        // In case it doesn't have a type (wasn't called from class)
-        if (!isset($caller['type'])) {
-            $caller['type'] = '';
-        }
-
-        $log->write(sprintf(
-            "[%s::%s() (line %d)] %s",
-            $caller['class'],
-            $caller['function'],
-            $caller['line'],
-            $message
-        ));
-    }
-
-    /**
-     * Returns the {@link DeploynautLogFile} instance that will actually write to this log file.
-     *
-     * @return DeploynautLogFile
-     * @throws RuntimeException
-     */
-    public function getLogger()
-    {
-        if (!$this->isInDB()) {
-            throw new RuntimeException("Can't write to a log file until we know the database ID.");
-        }
-
-        if (!$this->Environment()) {
-            throw new RuntimeException("Can't write to a log file until we have an Environment.");
-        }
-
-        if ($this->Environment() && !$this->Environment()->Project()) {
-            throw new RuntimeException("Can't write to a log file until we have the Environment's project.");
-        }
-
-        $environment = $this->Environment();
-        $filename = sprintf('%s.pipeline.%d.log', $environment->getFullName('.'), $this->ID);
-
-        return Injector::inst()->createWithArgs('DeploynautLogFile', array($filename));
-    }
-
-    /**
-     * @return bool
-     */
-    public function getDryRun()
-    {
-        return $this->getField('DryRun');
-    }
-
-    /**
-     * @param string|null $action
-     *
-     * @return string
-     */
-    public function Link($action = null)
-    {
-        return Controller::join_links($this->Environment()->Link(), 'pipeline', $this->ID, $action);
-    }
-
-    /**
-     * Link to an action on the current step
-     *
-     * @param string|null $action
-     * @return string
-     */
-    public function StepLink($action = null)
-    {
-        return Controller::join_links($this->Link('step'), $action);
-    }
-
-    /**
-     * @return string
-     */
-    public function AbortLink()
-    {
-        return $this->Link('abort');
-    }
-
-    /**
-     * @return string
-     */
-    public function LogLink()
-    {
-        return $this->Link('log');
-    }
-
-    /**
-     * @return string
-     */
-    public function LogContent()
-    {
-        if ($this->exists() && $this->Environment()) {
-            $logger = $this->getLogger();
-            if ($logger->exists()) {
-                return $logger->content();
-            }
-        }
-    }
+	/**
+	 * Messages
+	 */
+	const ALERT_ABORT = 'Abort';
+	const ALERT_SUCCESS = 'Success';
+	const ALERT_FAILURE = 'Failure';
+	const ALERT_ROLLBACK_STARTED = 'RollbackStarted';
+	const ALERT_ROLLBACK_SUCCESS = 'RollbackSuccess';
+	const ALERT_ROLLBACK_FAILURE = 'RollbackFailure';
+
+	/**
+	 * - Status: Current status of this Pipeline. Running means 'currently executing a {@link PipelineStep}'.
+	 *           See the {@link PipelineControllerTask} class for why this is important.
+	 * - SHA:    This is the Git SHA that the pipeline is acting on. This is passed into the {@link PipelineStep}
+	 *           objects so that the steps know what to smoketest, deploy, etc.
+	 *
+	 * @var array
+	 */
+	private static $db = array(
+		'Status' => 'Enum("Running,Complete,Failed,Aborted,Rollback,Queued", "Queued")',
+		'Config' => 'Text', // serialized array of configuration for this pipeline
+		'SHA' => 'Varchar(255)',
+		'DryRun' => 'Boolean', // Try if this deployment is a test dryrun
+		'LastMessageSent' => 'Varchar(255)' // ID of last message sent
+	);
+
+	/**
+	 * - Author:      The {@link Member} object that started this pipeline running.
+	 * - Environment: The {@link DNEnvironment} that this Pipeline is associated to.
+	 * - CurrentStep: The current {@link PipelineStep} object that is keeping this pipeline alive. This should be
+	 *                cleared when the last step is complete.
+	 *
+	 * @var array
+	 */
+	private static $has_one = array(
+		'Author' => 'Member',
+		'Environment' => 'DNEnvironment',
+		'CurrentStep' => 'PipelineStep',
+		// to be used for rollbacks
+		"PreviousSnapshot" => "DNDataTransfer",
+		"PreviousDeployment" => 'DNDeployment',
+		"CurrentDeployment" => "DNDeployment",
+		"RollbackStep1" => "PipelineStep",
+		"RollbackStep2" => "PipelineStep"
+	);
+
+	/**
+	 * - Steps: These are ordered by the `PipelineStep`.`Order` attribute.
+	 *
+	 * @var array
+	 */
+	private static $has_many = array(
+		'Steps' => 'PipelineStep'
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $summary_fields = array(
+		'ID' => 'ID',
+		'Status' => 'Status',
+		'SHA' => 'SHA',
+		'Author.Title' => 'Author',
+		'CurrentStep.Name' => 'Current Step',
+		'Created' => 'Created',
+		'LastEdited' => 'Last Updated'
+	);
+
+	/**
+	 * @var string
+	 */
+	private static $default_sort = '"Created" DESC';
+
+	/**
+	 * @var array
+	 */
+	private static $cast = array(
+		'RunningDescription' => 'HTMLText'
+	);
+
+	/**
+	 * @config
+	 * @var array
+	 */
+	private static $dependencies = array(
+		'MessagingService' => '%$ConfirmationMessagingService'
+	);
+
+	/**
+	 * Currently assigned messaging service
+	 *
+	 * @var ConfirmationMessagingService
+	 */
+	private $messagingService = null;
+
+	/**
+	 * @param ConfirmationMessagingService $service
+	 */
+	public function setMessagingService(ConfirmationMessagingService $service)
+	{
+		$this->messagingService = $service;
+	}
+
+	/**
+	 * @return ConfirmationMessagingService
+	 */
+	public function getMessagingService()
+	{
+		return $this->messagingService;
+	}
+
+	public function __isset($property)
+	{
+		// Workaround fixed in https://github.com/silverstripe/silverstripe-framework/pull/3201
+		// Remove this once we update to a version of framework which supports this
+		if ($property === 'MessagingService') {
+			return !empty($this->messagingService);
+		}
+		return parent::__isset($property);
+	}
+
+	/**
+	 * Retrieve message template replacements
+	 *
+	 * @return array
+	 */
+	public function getReplacements()
+	{
+		// Get member who began this request
+		$author = $this->Author();
+		$environment = $this->Environment();
+		return array(
+			'<abortlink>' => Director::absoluteURL($this->Environment()->Link()),
+			'<pipelinelink>' => Director::absoluteURL($this->Link()),
+			'<requester>' => $author->Title,
+			'<requester-email>' => $author->Email,
+			'<environment>' => $environment->Name,
+			'<project>' => $environment->Project()->Name,
+			'<commitsha>' => $this->SHA
+		);
+	}
+
+	/**
+	 * Title of this step
+	 *
+	 * @return string
+	 */
+	public function getTitle()
+	{
+		return "Pipeline {$this->ID} (Status: {$this->Status})";
+	}
+
+	/**
+	 * @param Member $member
+	 */
+	public function canAbort($member = null)
+	{
+		// Owner can abort
+		$member = $member ?: Member::currentUser();
+		if (!$member) {
+			return false;
+		}
+		if ($member->ID == $this->AuthorID) {
+			return true;
+		}
+
+		// Check environment permission
+		return $this->Environment()->canAbort($member);
+	}
+
+	/**
+	 * Get status of currently running step
+	 *
+	 * @return string Status description (html format)
+	 */
+	public function getRunningDescription()
+	{
+		if (!$this->isActive()) {
+			return 'This pipeline is not currently running';
+		}
+		$result = '';
+		if ($step = $this->CurrentStep()) {
+			$result = $step->getRunningDescription();
+		}
+		return $result ?: 'This pipeline is currently running';
+	}
+
+	/**
+	 * Get options for the currently running pipeline, if and only if it is currently running
+	 *
+	 * @return ArrayList List of items with a Link and Title attribute
+	 */
+	public function RunningOptions()
+	{
+		if (!$this->isActive()) {
+			return null;
+		}
+		$actions = array();
+
+		// Let current step update the current list of options
+		if (($step = $this->CurrentStep()) && ($step->isRunning())) {
+			$actions = $step->allowedActions();
+		}
+		return new ArrayList($actions);
+	}
+
+	/**
+	 * Get possible logs for the currently pipeline
+	 *
+	 * @return ArrayList List of logs with a Link and Title attribute
+	 */
+	public function LogOptions()
+	{
+		if (!$this->isActive()) {
+			return null;
+		}
+
+		$logs = array();
+
+		$logs[] = array(
+			'ButtonText' => 'Pipeline Log',
+			'Link' => $this->Link()
+		);
+
+		if ($this->PreviousSnapshotID > 0) {
+			$logs[] = array(
+				'ButtonText' => 'Snapshot Log',
+				'Link' => $this->PreviousSnapshot()->Link()
+			);
+		}
+
+		if ($this->CurrentDeploymentID > 0) {
+			$logs[] = array(
+				'ButtonText' => 'Deployment Log',
+				'Link' => $this->CurrentDeployment()->Link()
+			);
+		}
+
+		// Get logs from rollback steps (only for RollbackSteps).
+		$rollbackSteps = array($this->RollbackStep1(), $this->RollbackStep2());
+		foreach ($rollbackSteps as $rollback) {
+			if ($rollback->exists() && $rollback->ClassName == 'RollbackStep') {
+				if ($rollback->RollbackDeploymentID > 0) {
+					$logs[] = array(
+						'ButtonText' => 'Rollback Log',
+						'Link' => $rollback->RollbackDeployment()->Link()
+					);
+				}
+
+				if ($rollback->RollbackDatabaseID > 0) {
+					$logs[] = array(
+						'ButtonText' => 'Rollback DB Log',
+						'Link' => $rollback->RollbackDatabase()->Link()
+					);
+				}
+			}
+		}
+
+		return new ArrayList($logs);
+	}
+
+	/**
+	 * Cached of config merged with defaults
+	 *
+	 * @var array|null
+	 */
+	protected $mergedConfig;
+
+	/**
+	 * Get this pipeline configuration. If the configuration has been serialized
+	 * and saved into the Config field, it'll use that. If that field is empty,
+	 * it'll read the YAML file directly and return that instead.
+	 *
+	 * @return array
+	 * @throws Exception
+	 */
+	public function getConfigData()
+	{
+		// Lazy load if necessary
+		$data = null;
+		if (!$this->Config && ($data = $this->Environment()->loadPipelineConfig())) {
+			$this->Config = serialize($data);
+		}
+
+		// Merge with defaults
+		if ($this->Config) {
+			if (!$this->mergedConfig) {
+				$this->mergedConfig = $data ?: unserialize($this->Config);
+				if ($default = self::config()->default_config) {
+					Config::merge_array_low_into_high($this->mergedConfig, $default);
+				}
+			}
+			return $this->mergedConfig;
+		}
+
+		// Fail if no data available
+		$path = $this->Environment()->getPipelineFilename();
+		throw new Exception(sprintf('YAML configuration for pipeline not found at path "%s"', $path));
+	}
+
+	public function setConfig($data)
+	{
+		$this->mergedConfig = null;
+		return parent::setField('Config', $data);
+	}
+
+	/**
+	 * Retrieve the value of a specific config setting
+	 *
+	 * @param string $setting Settings
+	 * @return mixed Value of setting, or null if not set
+	 */
+	public function getConfigSetting($setting)
+	{
+		$source = $this->getConfigData();
+
+		foreach (func_get_args() as $setting) {
+			if (empty($source[$setting])) {
+				return null;
+			}
+			$source = $source[$setting];
+		}
+
+		return $source;
+	}
+
+	/**
+	 * @return FieldList
+	 */
+	public function getCMSFields()
+	{
+		$fields = new FieldList(new TabSet('Root'));
+
+		// Main fields
+		$fields->addFieldsToTab('Root.Main', array(
+			TextField::create('SHA')
+				->setDescription('SHA of the commit this pipeline is running against')
+				->performReadonlyTransformation(),
+			TextField::create('AuthorName', 'Author', ($author = $this->Author()) ? $author->Title : null)
+				->setDescription('Person who initiated this pipeline')
+				->performReadonlyTransformation(),
+			DropdownField::create('Status', 'Status', $this->dbObject('Status')->enumValues()),
+			DropdownField::create('CurrentStepID', 'Current Step', $this->Steps()->map('ID', 'TreeTitle')),
+			TextField::create(
+				'CurrentDeployment_Label',
+				'Current Deployment',
+				$this->CurrentDeployment()->getTitle()
+			)    ->setDescription('Deployment generated by this pipeline')
+				->performReadonlyTransformation(),
+		));
+
+		// Backup fields
+		$fields->addFieldsToTab('Root.Backups', array(
+			TextField::create(
+				'PreviousDeployment_Label',
+				'Previous Deployment',
+				$this->PreviousDeployment()->getTitle()
+			)    ->setDescription('Prior deployment to revert to if this pipeline fails')
+				->performReadonlyTransformation(),
+			TextField::create(
+				'PreviousSnapshot_Label',
+				'Previous DB Snapshot',
+				$this->PreviousSnapshot()->getTitle()
+			)    ->setDescription('Database backup to revert to if this pipeline fails')
+				->performReadonlyTransformation()
+		));
+
+		if ($log = $this->LogContent()) {
+			$fields->addFieldToTab(
+				'Root.Main',
+				ToggleCompositeField::create(
+					'PipelineLog',
+					'Pipeline Log',
+					LiteralField::create('LogText', nl2br(Convert::raw2xml($log)))
+				)
+			);
+		}
+
+		// Steps
+		$stepConfig = GridFieldConfig_RecordEditor::create();
+		$steps = GridField::create('Steps', 'Pipeline Steps', $this->Steps(), $stepConfig);
+		$fields->addFieldsToTab('Root.PipelineSteps', $steps);
+
+		return $fields;
+	}
+
+	/**
+	 * Return a dependent {@link DNEnvironment} based on this pipeline's dependent environment configuration.
+	 *
+	 * @return DNEnvironment
+	 */
+	public function getDependentEnvironment()
+	{
+		// dependent environment not available
+		$projectName = $this->getConfigSetting('PipelineConfig', 'DependsOnProject');
+		$environmentName = $this->getConfigSetting('PipelineConfig', 'DependsOnEnvironment');
+		if (empty($projectName) || empty($environmentName)) {
+			return null;
+		}
+
+		$project = DNProject::get()->filter('Name', $projectName)->first();
+		if (!($project && $project->exists())) {
+			throw new Exception(sprintf('Could not find dependent project "%s"', $projectName));
+		}
+
+		$environment = DNEnvironment::get()->filter(array(
+			'ProjectID' => $project->ID,
+			'Name' => $environmentName
+		))->first();
+
+		if (!($environment && $environment->exists())) {
+			throw new Exception(sprintf(
+				'Could not find dependent environment "%s" in project "%s"',
+				$environmentName,
+				$projectName
+			));
+		}
+
+		return $environment;
+	}
+
+	/**
+	 * Generate a step from a name, config, and sort order
+	 *
+	 * @throws Exception
+	 * @param string $name
+	 * @param array $stepConfig
+	 * @param int $order
+	 * @return PipelineStep
+	 */
+	protected function generateStep($name, $stepConfig, $order = 0)
+	{
+		$stepClass = isset($stepConfig['Class']) ? $stepConfig['Class'] : $stepConfig;
+
+		if (empty($stepClass)) {
+			throw new Exception(
+				sprintf('Missing or empty Class specifier for step "%s"', $name)
+			);
+		}
+
+		if (!is_subclass_of($stepClass, 'PipelineStep')) {
+			throw new Exception(
+				sprintf('%s is not a valid "Class" field name for step "%s"', var_export($stepClass, true), $name)
+			);
+		}
+
+		$step = $stepClass::create();
+		$step->Name = $name;
+		$step->PipelineID = $this->ID;
+		$step->Order = $order;
+		$step->Status = 'Queued';
+		$step->Config = serialize($stepConfig);
+		$step->write();
+
+		return $step;
+	}
+
+	/**
+	 * Starts the pipeline process.
+	 *
+	 * Reads a YAML configuration from the linked {@link DNEnvironment}
+	 * and builds the {@link PipelineStep} objects and runs them.
+	 *
+	 * Note that this method doesn't actually start any {@link PipelineStep} objects, that is handled by
+	 * {@link self::checkPipelineStatus()}, and the daemon running the process.
+	 *
+	 * @throws LogicException
+	 * @return boolean
+	 */
+	public function start()
+	{
+		// Ensure there are no other running {@link Pipeline} objects for this {@link DNEnvironment}
+		// Requires that $this->EnvironmentID has been set
+		$env = $this->Environment();
+		if (!($env && $env->exists())) {
+			throw new LogicException("This pipeline needs a valid environment to run on.");
+		}
+
+		if ($env->HasCurrentPipeline()) {
+			throw new LogicException("You can only run one pipeline at a time on this environment.");
+		}
+
+		$this->write(); // ensure we've written this record first
+
+		// Instantiate steps.
+		foreach ($this->getConfigSetting('Steps') as $name => $stepConfig) {
+			$this->pushPipelineStep($name, $stepConfig);
+		}
+
+		$this->Status = 'Running';
+		$this->write();
+
+		$this->log('Started logging for this pipeline!');
+
+		return true;
+	}
+
+	/**
+	 * Mark this Pipeline as completed.
+	 */
+	public function markComplete()
+	{
+		$this->Status = "Complete";
+		$this->log("Pipeline completed successfully.");
+		$this->write();
+		// Some steps may pre-emptively send a success message before the pipeline itself has completed
+		if ($this->LastMessageSent !== self::ALERT_SUCCESS) {
+			$this->sendMessage(self::ALERT_SUCCESS);
+		}
+	}
+
+	/**
+	 * @return bool true if this Pipeline has successfully completed all {@link PipelineStep} steps already.
+	 */
+	public function isComplete()
+	{
+		return $this->Status == "Complete";
+	}
+
+	/**
+	 * True if the pipeline is running but NOT doing a rollback
+	 *
+	 * @return bool
+	 */
+	public function isRunning()
+	{
+		return $this->Status == "Running";
+	}
+
+	/**
+	 * True if the pipeline is running or doing a rollback
+	 *
+	 * @return bool
+	 */
+	public function isActive()
+	{
+		return $this->isRunning() || $this->isRollback();
+	}
+
+	/**
+	 * Push a step to the end of a pipeline
+	 *
+	 * @param string $name
+	 * @param array $stepConfig
+	 * @return PipelineStep
+	 */
+	private function pushPipelineStep($name, $stepConfig)
+	{
+		$lastStep = $this->Steps()->sort("Order DESC")->first();
+		$order = $lastStep ? $lastStep->Order + 1 : 1;
+		return $this->generateStep($name, $stepConfig, $order);
+	}
+
+	/**
+	 * The rollback has finished - close the pipeline and send relevant messages.
+	 */
+	protected function finaliseRollback()
+	{
+
+		// Figure out the status by inspecting specific rollback steps.
+		$success = true;
+		$rollback1 = $this->RollbackStep1();
+		$rollback2 = $this->RollbackStep2();
+		if (!empty($rollback1) && $rollback1->Status == 'Failed') {
+			$success = false;
+		}
+		if (!empty($rollback2) && $rollback2->Status == 'Failed') {
+			$success = false;
+		}
+
+		// Send messages.
+		if ($success) {
+			$this->log("Pipeline failed, but rollback completed successfully.");
+			$this->sendMessage(self::ALERT_ROLLBACK_SUCCESS);
+		} else {
+			$this->log("Pipeline failed, rollback failed.");
+			$this->sendMessage(self::ALERT_ROLLBACK_FAILURE);
+		}
+
+		// Finish off the pipeline - rollback will only be triggered on a failed pipeline.
+		$this->Status = 'Failed';
+		$this->write();
+	}
+
+	/**
+	 * Initiate a rollback. Moves the pipeline to the 'Rollback' status.
+	 */
+	protected function beginRollback()
+	{
+		$this->log("Beginning rollback...");
+		$this->sendMessage(self::ALERT_ROLLBACK_STARTED);
+
+		// Add rollback step.
+		$configRollback1 = $this->getConfigSetting('RollbackStep1');
+		$stepRollback1 = $this->pushPipelineStep('RollbackStep1', $configRollback1);
+		$this->RollbackStep1ID = $stepRollback1->ID;
+		$this->CurrentStepID = $stepRollback1->ID;
+		$this->Status = 'Rollback';
+
+		// Add smoke test step, if available, for later processing.
+		$configRollback2 = $this->getConfigSetting('RollbackStep2');
+		if ($configRollback2) {
+			$stepRollback2 = $this->pushPipelineStep('RollbackStep2', $configRollback2);
+			$this->RollbackStep2ID = $stepRollback2->ID;
+		}
+
+		$this->write();
+
+		$stepRollback1->start();
+	}
+
+	/**
+	 * Check if pipeline currently permits a rollback.
+	 * This could be influenced by both the current state and by the specific configuration.
+	 *
+	 * @return boolean
+	 */
+	protected function canStartRollback()
+	{
+		// The rollback cannot run twice.
+		if ($this->isRollback()) {
+			return false;
+		}
+
+		// Rollbacks must be configured.
+		if (!$this->getConfigSetting('RollbackStep1')) {
+			return false;
+		}
+
+		// On dryrun let rollback run
+		if ($this->DryRun) {
+			return true;
+		}
+
+		// Pipeline must have ran a deployment to be able to rollback.
+		$deploy = $this->CurrentDeployment();
+		$previous = $this->PreviousDeployment();
+		if (!$deploy->exists() || !$previous->exists()) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Notify Pipeline that a step has failed and failure processing should kick in. If rollback steps are present
+	 * the pipeline will be put into 'Rollback' state. After rollback is complete, regardless of the rollback result,
+	 * the pipeline will be failed.
+	 *
+	 * @param bool $notify Set to false to disable notifications for this failure
+	 */
+	public function markFailed($notify = true)
+	{
+		// Abort all running or queued steps.
+		$steps = $this->Steps();
+		foreach ($steps as $step) {
+			if ($step->isQueued() || $step->isRunning()) {
+				$step->abort();
+			}
+		}
+
+		if ($this->canStartRollback()) {
+			$this->beginRollback();
+		} elseif ($this->isRollback()) {
+			$this->finaliseRollback();
+		} else {
+			// Not able to roll back - fail immediately.
+			$this->Status = 'Failed';
+			$this->log("Pipeline failed, not running rollback (not configured or not applicable yet).");
+			$this->write();
+			if ($notify) {
+				$this->sendMessage(self::ALERT_FAILURE);
+			}
+		}
+	}
+
+	/**
+	 * @return bool true if this Pipeline failed to execute all {@link PipelineStep} steps successfully
+	 */
+	public function isFailed()
+	{
+		return $this->Status == "Failed";
+	}
+
+	/**
+	 * @return bool true if this Pipeline is rolling back.
+	 */
+	public function isRollback()
+	{
+		return $this->Status == "Rollback";
+	}
+
+	/**
+	 * Mark this Pipeline as aborted
+	 */
+	public function markAborted()
+	{
+		$this->Status = 'Aborted';
+		$logMessage = sprintf(
+			"Pipeline processing aborted. %s (%s) aborted the pipeline",
+			Member::currentUser()->Name,
+			Member::currentUser()->Email
+		);
+		$this->log($logMessage);
+		$this->write();
+
+		// Abort all running or queued steps.
+		$steps = $this->Steps();
+		foreach ($steps as $step) {
+			if ($step->isQueued() || $step->isRunning()) {
+				$step->abort();
+			}
+		}
+
+		// Send notification to users about this event
+		$this->sendMessage(self::ALERT_ABORT);
+	}
+
+	/**
+	 * Finds a message template for a given role and message
+	 *
+	 * @param string $messageID Message ID
+	 * @return array Resulting array(subject, message)
+	 */
+	protected function generateMessageTemplate($messageID)
+	{
+		$subject = $this->getConfigSetting('PipelineConfig', 'Subjects', $messageID);
+		$message = $this->getConfigSetting('PipelineConfig', 'Messages', $messageID);
+		$substitutions = $this->getReplacements();
+		return $this->injectMessageReplacements($message, $subject, $substitutions);
+	}
+
+	/**
+	 * Substitute templated variables into the given message and subject
+	 *
+	 * @param string $message
+	 * @param string $subject
+	 * @param array $substitutions
+	 * @return array Resulting array(subject, message)
+	 */
+	public function injectMessageReplacements($message, $subject, $substitutions)
+	{
+		// Handle empty messages
+		if (empty($subject) && empty($message)) {
+			return array(null, null);
+		}
+
+		// Check if there's a role specific message
+		$subjectText = str_replace(
+			array_keys($substitutions),
+			array_values($substitutions),
+			$subject ?: $message
+		);
+		$messageText = str_replace(
+			array_keys($substitutions),
+			array_values($substitutions),
+			$message ?: $subject
+		);
+
+
+		return array($subjectText, $messageText);
+	}
+
+	/**
+	 * Sends a specific message to all marked recipients, including the author of this pipeline
+	 *
+	 * @param string $messageID Message ID. One of 'Abort', 'Success', or 'Failure', or some custom message
+	 * @return boolean|null True if successful
+	 */
+	public function sendMessage($messageID)
+	{
+		// Check message, subject, and additional arguments to include
+		list($subject, $message) = $this->generateMessageTemplate($messageID);
+		if (empty($subject) || empty($message)) {
+			$this->log("Skipping sending message. None configured for $messageID");
+			return true;
+		}
+
+		// Save last sent message
+		$this->LastMessageSent = $messageID;
+		$this->write();
+
+		// Setup messaging arguments
+		$arguments = array_merge(
+			$this->getConfigSetting('PipelineConfig', 'ServiceArguments') ?: array(),
+			array('subject' => $subject)
+		);
+
+		// Send message to author
+		if ($author = $this->Author()) {
+			$this->log("Pipeline sending $messageID message to {$author->Email}");
+			$this->messagingService->sendMessage($this, $message, $author, $arguments);
+		} else {
+			$this->log("Skipping sending message to missing author");
+		}
+
+		// Get additional recipients
+		$recipients = $this->getConfigSetting('PipelineConfig', 'Recipients', $messageID);
+		if (empty($recipients)) {
+			$this->log("Skipping sending message to empty recipients");
+		} else {
+			$recipientsStr = is_array($recipients) ? implode(',', $recipients) : $recipients;
+			$this->log("Pipeline sending $messageID message to $recipientsStr");
+			$this->messagingService->sendMessage($this, $message, $recipients, $arguments);
+		}
+	}
+
+	/**
+	 * @return bool true if this Pipeline has been aborted
+	 */
+	public function isAborted()
+	{
+		return $this->Status === "Aborted";
+	}
+
+	/**
+	 * This method should be called only by the {@link CheckPipelineStatus} controller. It iterates through all the
+	 * {@link PipelineStep} objects associated with this Pipeline, and finds a place where the pipeline has stalled
+	 * (where one step has completed, but the next one has yet to start). It will then start the next step if required.
+	 *
+	 * We check here whether the {@link PipelineStep} finished successfully, and will mark the Pipeline as Failed if
+	 * the step failed, but this is only a fallback, and should not be relied upon. The individual {@link PipelineStep}
+	 * should mark itself as failed and then call {@link Pipeline::markFailed()} directly.
+	 *
+	 * If the Pipeline has run out of steps, then it will mark the pipeline as completed.
+	 */
+	public function checkPipelineStatus()
+	{
+		$message = "";
+
+		if (!$this->isActive()) {
+			$message = "Pipeline::checkPipelineStatus() should only be called on running or rolling back pipelines.";
+		}
+
+		if (!$this->ID || !$this->isInDB()) {
+			$message = "Pipeline::checkPipelineStatus() can only be called on pipelines already saved.";
+		}
+
+		$currentStep = ($this->CurrentStep() && $this->CurrentStep()->isInDB())
+			? $this->CurrentStep()
+			: null;
+
+		if ($currentStep && $currentStep->PipelineID != $this->ID) {
+			$message = sprintf(
+				"The current step (#%d) has a pipeline ID (#%d) that doesn't match this pipeline's ID (#%d).",
+				$currentStep->ID,
+				$currentStep->PipelineID,
+				$this->ID
+			);
+		}
+
+		if ($message) {
+			$this->log($message);
+			throw new LogicException($message);
+		}
+
+		// Fallback check only: this shouldn't be called unless a {@link PipelineStep} has been implemented incorrectly
+		if ($currentStep && $currentStep->isFailed() && !$this->isFailed() && !$this->isRollback()) {
+			$this->log(sprintf("Marking pipeline step (#%d) as failed - this pipeline step needs to be amended to mark"
+				. " the pipeline (as well as itself) as failed to ensure consistency.",
+				$this->CurrentStep()->ID
+			));
+
+			$this->markFailed();
+			return;
+		}
+
+		// If this is the first time the Pipeline is run, then we don't have a CurrentStep, so set it,
+		// start it running, and return
+		if (!$currentStep) {
+			$step = $this->Steps()->first();
+			$this->CurrentStepID = $step->ID;
+			$this->write();
+
+			$this->log("Starting first pipeline step...");
+			$step->start();
+		} elseif ($currentStep->isFinished()) {
+			// Sort through the list of {@link PipelineStep} objects to find the next step we need to start.
+			$this->log("Finding next step to execute...");
+			$nextStep = $this->findNextStep();
+
+			if (!$nextStep) {
+
+				// Special handling, since the main pipeline has already failed at this stage.
+				if ($this->isRollback()) {
+					$this->finaliseRollback();
+					return false;
+				}
+
+				// Double check for any steps that failed, but didn't notify the pipeline via markFailed.
+				$failedSteps = PipelineStep::get()->filter(array(
+					'PipelineID' => $this->ID,
+					'Status' => 'Failed'
+				))->count();
+				if ($failedSteps) {
+					$this->log('At least one of the steps has failed marking the pipeline as failed');
+					$this->markFailed();
+					return false;
+				}
+
+				// We've reached the end of this pipeline successfully!
+				$this->markComplete();
+				return;
+			} else {
+				$this->CurrentStepID = $nextStep->ID;
+				$this->write();
+				// Otherwise, kick off the next step
+				$this->log(sprintf("Found the next step (#%s), starting it now...", $nextStep->Name));
+				$nextStep->start();
+			}
+		// if the current step is failing run it again
+		} elseif ($step = $this->CurrentStep()) {
+			$step->start();
+		}
+	}
+
+	/**
+	 * Finds the next {@link PipelineStep} that needs to execute. Relies on $this->CurrentStep() being a valid step.
+	 *
+	 * @return DataObject|null The next step in the pipeline, or null if none remain.
+	 */
+	protected function findNextStep()
+	{
+		// otherwise get next step in chain
+		$currentStep = $this->CurrentStep();
+
+		return $this
+			->Steps()
+			->filter("Status", "Queued")
+			->filter("Order:GreaterThanOrEqual", $currentStep->Order)
+			->exclude("ID", $currentStep->ID)
+			->sort("Order ASC")
+			->first();
+	}
+
+	/**
+	 * Finds the previous {@link PipelineStep} that executed. Relies on $this->CurrentStep() being a valid step.
+	 *
+	 * @return DataObject|null The previous step in the pipeline, or null if this is the first.
+	 */
+	public function findPreviousStep()
+	{
+		// otherwise get previous step in chain
+		$currentStep = $this->CurrentStep();
+
+		return $this
+			->Steps()
+			->filter("Status", "Finished")
+			->filter("Order:LessThanOrEqual", $currentStep->Order)
+			->exclude("ID", $currentStep->ID)
+			->sort("Order DESC")
+			->first();
+	}
+
+	/**
+	 * Write to a common log file. This log file will be the same regardless of how often this pipeline is re-created
+	 * from the database. To this end, it needs to know the database ID of this pipeline instance, so that it can
+	 * generate the correct filename to open.
+	 *
+	 * This also includes the calling class and method name that called ->log() in the first place, so we can trace
+	 * back where it was written from.
+	 *
+	 * @param string $message The message to log
+	 * @throws LogicException Thrown if we can't log yet because we don't know what to log to (no db record yet).
+	 */
+	public function log($message = "")
+	{
+		$log = $this->getLogger();
+
+		// Taken from Debug::caller(), amended for our purposes to filter out the intermediate call to
+		// PipelineStep->log(), so that our log message shows where the log message was actually created from.
+		$bt = debug_backtrace();
+
+		$index = ($bt[1]['class'] == 'PipelineStep') ? 2 : 1;
+
+		$caller = $bt[$index];
+		$caller['line'] = $bt[($index - 1)]['line']; // Overwrite line and file to be the the line/file that actually
+		$caller['file'] = $bt[($index - 1)]['file']; // called the function, not where the function is defined.
+		// In case it wasn't called from a class
+		if (!isset($caller['class'])) {
+			$caller['class'] = '';
+		}
+		// In case it doesn't have a type (wasn't called from class)
+		if (!isset($caller['type'])) {
+			$caller['type'] = '';
+		}
+
+		$log->write(sprintf(
+			"[%s::%s() (line %d)] %s",
+			$caller['class'],
+			$caller['function'],
+			$caller['line'],
+			$message
+		));
+	}
+
+	/**
+	 * Returns the {@link DeploynautLogFile} instance that will actually write to this log file.
+	 *
+	 * @return DeploynautLogFile
+	 * @throws RuntimeException
+	 */
+	public function getLogger()
+	{
+		if (!$this->isInDB()) {
+			throw new RuntimeException("Can't write to a log file until we know the database ID.");
+		}
+
+		if (!$this->Environment()) {
+			throw new RuntimeException("Can't write to a log file until we have an Environment.");
+		}
+
+		if ($this->Environment() && !$this->Environment()->Project()) {
+			throw new RuntimeException("Can't write to a log file until we have the Environment's project.");
+		}
+
+		$environment = $this->Environment();
+		$filename = sprintf('%s.pipeline.%d.log', $environment->getFullName('.'), $this->ID);
+
+		return Injector::inst()->createWithArgs('DeploynautLogFile', array($filename));
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getDryRun()
+	{
+		return $this->getField('DryRun');
+	}
+
+	/**
+	 * @param string|null $action
+	 *
+	 * @return string
+	 */
+	public function Link($action = null)
+	{
+		return Controller::join_links($this->Environment()->Link(), 'pipeline', $this->ID, $action);
+	}
+
+	/**
+	 * Link to an action on the current step
+	 *
+	 * @param string|null $action
+	 * @return string
+	 */
+	public function StepLink($action = null)
+	{
+		return Controller::join_links($this->Link('step'), $action);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function AbortLink()
+	{
+		return $this->Link('abort');
+	}
+
+	/**
+	 * @return string
+	 */
+	public function LogLink()
+	{
+		return $this->Link('log');
+	}
+
+	/**
+	 * @return string
+	 */
+	public function LogContent()
+	{
+		if ($this->exists() && $this->Environment()) {
+			$logger = $this->getLogger();
+			if ($logger->exists()) {
+				return $logger->content();
+			}
+		}
+	}
 }

code/model/PipelineData.php

Indentation +12 added lines, -12 removed lines

@@ -3,17 +3,17 @@
 interface PipelineData
 {
 
-    /**
-     * Is this a dry run?
-     *
-     * @return bool
-     */
-    public function getDryRun();
+	/**
+	 * Is this a dry run?
+	 *
+	 * @return bool
+	 */
+	public function getDryRun();
 
-    /**
-     * Log message
-     *
-     * @param string $message The message to log
-     */
-    public function log($message);
+	/**
+	 * Log message
+	 *
+	 * @param string $message The message to log
+	 */
+	public function log($message);
 }

code/model/jobs/DNCreateEnvironment.php

Indentation +193 added lines, -193 removed lines

@@ -16,197 +16,197 @@
 class DNCreateEnvironment extends DataObject
 {
 
-    /**
-     * @var array
-     */
-    private static $db = array(
-        'Data' => 'Text',
-        'ResqueToken' => 'Varchar(255)',
-        "Status" => "Enum('Queued, Started, Finished, Failed, n/a', 'n/a')",
-        'IsInitialEnvironment' => 'Boolean',
-    );
-
-    /**
-     * @var array
-     */
-    private static $has_one = array(
-        'Project' => 'DNProject',
-        'Creator' => 'Member'
-    );
-
-    /**
-     *
-     * @param int $int
-     * @return string
-     */
-    public static function map_resque_status($int)
-    {
-        $remap = array(
-            Resque_Job_Status::STATUS_WAITING => "Queued",
-            Resque_Job_Status::STATUS_RUNNING => "Running",
-            Resque_Job_Status::STATUS_FAILED => "Failed",
-            Resque_Job_Status::STATUS_COMPLETE => "Complete",
-            false => "Invalid",
-        );
-        return $remap[$int];
-    }
-
-    /**
-     * @return string
-     */
-    public function Name()
-    {
-        $data = unserialize($this->Data);
-        return !empty($data['Name']) ? Convert::raw2xml($data['Name']) : '';
-    }
-
-    /**
-     * @return string
-     */
-    public function Link()
-    {
-        return Controller::join_links($this->Project()->Link(), 'createenv', $this->ID);
-    }
-
-    /**
-     * @return string
-     */
-    public function LogLink()
-    {
-        return $this->Link() . '/log';
-    }
-
-    /**
-     * @return boolean
-     */
-    public function canView($member = null)
-    {
-        return $this->Project()->canView($member);
-    }
-
-    /**
-     * Return a path to the log file.
-     * @return string
-     */
-    protected function logfile()
-    {
-        return sprintf(
-            '%s.createenv.%s.log',
-            $this->Project()->Name,
-            $this->ID
-        );
-    }
-
-    /**
-     * @return DeploynautLogFile
-     */
-    public function log()
-    {
-        return Injector::inst()->createWithArgs('DeploynautLogFile', array($this->logfile()));
-    }
-
-    public function LogContent()
-    {
-        return $this->log()->content();
-    }
-
-    /**
-     * Returns the status of the resque job
-     *
-     * @return string
-     */
-    public function ResqueStatus()
-    {
-        $status = new Resque_Job_Status($this->ResqueToken);
-        $statusCode = $status->get();
-        // The Resque job can no longer be found, fallback to the DNDeployment.Status
-        if ($statusCode === false) {
-            // Translate from the DNDeployment.Status to the Resque job status for UI purposes
-            switch ($this->Status) {
-                case 'Finished':
-                    return 'Complete';
-                case 'Started':
-                    return 'Running';
-                default:
-                    return $this->Status;
-            }
-        }
-        return self::map_resque_status($statusCode);
-    }
-
-    /**
-     * Start a resque job for this creation.
-     *
-     * @return string Resque token
-     */
-    protected function enqueueCreation()
-    {
-        $project = $this->Project();
-        $log = $this->log();
-
-        $args = array(
-            'createID' => $this->ID,
-            'logfile' => $this->logfile(),
-            'projectName' => $project->Name
-        );
-
-        if (!$this->CreatorID) {
-            $this->CreatorID = Member::currentUserID();
-        }
-
-        if ($this->CreatorID) {
-            $creator = $this->Creator();
-            $message = sprintf(
-                'Environment creation for project %s initiated by %s (%s), with IP address %s',
-                $project->Name,
-                $creator->getName(),
-                $creator->Email,
-                Controller::curr()->getRequest()->getIP()
-            );
-            $log->write($message);
-        }
-
-        return Resque::enqueue('create', 'CreateEnvJob', $args, true);
-    }
-
-    public function start()
-    {
-        $log = $this->log();
-        $token = $this->enqueueCreation();
-        $this->ResqueToken = $token;
-        $this->Status = 'Queued';
-        $this->write();
-
-        $message = sprintf('Environment creation queued as job %s', $token);
-        $log->write($message);
-    }
-
-    public function createEnvironment()
-    {
-        $backend = $this->getBackend();
-        if ($backend) {
-            return $backend->createEnvironment($this);
-        }
-        throw new Exception("Unable to find backend.");
-    }
-
-    /**
-     * Fetches the EnvironmentCreateBackend based on the EnvironmentType saved to this job.
-     *
-     * @return EnvironmentCreateBackend|null
-     * @throws Exception
-     */
-    public function getBackend()
-    {
-        $data = unserialize($this->Data);
-        if (isset($data['EnvironmentType']) && class_exists($data['EnvironmentType'])) {
-            $env = Injector::inst()->get($data['EnvironmentType']);
-            if ($env instanceof EnvironmentCreateBackend) {
-                return $env;
-            } else {
-                throw new Exception("Invalid backend: " . $data['EnvironmentType']);
-            }
-        }
-        return null;
-    }
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		'Data' => 'Text',
+		'ResqueToken' => 'Varchar(255)',
+		"Status" => "Enum('Queued, Started, Finished, Failed, n/a', 'n/a')",
+		'IsInitialEnvironment' => 'Boolean',
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $has_one = array(
+		'Project' => 'DNProject',
+		'Creator' => 'Member'
+	);
+
+	/**
+	 *
+	 * @param int $int
+	 * @return string
+	 */
+	public static function map_resque_status($int)
+	{
+		$remap = array(
+			Resque_Job_Status::STATUS_WAITING => "Queued",
+			Resque_Job_Status::STATUS_RUNNING => "Running",
+			Resque_Job_Status::STATUS_FAILED => "Failed",
+			Resque_Job_Status::STATUS_COMPLETE => "Complete",
+			false => "Invalid",
+		);
+		return $remap[$int];
+	}
+
+	/**
+	 * @return string
+	 */
+	public function Name()
+	{
+		$data = unserialize($this->Data);
+		return !empty($data['Name']) ? Convert::raw2xml($data['Name']) : '';
+	}
+
+	/**
+	 * @return string
+	 */
+	public function Link()
+	{
+		return Controller::join_links($this->Project()->Link(), 'createenv', $this->ID);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function LogLink()
+	{
+		return $this->Link() . '/log';
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function canView($member = null)
+	{
+		return $this->Project()->canView($member);
+	}
+
+	/**
+	 * Return a path to the log file.
+	 * @return string
+	 */
+	protected function logfile()
+	{
+		return sprintf(
+			'%s.createenv.%s.log',
+			$this->Project()->Name,
+			$this->ID
+		);
+	}
+
+	/**
+	 * @return DeploynautLogFile
+	 */
+	public function log()
+	{
+		return Injector::inst()->createWithArgs('DeploynautLogFile', array($this->logfile()));
+	}
+
+	public function LogContent()
+	{
+		return $this->log()->content();
+	}
+
+	/**
+	 * Returns the status of the resque job
+	 *
+	 * @return string
+	 */
+	public function ResqueStatus()
+	{
+		$status = new Resque_Job_Status($this->ResqueToken);
+		$statusCode = $status->get();
+		// The Resque job can no longer be found, fallback to the DNDeployment.Status
+		if ($statusCode === false) {
+			// Translate from the DNDeployment.Status to the Resque job status for UI purposes
+			switch ($this->Status) {
+				case 'Finished':
+					return 'Complete';
+				case 'Started':
+					return 'Running';
+				default:
+					return $this->Status;
+			}
+		}
+		return self::map_resque_status($statusCode);
+	}
+
+	/**
+	 * Start a resque job for this creation.
+	 *
+	 * @return string Resque token
+	 */
+	protected function enqueueCreation()
+	{
+		$project = $this->Project();
+		$log = $this->log();
+
+		$args = array(
+			'createID' => $this->ID,
+			'logfile' => $this->logfile(),
+			'projectName' => $project->Name
+		);
+
+		if (!$this->CreatorID) {
+			$this->CreatorID = Member::currentUserID();
+		}
+
+		if ($this->CreatorID) {
+			$creator = $this->Creator();
+			$message = sprintf(
+				'Environment creation for project %s initiated by %s (%s), with IP address %s',
+				$project->Name,
+				$creator->getName(),
+				$creator->Email,
+				Controller::curr()->getRequest()->getIP()
+			);
+			$log->write($message);
+		}
+
+		return Resque::enqueue('create', 'CreateEnvJob', $args, true);
+	}
+
+	public function start()
+	{
+		$log = $this->log();
+		$token = $this->enqueueCreation();
+		$this->ResqueToken = $token;
+		$this->Status = 'Queued';
+		$this->write();
+
+		$message = sprintf('Environment creation queued as job %s', $token);
+		$log->write($message);
+	}
+
+	public function createEnvironment()
+	{
+		$backend = $this->getBackend();
+		if ($backend) {
+			return $backend->createEnvironment($this);
+		}
+		throw new Exception("Unable to find backend.");
+	}
+
+	/**
+	 * Fetches the EnvironmentCreateBackend based on the EnvironmentType saved to this job.
+	 *
+	 * @return EnvironmentCreateBackend|null
+	 * @throws Exception
+	 */
+	public function getBackend()
+	{
+		$data = unserialize($this->Data);
+		if (isset($data['EnvironmentType']) && class_exists($data['EnvironmentType'])) {
+			$env = Injector::inst()->get($data['EnvironmentType']);
+			if ($env instanceof EnvironmentCreateBackend) {
+				return $env;
+			} else {
+				throw new Exception("Invalid backend: " . $data['EnvironmentType']);
+			}
+		}
+		return null;
+	}
 }

code/model/jobs/DNDataTransfer.php

Indentation +270 added lines, -270 removed lines

@@ -34,274 +34,274 @@
 class DNDataTransfer extends DataObject
 {
 
-    private static $db = array(
-        "ResqueToken" => "Varchar(255)",
-        // Observe that this is not the same as Resque status, since ResqueStatus is not persistent.
-        "Status" => "Enum('Queued, Started, Finished, Failed, n/a', 'n/a')",
-        "Direction" => "Enum('get, push', 'get')",
-        "Mode" => "Enum('all, assets, db', '')",
-        "Origin" => "Enum('EnvironmentTransfer,ManualUpload', 'EnvironmentTransfer')",
-    );
-
-    private static $has_one = array(
-        "Environment" => "DNEnvironment",
-        "Author" => "Member",
-        "DataArchive" => "DNDataArchive",
-        "BackupDataTransfer" => "DNDataTransfer" // denotes an automated backup done for a push of this data transfer
-    );
-
-    private static $singular_name = 'Data Transfer';
-
-    private static $plural_name = 'Data Transfers';
-
-    private static $summary_fields = array(
-        'Created' => 'Created',
-        'Author.Title' => 'Author',
-        'Environment.Project.Name' => 'Project',
-        'Environment.Name' => 'Environment',
-        'Status' => 'Status',
-        'Origin' => 'Origin',
-    );
-
-    private static $searchable_fields = array(
-        'Environment.Project.Name' => array(
-            'title' => 'Project',
-        ),
-        'Environment.Name' => array(
-            'title' => 'Environment',
-        ),
-        'Status' => array(
-            'title' => 'Status',
-        ),
-        'Origin' => array(
-            'title' => 'Origin',
-        ),
-        'Mode' => array(
-            'title' => 'Mode',
-        ),
-        'Direction' => array(
-            'title' => 'Direction',
-        ),
-    );
-
-    /**
-     * When running the transfer, should a backup be performed before pushing the data?
-     * @var bool
-     */
-    protected $backupBeforePush = true;
-
-    /**
-     * @param int $int
-     * @return string
-     */
-    public static function map_resque_status($int)
-    {
-        $remap = array(
-            Resque_Job_Status::STATUS_WAITING => "Queued",
-            Resque_Job_Status::STATUS_RUNNING => "Running",
-            Resque_Job_Status::STATUS_FAILED => "Failed",
-            Resque_Job_Status::STATUS_COMPLETE => "Complete",
-            false => "Invalid",
-        );
-        return $remap[$int];
-    }
-
-    /**
-     * @param boolean $value
-     */
-    public function setBackupBeforePush($value)
-    {
-        $this->backupBeforePush = $value;
-    }
-
-    public function getTitle()
-    {
-        return $this->dbObject('Created')->Nice() . " (Status: {$this->Status})";
-    }
-
-    public function Link()
-    {
-        return Controller::join_links($this->Environment()->Project()->Link(), 'transfer', $this->ID);
-    }
-
-    public function LogLink()
-    {
-        return Controller::join_links($this->Link(), 'log');
-    }
-
-    public function getDefaultSearchContext()
-    {
-        $context = parent::getDefaultSearchContext();
-        $context->getFields()->dataFieldByName('Status')->setHasEmptyDefault(true);
-        $context->getFields()->dataFieldByName('Origin')->setHasEmptyDefault(true);
-
-        return $context;
-    }
-
-    public function getCMSFields()
-    {
-        $fields = parent::getCMSFields();
-        $fields->removeByName('EnvironmentID');
-        $fields->removeByName('ArchiveFile');
-        $fields->addFieldsToTab(
-            'Root.Main',
-            array(
-                new ReadonlyField('ProjectName', 'Project', $this->Environment()->Project()->Name),
-                new ReadonlyField('EnvironmentName', 'Environment', $this->Environment()->Name),
-                new ReadonlyField(
-                    'DataArchive',
-                    'Archive File',
-                    sprintf(
-                        '<a href="%s">%s</a>',
-                        $this->DataArchive()->ArchiveFile()->AbsoluteURL,
-                        $this->DataArchive()->ArchiveFile()->Filename
-                    )
-                ),
-            )
-        );
-        $fields = $fields->makeReadonly();
-
-        return $fields;
-    }
-
-    /**
-     * Queue a transfer job
-     */
-    public function start()
-    {
-        $env = $this->Environment();
-        $log = $this->log();
-
-        $args = array(
-            'dataTransferID' => $this->ID,
-            'logfile' => $this->logfile(),
-            'backupBeforePush' => $this->backupBeforePush
-        );
-
-        if (!$this->AuthorID) {
-            $this->AuthorID = Member::currentUserID();
-        }
-
-        if ($this->AuthorID) {
-            $author = $this->Author();
-            $message = sprintf(
-                'Data transfer on %s (%s, %s) initiated by %s (%s), with IP address %s',
-                $env->getFullName(),
-                $this->Direction,
-                $this->Mode,
-                $author->getName(),
-                $author->Email,
-                Controller::curr()->getRequest()->getIP()
-            );
-            $log->write($message);
-        }
-
-        $token = Resque::enqueue('git', 'DataTransferJob', $args, true);
-        $this->ResqueToken = $token;
-        $this->write();
-
-        $message = sprintf('Data transfer queued as job %s', $token);
-        $log->write($message);
-    }
-
-    /**
-     * @param Member|null $member
-     * @return bool
-     */
-    public function canView($member = null)
-    {
-        return $this->Environment()->canView($member);
-    }
-
-    /**
-     * Return a path to the log file.
-     * @return string
-     */
-    protected function logfile()
-    {
-        return sprintf(
-            '%s.datatransfer.%s.log',
-            $this->Environment()->getFullName('.'),
-            $this->ID
-        );
-    }
-
-    /**
-     * @return \DeploynautLogFile
-     */
-    public function log()
-    {
-        return new DeploynautLogFile($this->logfile());
-    }
-
-    /**
-     * @return string
-     */
-    public function LogContent()
-    {
-        return $this->log()->content();
-    }
-
-    public function getDescription()
-    {
-        $envName = $this->Environment()->getFullName();
-        if ($this->Direction == 'get') {
-            if ($this->Origin == 'ManualUpload') {
-                $description = 'Manual upload of ' . $this->getModeNice() . ' to ' . $envName;
-            } elseif ($this->IsBackupDataTransfer()) {
-                $description = 'Automated backup of ' . $this->getModeNice() . ' from ' . $envName;
-            } else {
-                $description = 'Backup of ' . $this->getModeNice() . ' to ' . $envName;
-            }
-        } else {
-            $description = 'Restore ' . $this->getModeNice() . ' to ' . $envName;
-        }
-
-        return $description;
-    }
-
-    public function getModeNice()
-    {
-        if ($this->Mode == 'all') {
-            return 'database and assets';
-        } else {
-            return $this->Mode;
-        }
-    }
-
-    /**
-     * Is this transfer an automated backup of a push transfer?
-     * @return boolean
-     */
-    public function IsBackupDataTransfer()
-    {
-        return DB::query(sprintf(
-            'SELECT COUNT("ID") FROM "DNDataTransfer" WHERE "BackupDataTransferID" = %d',
-            $this->ID
-        ))->value();
-    }
-
-    /**
-     * Returns the status of the resque job
-     *
-     * @return string
-     */
-    public function ResqueStatus()
-    {
-        $status = new Resque_Job_Status($this->ResqueToken);
-        $statusCode = $status->get();
-        // The Resque job can no longer be found, fallback to the DNDataTransfer.Status
-        if ($statusCode === false) {
-            // Translate from the DNDataTransfer.Status to the Resque job status for UI purposes
-            switch ($this->Status) {
-                case 'Finished':
-                    return 'Complete';
-                case 'Started':
-                    return 'Running';
-                default:
-                    return $this->Status;
-            }
-        }
-        return self::map_resque_status($statusCode);
-    }
+	private static $db = array(
+		"ResqueToken" => "Varchar(255)",
+		// Observe that this is not the same as Resque status, since ResqueStatus is not persistent.
+		"Status" => "Enum('Queued, Started, Finished, Failed, n/a', 'n/a')",
+		"Direction" => "Enum('get, push', 'get')",
+		"Mode" => "Enum('all, assets, db', '')",
+		"Origin" => "Enum('EnvironmentTransfer,ManualUpload', 'EnvironmentTransfer')",
+	);
+
+	private static $has_one = array(
+		"Environment" => "DNEnvironment",
+		"Author" => "Member",
+		"DataArchive" => "DNDataArchive",
+		"BackupDataTransfer" => "DNDataTransfer" // denotes an automated backup done for a push of this data transfer
+	);
+
+	private static $singular_name = 'Data Transfer';
+
+	private static $plural_name = 'Data Transfers';
+
+	private static $summary_fields = array(
+		'Created' => 'Created',
+		'Author.Title' => 'Author',
+		'Environment.Project.Name' => 'Project',
+		'Environment.Name' => 'Environment',
+		'Status' => 'Status',
+		'Origin' => 'Origin',
+	);
+
+	private static $searchable_fields = array(
+		'Environment.Project.Name' => array(
+			'title' => 'Project',
+		),
+		'Environment.Name' => array(
+			'title' => 'Environment',
+		),
+		'Status' => array(
+			'title' => 'Status',
+		),
+		'Origin' => array(
+			'title' => 'Origin',
+		),
+		'Mode' => array(
+			'title' => 'Mode',
+		),
+		'Direction' => array(
+			'title' => 'Direction',
+		),
+	);
+
+	/**
+	 * When running the transfer, should a backup be performed before pushing the data?
+	 * @var bool
+	 */
+	protected $backupBeforePush = true;
+
+	/**
+	 * @param int $int
+	 * @return string
+	 */
+	public static function map_resque_status($int)
+	{
+		$remap = array(
+			Resque_Job_Status::STATUS_WAITING => "Queued",
+			Resque_Job_Status::STATUS_RUNNING => "Running",
+			Resque_Job_Status::STATUS_FAILED => "Failed",
+			Resque_Job_Status::STATUS_COMPLETE => "Complete",
+			false => "Invalid",
+		);
+		return $remap[$int];
+	}
+
+	/**
+	 * @param boolean $value
+	 */
+	public function setBackupBeforePush($value)
+	{
+		$this->backupBeforePush = $value;
+	}
+
+	public function getTitle()
+	{
+		return $this->dbObject('Created')->Nice() . " (Status: {$this->Status})";
+	}
+
+	public function Link()
+	{
+		return Controller::join_links($this->Environment()->Project()->Link(), 'transfer', $this->ID);
+	}
+
+	public function LogLink()
+	{
+		return Controller::join_links($this->Link(), 'log');
+	}
+
+	public function getDefaultSearchContext()
+	{
+		$context = parent::getDefaultSearchContext();
+		$context->getFields()->dataFieldByName('Status')->setHasEmptyDefault(true);
+		$context->getFields()->dataFieldByName('Origin')->setHasEmptyDefault(true);
+
+		return $context;
+	}
+
+	public function getCMSFields()
+	{
+		$fields = parent::getCMSFields();
+		$fields->removeByName('EnvironmentID');
+		$fields->removeByName('ArchiveFile');
+		$fields->addFieldsToTab(
+			'Root.Main',
+			array(
+				new ReadonlyField('ProjectName', 'Project', $this->Environment()->Project()->Name),
+				new ReadonlyField('EnvironmentName', 'Environment', $this->Environment()->Name),
+				new ReadonlyField(
+					'DataArchive',
+					'Archive File',
+					sprintf(
+						'<a href="%s">%s</a>',
+						$this->DataArchive()->ArchiveFile()->AbsoluteURL,
+						$this->DataArchive()->ArchiveFile()->Filename
+					)
+				),
+			)
+		);
+		$fields = $fields->makeReadonly();
+
+		return $fields;
+	}
+
+	/**
+	 * Queue a transfer job
+	 */
+	public function start()
+	{
+		$env = $this->Environment();
+		$log = $this->log();
+
+		$args = array(
+			'dataTransferID' => $this->ID,
+			'logfile' => $this->logfile(),
+			'backupBeforePush' => $this->backupBeforePush
+		);
+
+		if (!$this->AuthorID) {
+			$this->AuthorID = Member::currentUserID();
+		}
+
+		if ($this->AuthorID) {
+			$author = $this->Author();
+			$message = sprintf(
+				'Data transfer on %s (%s, %s) initiated by %s (%s), with IP address %s',
+				$env->getFullName(),
+				$this->Direction,
+				$this->Mode,
+				$author->getName(),
+				$author->Email,
+				Controller::curr()->getRequest()->getIP()
+			);
+			$log->write($message);
+		}
+
+		$token = Resque::enqueue('git', 'DataTransferJob', $args, true);
+		$this->ResqueToken = $token;
+		$this->write();
+
+		$message = sprintf('Data transfer queued as job %s', $token);
+		$log->write($message);
+	}
+
+	/**
+	 * @param Member|null $member
+	 * @return bool
+	 */
+	public function canView($member = null)
+	{
+		return $this->Environment()->canView($member);
+	}
+
+	/**
+	 * Return a path to the log file.
+	 * @return string
+	 */
+	protected function logfile()
+	{
+		return sprintf(
+			'%s.datatransfer.%s.log',
+			$this->Environment()->getFullName('.'),
+			$this->ID
+		);
+	}
+
+	/**
+	 * @return \DeploynautLogFile
+	 */
+	public function log()
+	{
+		return new DeploynautLogFile($this->logfile());
+	}
+
+	/**
+	 * @return string
+	 */
+	public function LogContent()
+	{
+		return $this->log()->content();
+	}
+
+	public function getDescription()
+	{
+		$envName = $this->Environment()->getFullName();
+		if ($this->Direction == 'get') {
+			if ($this->Origin == 'ManualUpload') {
+				$description = 'Manual upload of ' . $this->getModeNice() . ' to ' . $envName;
+			} elseif ($this->IsBackupDataTransfer()) {
+				$description = 'Automated backup of ' . $this->getModeNice() . ' from ' . $envName;
+			} else {
+				$description = 'Backup of ' . $this->getModeNice() . ' to ' . $envName;
+			}
+		} else {
+			$description = 'Restore ' . $this->getModeNice() . ' to ' . $envName;
+		}
+
+		return $description;
+	}
+
+	public function getModeNice()
+	{
+		if ($this->Mode == 'all') {
+			return 'database and assets';
+		} else {
+			return $this->Mode;
+		}
+	}
+
+	/**
+	 * Is this transfer an automated backup of a push transfer?
+	 * @return boolean
+	 */
+	public function IsBackupDataTransfer()
+	{
+		return DB::query(sprintf(
+			'SELECT COUNT("ID") FROM "DNDataTransfer" WHERE "BackupDataTransferID" = %d',
+			$this->ID
+		))->value();
+	}
+
+	/**
+	 * Returns the status of the resque job
+	 *
+	 * @return string
+	 */
+	public function ResqueStatus()
+	{
+		$status = new Resque_Job_Status($this->ResqueToken);
+		$statusCode = $status->get();
+		// The Resque job can no longer be found, fallback to the DNDataTransfer.Status
+		if ($statusCode === false) {
+			// Translate from the DNDataTransfer.Status to the Resque job status for UI purposes
+			switch ($this->Status) {
+				case 'Finished':
+					return 'Complete';
+				case 'Started':
+					return 'Running';
+				default:
+					return $this->Status;
+			}
+		}
+		return self::map_resque_status($statusCode);
+	}
 }

code/model/jobs/DNDeployment.php

Indentation +340 added lines, -340 removed lines

@@ -15,344 +15,344 @@
 class DNDeployment extends DataObject
 {
 
-    /**
-     * @var array
-     */
-    private static $db = array(
-        "SHA" => "GitSHA",
-        "ResqueToken" => "Varchar(255)",
-        // Observe that this is not the same as Resque status, since ResqueStatus is not persistent
-        // It's used for finding successful deployments and displaying that in history views in the frontend
-        "Status" => "Enum('Queued, Started, Finished, Failed, n/a', 'n/a')",
-        // JSON serialised DeploymentStrategy.
-        "Strategy" => "Text"
-    );
-
-    /**
-     * @var array
-     */
-    private static $has_one = array(
-        "Environment" => "DNEnvironment",
-        "Deployer" => "Member",
-    );
-
-    private static $default_sort = '"LastEdited" DESC';
-
-    public function getTitle()
-    {
-        return "#{$this->ID}: {$this->SHA} (Status: {$this->Status})";
-    }
-
-    private static $summary_fields = array(
-        'LastEdited' => 'Last Edited',
-        'SHA' => 'SHA',
-        'Status' => 'Status',
-        'Deployer.Name' => 'Deployer'
-    );
-
-    /**
-     * @param int $int
-     * @return string
-     */
-    public static function map_resque_status($int)
-    {
-        $remap = array(
-            Resque_Job_Status::STATUS_WAITING => "Queued",
-            Resque_Job_Status::STATUS_RUNNING => "Running",
-            Resque_Job_Status::STATUS_FAILED => "Failed",
-            Resque_Job_Status::STATUS_COMPLETE => "Complete",
-            false => "Invalid",
-        );
-        return $remap[$int];
-    }
-
-
-    public function Link()
-    {
-        return Controller::join_links($this->Environment()->Link(), 'deploy', $this->ID);
-    }
-
-    public function LogLink()
-    {
-        return $this->Link() . '/log';
-    }
-
-    public function canView($member = null)
-    {
-        return $this->Environment()->canView($member);
-    }
-
-    /**
-     * Return a path to the log file.
-     * @return string
-     */
-    protected function logfile()
-    {
-        return sprintf(
-            '%s.%s.log',
-            $this->Environment()->getFullName('.'),
-            $this->ID
-        );
-    }
-
-    /**
-     * @return DeploynautLogFile
-     */
-    public function log()
-    {
-        return Injector::inst()->createWithArgs('DeploynautLogFile', array($this->logfile()));
-    }
-
-    public function LogContent()
-    {
-        return $this->log()->content();
-    }
-
-    /**
-     * Returns the status of the resque job
-     *
-     * @return string
-     */
-    public function ResqueStatus()
-    {
-        $status = new Resque_Job_Status($this->ResqueToken);
-        $statusCode = $status->get();
-        // The Resque job can no longer be found, fallback to the DNDeployment.Status
-        if ($statusCode === false) {
-            // Translate from the DNDeployment.Status to the Resque job status for UI purposes
-            switch ($this->Status) {
-                case 'Finished':
-                    return 'Complete';
-                case 'Started':
-                    return 'Running';
-                default:
-                    return $this->Status;
-            }
-        }
-        return self::map_resque_status($statusCode);
-    }
-
-
-    /**
-     * Fetch the git repository
-     *
-     * @return \Gitonomy\Git\Repository|null
-     */
-    public function getRepository()
-    {
-        if (!$this->SHA) {
-            return null;
-        }
-        return $this->Environment()->Project()->getRepository();
-    }
-
-
-    /**
-     * Gets the commit from source. The result is cached upstream in Repository.
-     *
-     * @return \Gitonomy\Git\Commit|null
-     */
-    public function getCommit()
-    {
-        $repo = $this->getRepository();
-        if ($repo) {
-            try {
-                return $repo->getCommit($this->SHA);
-            } catch (Gitonomy\Git\Exception\ReferenceNotFoundException $ex) {
-                return null;
-            }
-        }
-
-        return null;
-    }
-
-
-    /**
-     * Gets the commit message.
-     *
-     * @return string|null
-     */
-    public function getCommitMessage()
-    {
-        $commit = $this->getCommit();
-        if ($commit) {
-            try {
-                return Convert::raw2xml($commit->getMessage());
-            } catch (Gitonomy\Git\Exception\ReferenceNotFoundException $e) {
-                return null;
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Return all tags for the deployed commit.
-     *
-     * @return ArrayList
-     */
-    public function getTags()
-    {
-        $returnTags = array();
-        $repo = $this->getRepository();
-        if ($repo) {
-            $tags = $repo->getReferences()->resolveTags($this->SHA);
-            if (!empty($tags)) {
-                foreach ($tags as $tag) {
-                    $field = Varchar::create('Tag', '255');
-                    $field->setValue($tag->getName());
-                    $returnTags[] = $field;
-                }
-            }
-        }
-        return new ArrayList($returnTags);
-    }
-
-    /**
-     * Collate the list of additional flags to affix to this deployment.
-     * Elements of the array will be rendered literally.
-     *
-     * @return ArrayList
-     */
-    public function getFullDeployMessages()
-    {
-        $strategy = $this->getDeploymentStrategy();
-        if ($strategy->getActionCode()!=='full') {
-            return null;
-        }
-
-        $changes = $strategy->getChangesModificationNeeded();
-        $messages = [];
-        foreach ($changes as $change => $details) {
-            if ($change==='Code version') {
-                continue;
-            }
-
-            $messages[] = [
-                'Flag' => sprintf(
-                    '<span class="label label-default full-deploy-info-item">%s</span>',
-                    $change[0]
-                ),
-                'Text' => sprintf('%s changed', $change)
-            ];
-        }
-
-        if (empty($messages)) {
-            $messages[] = [
-                'Flag' => '',
-                'Text' => '<i>Environment changes have been made.</i>'
-            ];
-        }
-
-        return new ArrayList($messages);
-    }
-
-    /**
-     * Fetches the latest tag for the deployed commit
-     *
-     * @return \Varchar|null
-     */
-    public function getTag()
-    {
-        $tags = $this->getTags();
-        if ($tags->count() > 0) {
-            return $tags->last();
-        }
-        return null;
-    }
-
-    /**
-     * @return DeploymentStrategy
-     */
-    public function getDeploymentStrategy()
-    {
-        $environment = $this->Environment();
-        $strategy = new DeploymentStrategy($environment);
-        $strategy->fromJSON($this->Strategy);
-        return $strategy;
-    }
-
-    /**
-     * Return a list of things that are going to be deployed, such
-     * as the code version, and any infrastrucutral changes.
-     *
-     * @return ArrayList
-     */
-    public function getChanges()
-    {
-        $list = new ArrayList();
-        $strategy = $this->getDeploymentStrategy();
-        foreach ($strategy->getChanges() as $name => $change) {
-            if (empty($change['to'])) {
-                continue;
-            }
-
-            $list->push(new ArrayData([
-                'Name' => $name,
-                'From' => $change['from'],
-                'To' => $change['to'],
-                'Description' => isset($change['description']) ? $change['description'] : '',
-                'Changed' => $change['from'] != $change['to'],
-                'CompareUrl' => isset($change['compareUrl']) ? $change['compareUrl'] : ''
-            ]));
-        }
-
-        return $list;
-    }
-
-    /**
-     * Start a resque job for this deployment
-     *
-     * @return string Resque token
-     */
-    protected function enqueueDeployment()
-    {
-        $environment = $this->Environment();
-        $project = $environment->Project();
-        $log = $this->log();
-
-        $args = array(
-            'environmentName' => $environment->Name,
-            'repository' => $project->getLocalCVSPath(),
-            'logfile' => $this->logfile(),
-            'projectName' => $project->Name,
-            'env' => $project->getProcessEnv(),
-            'deploymentID' => $this->ID
-        );
-
-        $strategy = $this->getDeploymentStrategy();
-        // Inject options.
-        $args = array_merge($args, $strategy->getOptions());
-        // Make sure we use the SHA as it was written into this DNDeployment.
-        $args['sha'] = $this->SHA;
-
-        if (!$this->DeployerID) {
-            $this->DeployerID = Member::currentUserID();
-        }
-
-        if ($this->DeployerID) {
-            $deployer = $this->Deployer();
-            $message = sprintf(
-                'Deploy to %s initiated by %s (%s), with IP address %s',
-                $environment->getFullName(),
-                $deployer->getName(),
-                $deployer->Email,
-                Controller::curr()->getRequest()->getIP()
-            );
-            $log->write($message);
-        }
-
-        return Resque::enqueue('deploy', 'DeployJob', $args, true);
-    }
-
-    public function start()
-    {
-        $log = $this->log();
-        $token = $this->enqueueDeployment();
-        $this->ResqueToken = $token;
-        $this->Status = 'Queued';
-        $this->write();
-
-        $message = sprintf('Deploy queued as job %s', $token);
-        $log->write($message);
-    }
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		"SHA" => "GitSHA",
+		"ResqueToken" => "Varchar(255)",
+		// Observe that this is not the same as Resque status, since ResqueStatus is not persistent
+		// It's used for finding successful deployments and displaying that in history views in the frontend
+		"Status" => "Enum('Queued, Started, Finished, Failed, n/a', 'n/a')",
+		// JSON serialised DeploymentStrategy.
+		"Strategy" => "Text"
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $has_one = array(
+		"Environment" => "DNEnvironment",
+		"Deployer" => "Member",
+	);
+
+	private static $default_sort = '"LastEdited" DESC';
+
+	public function getTitle()
+	{
+		return "#{$this->ID}: {$this->SHA} (Status: {$this->Status})";
+	}
+
+	private static $summary_fields = array(
+		'LastEdited' => 'Last Edited',
+		'SHA' => 'SHA',
+		'Status' => 'Status',
+		'Deployer.Name' => 'Deployer'
+	);
+
+	/**
+	 * @param int $int
+	 * @return string
+	 */
+	public static function map_resque_status($int)
+	{
+		$remap = array(
+			Resque_Job_Status::STATUS_WAITING => "Queued",
+			Resque_Job_Status::STATUS_RUNNING => "Running",
+			Resque_Job_Status::STATUS_FAILED => "Failed",
+			Resque_Job_Status::STATUS_COMPLETE => "Complete",
+			false => "Invalid",
+		);
+		return $remap[$int];
+	}
+
+
+	public function Link()
+	{
+		return Controller::join_links($this->Environment()->Link(), 'deploy', $this->ID);
+	}
+
+	public function LogLink()
+	{
+		return $this->Link() . '/log';
+	}
+
+	public function canView($member = null)
+	{
+		return $this->Environment()->canView($member);
+	}
+
+	/**
+	 * Return a path to the log file.
+	 * @return string
+	 */
+	protected function logfile()
+	{
+		return sprintf(
+			'%s.%s.log',
+			$this->Environment()->getFullName('.'),
+			$this->ID
+		);
+	}
+
+	/**
+	 * @return DeploynautLogFile
+	 */
+	public function log()
+	{
+		return Injector::inst()->createWithArgs('DeploynautLogFile', array($this->logfile()));
+	}
+
+	public function LogContent()
+	{
+		return $this->log()->content();
+	}
+
+	/**
+	 * Returns the status of the resque job
+	 *
+	 * @return string
+	 */
+	public function ResqueStatus()
+	{
+		$status = new Resque_Job_Status($this->ResqueToken);
+		$statusCode = $status->get();
+		// The Resque job can no longer be found, fallback to the DNDeployment.Status
+		if ($statusCode === false) {
+			// Translate from the DNDeployment.Status to the Resque job status for UI purposes
+			switch ($this->Status) {
+				case 'Finished':
+					return 'Complete';
+				case 'Started':
+					return 'Running';
+				default:
+					return $this->Status;
+			}
+		}
+		return self::map_resque_status($statusCode);
+	}
+
+
+	/**
+	 * Fetch the git repository
+	 *
+	 * @return \Gitonomy\Git\Repository|null
+	 */
+	public function getRepository()
+	{
+		if (!$this->SHA) {
+			return null;
+		}
+		return $this->Environment()->Project()->getRepository();
+	}
+
+
+	/**
+	 * Gets the commit from source. The result is cached upstream in Repository.
+	 *
+	 * @return \Gitonomy\Git\Commit|null
+	 */
+	public function getCommit()
+	{
+		$repo = $this->getRepository();
+		if ($repo) {
+			try {
+				return $repo->getCommit($this->SHA);
+			} catch (Gitonomy\Git\Exception\ReferenceNotFoundException $ex) {
+				return null;
+			}
+		}
+
+		return null;
+	}
+
+
+	/**
+	 * Gets the commit message.
+	 *
+	 * @return string|null
+	 */
+	public function getCommitMessage()
+	{
+		$commit = $this->getCommit();
+		if ($commit) {
+			try {
+				return Convert::raw2xml($commit->getMessage());
+			} catch (Gitonomy\Git\Exception\ReferenceNotFoundException $e) {
+				return null;
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Return all tags for the deployed commit.
+	 *
+	 * @return ArrayList
+	 */
+	public function getTags()
+	{
+		$returnTags = array();
+		$repo = $this->getRepository();
+		if ($repo) {
+			$tags = $repo->getReferences()->resolveTags($this->SHA);
+			if (!empty($tags)) {
+				foreach ($tags as $tag) {
+					$field = Varchar::create('Tag', '255');
+					$field->setValue($tag->getName());
+					$returnTags[] = $field;
+				}
+			}
+		}
+		return new ArrayList($returnTags);
+	}
+
+	/**
+	 * Collate the list of additional flags to affix to this deployment.
+	 * Elements of the array will be rendered literally.
+	 *
+	 * @return ArrayList
+	 */
+	public function getFullDeployMessages()
+	{
+		$strategy = $this->getDeploymentStrategy();
+		if ($strategy->getActionCode()!=='full') {
+			return null;
+		}
+
+		$changes = $strategy->getChangesModificationNeeded();
+		$messages = [];
+		foreach ($changes as $change => $details) {
+			if ($change==='Code version') {
+				continue;
+			}
+
+			$messages[] = [
+				'Flag' => sprintf(
+					'<span class="label label-default full-deploy-info-item">%s</span>',
+					$change[0]
+				),
+				'Text' => sprintf('%s changed', $change)
+			];
+		}
+
+		if (empty($messages)) {
+			$messages[] = [
+				'Flag' => '',
+				'Text' => '<i>Environment changes have been made.</i>'
+			];
+		}
+
+		return new ArrayList($messages);
+	}
+
+	/**
+	 * Fetches the latest tag for the deployed commit
+	 *
+	 * @return \Varchar|null
+	 */
+	public function getTag()
+	{
+		$tags = $this->getTags();
+		if ($tags->count() > 0) {
+			return $tags->last();
+		}
+		return null;
+	}
+
+	/**
+	 * @return DeploymentStrategy
+	 */
+	public function getDeploymentStrategy()
+	{
+		$environment = $this->Environment();
+		$strategy = new DeploymentStrategy($environment);
+		$strategy->fromJSON($this->Strategy);
+		return $strategy;
+	}
+
+	/**
+	 * Return a list of things that are going to be deployed, such
+	 * as the code version, and any infrastrucutral changes.
+	 *
+	 * @return ArrayList
+	 */
+	public function getChanges()
+	{
+		$list = new ArrayList();
+		$strategy = $this->getDeploymentStrategy();
+		foreach ($strategy->getChanges() as $name => $change) {
+			if (empty($change['to'])) {
+				continue;
+			}
+
+			$list->push(new ArrayData([
+				'Name' => $name,
+				'From' => $change['from'],
+				'To' => $change['to'],
+				'Description' => isset($change['description']) ? $change['description'] : '',
+				'Changed' => $change['from'] != $change['to'],
+				'CompareUrl' => isset($change['compareUrl']) ? $change['compareUrl'] : ''
+			]));
+		}
+
+		return $list;
+	}
+
+	/**
+	 * Start a resque job for this deployment
+	 *
+	 * @return string Resque token
+	 */
+	protected function enqueueDeployment()
+	{
+		$environment = $this->Environment();
+		$project = $environment->Project();
+		$log = $this->log();
+
+		$args = array(
+			'environmentName' => $environment->Name,
+			'repository' => $project->getLocalCVSPath(),
+			'logfile' => $this->logfile(),
+			'projectName' => $project->Name,
+			'env' => $project->getProcessEnv(),
+			'deploymentID' => $this->ID
+		);
+
+		$strategy = $this->getDeploymentStrategy();
+		// Inject options.
+		$args = array_merge($args, $strategy->getOptions());
+		// Make sure we use the SHA as it was written into this DNDeployment.
+		$args['sha'] = $this->SHA;
+
+		if (!$this->DeployerID) {
+			$this->DeployerID = Member::currentUserID();
+		}
+
+		if ($this->DeployerID) {
+			$deployer = $this->Deployer();
+			$message = sprintf(
+				'Deploy to %s initiated by %s (%s), with IP address %s',
+				$environment->getFullName(),
+				$deployer->getName(),
+				$deployer->Email,
+				Controller::curr()->getRequest()->getIP()
+			);
+			$log->write($message);
+		}
+
+		return Resque::enqueue('deploy', 'DeployJob', $args, true);
+	}
+
+	public function start()
+	{
+		$log = $this->log();
+		$token = $this->enqueueDeployment();
+		$this->ResqueToken = $token;
+		$this->Status = 'Queued';
+		$this->write();
+
+		$message = sprintf('Deploy queued as job %s', $token);
+		$log->write($message);
+	}
 }

code/model/jobs/DNGitFetch.php

Indentation +138 added lines, -138 removed lines

@@ -14,142 +14,142 @@
 class DNGitFetch extends DataObject
 {
 
-    /**
-     * @var array
-     */
-    private static $db = array(
-        "ResqueToken" => "Varchar(255)",
-        // Observe that this is not the same as Resque status, since ResqueStatus is not persistent
-        // It's used for finding successful deployments and displaying that in history views in the frontend
-        "Status" => "Enum('Queued, Started, Finished, Failed, n/a', 'n/a')",
-    );
-
-    /**
-     * @var array
-     */
-    private static $has_one = array(
-        "Project" => "DNProject",
-        "Deployer" => "Member"
-    );
-
-    /**
-     * @param int $int
-     * @return string
-     */
-    public static function map_resque_status($int)
-    {
-        $remap = array(
-            Resque_Job_Status::STATUS_WAITING => "Queued",
-            Resque_Job_Status::STATUS_RUNNING => "Running",
-            Resque_Job_Status::STATUS_FAILED => "Failed",
-            Resque_Job_Status::STATUS_COMPLETE => "Complete",
-            false => "Invalid",
-        );
-        return $remap[$int];
-    }
-
-    /**
-     * Queue a fetch job
-     * @param bool $forceClone Force repository to be re-cloned
-     */
-    public function start($forceClone = false)
-    {
-        $project = $this->Project();
-        $log = $this->log();
-
-        if (!$this->DeployerID) {
-            $this->DeployerID = Member::currentUserID();
-        }
-
-        if ($this->DeployerID) {
-            $deployer = $this->Deployer();
-            $message = sprintf(
-                'Update repository job for %s initiated by %s (%s)',
-                $project->Name,
-                $deployer->getName(),
-                $deployer->Email
-            );
-            $log->write($message);
-        }
-
-        // write first, so we have the ID. We have to write again
-        // later once we have the resque token.
-        $this->write();
-
-        $args = array(
-            'projectID' => $project->ID,
-            'logfile' => $this->logfile(),
-            'fetchID' => $this->ID,
-            'forceClone' => $forceClone
-        );
-
-        $token = Resque::enqueue('git', 'FetchJob', $args, true);
-        $this->ResqueToken = $token;
-        $this->write();
-
-        $message = sprintf('Fetch queued as job %s', $token);
-        $log->write($message);
-    }
-
-    /**
-     * @param Member|null $member
-     * @return bool
-     */
-    public function canView($member = null)
-    {
-        return $this->Project()->canView($member);
-    }
-
-    /**
-     * Return a path to the log file.
-     * @return string
-     */
-    protected function logfile()
-    {
-        return sprintf(
-            '%s.fetch.%s.log',
-            $this->Project()->Name,
-            $this->ID
-        );
-    }
-
-    /**
-     * @return \DeploynautLogFile
-     */
-    public function log()
-    {
-        return new DeploynautLogFile($this->logfile());
-    }
-
-    /**
-     * @return string
-     */
-    public function LogContent()
-    {
-        return $this->log()->content();
-    }
-
-    /**
-     * Returns the status of the resque job
-     *
-     * @return string
-     */
-    public function ResqueStatus()
-    {
-        $status = new Resque_Job_Status($this->ResqueToken);
-        $statusCode = $status->get();
-        // The Resque job can no longer be found, fallback to the DNDeployment.Status
-        if ($statusCode === false) {
-            // Translate from the DNDeployment.Status to the Resque job status for UI purposes
-            switch ($this->Status) {
-                case 'Finished':
-                    return 'Complete';
-                case 'Started':
-                    return 'Running';
-                default:
-                    return $this->Status;
-            }
-        }
-        return self::map_resque_status($statusCode);
-    }
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		"ResqueToken" => "Varchar(255)",
+		// Observe that this is not the same as Resque status, since ResqueStatus is not persistent
+		// It's used for finding successful deployments and displaying that in history views in the frontend
+		"Status" => "Enum('Queued, Started, Finished, Failed, n/a', 'n/a')",
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $has_one = array(
+		"Project" => "DNProject",
+		"Deployer" => "Member"
+	);
+
+	/**
+	 * @param int $int
+	 * @return string
+	 */
+	public static function map_resque_status($int)
+	{
+		$remap = array(
+			Resque_Job_Status::STATUS_WAITING => "Queued",
+			Resque_Job_Status::STATUS_RUNNING => "Running",
+			Resque_Job_Status::STATUS_FAILED => "Failed",
+			Resque_Job_Status::STATUS_COMPLETE => "Complete",
+			false => "Invalid",
+		);
+		return $remap[$int];
+	}
+
+	/**
+	 * Queue a fetch job
+	 * @param bool $forceClone Force repository to be re-cloned
+	 */
+	public function start($forceClone = false)
+	{
+		$project = $this->Project();
+		$log = $this->log();
+
+		if (!$this->DeployerID) {
+			$this->DeployerID = Member::currentUserID();
+		}
+
+		if ($this->DeployerID) {
+			$deployer = $this->Deployer();
+			$message = sprintf(
+				'Update repository job for %s initiated by %s (%s)',
+				$project->Name,
+				$deployer->getName(),
+				$deployer->Email
+			);
+			$log->write($message);
+		}
+
+		// write first, so we have the ID. We have to write again
+		// later once we have the resque token.
+		$this->write();
+
+		$args = array(
+			'projectID' => $project->ID,
+			'logfile' => $this->logfile(),
+			'fetchID' => $this->ID,
+			'forceClone' => $forceClone
+		);
+
+		$token = Resque::enqueue('git', 'FetchJob', $args, true);
+		$this->ResqueToken = $token;
+		$this->write();
+
+		$message = sprintf('Fetch queued as job %s', $token);
+		$log->write($message);
+	}
+
+	/**
+	 * @param Member|null $member
+	 * @return bool
+	 */
+	public function canView($member = null)
+	{
+		return $this->Project()->canView($member);
+	}
+
+	/**
+	 * Return a path to the log file.
+	 * @return string
+	 */
+	protected function logfile()
+	{
+		return sprintf(
+			'%s.fetch.%s.log',
+			$this->Project()->Name,
+			$this->ID
+		);
+	}
+
+	/**
+	 * @return \DeploynautLogFile
+	 */
+	public function log()
+	{
+		return new DeploynautLogFile($this->logfile());
+	}
+
+	/**
+	 * @return string
+	 */
+	public function LogContent()
+	{
+		return $this->log()->content();
+	}
+
+	/**
+	 * Returns the status of the resque job
+	 *
+	 * @return string
+	 */
+	public function ResqueStatus()
+	{
+		$status = new Resque_Job_Status($this->ResqueToken);
+		$statusCode = $status->get();
+		// The Resque job can no longer be found, fallback to the DNDeployment.Status
+		if ($statusCode === false) {
+			// Translate from the DNDeployment.Status to the Resque job status for UI purposes
+			switch ($this->Status) {
+				case 'Finished':
+					return 'Complete';
+				case 'Started':
+					return 'Running';
+				default:
+					return $this->Status;
+			}
+		}
+		return self::map_resque_status($statusCode);
+	}
 }

code/model/jobs/DNPing.php

Indentation +134 added lines, -134 removed lines

@@ -1,140 +1,140 @@
 <?php
 /**
- * This class will queue a ping job and also proxy to the log file of that output
- *
- * @property string $ResqueToken
- *
- * @method DNEnvironment Environment()
- * @property int EnvironmentID
- * @method Member Deployer()
- * @property int DeployerID
- */
+	 * This class will queue a ping job and also proxy to the log file of that output
+	 *
+	 * @property string $ResqueToken
+	 *
+	 * @method DNEnvironment Environment()
+	 * @property int EnvironmentID
+	 * @method Member Deployer()
+	 * @property int DeployerID
+	 */
 class DNPing extends DataObject
 {
 
-    /**
-     * @var array
-     */
-    private static $db = array(
-        "ResqueToken" => "Varchar(255)",
-    );
-
-    /**
-     * @var array
-     */
-    private static $has_one = array(
-        "Environment" => "DNEnvironment",
-        "Deployer" =>"Member",
-    );
-
-    /**
-     * @return string
-     */
-    public function Link()
-    {
-        return Controller::join_links($this->Environment()->Link(), 'ping', $this->ID);
-    }
-
-    /**
-     * @return string
-     */
-    public function LogLink()
-    {
-        return $this->Link() . '/log';
-    }
-
-    /**
-     * @param Member|null $member
-     * @return bool
-     */
-    public function canView($member = null)
-    {
-        return $this->Environment()->canView($member);
-    }
-
-    /**
-     * Return a path to the log file.
-     * @return string
-     */
-    protected function logfile()
-    {
-        return sprintf(
-            '%s.ping.%s.log',
-            $this->Environment()->getFullName('.'),
-            $this->ID
-        );
-    }
-
-    /**
-     * @return \DeploynautLogFile
-     */
-    public function log()
-    {
-        return new DeploynautLogFile($this->logfile());
-    }
-
-    /**
-     * @return string
-     */
-    public function LogContent()
-    {
-        return $this->log()->content();
-    }
-
-    /**
-     * @return string
-     */
-    public function ResqueStatus()
-    {
-        $status = new Resque_Job_Status($this->ResqueToken);
-
-        $remap = array(
-            Resque_Job_Status::STATUS_WAITING => "Queued",
-            Resque_Job_Status::STATUS_RUNNING => "Running",
-            Resque_Job_Status::STATUS_FAILED => "Failed",
-            Resque_Job_Status::STATUS_COMPLETE => "Complete",
-            false => "Invalid",
-        );
-
-        return $remap[$status->get()];
-    }
-
-    /**
-     * Queue a ping job
-     */
-    public function start()
-    {
-        $environment = $this->Environment();
-        $project = $environment->Project();
-        $log = $this->log();
-
-        $args = array(
-            'environmentName' => $environment->Name,
-            'logfile' => $this->logfile(),
-            'projectName' => $project->Name,
-            'env' => $project->getProcessEnv()
-        );
-
-        if (!$this->DeployerID) {
-            $this->DeployerID = Member::currentUserID();
-        }
-
-        if ($this->DeployerID) {
-            $deployer = $this->Deployer();
-            $message = sprintf(
-                'Ping to %s initiated by %s (%s)',
-                $environment->getFullName(),
-                $deployer->getName(),
-                $deployer->Email
-            );
-            $log->write($message);
-        }
-
-        $token = Resque::enqueue('deploy', 'PingJob', $args, true);
-        $this->ResqueToken = $token;
-        $this->write();
-
-        $message = sprintf('Ping queued as job %s', $token);
-        $log->write($message);
-    }
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		"ResqueToken" => "Varchar(255)",
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $has_one = array(
+		"Environment" => "DNEnvironment",
+		"Deployer" =>"Member",
+	);
+
+	/**
+	 * @return string
+	 */
+	public function Link()
+	{
+		return Controller::join_links($this->Environment()->Link(), 'ping', $this->ID);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function LogLink()
+	{
+		return $this->Link() . '/log';
+	}
+
+	/**
+	 * @param Member|null $member
+	 * @return bool
+	 */
+	public function canView($member = null)
+	{
+		return $this->Environment()->canView($member);
+	}
+
+	/**
+	 * Return a path to the log file.
+	 * @return string
+	 */
+	protected function logfile()
+	{
+		return sprintf(
+			'%s.ping.%s.log',
+			$this->Environment()->getFullName('.'),
+			$this->ID
+		);
+	}
+
+	/**
+	 * @return \DeploynautLogFile
+	 */
+	public function log()
+	{
+		return new DeploynautLogFile($this->logfile());
+	}
+
+	/**
+	 * @return string
+	 */
+	public function LogContent()
+	{
+		return $this->log()->content();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function ResqueStatus()
+	{
+		$status = new Resque_Job_Status($this->ResqueToken);
+
+		$remap = array(
+			Resque_Job_Status::STATUS_WAITING => "Queued",
+			Resque_Job_Status::STATUS_RUNNING => "Running",
+			Resque_Job_Status::STATUS_FAILED => "Failed",
+			Resque_Job_Status::STATUS_COMPLETE => "Complete",
+			false => "Invalid",
+		);
+
+		return $remap[$status->get()];
+	}
+
+	/**
+	 * Queue a ping job
+	 */
+	public function start()
+	{
+		$environment = $this->Environment();
+		$project = $environment->Project();
+		$log = $this->log();
+
+		$args = array(
+			'environmentName' => $environment->Name,
+			'logfile' => $this->logfile(),
+			'projectName' => $project->Name,
+			'env' => $project->getProcessEnv()
+		);
+
+		if (!$this->DeployerID) {
+			$this->DeployerID = Member::currentUserID();
+		}
+
+		if ($this->DeployerID) {
+			$deployer = $this->Deployer();
+			$message = sprintf(
+				'Ping to %s initiated by %s (%s)',
+				$environment->getFullName(),
+				$deployer->getName(),
+				$deployer->Email
+			);
+			$log->write($message);
+		}
+
+		$token = Resque::enqueue('deploy', 'PingJob', $args, true);
+		$this->ResqueToken = $token;
+		$this->write();
+
+		$message = sprintf('Ping queued as job %s', $token);
+		$log->write($message);
+	}
 }