silverstripe / deploynaut

code/model/steps/EmergencyRollbackStep.php

Indentation +167 added lines, -167 removed lines

@@ -26,171 +26,171 @@
 class EmergencyRollbackStep extends LongRunningPipelineStep
 {
 
-    /**
-     * @var array
-     */
-    private static $db = array(
-        // if this has been rolled back set the date it was requested
-        'RolledBack' => "SS_Datetime"
-    );
-
-    /**
-     * @var array
-     */
-    private static $has_one = array(
-        'Responder' => 'Member'
-    );
-
-    /**
-     * @return bool
-     */
-    public function start()
-    {
-        // Just in case this step is being mistakenly restarted
-        if (!empty($this->RolledBack)) {
-            $this->log(_t('EmergencyRollbackStep.BEENROLLEDBACK',
-                "{$this->Title} has already been rolled back"));
-            $this->markFailed();
-            return false;
-        }
-
-        // check if we have timed out
-        if ($this->isTimedOut()) {
-            $this->log(sprintf(_t('EmergencyRollbackStep.ROLLBACKTIMEOUT',
-                "{$this->Title} is older than %s seconds and has timed out"),
-                $this->MaxDuration));
-            $this->finish();
-            return true;
-        }
-
-        // Begin or process this step
-        switch ($this->Status) {
-            case 'Started':
-                return true;
-            case 'Queued':
-                return $this->beginRollbackWindow();
-            default:
-                $this->log(_t('EmergencyRollbackStep.STARTERROR',
-                    "Unable to process {$this->Title} with status of {$this->Status}"));
-                $this->markFailed();
-                return false;
-        }
-    }
-
-    /**
-     * The user can do an emergency rollback if he could have deployed the code, or if he can abort pipelines.
-     *
-     * @param Member|null $member
-     * @return boolean
-     */
-    public function canTriggerRollback($member = null)
-    {
-        return $this->Pipeline()->Environment()->canDeploy($member) || $this->Pipeline()->canAbort($member);
-    }
-
-    /**
-     * When a member wishes to rollback this pipeline
-     *
-     * @return boolean True if successful
-     */
-    public function rollback()
-    {
-        // Check permission
-        if (!$this->canTriggerRollback()) {
-            return Security::permissionFailure(
-                null,
-                _t("EmergencyRollbackStep.DENYROLLBACKED",
-                "You do not have permission to rollback this pipeline")
-            );
-        }
-
-        if ($this->Status == 'Queued') {
-            $this->start();
-        }
-
-        // Write down some metadata.
-        $this->RolledBack = SS_Datetime::now()->Rfc2822();
-        $this->log(_t('EmergencyRollbackStep.BEINGROLLEDBACK', "{$this->Title} is being rolled back"));
-        $this->ResponderID = Member::currentUserID();
-        $this->write();
-
-        // Rollback itself is handled by the Pipeline object. This step will be marked as failed.
-        if ($this->Pipeline()->isRunning()) {
-            $this->Pipeline()->markFailed();
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * Dismiss the rollback window
-     */
-    public function dismiss()
-    {
-        // Check permission
-        if (!$this->canTriggerRollback()) {
-            return Security::permissionFailure(
-                null,
-                _t("EmergencyRollbackStep.DENYROLLBACKED",
-                "You do not have permission to rollback this pipeline")
-            );
-        }
-
-        $this->log("Dismissing rollback window.");
-        $this->finish();
-        return true;
-    }
-
-    /**
-     * Initiate the a rollback window
-     */
-    public function beginRollbackWindow()
-    {
-        $this->Status = 'Started';
-        if (!$this->Started) {
-            $this->Started = SS_Datetime::now()->Rfc2822();
-        }
-        $this->log(_t('EmergencyRollbackStep.BEGINROLLBACKWINDOW',
-            "{$this->Title} is beginning a rollback window..."));
-        $this->write();
-        // Message author that the deployment is complete
-        $this->Pipeline()->sendMessage(Pipeline::ALERT_SUCCESS);
-        return true;
-    }
-
-    public function getRunningDescription()
-    {
-        // Don't show options if this step has already been confirmed
-        if ($this->RolledBack) {
-            return;
-        }
-
-        return _t('EmergencyRollbackStep.RUNNINGDESCRIPTION',
-            'You may now roll back to the previous version, if needed.');
-    }
-
-    public function allowedActions()
-    {
-        // Don't show options if this step has already been confirmed or can't be confirmed
-        if (!$this->canTriggerRollback()) {
-            return parent::allowedActions();
-        }
-
-        // Return actions
-        return array(
-            'rollback' => array(
-                'ButtonText' => _t('EmergencyRollbackStep.ROLLBACKBUTTON', 'Rollback'),
-                'ButtonType' => 'btn-success',
-                'Link' => $this->Pipeline()->StepLink('rollback'),
-                'Title' => _t('EmergencyRollbackStep.ROLLBACKTHEDEPLOYMENTTITLE', 'Rollback the deployment')
-            ),
-            'dismiss' => array(
-                'ButtonText' => _t('EmergencyRollbackStep.DISMISS', 'Dismiss'),
-                'ButtonType' => 'btn-info',
-                'Link' => $this->Pipeline()->StepLink('dismiss'),
-                'Title' => _t('EmergencyRollbackStep.ROLLBACKTHEDEPLOYMENTTITLE', 'Dismiss this option')
-            )
-        );
-    }
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		// if this has been rolled back set the date it was requested
+		'RolledBack' => "SS_Datetime"
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $has_one = array(
+		'Responder' => 'Member'
+	);
+
+	/**
+	 * @return bool
+	 */
+	public function start()
+	{
+		// Just in case this step is being mistakenly restarted
+		if (!empty($this->RolledBack)) {
+			$this->log(_t('EmergencyRollbackStep.BEENROLLEDBACK',
+				"{$this->Title} has already been rolled back"));
+			$this->markFailed();
+			return false;
+		}
+
+		// check if we have timed out
+		if ($this->isTimedOut()) {
+			$this->log(sprintf(_t('EmergencyRollbackStep.ROLLBACKTIMEOUT',
+				"{$this->Title} is older than %s seconds and has timed out"),
+				$this->MaxDuration));
+			$this->finish();
+			return true;
+		}
+
+		// Begin or process this step
+		switch ($this->Status) {
+			case 'Started':
+				return true;
+			case 'Queued':
+				return $this->beginRollbackWindow();
+			default:
+				$this->log(_t('EmergencyRollbackStep.STARTERROR',
+					"Unable to process {$this->Title} with status of {$this->Status}"));
+				$this->markFailed();
+				return false;
+		}
+	}
+
+	/**
+	 * The user can do an emergency rollback if he could have deployed the code, or if he can abort pipelines.
+	 *
+	 * @param Member|null $member
+	 * @return boolean
+	 */
+	public function canTriggerRollback($member = null)
+	{
+		return $this->Pipeline()->Environment()->canDeploy($member) || $this->Pipeline()->canAbort($member);
+	}
+
+	/**
+	 * When a member wishes to rollback this pipeline
+	 *
+	 * @return boolean True if successful
+	 */
+	public function rollback()
+	{
+		// Check permission
+		if (!$this->canTriggerRollback()) {
+			return Security::permissionFailure(
+				null,
+				_t("EmergencyRollbackStep.DENYROLLBACKED",
+				"You do not have permission to rollback this pipeline")
+			);
+		}
+
+		if ($this->Status == 'Queued') {
+			$this->start();
+		}
+
+		// Write down some metadata.
+		$this->RolledBack = SS_Datetime::now()->Rfc2822();
+		$this->log(_t('EmergencyRollbackStep.BEINGROLLEDBACK', "{$this->Title} is being rolled back"));
+		$this->ResponderID = Member::currentUserID();
+		$this->write();
+
+		// Rollback itself is handled by the Pipeline object. This step will be marked as failed.
+		if ($this->Pipeline()->isRunning()) {
+			$this->Pipeline()->markFailed();
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * Dismiss the rollback window
+	 */
+	public function dismiss()
+	{
+		// Check permission
+		if (!$this->canTriggerRollback()) {
+			return Security::permissionFailure(
+				null,
+				_t("EmergencyRollbackStep.DENYROLLBACKED",
+				"You do not have permission to rollback this pipeline")
+			);
+		}
+
+		$this->log("Dismissing rollback window.");
+		$this->finish();
+		return true;
+	}
+
+	/**
+	 * Initiate the a rollback window
+	 */
+	public function beginRollbackWindow()
+	{
+		$this->Status = 'Started';
+		if (!$this->Started) {
+			$this->Started = SS_Datetime::now()->Rfc2822();
+		}
+		$this->log(_t('EmergencyRollbackStep.BEGINROLLBACKWINDOW',
+			"{$this->Title} is beginning a rollback window..."));
+		$this->write();
+		// Message author that the deployment is complete
+		$this->Pipeline()->sendMessage(Pipeline::ALERT_SUCCESS);
+		return true;
+	}
+
+	public function getRunningDescription()
+	{
+		// Don't show options if this step has already been confirmed
+		if ($this->RolledBack) {
+			return;
+		}
+
+		return _t('EmergencyRollbackStep.RUNNINGDESCRIPTION',
+			'You may now roll back to the previous version, if needed.');
+	}
+
+	public function allowedActions()
+	{
+		// Don't show options if this step has already been confirmed or can't be confirmed
+		if (!$this->canTriggerRollback()) {
+			return parent::allowedActions();
+		}
+
+		// Return actions
+		return array(
+			'rollback' => array(
+				'ButtonText' => _t('EmergencyRollbackStep.ROLLBACKBUTTON', 'Rollback'),
+				'ButtonType' => 'btn-success',
+				'Link' => $this->Pipeline()->StepLink('rollback'),
+				'Title' => _t('EmergencyRollbackStep.ROLLBACKTHEDEPLOYMENTTITLE', 'Rollback the deployment')
+			),
+			'dismiss' => array(
+				'ButtonText' => _t('EmergencyRollbackStep.DISMISS', 'Dismiss'),
+				'ButtonType' => 'btn-info',
+				'Link' => $this->Pipeline()->StepLink('dismiss'),
+				'Title' => _t('EmergencyRollbackStep.ROLLBACKTHEDEPLOYMENTTITLE', 'Dismiss this option')
+			)
+		);
+	}
 }

code/model/steps/LongRunningPipelineStep.php

Indentation +50 added lines, -50 removed lines

@@ -12,58 +12,58 @@
 class LongRunningPipelineStep extends PipelineStep
 {
 
-    /**
-     * Determines maximum allowed execution for deployment
-     *
-     * @return int Number of seconds, or null if not enabled
-     */
-    public function getMaxDuration()
-    {
-        return $this->getConfigSetting('MaxDuration') ?: null;
-    }
+	/**
+	 * Determines maximum allowed execution for deployment
+	 *
+	 * @return int Number of seconds, or null if not enabled
+	 */
+	public function getMaxDuration()
+	{
+		return $this->getConfigSetting('MaxDuration') ?: null;
+	}
 
-    /**
-     * @var array
-     */
-    private static $db = array(
-        'Started' => 'SS_Datetime'
-    );
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		'Started' => 'SS_Datetime'
+	);
 
-    /**
-     * Return true if this has timed out
-     *
-     * @return boolean
-     */
-    public function isTimedOut()
-    {
-        $age = $this->getAge();
-        $timeout = $this->getMaxDuration();
-        return $age && $timeout && ($age > $timeout);
-    }
+	/**
+	 * Return true if this has timed out
+	 *
+	 * @return boolean
+	 */
+	public function isTimedOut()
+	{
+		$age = $this->getAge();
+		$timeout = $this->getMaxDuration();
+		return $age && $timeout && ($age > $timeout);
+	}
 
-    /**
-     * Gets the age of this job in seconds, or 0 if not started
-     *
-     * @return int Age in seconds
-     */
-    public function getAge()
-    {
-        if ($this->Started) {
-            $started = intval($this->dbObject('Started')->Format('U'));
-            $now = intval(SS_Datetime::now()->Format('U'));
-            if ($started && $now) {
-                return $now - $started;
-            }
-        }
-        return 0;
-    }
+	/**
+	 * Gets the age of this job in seconds, or 0 if not started
+	 *
+	 * @return int Age in seconds
+	 */
+	public function getAge()
+	{
+		if ($this->Started) {
+			$started = intval($this->dbObject('Started')->Format('U'));
+			$now = intval(SS_Datetime::now()->Format('U'));
+			if ($started && $now) {
+				return $now - $started;
+			}
+		}
+		return 0;
+	}
 
-    public function start()
-    {
-        // Ensure started date is set
-        if (!$this->Started) {
-            $this->Started = SS_Datetime::now()->Rfc2822();
-            $this->write();
-        }
-    }
+	public function start()
+	{
+		// Ensure started date is set
+		if (!$this->Started) {
+			$this->Started = SS_Datetime::now()->Rfc2822();
+			$this->write();
+		}
+	}
 }

code/model/steps/PipelineStep.php

Indentation +255 added lines, -255 removed lines

@@ -28,288 +28,288 @@
 class PipelineStep extends DataObject implements PipelineData
 {
 
-    /**
-     * @var array
-     * - Order:  The order in which this step is to be executed within the {@link Pipeline}.
-     *           Links to the 'Pipeline' has_one below.
-     * - Status: The status if this particular step in the Pipeline. You can always query $this->Pipeline()->Status to
-     *           see the overall status of the pipeline itself.
-     */
-    private static $db = array(
-        'Name' => 'Varchar(255)',
-        'Order' => 'Int',
-        'Status' => 'Enum("Queued,Started,Finished,Failed,Aborted,n/a", "n/a")',
-        'Config' => 'Text' // serialized array of configuration for this step
-    );
+	/**
+	 * @var array
+	 * - Order:  The order in which this step is to be executed within the {@link Pipeline}.
+	 *           Links to the 'Pipeline' has_one below.
+	 * - Status: The status if this particular step in the Pipeline. You can always query $this->Pipeline()->Status to
+	 *           see the overall status of the pipeline itself.
+	 */
+	private static $db = array(
+		'Name' => 'Varchar(255)',
+		'Order' => 'Int',
+		'Status' => 'Enum("Queued,Started,Finished,Failed,Aborted,n/a", "n/a")',
+		'Config' => 'Text' // serialized array of configuration for this step
+	);
 
-    private static $has_one = array(
-        'Pipeline' => 'Pipeline'
-    );
+	private static $has_one = array(
+		'Pipeline' => 'Pipeline'
+	);
 
-    /**
-     * @var string Ensure we use the 'Order' int as the sort order. This means that all code that references
-     * {@link Pipeline::PipelineSteps()} will always get the steps in the same order.
-     */
-    private static $default_sort = 'Order';
+	/**
+	 * @var string Ensure we use the 'Order' int as the sort order. This means that all code that references
+	 * {@link Pipeline::PipelineSteps()} will always get the steps in the same order.
+	 */
+	private static $default_sort = 'Order';
 
-    private static $summary_fields = array(
-        'Name',
-        'Status',
-        'LastEdited'
-    );
+	private static $summary_fields = array(
+		'Name',
+		'Status',
+		'LastEdited'
+	);
 
-    /**
-     * Cached of config merged with defaults
-     *
-     * @var array|null
-     */
-    protected $mergedConfig;
+	/**
+	 * Cached of config merged with defaults
+	 *
+	 * @var array|null
+	 */
+	protected $mergedConfig;
 
-    /**
-     * Title of this step
-     *
-     * @return string
-     */
-    public function getTitle()
-    {
-        return $this->Name ?: get_class($this);
-    }
+	/**
+	 * Title of this step
+	 *
+	 * @return string
+	 */
+	public function getTitle()
+	{
+		return $this->Name ?: get_class($this);
+	}
 
-    public function getTreeTitle()
-    {
-        return $this->Title . ' (Status: ' . $this->Status . ')';
-    }
+	public function getTreeTitle()
+	{
+		return $this->Title . ' (Status: ' . $this->Status . ')';
+	}
 
-    public function getNiceName()
-    {
-        $niceName = $this->getConfigSetting('NiceName')
-            ?: ucwords(trim(strtolower(preg_replace('/_?([A-Z])/', ' $1', $this->getTitle()))));
+	public function getNiceName()
+	{
+		$niceName = $this->getConfigSetting('NiceName')
+			?: ucwords(trim(strtolower(preg_replace('/_?([A-Z])/', ' $1', $this->getTitle()))));
 
-        if ($this->isFinished()) {
-            $niceName = $this->getConfigSetting('NiceDone') ?: $niceName;
-        }
+		if ($this->isFinished()) {
+			$niceName = $this->getConfigSetting('NiceDone') ?: $niceName;
+		}
 
-        return $niceName;
-    }
+		return $niceName;
+	}
 
-    /**
-     * Unserializes a snippet of configuration that was saved at the time this step
-     * was created at {@link Pipeline::start()} so that this step can use that configuration
-     * to determine what it needs to do. e.g for SmokeTestPipelineStep this might contain
-     * a list of URLs that need to be checked and which status codes to check for.
-     *
-     * @return array
-     */
-    public function getConfigData()
-    {
-        if (!$this->Config) {
-            return array();
-        }
+	/**
+	 * Unserializes a snippet of configuration that was saved at the time this step
+	 * was created at {@link Pipeline::start()} so that this step can use that configuration
+	 * to determine what it needs to do. e.g for SmokeTestPipelineStep this might contain
+	 * a list of URLs that need to be checked and which status codes to check for.
+	 *
+	 * @return array
+	 */
+	public function getConfigData()
+	{
+		if (!$this->Config) {
+			return array();
+		}
 
-        // Merge with defaults
-        if (!$this->mergedConfig) {
-            $this->mergedConfig = unserialize($this->Config);
-            if ($default = self::config()->default_config) {
-                Config::merge_array_low_into_high($this->mergedConfig, $default);
-            }
-        }
-        return $this->mergedConfig;
-    }
+		// Merge with defaults
+		if (!$this->mergedConfig) {
+			$this->mergedConfig = unserialize($this->Config);
+			if ($default = self::config()->default_config) {
+				Config::merge_array_low_into_high($this->mergedConfig, $default);
+			}
+		}
+		return $this->mergedConfig;
+	}
 
-    public function setConfig($data)
-    {
-        $this->mergedConfig = null;
-        return parent::setField('Config', $data);
-    }
+	public function setConfig($data)
+	{
+		$this->mergedConfig = null;
+		return parent::setField('Config', $data);
+	}
 
-    /**
-     * Describe what the step is currently doing.
-     *
-     * @return string
-     */
-    public function getRunningDescription()
-    {
-        return '';
-    }
+	/**
+	 * Describe what the step is currently doing.
+	 *
+	 * @return string
+	 */
+	public function getRunningDescription()
+	{
+		return '';
+	}
 
-    /**
-     * 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;
-    }
+	/**
+	 * 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;
+	}
 
-    public function finish()
-    {
-        $this->Status = 'Finished';
-        $this->log('Step finished successfully!');
-        $this->write();
-    }
+	public function finish()
+	{
+		$this->Status = 'Finished';
+		$this->log('Step finished successfully!');
+		$this->write();
+	}
 
-    /**
-     * Fail this pipeline step
-     *
-     * @param bool $notify Set to false to disable notifications for this failure
-     */
-    public function markFailed($notify = true)
-    {
-        $this->Status = 'Failed';
-        $this->log('Marking pipeline step as failed. See earlier log messages to determine cause.');
-        $this->write();
-        $this->Pipeline()->markFailed($notify);
-    }
+	/**
+	 * Fail this pipeline step
+	 *
+	 * @param bool $notify Set to false to disable notifications for this failure
+	 */
+	public function markFailed($notify = true)
+	{
+		$this->Status = 'Failed';
+		$this->log('Marking pipeline step as failed. See earlier log messages to determine cause.');
+		$this->write();
+		$this->Pipeline()->markFailed($notify);
+	}
 
-    /**
-     * Determine if this step is in progress (Started state).
-     *
-     * @return boolean
-     */
-    public function isQueued()
-    {
-        return $this->Status === 'Queued';
-    }
+	/**
+	 * Determine if this step is in progress (Started state).
+	 *
+	 * @return boolean
+	 */
+	public function isQueued()
+	{
+		return $this->Status === 'Queued';
+	}
 
-    /**
-     * Determine if this step is in progress (Started state).
-     *
-     * @return boolean
-     */
-    public function isRunning()
-    {
-        return $this->Status === 'Started';
-    }
+	/**
+	 * Determine if this step is in progress (Started state).
+	 *
+	 * @return boolean
+	 */
+	public function isRunning()
+	{
+		return $this->Status === 'Started';
+	}
 
-    /**
-     * Determine if this step is in progress (Started state).
-     *
-     * @return boolean
-     */
-    public function isFinished()
-    {
-        return $this->Status === "Finished";
-    }
+	/**
+	 * Determine if this step is in progress (Started state).
+	 *
+	 * @return boolean
+	 */
+	public function isFinished()
+	{
+		return $this->Status === "Finished";
+	}
 
-    /**
-     * Determine if the step has failed on its own (Failed state). No further state transitions may occur.
-     * If Pipeline determines the step to be failed, all subsequent states will be aborted.
-     *
-     * @return boolean
-     */
-    public function isFailed()
-    {
-        return $this->Status === "Failed";
-    }
+	/**
+	 * Determine if the step has failed on its own (Failed state). No further state transitions may occur.
+	 * If Pipeline determines the step to be failed, all subsequent states will be aborted.
+	 *
+	 * @return boolean
+	 */
+	public function isFailed()
+	{
+		return $this->Status === "Failed";
+	}
 
-    /**
-     * Determine if the step has been aborted (Aborted state).
-     *
-     * @return boolean
-     */
-    public function isAborted()
-    {
-        return $this->Status === "Aborted";
-    }
+	/**
+	 * Determine if the step has been aborted (Aborted state).
+	 *
+	 * @return boolean
+	 */
+	public function isAborted()
+	{
+		return $this->Status === "Aborted";
+	}
 
-    /**
-     * Log a message to the current log
-     *
-     * @param string $message
-     */
-    public function log($message = "")
-    {
-        $this->Pipeline()->log($message);
-    }
+	/**
+	 * Log a message to the current log
+	 *
+	 * @param string $message
+	 */
+	public function log($message = "")
+	{
+		$this->Pipeline()->log($message);
+	}
 
-    /**
-     * Tries to look up the value of the 'PerformTestOn' yml key for this step, and return the {@link DNEnvironment}
-     * that the key refers to, if set.
-     *
-     * If the key isn't set, then it should return the current environment that the Pipeline is running for (e.g.
-     * $this->Pipeline()->Environment()).
-     *
-     * @return DNEnvironment The dependent {@link DNEnvironment}.
-     */
-    protected function getDependentEnvironment()
-    {
-        if ($this->getConfigSetting('PerformTestOn') === 'DependentEnvironment') {
-            try {
-                $environment = $this->Pipeline()->getDependentEnvironment();
-            } catch (Exception $e) {
-                $this->log($e->getMessage());
-                $this->markFailed();
-                return false;
-            }
-        } else {
-            $environment = $this->Pipeline()->Environment();
-        }
+	/**
+	 * Tries to look up the value of the 'PerformTestOn' yml key for this step, and return the {@link DNEnvironment}
+	 * that the key refers to, if set.
+	 *
+	 * If the key isn't set, then it should return the current environment that the Pipeline is running for (e.g.
+	 * $this->Pipeline()->Environment()).
+	 *
+	 * @return DNEnvironment The dependent {@link DNEnvironment}.
+	 */
+	protected function getDependentEnvironment()
+	{
+		if ($this->getConfigSetting('PerformTestOn') === 'DependentEnvironment') {
+			try {
+				$environment = $this->Pipeline()->getDependentEnvironment();
+			} catch (Exception $e) {
+				$this->log($e->getMessage());
+				$this->markFailed();
+				return false;
+			}
+		} else {
+			$environment = $this->Pipeline()->Environment();
+		}
 
-        return $environment;
-    }
+		return $environment;
+	}
 
-    /**
-     * Initialise the step unless it's already running (Started state).
-     * The step will be expected to transition from here to Finished, Failed or Aborted state.
-     *
-     * @return boolean|null True if successfully started, false if error
-     */
-    public function start()
-    {
-        $this->Status = 'Started';
-        $this->write();
-    }
+	/**
+	 * Initialise the step unless it's already running (Started state).
+	 * The step will be expected to transition from here to Finished, Failed or Aborted state.
+	 *
+	 * @return boolean|null True if successfully started, false if error
+	 */
+	public function start()
+	{
+		$this->Status = 'Started';
+		$this->write();
+	}
 
-    /**
-     * Abort the step immediately, regardless of its current state, performing any cleanup necessary.
-     * If a step is aborted, all subsequent states will also be aborted by the Pipeline, so it is possible
-     * for a Queued step to skip straight to Aborted state.
-     *
-     * No further state transitions may occur. If aborting fails return false but remain in Aborted state.
-     *
-     * @return boolean True if successfully aborted, false if error
-     */
-    public function abort()
-    {
-        if ($this->isQueued() || $this->isRunning()) {
-            $this->Status = 'Aborted';
-            $this->log('Step aborted');
-            $this->write();
-        }
+	/**
+	 * Abort the step immediately, regardless of its current state, performing any cleanup necessary.
+	 * If a step is aborted, all subsequent states will also be aborted by the Pipeline, so it is possible
+	 * for a Queued step to skip straight to Aborted state.
+	 *
+	 * No further state transitions may occur. If aborting fails return false but remain in Aborted state.
+	 *
+	 * @return boolean True if successfully aborted, false if error
+	 */
+	public function abort()
+	{
+		if ($this->isQueued() || $this->isRunning()) {
+			$this->Status = 'Aborted';
+			$this->log('Step aborted');
+			$this->write();
+		}
 
-        return true;
-    }
+		return true;
+	}
 
-    /**
-     * List of allowed actions the user is all allowed to take on this step
-     *
-     * @return array $options List of items, each as an associative array in the form
-     * array(
-     *     'action' => array(
-     *         'ButtonText' => 'Action Title',
-     *         'ButtonType' => 'btn-success',
-     *         'Link' => 'naut/project/ss3/environment/deployuat/pipeline/1/step/action',
-     *         'Title' => 'Action description',
-     *         'Confirm' => 'Are you sure you wish to action?'
-     *     )
-     * )
-     */
-    public function allowedActions()
-    {
-        return array();
-    }
+	/**
+	 * List of allowed actions the user is all allowed to take on this step
+	 *
+	 * @return array $options List of items, each as an associative array in the form
+	 * array(
+	 *     'action' => array(
+	 *         'ButtonText' => 'Action Title',
+	 *         'ButtonType' => 'btn-success',
+	 *         'Link' => 'naut/project/ss3/environment/deployuat/pipeline/1/step/action',
+	 *         'Title' => 'Action description',
+	 *         'Confirm' => 'Are you sure you wish to action?'
+	 *     )
+	 * )
+	 */
+	public function allowedActions()
+	{
+		return array();
+	}
 
-    public function getDryRun()
-    {
-        return $this->Pipeline()->DryRun;
-    }
+	public function getDryRun()
+	{
+		return $this->Pipeline()->DryRun;
+	}
 }

code/model/steps/RollbackStep.php

Indentation +233 added lines, -233 removed lines

@@ -25,263 +25,263 @@
 class RollbackStep extends LongRunningPipelineStep
 {
 
-    /**
-     * @var array
-     */
-    private static $db = array(
-        'Doing' => "Enum('Deployment,Snapshot,Queued', 'Queued')"
-    );
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		'Doing' => "Enum('Deployment,Snapshot,Queued', 'Queued')"
+	);
 
-    /**
-     * @var array
-     */
-    private static $has_one = array(
-        'RollbackDeployment' => 'DNDeployment',
-        'RollbackDatabase' => 'DNDataTransfer'
-    );
+	/**
+	 * @var array
+	 */
+	private static $has_one = array(
+		'RollbackDeployment' => 'DNDeployment',
+		'RollbackDatabase' => 'DNDataTransfer'
+	);
 
-    /**
-     * @return string
-     */
-    public function getTitle()
-    {
-        // Make sure the title includes the subtask
-        return parent::getTitle() . ":{$this->Doing}";
-    }
+	/**
+	 * @return string
+	 */
+	public function getTitle()
+	{
+		// Make sure the title includes the subtask
+		return parent::getTitle() . ":{$this->Doing}";
+	}
 
-    /**
-     * @return bool|null
-     */
-    public function start()
-    {
-        parent::start();
+	/**
+	 * @return bool|null
+	 */
+	public function start()
+	{
+		parent::start();
 
-        switch ($this->Status) {
-            case 'Started':
-                // If we are doing a subtask, check which one to continue
-                switch ($this->Doing) {
-                    case 'Deployment':
-                        return $this->continueRevertDeploy();
-                    case 'Snapshot':
-                        return $this->continueRevertDatabase();
-                    default:
-                        $this->log("Unable to process {$this->Title} with subtask of {$this->Doing}");
-                        $this->markFailed();
-                        return false;
-                }
-            case 'Queued':
-                // Begin rollback by initiating deployment
-                return $this->startRevertDeploy();
-            default:
-                $this->log("Unable to process {$this->Title} with status of {$this->Status}");
-                $this->markFailed();
-                return false;
-        }
-    }
+		switch ($this->Status) {
+			case 'Started':
+				// If we are doing a subtask, check which one to continue
+				switch ($this->Doing) {
+					case 'Deployment':
+						return $this->continueRevertDeploy();
+					case 'Snapshot':
+						return $this->continueRevertDatabase();
+					default:
+						$this->log("Unable to process {$this->Title} with subtask of {$this->Doing}");
+						$this->markFailed();
+						return false;
+				}
+			case 'Queued':
+				// Begin rollback by initiating deployment
+				return $this->startRevertDeploy();
+			default:
+				$this->log("Unable to process {$this->Title} with status of {$this->Status}");
+				$this->markFailed();
+				return false;
+		}
+	}
 
-    /**
-     * Begin a new deployment
-     *
-     * @return boolean
-     */
-    protected function startRevertDeploy()
-    {
-        $this->Status = 'Started';
-        $this->Doing = 'Deployment';
-        $this->log("{$this->Title} starting revert deployment");
+	/**
+	 * Begin a new deployment
+	 *
+	 * @return boolean
+	 */
+	protected function startRevertDeploy()
+	{
+		$this->Status = 'Started';
+		$this->Doing = 'Deployment';
+		$this->log("{$this->Title} starting revert deployment");
 
-        // Skip deployment for dry run
-        if ($this->Pipeline()->DryRun) {
-            $this->log("[Skipped] Create DNDeployment");
-            $this->write();
-            return true;
-        }
+		// Skip deployment for dry run
+		if ($this->Pipeline()->DryRun) {
+			$this->log("[Skipped] Create DNDeployment");
+			$this->write();
+			return true;
+		}
 
-        // Get old deployment from pipeline
-        $pipeline = $this->Pipeline();
-        $previous = $pipeline->PreviousDeployment();
-        if (empty($previous) || empty($previous->SHA)) {
-            $this->log("No available SHA for {$this->Title}");
-            $this->markFailed();
-            return false;
-        }
+		// Get old deployment from pipeline
+		$pipeline = $this->Pipeline();
+		$previous = $pipeline->PreviousDeployment();
+		if (empty($previous) || empty($previous->SHA)) {
+			$this->log("No available SHA for {$this->Title}");
+			$this->markFailed();
+			return false;
+		}
 
-        // Initialise deployment
-        $strategy = new DeploymentStrategy($pipeline->Environment(), array(
-            'sha'=>$pipeline->SHA,
-            // Leave the maintenance page up if we are restoring the DB
-            'leaveMaintenancePage' => $this->doRestoreDB()
-        ));
-        $deployment = $strategy->createDeployment();
+		// Initialise deployment
+		$strategy = new DeploymentStrategy($pipeline->Environment(), array(
+			'sha'=>$pipeline->SHA,
+			// Leave the maintenance page up if we are restoring the DB
+			'leaveMaintenancePage' => $this->doRestoreDB()
+		));
+		$deployment = $strategy->createDeployment();
 
-        $deployment->DeployerID = $pipeline->AuthorID;
-        $deployment->write();
-        $deployment->start();
-        $this->RollbackDeploymentID = $deployment->ID;
-        $this->write();
+		$deployment->DeployerID = $pipeline->AuthorID;
+		$deployment->write();
+		$deployment->start();
+		$this->RollbackDeploymentID = $deployment->ID;
+		$this->write();
 
-        return true;
-    }
+		return true;
+	}
 
-    /**
-     * Create a snapshot of the db and store the ID on the Pipline
-     *
-     * @return bool True if success
-     */
-    protected function startRevertDatabase()
-    {
-        // Mark self as creating a snapshot
-        $this->Status = 'Started';
-        $this->Doing = 'Snapshot';
-        $this->log("{$this->Title} reverting database from snapshot");
+	/**
+	 * Create a snapshot of the db and store the ID on the Pipline
+	 *
+	 * @return bool True if success
+	 */
+	protected function startRevertDatabase()
+	{
+		// Mark self as creating a snapshot
+		$this->Status = 'Started';
+		$this->Doing = 'Snapshot';
+		$this->log("{$this->Title} reverting database from snapshot");
 
-        // Skip deployment for dry run
-        if ($this->Pipeline()->DryRun) {
-            $this->write();
-            $this->log("[Skipped] Create DNDataTransfer restore");
-            return true;
-        }
+		// Skip deployment for dry run
+		if ($this->Pipeline()->DryRun) {
+			$this->write();
+			$this->log("[Skipped] Create DNDataTransfer restore");
+			return true;
+		}
 
-        // Get snapshot
-        $pipeline = $this->Pipeline();
-        $backup = $pipeline->PreviousSnapshot();
-        if (empty($backup) || !$backup->exists()) {
-            $this->log("No database to revert for {$this->Title}");
-            $this->markFailed();
-            return false;
-        }
+		// Get snapshot
+		$pipeline = $this->Pipeline();
+		$backup = $pipeline->PreviousSnapshot();
+		if (empty($backup) || !$backup->exists()) {
+			$this->log("No database to revert for {$this->Title}");
+			$this->markFailed();
+			return false;
+		}
 
-        // Create restore job
-        $job = DNDataTransfer::create();
-        $job->EnvironmentID = $pipeline->EnvironmentID;
-        $job->Direction = 'push';
-        $job->Mode = 'db';
-        $job->DataArchiveID = $backup->DataArchiveID;
-        $job->AuthorID = $pipeline->AuthorID;
-        $job->EnvironmentID = $pipeline->EnvironmentID;
-        $job->write();
-        $job->start();
+		// Create restore job
+		$job = DNDataTransfer::create();
+		$job->EnvironmentID = $pipeline->EnvironmentID;
+		$job->Direction = 'push';
+		$job->Mode = 'db';
+		$job->DataArchiveID = $backup->DataArchiveID;
+		$job->AuthorID = $pipeline->AuthorID;
+		$job->EnvironmentID = $pipeline->EnvironmentID;
+		$job->write();
+		$job->start();
 
-        // Save rollback
-        $this->RollbackDatabaseID = $job->ID;
-        $this->write();
-        return true;
-    }
+		// Save rollback
+		$this->RollbackDatabaseID = $job->ID;
+		$this->write();
+		return true;
+	}
 
-    /**
-     * Check status of current snapshot
-     */
-    protected function continueRevertDatabase()
-    {
-        $this->log("Checking status of {$this->Title}...");
+	/**
+	 * Check status of current snapshot
+	 */
+	protected function continueRevertDatabase()
+	{
+		$this->log("Checking status of {$this->Title}...");
 
-        // Skip snapshot for dry run
-        if ($this->Pipeline()->DryRun) {
-            $this->log("[Skipped] Checking progress of snapshot restore");
-            return $this->finish();
-        }
+		// Skip snapshot for dry run
+		if ($this->Pipeline()->DryRun) {
+			$this->log("[Skipped] Checking progress of snapshot restore");
+			return $this->finish();
+		}
 
-        // Get related snapshot
-        $transfer = $this->RollbackDatabase();
-        if (empty($transfer) || !$transfer->exists()) {
-            $this->log("Missing database transfer for in-progress {$this->Title}");
-            $this->markFailed();
-            return false;
-        }
+		// Get related snapshot
+		$transfer = $this->RollbackDatabase();
+		if (empty($transfer) || !$transfer->exists()) {
+			$this->log("Missing database transfer for in-progress {$this->Title}");
+			$this->markFailed();
+			return false;
+		}
 
-        // Check finished state
-        $status = $transfer->ResqueStatus();
-        if ($this->checkResqueStatus($status)) {
-            // Re-enable the site by disabling the maintenance, since the DB restored successfully
-            $this->Pipeline()->Environment()->disableMaintenance($this->Pipeline()->getLogger());
+		// Check finished state
+		$status = $transfer->ResqueStatus();
+		if ($this->checkResqueStatus($status)) {
+			// Re-enable the site by disabling the maintenance, since the DB restored successfully
+			$this->Pipeline()->Environment()->disableMaintenance($this->Pipeline()->getLogger());
 
-            // After revert is complete we are done
-            return $this->finish();
-        }
-    }
+			// After revert is complete we are done
+			return $this->finish();
+		}
+	}
 
-    /**
-     * Check status of deployment and finish task if complete, or fail if timedout
-     *
-     * @return boolean
-     */
-    protected function continueRevertDeploy()
-    {
-        $this->log("Checking status of {$this->Title}...");
+	/**
+	 * Check status of deployment and finish task if complete, or fail if timedout
+	 *
+	 * @return boolean
+	 */
+	protected function continueRevertDeploy()
+	{
+		$this->log("Checking status of {$this->Title}...");
 
-        // Skip deployment for dry run
-        if ($this->Pipeline()->DryRun) {
-            $this->log("[Skipped] Checking progress of deployment");
-            if ($this->getConfigSetting('RestoreDB')) {
-                return $this->startRevertDatabase();
-            } else {
-                $this->finish();
-                return true;
-            }
-        }
+		// Skip deployment for dry run
+		if ($this->Pipeline()->DryRun) {
+			$this->log("[Skipped] Checking progress of deployment");
+			if ($this->getConfigSetting('RestoreDB')) {
+				return $this->startRevertDatabase();
+			} else {
+				$this->finish();
+				return true;
+			}
+		}
 
-        // Get related deployment
-        $deployment = $this->RollbackDeployment();
-        if (empty($deployment) || !$deployment->exists()) {
-            $this->log("Missing deployment for in-progress {$this->Title}");
-            $this->markFailed();
-            return false;
-        }
+		// Get related deployment
+		$deployment = $this->RollbackDeployment();
+		if (empty($deployment) || !$deployment->exists()) {
+			$this->log("Missing deployment for in-progress {$this->Title}");
+			$this->markFailed();
+			return false;
+		}
 
-        // Check finished state
-        $status = $deployment->ResqueStatus();
-        if ($this->checkResqueStatus($status)) {
-            // Since deployment is finished, check if we should also do a db restoration
-            if ($this->doRestoreDB()) {
-                return $this->startRevertDatabase();
-            } else {
-                $this->finish();
-            }
-        }
-        return !$this->isFailed();
-    }
+		// Check finished state
+		$status = $deployment->ResqueStatus();
+		if ($this->checkResqueStatus($status)) {
+			// Since deployment is finished, check if we should also do a db restoration
+			if ($this->doRestoreDB()) {
+				return $this->startRevertDatabase();
+			} else {
+				$this->finish();
+			}
+		}
+		return !$this->isFailed();
+	}
 
-    /**
-     * Check if we are intending to restore the DB after this deployment
-     *
-     * @return boolean
-     */
-    protected function doRestoreDB()
-    {
-        return $this->getConfigSetting('RestoreDB') && $this->Pipeline()->PreviousSnapshot();
-    }
+	/**
+	 * Check if we are intending to restore the DB after this deployment
+	 *
+	 * @return boolean
+	 */
+	protected function doRestoreDB()
+	{
+		return $this->getConfigSetting('RestoreDB') && $this->Pipeline()->PreviousSnapshot();
+	}
 
-    /**
-     * Check the status of a resque sub-task
-     *
-     * @param string $status Resque task status
-     * @return boolean True if the task is finished successfully
-     */
-    protected function checkResqueStatus($status)
-    {
-        switch ($status) {
-            case "Complete":
-                return true;
-            case "Failed":
-            case "Invalid":
-                $this->log("{$this->Title} failed with task status $status");
-                $this->markFailed();
-                return false;
-            case "Queued":
-            case "Running":
-            default:
-                // For running or queued tasks ensure that we have not exceeded
-                // a reasonable time-elapsed to consider this job inactive
-                if ($this->isTimedOut()) {
-                    $this->log("{$this->Title} took longer than {$this->MaxDuration} seconds to run and has timed out");
-                    $this->markFailed();
-                    return false;
-                } else {
-                    // While still running report no error, waiting for resque job to eventually finish
-                    // some time in the future
-                    $this->log("{$this->Title} is still in progress");
-                    return false;
-                }
-        }
-    }
+	/**
+	 * Check the status of a resque sub-task
+	 *
+	 * @param string $status Resque task status
+	 * @return boolean True if the task is finished successfully
+	 */
+	protected function checkResqueStatus($status)
+	{
+		switch ($status) {
+			case "Complete":
+				return true;
+			case "Failed":
+			case "Invalid":
+				$this->log("{$this->Title} failed with task status $status");
+				$this->markFailed();
+				return false;
+			case "Queued":
+			case "Running":
+			default:
+				// For running or queued tasks ensure that we have not exceeded
+				// a reasonable time-elapsed to consider this job inactive
+				if ($this->isTimedOut()) {
+					$this->log("{$this->Title} took longer than {$this->MaxDuration} seconds to run and has timed out");
+					$this->markFailed();
+					return false;
+				} else {
+					// While still running report no error, waiting for resque job to eventually finish
+					// some time in the future
+					$this->log("{$this->Title} is still in progress");
+					return false;
+				}
+		}
+	}
 }

code/model/steps/SmokeTestPipelineStep.php

Indentation +202 added lines, -202 removed lines

@@ -47,206 +47,206 @@
 class SmokeTestPipelineStep extends PipelineStep
 {
 
-    /**
-     * Default config setting
-     *
-     * @var array
-     * @config
-     */
-    private static $default_config = array(
-        'RequestTimeout' => 20, // Seconds to allow for each request
-        'Attempts' => 1, // Number of attempts allowed
-        'AttemptDelay' => 10 // Timeout between requests
-    );
-
-    /**
-     * Get all tests to be run by this smoketest
-     *
-     * @return array List of tests
-     */
-    protected function getTests()
-    {
-        // Get core tests
-        $tests = $this->getConfigSetting('Tests');
-
-        // Merge with default tests
-        $defaultTests = $this->Pipeline()->getConfigSetting('PipelineConfig', 'Tests');
-        if ($tests && $defaultTests) {
-            Config::merge_array_low_into_high($tests, $defaultTests);
-        } elseif (!$tests && $defaultTests) {
-            $tests = $defaultTests;
-        }
-        if ($tests) {
-            return $tests;
-        }
-
-        // if there's no tests to check for, fallback to trying to find the
-        // site's homepage by looking at the DNEnvironment fields.
-        $environment = $this->getDependentEnvironment();
-        $url = $environment->URL;
-        if ($url) {
-            return array(
-                'default' => array(
-                    'URL' => $url,
-                    'ExpectStatus' => 200
-                )
-            );
-        }
-    }
-
-    /**
-     * Initialiase curl handle
-     *
-     * @return resource Curl handle
-     */
-    protected function initCurl()
-    {
-        $handle = curl_init();
-
-        // avoid curl_exec pushing out the response to the screen
-        $timeout = $this->getConfigSetting('RequestTimeout');
-        curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
-        curl_setopt($handle, CURLOPT_TIMEOUT, $timeout);
-        // don't allow this to run for more than 10 seconds to avoid tying up webserver processes.
-
-        // if we need to use a proxy, ensure that is configured
-        if (defined('SS_OUTBOUND_PROXY')) {
-            curl_setopt($handle, CURLOPT_PROXY, SS_OUTBOUND_PROXY);
-            curl_setopt($handle, CURLOPT_PROXYPORT, SS_OUTBOUND_PROXY_PORT);
-        }
-        return $handle;
-    }
-
-    /**
-     * Run a single test
-     *
-     * @param resource $ch Curl resource
-     * @param string $name Test name
-     * @param array $test Test data
-     * @return bool success
-     */
-    public function runTest($ch, $name, $test)
-    {
-        $this->log(sprintf('Starting smoke test "%s" to URL %s', $name, $test['URL']));
-        curl_setopt($ch, CURLOPT_URL, $test['URL']);
-
-        // Allow individual tests to override number of attempts
-        $attempts = (int) $this->getConfigSetting('Attempts');
-        if (!empty($test['Attempts'])) {
-            $attempts = $test['Attempts'];
-        }
-
-        // Run through each attempt
-        for ($i = 0; $i < $attempts; $i++) {
-            if ($i > 0) {
-                $this->log("Request failed, performing reattempt (#{$i})");
-
-                // Ensure a non-zero delay between each request
-                $delay = $this->getConfigSetting('AttemptDelay');
-                sleep($delay);
-            }
-
-            // Perform request
-            $contents = curl_exec($ch);
-            if (curl_errno($ch)) {
-                $this->log(sprintf('Curl error: %s', curl_error($ch)));
-                continue;
-            }
-
-            // Check response
-            $info = curl_getinfo($ch);
-
-            // if an expected response time is specified, check that against the results
-            if (isset($test['ExpectResponse'])) {
-                if ($info['total_time'] > $test['ExpectResponse']) {
-                    $this->log(sprintf(
-                        'Smoke test "%s" to URL %s failed. Expected response time %s seconds, actual was %s seconds',
-                        $name,
-                        $test['URL'],
-                        $test['ExpectResponse'],
-                        $info['total_time']
-                    ));
-                    continue;
-                }
-            }
-
-            // Check response code
-            if ($info['http_code'] != $test['ExpectStatus']) {
-                $this->log("=================================================================");
-                $this->log(sprintf(
-                    "Printing output from smoke test '%s' (URL: '%s'):",
-                    $name,
-                    $test['URL']
-                ));
-                $this->log(sprintf("HTTP Status Code: %d", $info['http_code']));
-                $this->log($contents ? $contents : "No output (check status code?)");
-                $this->log("=================================================================");
-
-                $this->log(sprintf(
-                    'Smoke test "%s" to URL %s failed. Expected status code %s, got %s. See above for HTML returned.',
-                    $name,
-                    $test['URL'],
-                    $test['ExpectStatus'],
-                    $info['http_code']
-                ));
-                continue;
-            }
-
-            $this->log(sprintf('Smoke test "%s" to URL %s successful', $name, $test['URL']));
-            return true;
-        }
-
-        // Run out of re-attempts
-        if ($attempts > 1) {
-            $this->log("Failed after {$attempts} attempts");
-        }
-        return false;
-    }
-
-    public function start()
-    {
-        $this->Status = 'Started';
-        $this->log("Starting {$this->Title}...");
-        $this->write();
-
-        // Get tests to run
-        $tests = $this->getTests();
-        if (empty($tests)) {
-            $this->log('No smoke tests available. Aborting');
-            $this->markFailed();
-            return false;
-        }
-
-        // work through each of the configured tests and perform a web request and check the result
-        $ch = $this->initCurl();
-        $success = true;
-        foreach ($tests as $name => $test) {
-            $testSuccess = $this->runTest($ch, $name, $test);
-            $success = $testSuccess && $success;
-        }
-        curl_close($ch);
-
-        // Check result
-        if ($success) {
-            $this->finish();
-        } else {
-            // At least one test failed, so mark the test as failed
-            $this->markFailed();
-        }
-        return $success;
-    }
-
-    public function markFailed($notify = true)
-    {
-        if ($this->getDryRun()) {
-            $this->log("[Skipped] Smoke testing failed: Putting up emergency maintenance page");
-        } else {
-            // Put up maintenance page after this fails
-            $this->log("Smoke testing failed: Putting up emergency maintenance page");
-            $this->Pipeline()->Environment()->enableMaintenace($this->Pipeline()->getLogger());
-        }
-
-        // Mark pipeline and step failed
-        parent::markFailed($notify);
-    }
+	/**
+	 * Default config setting
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $default_config = array(
+		'RequestTimeout' => 20, // Seconds to allow for each request
+		'Attempts' => 1, // Number of attempts allowed
+		'AttemptDelay' => 10 // Timeout between requests
+	);
+
+	/**
+	 * Get all tests to be run by this smoketest
+	 *
+	 * @return array List of tests
+	 */
+	protected function getTests()
+	{
+		// Get core tests
+		$tests = $this->getConfigSetting('Tests');
+
+		// Merge with default tests
+		$defaultTests = $this->Pipeline()->getConfigSetting('PipelineConfig', 'Tests');
+		if ($tests && $defaultTests) {
+			Config::merge_array_low_into_high($tests, $defaultTests);
+		} elseif (!$tests && $defaultTests) {
+			$tests = $defaultTests;
+		}
+		if ($tests) {
+			return $tests;
+		}
+
+		// if there's no tests to check for, fallback to trying to find the
+		// site's homepage by looking at the DNEnvironment fields.
+		$environment = $this->getDependentEnvironment();
+		$url = $environment->URL;
+		if ($url) {
+			return array(
+				'default' => array(
+					'URL' => $url,
+					'ExpectStatus' => 200
+				)
+			);
+		}
+	}
+
+	/**
+	 * Initialiase curl handle
+	 *
+	 * @return resource Curl handle
+	 */
+	protected function initCurl()
+	{
+		$handle = curl_init();
+
+		// avoid curl_exec pushing out the response to the screen
+		$timeout = $this->getConfigSetting('RequestTimeout');
+		curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
+		curl_setopt($handle, CURLOPT_TIMEOUT, $timeout);
+		// don't allow this to run for more than 10 seconds to avoid tying up webserver processes.
+
+		// if we need to use a proxy, ensure that is configured
+		if (defined('SS_OUTBOUND_PROXY')) {
+			curl_setopt($handle, CURLOPT_PROXY, SS_OUTBOUND_PROXY);
+			curl_setopt($handle, CURLOPT_PROXYPORT, SS_OUTBOUND_PROXY_PORT);
+		}
+		return $handle;
+	}
+
+	/**
+	 * Run a single test
+	 *
+	 * @param resource $ch Curl resource
+	 * @param string $name Test name
+	 * @param array $test Test data
+	 * @return bool success
+	 */
+	public function runTest($ch, $name, $test)
+	{
+		$this->log(sprintf('Starting smoke test "%s" to URL %s', $name, $test['URL']));
+		curl_setopt($ch, CURLOPT_URL, $test['URL']);
+
+		// Allow individual tests to override number of attempts
+		$attempts = (int) $this->getConfigSetting('Attempts');
+		if (!empty($test['Attempts'])) {
+			$attempts = $test['Attempts'];
+		}
+
+		// Run through each attempt
+		for ($i = 0; $i < $attempts; $i++) {
+			if ($i > 0) {
+				$this->log("Request failed, performing reattempt (#{$i})");
+
+				// Ensure a non-zero delay between each request
+				$delay = $this->getConfigSetting('AttemptDelay');
+				sleep($delay);
+			}
+
+			// Perform request
+			$contents = curl_exec($ch);
+			if (curl_errno($ch)) {
+				$this->log(sprintf('Curl error: %s', curl_error($ch)));
+				continue;
+			}
+
+			// Check response
+			$info = curl_getinfo($ch);
+
+			// if an expected response time is specified, check that against the results
+			if (isset($test['ExpectResponse'])) {
+				if ($info['total_time'] > $test['ExpectResponse']) {
+					$this->log(sprintf(
+						'Smoke test "%s" to URL %s failed. Expected response time %s seconds, actual was %s seconds',
+						$name,
+						$test['URL'],
+						$test['ExpectResponse'],
+						$info['total_time']
+					));
+					continue;
+				}
+			}
+
+			// Check response code
+			if ($info['http_code'] != $test['ExpectStatus']) {
+				$this->log("=================================================================");
+				$this->log(sprintf(
+					"Printing output from smoke test '%s' (URL: '%s'):",
+					$name,
+					$test['URL']
+				));
+				$this->log(sprintf("HTTP Status Code: %d", $info['http_code']));
+				$this->log($contents ? $contents : "No output (check status code?)");
+				$this->log("=================================================================");
+
+				$this->log(sprintf(
+					'Smoke test "%s" to URL %s failed. Expected status code %s, got %s. See above for HTML returned.',
+					$name,
+					$test['URL'],
+					$test['ExpectStatus'],
+					$info['http_code']
+				));
+				continue;
+			}
+
+			$this->log(sprintf('Smoke test "%s" to URL %s successful', $name, $test['URL']));
+			return true;
+		}
+
+		// Run out of re-attempts
+		if ($attempts > 1) {
+			$this->log("Failed after {$attempts} attempts");
+		}
+		return false;
+	}
+
+	public function start()
+	{
+		$this->Status = 'Started';
+		$this->log("Starting {$this->Title}...");
+		$this->write();
+
+		// Get tests to run
+		$tests = $this->getTests();
+		if (empty($tests)) {
+			$this->log('No smoke tests available. Aborting');
+			$this->markFailed();
+			return false;
+		}
+
+		// work through each of the configured tests and perform a web request and check the result
+		$ch = $this->initCurl();
+		$success = true;
+		foreach ($tests as $name => $test) {
+			$testSuccess = $this->runTest($ch, $name, $test);
+			$success = $testSuccess && $success;
+		}
+		curl_close($ch);
+
+		// Check result
+		if ($success) {
+			$this->finish();
+		} else {
+			// At least one test failed, so mark the test as failed
+			$this->markFailed();
+		}
+		return $success;
+	}
+
+	public function markFailed($notify = true)
+	{
+		if ($this->getDryRun()) {
+			$this->log("[Skipped] Smoke testing failed: Putting up emergency maintenance page");
+		} else {
+			// Put up maintenance page after this fails
+			$this->log("Smoke testing failed: Putting up emergency maintenance page");
+			$this->Pipeline()->Environment()->enableMaintenace($this->Pipeline()->getLogger());
+		}
+
+		// Mark pipeline and step failed
+		parent::markFailed($notify);
+	}
 }

code/model/steps/TriggerDeployStep.php

Indentation +120 added lines, -120 removed lines

@@ -25,136 +25,136 @@
 class TriggerDeployStep extends LongRunningPipelineStep
 {
 
-    /**
-     * @var array
-     */
-    private static $db = array(
-        // if this is deployed set the date it was requested
-        'Deployed' => "SS_Datetime"
-    );
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		// if this is deployed set the date it was requested
+		'Deployed' => "SS_Datetime"
+	);
 
-    /**
-     * @var array
-     */
-    private static $has_one = array(
-        'Responder' => 'Member'
-    );
+	/**
+	 * @var array
+	 */
+	private static $has_one = array(
+		'Responder' => 'Member'
+	);
 
-    /**
-     * @return bool
-     */
-    public function start()
-    {
-        // Just in case this step is being mistakenly restarted
-        if (!empty($this->Deployed)) {
-            $this->log(_t('TriggerDeployStep.BEENDEPLOYED',
-                "{$this->Title} has already been deployed"));
-            $this->markFailed();
-            return false;
-        }
+	/**
+	 * @return bool
+	 */
+	public function start()
+	{
+		// Just in case this step is being mistakenly restarted
+		if (!empty($this->Deployed)) {
+			$this->log(_t('TriggerDeployStep.BEENDEPLOYED',
+				"{$this->Title} has already been deployed"));
+			$this->markFailed();
+			return false;
+		}
 
-        // check if we have timed out
-        if ($this->isTimedOut()) {
-            $this->log(sprintf(_t('TriggerDeployStep.DEPLOYTIMEOUT',
-                'Deployment step is older then %s seconds and has timed out'),
-                $this->MaxDuration));
-            $this->markFailed();
-            return false;
-        }
+		// check if we have timed out
+		if ($this->isTimedOut()) {
+			$this->log(sprintf(_t('TriggerDeployStep.DEPLOYTIMEOUT',
+				'Deployment step is older then %s seconds and has timed out'),
+				$this->MaxDuration));
+			$this->markFailed();
+			return false;
+		}
 
-        // Begin or process this step
-        switch ($this->Status) {
-            case 'Started':
-                return true;
-            case 'Queued':
-                return $this->StartDeployment();
-            default:
-                $this->log(_t('TriggerDeployStep.STARTERROR',
-                     "Unable to process {$this->Title} with status of {$this->Status}"));
-                $this->markFailed();
-                return false;
-        }
-    }
+		// Begin or process this step
+		switch ($this->Status) {
+			case 'Started':
+				return true;
+			case 'Queued':
+				return $this->StartDeployment();
+			default:
+				$this->log(_t('TriggerDeployStep.STARTERROR',
+					 "Unable to process {$this->Title} with status of {$this->Status}"));
+				$this->markFailed();
+				return false;
+		}
+	}
 
-    /**
-     * Can the current user trigger the deployment for this pipeline?
-     *
-     * @param Member|null $member
-     * @return boolean
-     */
-    public function canTriggerDeploy($member = null)
-    {
-        return $this->Pipeline()->Environment()->canDeploy($member);
-    }
+	/**
+	 * Can the current user trigger the deployment for this pipeline?
+	 *
+	 * @param Member|null $member
+	 * @return boolean
+	 */
+	public function canTriggerDeploy($member = null)
+	{
+		return $this->Pipeline()->Environment()->canDeploy($member);
+	}
 
-    /**
-     * When a member wishes to deploy this pipeline
-     *
-     * @return boolean True if successful
-     */
-    public function deploy()
-    {
-        // Check permission
-        if (!$this->canTriggerDeploy()) {
-            return Security::permissionFailure(
-                null,
-                _t("TriggerDeployStep.DENYTRIGGERDEPLOY",
-                "You do not have permission to deploy this pipeline")
-            );
-        }
+	/**
+	 * When a member wishes to deploy this pipeline
+	 *
+	 * @return boolean True if successful
+	 */
+	public function deploy()
+	{
+		// Check permission
+		if (!$this->canTriggerDeploy()) {
+			return Security::permissionFailure(
+				null,
+				_t("TriggerDeployStep.DENYTRIGGERDEPLOY",
+				"You do not have permission to deploy this pipeline")
+			);
+		}
 
-        if ($this->Status == 'Queued') {
-            $this->start();
-        }
-        // Trigger deployment
-        $this->Deployed = SS_Datetime::now()->Rfc2822();
-        $this->log(_t('TriggerDeployStep.BEINGDEPLOYED',
-            "{$this->Title} is being deployed"));
-        $this->ResponderID = Member::currentUserID();
-        $this->finish();
-        return true;
-    }
+		if ($this->Status == 'Queued') {
+			$this->start();
+		}
+		// Trigger deployment
+		$this->Deployed = SS_Datetime::now()->Rfc2822();
+		$this->log(_t('TriggerDeployStep.BEINGDEPLOYED',
+			"{$this->Title} is being deployed"));
+		$this->ResponderID = Member::currentUserID();
+		$this->finish();
+		return true;
+	}
 
-    /**
-     * Initiate the deployment process
-     */
-    public function StartDeployment()
-    {
-        $this->Status = 'Started';
-        if (!$this->Started) {
-            $this->Started = SS_Datetime::now()->Rfc2822();
-        }
-        $this->log("Starting {$this->Title}...");
-        $this->write();
-        return true;
-    }
+	/**
+	 * Initiate the deployment process
+	 */
+	public function StartDeployment()
+	{
+		$this->Status = 'Started';
+		if (!$this->Started) {
+			$this->Started = SS_Datetime::now()->Rfc2822();
+		}
+		$this->log("Starting {$this->Title}...");
+		$this->write();
+		return true;
+	}
 
-    public function getRunningDescription()
-    {
-        // Don't show options if this step has already been confirmed
-        if ($this->Deployed) {
-            return;
-        }
+	public function getRunningDescription()
+	{
+		// Don't show options if this step has already been confirmed
+		if ($this->Deployed) {
+			return;
+		}
 
-        return _t('TriggerDeployStep.RUNNINGDESCRIPTION',
-            'Please press the "Deploy" button to continue deployment');
-    }
+		return _t('TriggerDeployStep.RUNNINGDESCRIPTION',
+			'Please press the "Deploy" button to continue deployment');
+	}
 
-    public function allowedActions()
-    {
-        // Don't show options if this step has already been confirmed or can't be confirmed
-        if (!$this->canTriggerDeploy()) {
-            return parent::allowedActions();
-        }
+	public function allowedActions()
+	{
+		// Don't show options if this step has already been confirmed or can't be confirmed
+		if (!$this->canTriggerDeploy()) {
+			return parent::allowedActions();
+		}
 
-        // Return actions
-        return array(
-            'deploy' => array(
-                'ButtonText' => 'Deploy',
-                'ButtonType' => 'btn-success',
-                'Link' => $this->Pipeline()->StepLink('deploy'),
-                'Title' => 'Trigger the current deployment, allowing it to continue'
-            )
-        );
-    }
+		// Return actions
+		return array(
+			'deploy' => array(
+				'ButtonText' => 'Deploy',
+				'ButtonType' => 'btn-success',
+				'Link' => $this->Pipeline()->StepLink('deploy'),
+				'Title' => 'Trigger the current deployment, allowing it to continue'
+			)
+		);
+	}
 }

code/model/steps/UserConfirmationStep.php

Indentation +368 added lines, -368 removed lines

@@ -55,372 +55,372 @@
 class UserConfirmationStep extends LongRunningPipelineStep
 {
 
-    /**
-     * Messages
-     */
-    const ALERT_APPROVE = 'Approve';
-    const ALERT_TIMEOUT = 'TimeOut';
-    const ALERT_REQUEST = 'Request';
-    const ALERT_REJECT = 'Reject';
-
-    /**
-     * Message roles
-     */
-    const ROLE_REQUESTER = 'Requester';
-    const ROLE_RECIPIENT = 'Recipient';
-
-    /**
-     * @var array
-     */
-    private static $db = array(
-        // A finished step is approved and a failed step is rejected.
-        // Aborted confirmation is left as None
-        'Approval' => "Enum('Approved,Rejected,None', 'None')",
-        // If RecipientsDelay is specified, this value records the index of the most recently notified
-        // group of users. This will be incremented once another level of fallback has been notified.
-        // E.g. once primary admin has been notified, the secondary admin can be notified, and this
-        // is incremented
-        'NotifiedGroup' => 'Int'
-    );
-
-    /**
-     * @var array
-     */
-    private static $defaults = array(
-        'Approval' => 'None',
-        'NotifiedGroup' => 0
-    );
-
-    /**
-     * @var array
-     */
-    private static $has_one = array(
-        'Responder' => 'Member'
-    );
-
-    /**
-     * This step depends on a configured messaging service
-     *
-     * @config
-     * @var array
-     */
-    private static $dependencies = array(
-        'MessagingService' => '%$ConfirmationMessagingService'
-    );
-
-    /**
-     * Currently assigned messaging service
-     *
-     * @var ConfirmationMessagingService
-     */
-    private $messagingService = null;
-
-    /**
-     * Assign a messaging service for this step
-     *
-     * @param ConfirmationMessagingService $service
-     */
-    public function setMessagingService(ConfirmationMessagingService $service)
-    {
-        $this->messagingService = $service;
-    }
-
-    /**
-     * Get the currently configured messaging service
-     *
-     * @return ConfirmationMessagingService
-     */
-    public function getMessagingService()
-    {
-        return $this->messagingService;
-    }
-
-    /**
-     * Determine if the confirmation has been responded to (ether with acceptance, rejection, or cancelled)
-     *
-     * @return boolean
-     */
-    public function hasResponse()
-    {
-        return $this->Approval !== 'None';
-    }
-
-    public function start()
-    {
-        parent::start();
-
-        // Just in case this step is being mistakenly restarted
-        if ($this->hasResponse()) {
-            $this->log("{$this->Title} has already been processed with a response of {$this->Approval}");
-            $this->markFailed();
-            return false;
-        }
-
-        // Begin or process this step
-        switch ($this->Status) {
-            case 'Started':
-                return $this->checkStatus();
-            case 'Queued':
-                return $this->startApproval();
-            default:
-                $this->log("Unable to process {$this->Title} with status of {$this->Status}");
-                $this->markFailed();
-                return false;
-        }
-    }
-
-    /**
-     * Can the current user approve this pipeline?
-     *
-     * @param Member|null $member
-     * @return boolean
-     */
-    public function canApprove($member = null)
-    {
-        return $this->Pipeline()->Environment()->canApprove($member);
-    }
-
-    /**
-     * When the recipient wishes to approve this request
-     *
-     * @return boolean True if successful
-     */
-    public function approve()
-    {
-        // Check permission
-        if (!$this->canApprove()) {
-            return Security::permissionFailure(
-                null,
-                _t("UserConfirmationStep.DENYAPPROVE", "You do not have permission to approve this deployment")
-            );
-        }
-
-        // Skip subsequent approvals if already approved / rejected
-        if ($this->hasResponse()) {
-            return;
-        }
-
-        // Approve
-        $this->Approval = 'Approved';
-        $this->log("{$this->Title} has been approved");
-        $this->ResponderID = Member::currentUserID();
-        $this->finish();
-        $this->sendMessage(self::ALERT_APPROVE);
-        return true;
-    }
-
-    /**
-     * When the recipient wishes to reject this request
-     *
-     * @return boolean True if successful
-     */
-    public function reject()
-    {
-        // Check permission
-        if (!$this->canApprove()) {
-            return Security::permissionFailure(
-                null,
-                _t("UserConfirmationStep.DENYREJECT", "You do not have permission to reject this deployment")
-            );
-        }
-
-        // Skip subsequent approvals if already approved / rejected
-        if ($this->hasResponse()) {
-            return;
-        }
-
-        // Reject
-        $this->Approval = 'Rejected';
-        $this->log("{$this->Title} has been rejected");
-        $this->ResponderID = Member::currentUserID();
-        $this->markFailed(false);
-        $this->sendMessage(self::ALERT_REJECT);
-        return true;
-    }
-
-    /**
-     * Report the status of the current request queue and makes sure it hasn't overrun it's time allowed
-     *
-     * @return boolean True if not failed
-     */
-    protected function checkStatus()
-    {
-        // For running or queued tasks ensure that we have not exceeded
-        // a reasonable time-elapsed to consider this job inactive
-        if ($this->isTimedOut()) {
-            $days = round($this->MaxDuration / (24.0 * 3600.0), 1);
-            $logMessage = "{$this->Title} took longer than {$this->MaxDuration} seconds ($days days) to be approved "
-                . "and has timed out";
-            $this->log($logMessage);
-            $this->markFailed();
-            $this->sendMessage(self::ALERT_TIMEOUT);
-            return false;
-        }
-
-        // If operating on a delayed notification schedule, determine if there are further groups who should be notified
-        if ($delay = $this->getConfigSetting('RecipientsDelay')) {
-            // Check group that should have been notified by now
-            $age = $this->getAge();
-            $escallateGroup = intval($age / $delay);
-            $recipients = $this->getConfigSetting('Recipients');
-            $lastGroup = count($recipients) - 1;
-            // If we can notify the next group, do so
-            // We only escallate one group at a time to ensure correct order is followed
-            if ($this->NotifiedGroup < $lastGroup && $this->NotifiedGroup < $escallateGroup) {
-                $this->NotifiedGroup++;
-                $groupDescription = is_array($recipients[$this->NotifiedGroup])
-                    ? implode(',', $recipients[$this->NotifiedGroup])
-                    : $recipients[$this->NotifiedGroup];
-                $this->log("Escalating approval request to group {$this->NotifiedGroup}: '$groupDescription'");
-                // Send to selected group
-                $this->sendMessage(self::ALERT_REQUEST, $this->NotifiedGroup);
-                $this->write();
-                return true;
-            }
-        }
-
-
-        // While still running report no error, waiting for resque job to eventually finish.
-        // Since this could potentially fill the log with hundreds of thousands of messages,
-        // if it takes a few days to get a response, don't write anything.
-        return true;
-    }
-
-    /**
-     * Initiate the approval process
-     */
-    public function startApproval()
-    {
-        $this->Status = 'Started';
-        $this->log("Starting {$this->Title}...");
-        // Determine if we should use delayed notification
-        $recipientGroup = 'all';
-        if ($this->getConfigSetting('RecipientsDelay')) {
-            $this->NotifiedGroup = $recipientGroup = 0;
-        }
-        // Send to selected group
-        $this->sendMessage(self::ALERT_REQUEST, $recipientGroup);
-        $this->write();
-        return true;
-    }
-
-    /**
-     * Finds a message template for a given role and message
-     *
-     * @param string $role Role name for role-customised messages. Usually 'Requester' or 'Recipient'
-     * @param string $messageID Message ID
-     * @return array Resulting array(subject, message)
-     */
-    protected function generateMessageTemplate($role, $messageID)
-    {
-        $subject = $this->getConfigSetting('Subjects', "$messageID-$role")
-                ?: $this->getConfigSetting('Subjects', $messageID);
-        $message = $this->getConfigSetting('Messages', "$messageID-$role")
-                ?: $this->getConfigSetting('Messages', $messageID);
-        $substitutions = $this->getReplacements();
-        return $this
-            ->Pipeline()
-            ->injectMessageReplacements($message, $subject, $substitutions);
-    }
-
-    /**
-     * Retrieve message replacements
-     *
-     * @return array
-     */
-    public function getReplacements()
-    {
-        // Get member who began this request
-        return array_merge(
-            $this->Pipeline()->getReplacements(),
-            array(
-                // Note that this actually displays the link to the interface to approve,
-                // not the direct link to the approve action
-                '<approvelink>' => Director::absoluteURL($this->Pipeline()->Environment()->Link())
-            )
-        );
-    }
-
-    /**
-     * Sends a message to a specified recipient(s)
-     *
-     * @param string $messageID Message ID. One of 'Reject', 'Approve', 'TimeOut' or 'Request'
-     * @param mixed $recipientGroup Either a numeric index of the next recipient to send to, or "all" for all
-     * This is used for delayed notification so that failover recipients can be notified.
-     * @return boolean|null True if successful
-     */
-    protected function sendMessage($messageID, $recipientGroup = 'all')
-    {
-        // Add additionally configured arguments
-        $arguments = $this->getConfigSetting('ServiceArguments') ?: array();
-
-        // Get member who began this request
-        $author = $this->Pipeline()->Author();
-
-        // Send message to requester
-        if ($recipientGroup === 'all' || $recipientGroup === 0) {
-            list($subject, $message) = $this->generateMessageTemplate(self::ROLE_REQUESTER, $messageID);
-            if ($subject && $message) {
-                $this->log("{$this->Title} sending $messageID message to {$author->Email}");
-                $extra = array('subject' => $subject);
-                $this->messagingService->sendMessage($this, $message, $author, array_merge($arguments, $extra));
-            }
-        }
-
-        // Filter recipients based on group
-        $recipients = $this->getConfigSetting('Recipients');
-        if (is_array($recipients) && $recipientGroup !== 'all') {
-            $recipients = isset($recipients[$recipientGroup])
-                ? $recipients[$recipientGroup]
-                : null;
-        }
-        if (empty($recipients)) {
-            $this->log("Skipping sending message to empty recipients");
-            return;
-        }
-
-        // Send to recipients
-        list($subject, $message) = $this->generateMessageTemplate(self::ROLE_RECIPIENT, $messageID);
-        if ($subject && $message && $recipients) {
-            $recipientsStr = is_array($recipients) ? implode(',', $recipients) : $recipients;
-            $this->log("{$this->Title} sending $messageID message to $recipientsStr");
-            $extra = array('subject' => $subject);
-            $this->messagingService->sendMessage($this, $message, $recipients, array_merge($arguments, $extra));
-        }
-    }
-
-    public function getRunningDescription()
-    {
-
-        // Don't show options if this step has already been confirmed
-        if ($this->hasResponse() || !$this->isRunning()) {
-            return;
-        }
-
-        return 'This deployment is currently awaiting approval before it can complete.';
-    }
-
-    public function allowedActions()
-    {
-        // Don't show options if this step has already been confirmed or can't be confirmed
-        if ($this->hasResponse() || !$this->isRunning() || !$this->canApprove()) {
-            return parent::allowedActions();
-        }
-
-        // Return actions
-        return array(
-            'approve' => array(
-                'ButtonText' => 'Approve',
-                'ButtonType' => 'btn-success',
-                'Link' => $this->Pipeline()->StepLink('approve'),
-                'Title' => 'Approves the current deployment, allowing it to continue'
-            ),
-            'reject' => array(
-                'ButtonText' => 'Reject',
-                'ButtonType' => 'btn-danger',
-                'Link' => $this->Pipeline()->StepLink('reject'),
-                'Title' => 'Deny the request to release this deployment'
-            )
-        );
-    }
+	/**
+	 * Messages
+	 */
+	const ALERT_APPROVE = 'Approve';
+	const ALERT_TIMEOUT = 'TimeOut';
+	const ALERT_REQUEST = 'Request';
+	const ALERT_REJECT = 'Reject';
+
+	/**
+	 * Message roles
+	 */
+	const ROLE_REQUESTER = 'Requester';
+	const ROLE_RECIPIENT = 'Recipient';
+
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		// A finished step is approved and a failed step is rejected.
+		// Aborted confirmation is left as None
+		'Approval' => "Enum('Approved,Rejected,None', 'None')",
+		// If RecipientsDelay is specified, this value records the index of the most recently notified
+		// group of users. This will be incremented once another level of fallback has been notified.
+		// E.g. once primary admin has been notified, the secondary admin can be notified, and this
+		// is incremented
+		'NotifiedGroup' => 'Int'
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $defaults = array(
+		'Approval' => 'None',
+		'NotifiedGroup' => 0
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $has_one = array(
+		'Responder' => 'Member'
+	);
+
+	/**
+	 * This step depends on a configured messaging service
+	 *
+	 * @config
+	 * @var array
+	 */
+	private static $dependencies = array(
+		'MessagingService' => '%$ConfirmationMessagingService'
+	);
+
+	/**
+	 * Currently assigned messaging service
+	 *
+	 * @var ConfirmationMessagingService
+	 */
+	private $messagingService = null;
+
+	/**
+	 * Assign a messaging service for this step
+	 *
+	 * @param ConfirmationMessagingService $service
+	 */
+	public function setMessagingService(ConfirmationMessagingService $service)
+	{
+		$this->messagingService = $service;
+	}
+
+	/**
+	 * Get the currently configured messaging service
+	 *
+	 * @return ConfirmationMessagingService
+	 */
+	public function getMessagingService()
+	{
+		return $this->messagingService;
+	}
+
+	/**
+	 * Determine if the confirmation has been responded to (ether with acceptance, rejection, or cancelled)
+	 *
+	 * @return boolean
+	 */
+	public function hasResponse()
+	{
+		return $this->Approval !== 'None';
+	}
+
+	public function start()
+	{
+		parent::start();
+
+		// Just in case this step is being mistakenly restarted
+		if ($this->hasResponse()) {
+			$this->log("{$this->Title} has already been processed with a response of {$this->Approval}");
+			$this->markFailed();
+			return false;
+		}
+
+		// Begin or process this step
+		switch ($this->Status) {
+			case 'Started':
+				return $this->checkStatus();
+			case 'Queued':
+				return $this->startApproval();
+			default:
+				$this->log("Unable to process {$this->Title} with status of {$this->Status}");
+				$this->markFailed();
+				return false;
+		}
+	}
+
+	/**
+	 * Can the current user approve this pipeline?
+	 *
+	 * @param Member|null $member
+	 * @return boolean
+	 */
+	public function canApprove($member = null)
+	{
+		return $this->Pipeline()->Environment()->canApprove($member);
+	}
+
+	/**
+	 * When the recipient wishes to approve this request
+	 *
+	 * @return boolean True if successful
+	 */
+	public function approve()
+	{
+		// Check permission
+		if (!$this->canApprove()) {
+			return Security::permissionFailure(
+				null,
+				_t("UserConfirmationStep.DENYAPPROVE", "You do not have permission to approve this deployment")
+			);
+		}
+
+		// Skip subsequent approvals if already approved / rejected
+		if ($this->hasResponse()) {
+			return;
+		}
+
+		// Approve
+		$this->Approval = 'Approved';
+		$this->log("{$this->Title} has been approved");
+		$this->ResponderID = Member::currentUserID();
+		$this->finish();
+		$this->sendMessage(self::ALERT_APPROVE);
+		return true;
+	}
+
+	/**
+	 * When the recipient wishes to reject this request
+	 *
+	 * @return boolean True if successful
+	 */
+	public function reject()
+	{
+		// Check permission
+		if (!$this->canApprove()) {
+			return Security::permissionFailure(
+				null,
+				_t("UserConfirmationStep.DENYREJECT", "You do not have permission to reject this deployment")
+			);
+		}
+
+		// Skip subsequent approvals if already approved / rejected
+		if ($this->hasResponse()) {
+			return;
+		}
+
+		// Reject
+		$this->Approval = 'Rejected';
+		$this->log("{$this->Title} has been rejected");
+		$this->ResponderID = Member::currentUserID();
+		$this->markFailed(false);
+		$this->sendMessage(self::ALERT_REJECT);
+		return true;
+	}
+
+	/**
+	 * Report the status of the current request queue and makes sure it hasn't overrun it's time allowed
+	 *
+	 * @return boolean True if not failed
+	 */
+	protected function checkStatus()
+	{
+		// For running or queued tasks ensure that we have not exceeded
+		// a reasonable time-elapsed to consider this job inactive
+		if ($this->isTimedOut()) {
+			$days = round($this->MaxDuration / (24.0 * 3600.0), 1);
+			$logMessage = "{$this->Title} took longer than {$this->MaxDuration} seconds ($days days) to be approved "
+				. "and has timed out";
+			$this->log($logMessage);
+			$this->markFailed();
+			$this->sendMessage(self::ALERT_TIMEOUT);
+			return false;
+		}
+
+		// If operating on a delayed notification schedule, determine if there are further groups who should be notified
+		if ($delay = $this->getConfigSetting('RecipientsDelay')) {
+			// Check group that should have been notified by now
+			$age = $this->getAge();
+			$escallateGroup = intval($age / $delay);
+			$recipients = $this->getConfigSetting('Recipients');
+			$lastGroup = count($recipients) - 1;
+			// If we can notify the next group, do so
+			// We only escallate one group at a time to ensure correct order is followed
+			if ($this->NotifiedGroup < $lastGroup && $this->NotifiedGroup < $escallateGroup) {
+				$this->NotifiedGroup++;
+				$groupDescription = is_array($recipients[$this->NotifiedGroup])
+					? implode(',', $recipients[$this->NotifiedGroup])
+					: $recipients[$this->NotifiedGroup];
+				$this->log("Escalating approval request to group {$this->NotifiedGroup}: '$groupDescription'");
+				// Send to selected group
+				$this->sendMessage(self::ALERT_REQUEST, $this->NotifiedGroup);
+				$this->write();
+				return true;
+			}
+		}
+
+
+		// While still running report no error, waiting for resque job to eventually finish.
+		// Since this could potentially fill the log with hundreds of thousands of messages,
+		// if it takes a few days to get a response, don't write anything.
+		return true;
+	}
+
+	/**
+	 * Initiate the approval process
+	 */
+	public function startApproval()
+	{
+		$this->Status = 'Started';
+		$this->log("Starting {$this->Title}...");
+		// Determine if we should use delayed notification
+		$recipientGroup = 'all';
+		if ($this->getConfigSetting('RecipientsDelay')) {
+			$this->NotifiedGroup = $recipientGroup = 0;
+		}
+		// Send to selected group
+		$this->sendMessage(self::ALERT_REQUEST, $recipientGroup);
+		$this->write();
+		return true;
+	}
+
+	/**
+	 * Finds a message template for a given role and message
+	 *
+	 * @param string $role Role name for role-customised messages. Usually 'Requester' or 'Recipient'
+	 * @param string $messageID Message ID
+	 * @return array Resulting array(subject, message)
+	 */
+	protected function generateMessageTemplate($role, $messageID)
+	{
+		$subject = $this->getConfigSetting('Subjects', "$messageID-$role")
+				?: $this->getConfigSetting('Subjects', $messageID);
+		$message = $this->getConfigSetting('Messages', "$messageID-$role")
+				?: $this->getConfigSetting('Messages', $messageID);
+		$substitutions = $this->getReplacements();
+		return $this
+			->Pipeline()
+			->injectMessageReplacements($message, $subject, $substitutions);
+	}
+
+	/**
+	 * Retrieve message replacements
+	 *
+	 * @return array
+	 */
+	public function getReplacements()
+	{
+		// Get member who began this request
+		return array_merge(
+			$this->Pipeline()->getReplacements(),
+			array(
+				// Note that this actually displays the link to the interface to approve,
+				// not the direct link to the approve action
+				'<approvelink>' => Director::absoluteURL($this->Pipeline()->Environment()->Link())
+			)
+		);
+	}
+
+	/**
+	 * Sends a message to a specified recipient(s)
+	 *
+	 * @param string $messageID Message ID. One of 'Reject', 'Approve', 'TimeOut' or 'Request'
+	 * @param mixed $recipientGroup Either a numeric index of the next recipient to send to, or "all" for all
+	 * This is used for delayed notification so that failover recipients can be notified.
+	 * @return boolean|null True if successful
+	 */
+	protected function sendMessage($messageID, $recipientGroup = 'all')
+	{
+		// Add additionally configured arguments
+		$arguments = $this->getConfigSetting('ServiceArguments') ?: array();
+
+		// Get member who began this request
+		$author = $this->Pipeline()->Author();
+
+		// Send message to requester
+		if ($recipientGroup === 'all' || $recipientGroup === 0) {
+			list($subject, $message) = $this->generateMessageTemplate(self::ROLE_REQUESTER, $messageID);
+			if ($subject && $message) {
+				$this->log("{$this->Title} sending $messageID message to {$author->Email}");
+				$extra = array('subject' => $subject);
+				$this->messagingService->sendMessage($this, $message, $author, array_merge($arguments, $extra));
+			}
+		}
+
+		// Filter recipients based on group
+		$recipients = $this->getConfigSetting('Recipients');
+		if (is_array($recipients) && $recipientGroup !== 'all') {
+			$recipients = isset($recipients[$recipientGroup])
+				? $recipients[$recipientGroup]
+				: null;
+		}
+		if (empty($recipients)) {
+			$this->log("Skipping sending message to empty recipients");
+			return;
+		}
+
+		// Send to recipients
+		list($subject, $message) = $this->generateMessageTemplate(self::ROLE_RECIPIENT, $messageID);
+		if ($subject && $message && $recipients) {
+			$recipientsStr = is_array($recipients) ? implode(',', $recipients) : $recipients;
+			$this->log("{$this->Title} sending $messageID message to $recipientsStr");
+			$extra = array('subject' => $subject);
+			$this->messagingService->sendMessage($this, $message, $recipients, array_merge($arguments, $extra));
+		}
+	}
+
+	public function getRunningDescription()
+	{
+
+		// Don't show options if this step has already been confirmed
+		if ($this->hasResponse() || !$this->isRunning()) {
+			return;
+		}
+
+		return 'This deployment is currently awaiting approval before it can complete.';
+	}
+
+	public function allowedActions()
+	{
+		// Don't show options if this step has already been confirmed or can't be confirmed
+		if ($this->hasResponse() || !$this->isRunning() || !$this->canApprove()) {
+			return parent::allowedActions();
+		}
+
+		// Return actions
+		return array(
+			'approve' => array(
+				'ButtonText' => 'Approve',
+				'ButtonType' => 'btn-success',
+				'Link' => $this->Pipeline()->StepLink('approve'),
+				'Title' => 'Approves the current deployment, allowing it to continue'
+			),
+			'reject' => array(
+				'ButtonText' => 'Reject',
+				'ButtonType' => 'btn-danger',
+				'Link' => $this->Pipeline()->StepLink('reject'),
+				'Title' => 'Deny the request to release this deployment'
+			)
+		);
+	}
 }

code/queuereport/ResqueJob.php

Indentation +57 added lines, -57 removed lines

@@ -9,68 +9,68 @@
 class ResqueJob extends ViewableData
 {
 
-    /**
-     * @var array
-     */
-    protected $record = array();
+	/**
+	 * @var array
+	 */
+	protected $record = array();
 
-    /**
-     * @param array $data
-     */
-    public function __construct($data = array())
-    {
-        $this->record = $data;
-    }
+	/**
+	 * @param array $data
+	 */
+	public function __construct($data = array())
+	{
+		$this->record = $data;
+	}
 
-    /**
-     * @return string
-     */
-    public function i18n_singular_name()
-    {
-        return 'Resque queue';
-    }
+	/**
+	 * @return string
+	 */
+	public function i18n_singular_name()
+	{
+		return 'Resque queue';
+	}
 
-    /**
-     * @return boolean
-     */
-    public function canView()
-    {
-        return true;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function canView()
+	{
+		return true;
+	}
 
-    /**
-     * @return bool
-     */
-    public function canEdit()
-    {
-        return false;
-    }
+	/**
+	 * @return bool
+	 */
+	public function canEdit()
+	{
+		return false;
+	}
 
-    /**
-     * @return bool
-     */
-    public function candelete()
-    {
-        return false;
-    }
+	/**
+	 * @return bool
+	 */
+	public function candelete()
+	{
+		return false;
+	}
 
-    /**
-     * @return bool
-     */
-    public function cancreate()
-    {
-        return false;
-    }
+	/**
+	 * @return bool
+	 */
+	public function cancreate()
+	{
+		return false;
+	}
 
-    /**
-     * @param string $property
-     * @return mixed
-     */
-    public function __get($property)
-    {
-        if (isset($this->record[$property])) {
-            return $this->record[$property];
-        }
-        return null;
-    }
+	/**
+	 * @param string $property
+	 * @return mixed
+	 */
+	public function __get($property)
+	{
+		if (isset($this->record[$property])) {
+			return $this->record[$property];
+		}
+		return null;
+	}
 }

code/queuereport/ResqueQueue.php

Indentation +104 added lines, -104 removed lines

@@ -11,119 +11,119 @@
 class ResqueQueue extends ViewableData
 {
 
-    /**
-     * @var array
-     */
-    protected $record = array();
+	/**
+	 * @var array
+	 */
+	protected $record = array();
 
-    /**
-     * @param array $data
-     */
-    public function __construct($data = array())
-    {
-        $this->record = $data;
-    }
+	/**
+	 * @param array $data
+	 */
+	public function __construct($data = array())
+	{
+		$this->record = $data;
+	}
 
-    /**
-     * @return \FieldList
-     */
-    public function getCMSFields()
-    {
-        $fieldList = new FieldList();
-        $fieldList->push(new ReadonlyField('Name', 'Name', $this->Name));
-        $fieldList->push(new ReadonlyField('Size', 'Size', $this->Size));
-        $jobs = new GridField('Jobs', 'Jobs', $this->getJobs());
-        $dataComponent = $jobs->getConfig()->getComponentByType('GridFieldDataColumns');
-        $dataComponent->setDisplayFields(array(
-            'Name' => 'Name',
-            'Value' => 'Value',
-        ));
-        $fieldList->push($jobs);
-        return $fieldList;
-    }
+	/**
+	 * @return \FieldList
+	 */
+	public function getCMSFields()
+	{
+		$fieldList = new FieldList();
+		$fieldList->push(new ReadonlyField('Name', 'Name', $this->Name));
+		$fieldList->push(new ReadonlyField('Size', 'Size', $this->Size));
+		$jobs = new GridField('Jobs', 'Jobs', $this->getJobs());
+		$dataComponent = $jobs->getConfig()->getComponentByType('GridFieldDataColumns');
+		$dataComponent->setDisplayFields(array(
+			'Name' => 'Name',
+			'Value' => 'Value',
+		));
+		$fieldList->push($jobs);
+		return $fieldList;
+	}
 
-    /**
-     * @return string
-     */
-    public function i18n_singular_name()
-    {
-        return 'Resque queue';
-    }
+	/**
+	 * @return string
+	 */
+	public function i18n_singular_name()
+	{
+		return 'Resque queue';
+	}
 
-    protected function getJobs()
-    {
-        $jobs = new ArrayList();
+	protected function getJobs()
+	{
+		$jobs = new ArrayList();
 
-        $resqueJobs = Resque::redis()->lrange('queue:' . $this->Name, 0, -1);
-        if (!$resqueJobs) {
-            $jobs->push(new ResqueJob(array(
-                'Name' => 'null',
-                'Value' => 'null',
-            )));
-            return $jobs;
-        }
-        foreach ($resqueJobs as $idx => $job) {
-            $stdClass = json_decode($job);
-            if ($stdClass->class === 'CapistranoDeploy' || $stdClass->class === 'DeployJob') {
-                $value = $stdClass->args[0]->projectName
-                    . ':' . $stdClass->args[0]->environment
-                    . ' - ' . $stdClass->args[0]->sha;
-                $jobs->push(new ResqueJob(array(
-                    'Name' => $stdClass->class,
-                    'Value' => $value,
-                )));
-            } else {
-                $jobs->push(new ResqueJob(array(
-                    'Name' => $stdClass->class,
-                    'Value' => var_export($stdClass->args[0], true),
-                )));
-            }
-        }
+		$resqueJobs = Resque::redis()->lrange('queue:' . $this->Name, 0, -1);
+		if (!$resqueJobs) {
+			$jobs->push(new ResqueJob(array(
+				'Name' => 'null',
+				'Value' => 'null',
+			)));
+			return $jobs;
+		}
+		foreach ($resqueJobs as $idx => $job) {
+			$stdClass = json_decode($job);
+			if ($stdClass->class === 'CapistranoDeploy' || $stdClass->class === 'DeployJob') {
+				$value = $stdClass->args[0]->projectName
+					. ':' . $stdClass->args[0]->environment
+					. ' - ' . $stdClass->args[0]->sha;
+				$jobs->push(new ResqueJob(array(
+					'Name' => $stdClass->class,
+					'Value' => $value,
+				)));
+			} else {
+				$jobs->push(new ResqueJob(array(
+					'Name' => $stdClass->class,
+					'Value' => var_export($stdClass->args[0], true),
+				)));
+			}
+		}
 
-        return $jobs;
-    }
+		return $jobs;
+	}
 
-    /**
-     * @return boolean
-     */
-    public function canView()
-    {
-        return true;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function canView()
+	{
+		return true;
+	}
 
-    /**
-     * @return bool
-     */
-    public function canEdit()
-    {
-        return true;
-    }
+	/**
+	 * @return bool
+	 */
+	public function canEdit()
+	{
+		return true;
+	}
 
-    /**
-     * @return bool
-     */
-    public function candelete()
-    {
-        return false;
-    }
+	/**
+	 * @return bool
+	 */
+	public function candelete()
+	{
+		return false;
+	}
 
-    /**
-     * @return bool
-     */
-    public function cancreate()
-    {
-        return false;
-    }
+	/**
+	 * @return bool
+	 */
+	public function cancreate()
+	{
+		return false;
+	}
 
-    /**
-     * @param string $property
-     * @return mixed
-     */
-    public function __get($property)
-    {
-        if (isset($this->record[$property])) {
-            return $this->record[$property];
-        }
-        return null;
-    }
+	/**
+	 * @param string $property
+	 * @return mixed
+	 */
+	public function __get($property)
+	{
+		if (isset($this->record[$property])) {
+			return $this->record[$property];
+		}
+		return null;
+	}
 }