Add deployment events to chat notification services

This enables sending a chat message to Slack or Mattermost
  upon a successful, failed, or canceled deployment

4 files changed, 181 insertions, 0 deletions

diff --git a/spec/models/ci/build_spec.rb b/spec/models/ci/build_spec.rb
index 3a7d20a58c8..339483d4f7d 100644
--- a/spec/models/ci/build_spec.rb
+++ b/spec/models/ci/build_spec.rb
@@ -856,6 +856,10 @@ describe Ci::Build do
     let(:deployment) { build.deployment }
     let(:environment) { deployment.environment }
 
+    before do
+      allow(Deployments::FinishedWorker).to receive(:perform_async)
+    end
+
     it 'has deployments record with created status' do
       expect(deployment).to be_created
       expect(environment.name).to eq('review/master')
diff --git a/spec/models/deployment_spec.rb b/spec/models/deployment_spec.rb
index d9170d5fa07..0ca758429b8 100644
--- a/spec/models/deployment_spec.rb
+++ b/spec/models/deployment_spec.rb
@@ -102,6 +102,13 @@ describe Deployment do
 
         deployment.succeed!
       end
+
+      it 'executes Deployments::FinishedWorker asynchronously' do
+        expect(Deployments::FinishedWorker)
+          .to receive(:perform_async).with(deployment.id)
+
+        deployment.succeed!
+      end
     end
 
     context 'when deployment failed' do
@@ -115,6 +122,13 @@ describe Deployment do
           expect(deployment.finished_at).to be_like_time(Time.now)
         end
       end
+
+      it 'executes Deployments::FinishedWorker asynchronously' do
+        expect(Deployments::FinishedWorker)
+          .to receive(:perform_async).with(deployment.id)
+
+        deployment.drop!
+      end
     end
 
     context 'when deployment was canceled' do
@@ -128,6 +142,13 @@ describe Deployment do
           expect(deployment.finished_at).to be_like_time(Time.now)
         end
       end
+
+      it 'executes Deployments::FinishedWorker asynchronously' do
+        expect(Deployments::FinishedWorker)
+          .to receive(:perform_async).with(deployment.id)
+
+        deployment.cancel!
+      end
     end
   end
 
diff --git a/spec/models/project_services/chat_message/deployment_message_spec.rb b/spec/models/project_services/chat_message/deployment_message_spec.rb
new file mode 100644
index 00000000000..86565ce8b01
--- /dev/null
+++ b/spec/models/project_services/chat_message/deployment_message_spec.rb
@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe ChatMessage::DeploymentMessage do
+  describe '#pretext' do
+    it 'returns a message with the data returned by the deployment data builder' do
+      environment = create(:environment, name: "myenvironment")
+      project = create(:project, :repository)
+      commit = project.commit('HEAD')
+      deployment = create(:deployment, status: :success, environment: environment, project: project, sha: commit.sha)
+      data = Gitlab::DataBuilder::Deployment.build(deployment)
+
+      message = described_class.new(data)
+
+      expect(message.pretext).to eq("Deploy to myenvironment succeeded")
+    end
+
+    it 'returns a message for a successful deployment' do
+      data = {
+        status: 'success',
+        environment: 'production'
+      }
+
+      message = described_class.new(data)
+
+      expect(message.pretext).to eq('Deploy to production succeeded')
+    end
+
+    it 'returns a message for a failed deployment' do
+      data = {
+        status: 'failed',
+        environment: 'production'
+      }
+
+      message = described_class.new(data)
+
+      expect(message.pretext).to eq('Deploy to production failed')
+    end
+
+    it 'returns a message for a canceled deployment' do
+      data = {
+        status: 'canceled',
+        environment: 'production'
+      }
+
+      message = described_class.new(data)
+
+      expect(message.pretext).to eq('Deploy to production canceled')
+    end
+
+    it 'returns a message for a deployment to another environment' do
+      data = {
+        status: 'success',
+        environment: 'staging'
+      }
+
+      message = described_class.new(data)
+
+      expect(message.pretext).to eq('Deploy to staging succeeded')
+    end
+
+    it 'returns a message for a deployment with any other status' do
+      data = {
+        status: 'unknown',
+        environment: 'staging'
+      }
+
+      message = described_class.new(data)
+
+      expect(message.pretext).to eq('Deploy to staging unknown')
+    end
+  end
+
+  describe '#attachments' do
+    def deployment_data(params)
+      {
+        object_kind: "deployment",
+        status: "success",
+        deployable_id: 3,
+        deployable_url: "deployable_url",
+        environment: "sandbox",
+        project: {
+          name: "greatproject",
+          web_url: "project_web_url",
+          path_with_namespace: "project_path_with_namespace"
+        },
+        user: {
+          name: "Jane Person",
+          username: "jane"
+        },
+        short_sha: "12345678",
+        commit_url: "commit_url"
+      }.merge(params)
+    end
+
+    it 'returns attachments with the data returned by the deployment data builder' do
+      user = create(:user, name: "John Smith", username: "smith")
+      namespace = create(:namespace, name: "myspace")
+      project = create(:project, :repository, namespace: namespace, name: "myproject")
+      commit = project.commit('HEAD')
+      environment = create(:environment, name: "myenvironment", project: project)
+      ci_build = create(:ci_build, project: project)
+      deployment = create(:deployment, :success, deployable: ci_build, environment: environment, project: project, user: user, sha: commit.sha)
+      job_url = Gitlab::Routing.url_helpers.project_job_url(project, ci_build)
+      commit_url = Gitlab::UrlBuilder.build(deployment.commit)
+      data = Gitlab::DataBuilder::Deployment.build(deployment)
+
+      message = described_class.new(data)
+
+      expect(message.attachments).to eq([{
+        text: "[myspace/myproject](#{project.web_url})\n[Job ##{ci_build.id}](#{job_url}), SHA [#{deployment.short_sha}](#{commit_url}), by John Smith (smith)",
+        color: "good"
+      }])
+    end
+
+    it 'returns attachments for a failed deployment' do
+      data = deployment_data(status: 'failed')
+
+      message = described_class.new(data)
+
+      expect(message.attachments).to eq([{
+        text: "[project_path_with_namespace](project_web_url)\n[Job #3](deployable_url), SHA [12345678](commit_url), by Jane Person (jane)",
+        color: "danger"
+      }])
+    end
+
+    it 'returns attachments for a canceled deployment' do
+      data = deployment_data(status: 'canceled')
+
+      message = described_class.new(data)
+
+      expect(message.attachments).to eq([{
+        text: "[project_path_with_namespace](project_web_url)\n[Job #3](deployable_url), SHA [12345678](commit_url), by Jane Person (jane)",
+        color: "warning"
+      }])
+    end
+
+    it 'uses a neutral color for a deployment with any other status' do
+      data = deployment_data(status: 'some-new-status-we-make-in-the-future')
+
+      message = described_class.new(data)
+
+      expect(message.attachments).to eq([{
+        text: "[project_path_with_namespace](project_web_url)\n[Job #3](deployable_url), SHA [12345678](commit_url), by Jane Person (jane)",
+        color: "#334455"
+      }])
+    end
+  end
+end
diff --git a/spec/models/project_services/microsoft_teams_service_spec.rb b/spec/models/project_services/microsoft_teams_service_spec.rb
index 521d5265753..c025d7c882e 100644
--- a/spec/models/project_services/microsoft_teams_service_spec.rb
+++ b/spec/models/project_services/microsoft_teams_service_spec.rb
@@ -30,6 +30,12 @@ describe MicrosoftTeamsService do
     end
   end
 
+  describe '.supported_events' do
+    it 'does not support deployment_events' do
+      expect(described_class.supported_events).not_to include('deployment')
+    end
+  end
+
   describe "#execute" do
     let(:user)    { create(:user) }
     set(:project) { create(:project, :repository, :wiki_repo) }