Add deployment events to chat notification services

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

7 files changed, 101 insertions, 1 deletions

diff --git a/app/models/deployment.rb b/app/models/deployment.rb
index d847a0a11e4..f5fdf285522 100644
--- a/app/models/deployment.rb
+++ b/app/models/deployment.rb
@@ -47,6 +47,12 @@ class Deployment < ApplicationRecord
         Deployments::SuccessWorker.perform_async(id)
       end
     end
+
+    after_transition any => [:success, :failed, :canceled] do |deployment|
+      deployment.run_after_commit do
+        Deployments::FinishedWorker.perform_async(id)
+      end
+    end
   end
 
   enum status: {
@@ -82,6 +88,11 @@ class Deployment < ApplicationRecord
     project.deployment_platform(environment: environment.name)&.cluster
   end
 
+  def execute_hooks
+    deployment_data = Gitlab::DataBuilder::Deployment.build(self)
+    project.execute_services(deployment_data, :deployment_hooks)
+  end
+
   def last?
     self == environment.last_deployment
   end
diff --git a/app/models/project_services/chat_message/deployment_message.rb b/app/models/project_services/chat_message/deployment_message.rb
new file mode 100644
index 00000000000..656a3e6ab4b
--- /dev/null
+++ b/app/models/project_services/chat_message/deployment_message.rb
@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ChatMessage
+  class DeploymentMessage < BaseMessage
+    attr_reader :commit_url
+    attr_reader :deployable_id
+    attr_reader :deployable_url
+    attr_reader :environment
+    attr_reader :short_sha
+    attr_reader :status
+
+    def initialize(data)
+      super
+
+      @commit_url = data[:commit_url]
+      @deployable_id = data[:deployable_id]
+      @deployable_url = data[:deployable_url]
+      @environment = data[:environment]
+      @short_sha = data[:short_sha]
+      @status = data[:status]
+    end
+
+    def attachments
+      [{
+        text: "#{project_link}\n#{deployment_link}, SHA #{commit_link}, by #{user_combined_name}",
+        color: color
+      }]
+    end
+
+    def activity
+      {}
+    end
+
+    private
+
+    def message
+      "Deploy to #{environment} #{humanized_status}"
+    end
+
+    def color
+      case status
+      when 'success'
+        'good'
+      when 'canceled'
+        'warning'
+      when 'failed'
+        'danger'
+      else
+        '#334455'
+      end
+    end
+
+    def project_link
+      link(project_name, project_url)
+    end
+
+    def deployment_link
+      link("Job ##{deployable_id}", deployable_url)
+    end
+
+    def commit_link
+      link(short_sha, commit_url)
+    end
+
+    def humanized_status
+      status == 'success' ? 'succeeded' : status
+    end
+  end
+end
diff --git a/app/models/project_services/chat_notification_service.rb b/app/models/project_services/chat_notification_service.rb
index c10ee07ccf4..7c9ecc6b821 100644
--- a/app/models/project_services/chat_notification_service.rb
+++ b/app/models/project_services/chat_notification_service.rb
@@ -33,7 +33,7 @@ class ChatNotificationService < Service
 
   def self.supported_events
     %w[push issue confidential_issue merge_request note confidential_note tag_push
-       pipeline wiki_page]
+       pipeline wiki_page deployment]
   end
 
   def fields
@@ -122,6 +122,8 @@ class ChatNotificationService < Service
       ChatMessage::PipelineMessage.new(data) if should_pipeline_be_notified?(data)
     when "wiki_page"
       ChatMessage::WikiPageMessage.new(data)
+    when "deployment"
+      ChatMessage::DeploymentMessage.new(data)
     end
   end
 
diff --git a/app/models/project_services/discord_service.rb b/app/models/project_services/discord_service.rb
index 405676792de..4385834ed0a 100644
--- a/app/models/project_services/discord_service.rb
+++ b/app/models/project_services/discord_service.rb
@@ -33,6 +33,11 @@ class DiscordService < ChatNotificationService
     # No-op.
   end
 
+  def self.supported_events
+    %w[push issue confidential_issue merge_request note confidential_note tag_push
+       pipeline wiki_page]
+  end
+
   def default_fields
     [
       { type: "text", name: "webhook", placeholder: "e.g. https://discordapp.com/api/webhooks/…" },
diff --git a/app/models/project_services/hangouts_chat_service.rb b/app/models/project_services/hangouts_chat_service.rb
index 272cd0f4e47..699cf1659d1 100644
--- a/app/models/project_services/hangouts_chat_service.rb
+++ b/app/models/project_services/hangouts_chat_service.rb
@@ -35,6 +35,11 @@ class HangoutsChatService < ChatNotificationService
     'https://chat.googleapis.com/v1/spaces…'
   end
 
+  def self.supported_events
+    %w[push issue confidential_issue merge_request note confidential_note tag_push
+       pipeline wiki_page]
+  end
+
   def default_fields
     [
       { type: 'text', name: 'webhook', placeholder: "e.g. #{webhook_placeholder}" },
diff --git a/app/models/project_services/microsoft_teams_service.rb b/app/models/project_services/microsoft_teams_service.rb
index c34078f13c1..c22a6dc26f6 100644
--- a/app/models/project_services/microsoft_teams_service.rb
+++ b/app/models/project_services/microsoft_teams_service.rb
@@ -33,6 +33,11 @@ class MicrosoftTeamsService < ChatNotificationService
   def default_channel_placeholder
   end
 
+  def self.supported_events
+    %w[push issue confidential_issue merge_request note confidential_note tag_push
+       pipeline wiki_page]
+  end
+
   def default_fields
     [
       { type: 'text', name: 'webhook', placeholder: "e.g. #{webhook_placeholder}" },
diff --git a/app/models/service.rb b/app/models/service.rb
index de549becf71..9896aa12e90 100644
--- a/app/models/service.rb
+++ b/app/models/service.rb
@@ -50,6 +50,7 @@ class Service < ApplicationRecord
   scope :job_hooks, -> { where(job_events: true, active: true) }
   scope :pipeline_hooks, -> { where(pipeline_events: true, active: true) }
   scope :wiki_page_hooks, -> { where(wiki_page_events: true, active: true) }
+  scope :deployment_hooks, -> { where(deployment_events: true, active: true) }
   scope :external_issue_trackers, -> { issue_trackers.active.without_defaults }
   scope :deployment, -> { where(category: 'deployment') }
 
@@ -335,6 +336,8 @@ class Service < ApplicationRecord
       "Event will be triggered when a wiki page is created/updated"
     when "commit", "commit_events"
       "Event will be triggered when a commit is created/updated"
+    when "deployment"
+      "Event will be triggered when a deployment finishes"
     end
   end