Merge pull request #37 from tractorcow/pulls/more-messaging

API Update messaging

Author: Sean Harvey

_config/pipeline.yml

@@ -7,7 +7,7 @@ Pipeline:
       FilteredCommits: "DNFinishedCommits"
       Messages:
         Success: 'Deployment for <project>/<environment> has successfully completed'
-        Failure: 'Deployment for <project>/<environment> has failed'
+        Failure: 'Deployment for <project>/<environment> has failed. See <pipelinelink>'
         Abort: 'Deployment for <project>/<environment> has been aborted'
         RollbackStarted: 'Deployment failed, rollback for <project>/<environment> has begun.'
         RollbackSuccess: 'Rollback for <project>/<environment> has successfully completed.'
@@ -43,7 +43,7 @@ UserConfirmationStep:
       # Messages only sent to requester
       Request-Requester: 'You requested approval for deployment of <project>/<environment>. Cancel? <abortlink>'
       # Messages only sent to specified recipients
-      Request-Recipient: 'Deployment for <project>/<environment> requested by <requester>. Approve? <approvelink>'
+      Request-Recipient: 'Deployment for <project>/<environment> requested by <requester>. Login to approve at <approvelink>'
     Subjects:
       # Subject line for all users
       Cancel: 'Deployment for <project>/<environment>: Cancelled'

code/model/Pipeline.php

@@ -112,7 +112,8 @@ class Pipeline extends DataObject {
 	private static $db = array(
 		'Status' => 'Enum("Running,Complete,Failed,Aborted,Rollback,Queued","Queued")',
 		'Config' => 'Text', // serialized array of configuration for this pipeline
-		'SHA' => 'Varchar(255)'
+		'SHA' => 'Varchar(255)',
+		'LastMessageSent' => 'Varchar(255)' // ID of last message sent
 	);
 
 	/**
@@ -205,10 +206,12 @@ public function getReplacements() {
 		$environment = $this->Environment();
 		return array(
 			'<abortlink>' => Director::absoluteURL($this->Environment()->Link()),
+			'<pipelinelink>' => Director::absoluteURL($this->Link()),
 			'<requester>' => $author->Title,
 			'<requester-email>' => $author->Email,
 			'<environment>' => $environment->Name,
-			'<project>' => $environment->Project()->Name
+			'<project>' => $environment->Project()->Name,
+			'<commitsha>' => $this->SHA
 		);
 	}
 
@@ -539,7 +542,10 @@ public function markComplete() {
 		$this->Status = "Complete";
 		$this->log("Pipeline completed successfully.");
 		$this->write();
-		$this->sendMessage(self::ALERT_SUCCESS);
+		// Some steps may pre-emptively send a success message before the pipeline itself has completed
+		if($this->LastMessageSent !== self::ALERT_SUCCESS) {
+			$this->sendMessage(self::ALERT_SUCCESS);
+		}
 	}
 
 	/**
@@ -652,8 +658,10 @@ protected function canStartRollback() {
 	 * Notify Pipeline that a step has failed and failure processing should kick in. If rollback steps are present
 	 * the pipeline will be put into 'Rollback' state. After rollback is complete, regardless of the rollback result,
 	 * the pipeline will be failed.
+	 *
+	 * @param bool $notify Set to false to disable notifications for this failure
 	 */
-	public function markFailed() {
+	public function markFailed($notify = true) {
 		// Abort all running or queued steps.
 		$steps = $this->Steps();
 		foreach($steps as $step) {
@@ -669,7 +677,7 @@ public function markFailed() {
 			$this->Status = 'Failed';
 			$this->log("Pipeline failed, not running rollback (not configured or not applicable yet).");
 			$this->write();
-			$this->sendMessage(self::ALERT_FAILURE);
+			if($notify) $this->sendMessage(self::ALERT_FAILURE);
 		}
 	}
 
@@ -754,16 +762,22 @@ public function injectMessageReplacements($message, $subject, $substitutions) {
 	/**
 	 * Sends a specific message to all marked recipients, including the author of this pipeline
 	 *
-	 * @param string $messageID Message ID. One of 'Abort', 'Success', or 'Failure'
+	 * @param string $messageID Message ID. One of 'Abort', 'Success', or 'Failure', or some custom message
 	 * @return boolean True if successful
 	 */
-	protected function sendMessage($messageID) {
+	public function sendMessage($messageID) {
 		// Check message, subject, and additional arguments to include
 		list($subject, $message) = $this->generateMessageTemplate($messageID);
 		if(empty($subject) || empty($message)) {
 			$this->log("Skipping sending message. None configured for $messageID");
 			return true;
 		}
+
+		// Save last sent message
+		$this->LastMessageSent = $messageID;
+		$this->write();
+
+		// Setup messaging arguments
 		$arguments = array_merge(
 			$this->getConfigSetting('PipelineConfig', 'ServiceArguments') ?: array(),
 			array('subject' => $subject)

code/model/steps/EmergencyRollbackStep.php

@@ -131,6 +131,8 @@ public function beginRollbackWindow() {
 		$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;
 	}
 

code/model/steps/PipelineStep.php

@@ -48,7 +48,7 @@ class PipelineStep extends DataObject {
 		'Status',
 		'LastEdited'
 	);
-
+	
 	/**
 	 * Cached of config merged with defaults
 	 *
@@ -136,11 +136,16 @@ public function finish() {
 		$this->write();
 	}
 
-	public function markFailed() {
+	/**
+	 * 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();
+		$this->Pipeline()->markFailed($notify);
 	}
 
 	/**

code/model/steps/RollbackStep.php

@@ -82,6 +82,7 @@ protected function startRevertDeploy() {
 		$deployment->LeaveMaintenacePage = $this->doRestoreDB();
 		$deployment->EnvironmentID = $pipeline->EnvironmentID;
 		$deployment->SHA = $previous->SHA;
+		$deployment->DeployerID = $pipeline->AuthorID;
 		$deployment->write();
 		$deployment->start();
 		$this->RollbackDeploymentID = $deployment->ID;

code/model/steps/SmokeTestPipelineStep.php

@@ -169,13 +169,13 @@ public function start() {
 		}
 	}
 
-	public function markFailed() {
+	public function markFailed($notify = true) {
 		// 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();
+		parent::markFailed($notify);
 	}
 
 }

code/model/steps/UserConfirmationStep.php

@@ -122,13 +122,6 @@ public function getMessagingService() {
 		return $this->messagingService;
 	}
 
-	public function __isset($property) {
-		// Workaround fixed in https://github.com/silverstripe/silverstripe-framework/pull/3201
-		// Remove this once we update to a version of framework which supports this
-		if($property === 'MessagingService') return !empty($this->messagingService);
-		return parent::__isset($property);
-	}
-	
 	/**
 	 * Determine if the confirmation has been responded to (ether with acceptance, rejection, or cancelled)
 	 * 
@@ -218,7 +211,7 @@ public function reject() {
 		$this->Approval = 'Rejected';
 		$this->log("{$this->Title} has been rejected");
 		$this->ResponderID = Member::currentUserID();
-		$this->markFailed();
+		$this->markFailed(false);
 		$this->sendMessage(self::ALERT_REJECT);
 		return true;
 	}

tests/EmergencyRollbackStepTest.php

@@ -114,6 +114,9 @@ public function testBeginRollbackWindow() {
 
 		$this->logInWithPermission('APPLY_ROLES');
 		$this->assertTrue($step->beginRollbackWindow());
+
+		// Check that the message is sent
+		$this->assertSentMessage('Deployment for testproject/uat has successfully completed', 'test@example.com');
 	}
 
 	public function testRunningConfiguration() {
@@ -131,5 +134,8 @@ public function testStartFail() {
 		$step->Status = 'Failed';
 
 		$this->assertFalse($step->start());
+
+		// Check that the message is sent
+		$this->assertNotSentMessage('Deployment for testproject/uat has successfully completed', 'test@example.com');
 	}
 }

tests/UserConfirmationStepTest.php

@@ -161,6 +161,9 @@ public function testRejection() {
 		$this->assertEquals('Failed', $step->Status);
 		$this->assertEquals('Rejected', $step->Approval);
 		$this->assertHasLog('TestConfirmStep has been rejected');
+		$this->assertNotSentMessage('Deployment for testproject/uat has failed', 'test@example.com');
+		$this->assertNotSentMessage('Deployment for testproject/uat has failed', 'abort@example.com');
+		$this->assertNotSentMessage('Deployment for testproject/uat has failed', 'errors@example.com');
 		$this->assertSentMessage('Deployment for testproject/uat has been rejected', 'test@example.com');
 		$this->assertSentMessage('Deployment for testproject/uat has been rejected', 'admin@example.com');
 	}