Send mattermost action

lib/fastlane/plugin/ddg_apple_automation/actions/mattermost_send_message_action.rb

@@ -0,0 +1,97 @@
+require "fastlane/action"
+require "fastlane_core/configuration/config_item"
+require "yaml"
+require "httparty"
+require "json"
+require_relative "../helper/ddg_apple_automation_helper"
+
+module Fastlane
+  module Actions
+    class MattermostSendMessageAction < Action
+      def self.run(params)
+        github_handle = params[:github_handle]
+        template_name = params[:template_name]
+        mm_webhook_url = params[:mattermost_webhook_url]
+        args = (params[:template_args] || {}).merge(Hash(ENV).transform_keys { |key| key.downcase.gsub('-', '_') })
+        mapping_file = Helper::DdgAppleAutomationHelper.path_for_asset_file("mattermost_send_message/github-mattermost-user-id-mapping.yml")
+        user_mapping = YAML.load_file(mapping_file)
+        mattermost_user_handle = user_mapping[github_handle]
+
+        if mattermost_user_handle.nil? || mattermost_user_handle.to_s.empty?
+          UI.message("Mattermost user handle not known for #{github_handle}, skipping sending message")
+          return
+        end
+
+        text = process_template(template_name, args)
+        payload = {
+          "channel" => mattermost_user_handle,
+          "username" => "GitHub Actions",
+          "text" => text,
+          "icon_url" => "https://duckduckgo.com/assets/logo_header.v108.svg"
+        }
+
+        response = HTTParty.post(mm_webhook_url, {
+          headers: { 'Content-Type' => 'application/json' },
+          body: payload.to_json
+        })
+
+        # Check response status
+        if response.success?
+          UI.success("Message sent successfully!")
+        else
+          UI.user_error!("Failed to send message: #{response.body}")
+        end
+      end
+
+      def self.description
+        "This action sends a message to Mattermost, reporting the outcome to the user who triggered the workflow"
+      end
+
+      def self.authors
+        ["DuckDuckGo"]
+      end
+
+      def self.return_value
+        ""
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.process_template(template_name, args)
+        template_file = Helper::DdgAppleAutomationHelper.path_for_asset_file("mattermost_send_message/templates/#{template_name}.txt.erb")
+        Helper::DdgAppleAutomationHelper.process_erb_template(template_file, args)
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :mattermost_webhook_url,
+                                       env_name: "MM_WEBHOOK_URL",
+                                       description: "Mattermost webhook URL",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :github_handle,
+                                       description: "Github user handle",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :template_args,
+                                       description: "Template arguments. For backward compatibility, environment variables are added to this hash",
+                                       optional: true,
+                                       type: Hash,
+                                       default_value: {}),
+          FastlaneCore::ConfigItem.new(key: :template_name,
+                                       description: "Name of a template file (without extension) for the message. Templates can be found in assets/mattermost_send_message/templates subdirectory.
+      The file is processed before being posted",
+                                       optional: false,
+                                       type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

lib/fastlane/plugin/ddg_apple_automation/assets/mattermost_send_message/github-mattermost-user-id-mapping.yml

@@ -0,0 +1,30 @@
+aataraxiaa: "@psmith"
+afterxleep: "@dbernal" 
+alessandroboron: "@aboron"
+amddg44: "@amallon" 
+ayoy: "@dkapusta"
+brindy: "@brindy"
+bwaresiak: "@bartek"
+Bunn: "@fbunn"
+dharb: "@dave"
+diegoreymendez: "@dreymendez"
+dus7: "@mariusz"
+federicocappelli: "@fcappelli"
+GioSensation: "@emanuele"
+graeme: "@garthur"
+jaceklyp: "@jlyp"
+jonathanKingston: "@jkingston"
+jotaemepereira: "@jpereira"
+ladamski: "@ladamski"
+mallexxx: "@amartemyanov"
+miasma13: "@msmaga"
+muodov: "@mtsoy" 
+quanganhdo: "@ado"
+samsymons: "@ssymons"
+shakyShane: "@sosbourne"
+SabrinaTardio: "@stardio"
+THISISDINOSAUR: "@esullivan"
+tomasstrba: "@tom"
+viktorjansson: "@viktor"
+vinay-nadig-0042: "@vnadig"
+kshann: "@kshannon"

lib/fastlane/plugin/ddg_apple_automation/assets/mattermost_send_message/templates/ios-release-failed.txt.erb

@@ -0,0 +1 @@
+:warning: **iOS release job failed** :thisisfine: | [:github: Workflow run summary](<%= workflow_url %>)

lib/fastlane/plugin/ddg_apple_automation/assets/mattermost_send_message/templates/notarized-build-complete.txt.erb

@@ -0,0 +1 @@
+Notarized macOS app `<%= release_type %>` build is ready :goose_honk_tada: | [:github: Workflow run summary](<%= workflow_url %>)<% if defined?(asana_task_url) %> | [:asana: Asana Task](<%= asana_task_url %>)<% end %>

lib/fastlane/plugin/ddg_apple_automation/assets/mattermost_send_message/templates/notarized-build-failed.txt.erb

@@ -0,0 +1 @@
+:rotating_light: Notarized macOS app `<%= release_type %>` build failed | [:github: Workflow run summary](<%= workflow_url %>)<% if defined?(asana_task_url) %> | [:asana: Asana Task](<%= asana_task_url %>)<% end %>

lib/fastlane/plugin/ddg_apple_automation/assets/mattermost_send_message/templates/public-release-complete.txt.erb

@@ -0,0 +1 @@
+<%= app_platform %> app has been successfully uploaded to <%= destination %> :goose_honk_tada: | [:github: Workflow run summary](<%= workflow_url %>)

lib/fastlane/plugin/ddg_apple_automation/assets/mattermost_send_message/templates/public-release-failed.txt.erb

@@ -0,0 +1 @@
+:rotating_light: macOS app <%= destination %> workflow failed | [:github: Workflow run summary](<%= workflow_url %>)

lib/fastlane/plugin/ddg_apple_automation/assets/mattermost_send_message/templates/variants-release-failed.txt.erb

@@ -0,0 +1 @@
+:rotating_light: macOS app variants workflow failed | [:github: Workflow run summary](<%= workflow_url %>)

lib/fastlane/plugin/ddg_apple_automation/assets/mattermost_send_message/templates/variants-release-published.txt.erb

@@ -0,0 +1 @@
+macOS app variants have been published successfully :goose_honk_tada: | [:github: Workflow run summary](<%= workflow_url %>)

spec/mattermost_send_message_action_spec.rb

@@ -0,0 +1,146 @@
+describe Fastlane::Actions::MattermostSendMessageAction do
+  describe "run" do
+    let(:params) do
+      {
+        mattermost_webhook_url: "http://example.com/webhook",
+        github_handle: "user",
+        template_name: "test_template"
+      }
+    end
+
+    let(:user_mapping) { { "user" => "@mattermost_user" } }
+    let(:template_content) { { "text" => "Hello <%= name %>" } }
+    let(:processed_template) { "Hello World" }
+
+    before do
+      allow(YAML).to receive(:load_file).with(anything).and_return(user_mapping)
+      allow(Fastlane::Helper::DdgAppleAutomationHelper).to receive(:path_for_asset_file).and_return("mock_path")
+      allow(Fastlane::Helper::DdgAppleAutomationHelper).to receive(:process_erb_template).and_return(processed_template)
+      allow(YAML).to receive(:safe_load).and_return("text" => processed_template)
+      allow(HTTParty).to receive(:post).and_return(double(success?: true))
+
+      allow(ENV).to receive(:[]).with("NAME").and_return("World")
+    end
+
+    it "sends a message to Mattermost with correct payload" do
+      expected_payload = {
+        "channel" => "@mattermost_user",
+        "username" => "GitHub Actions",
+        "text" => "Hello World",
+        "icon_url" => "https://duckduckgo.com/assets/logo_header.v108.svg"
+      }
+
+      expect(HTTParty).to receive(:post).with(
+        "http://example.com/webhook",
+        hash_including(
+          headers: { 'Content-Type' => 'application/json' },
+          body: expected_payload.to_json
+        )
+      ).and_return(double(success?: true))
+
+      Fastlane::Actions::MattermostSendMessageAction.run(params)
+    end
+
+    it "skips sending if Mattermost user handle is unknown" do
+      allow(YAML).to receive(:load_file).and_return({})
+
+      expect(HTTParty).not_to receive(:post)
+      expect(FastlaneCore::UI).to receive(:message).with("Mattermost user handle not known for user, skipping sending message")
+
+      Fastlane::Actions::MattermostSendMessageAction.run(params)
+    end
+
+    it "handles unsuccessful HTTP response" do
+      allow(HTTParty).to receive(:post).and_return(double(success?: false, body: "Error message"))
+
+      expect { Fastlane::Actions::MattermostSendMessageAction.run(params) }.to raise_error(FastlaneCore::Interface::FastlaneError, "Failed to send message: Error message")
+    end
+  end
+
+  describe "process_template" do
+    it "processes ios-release-failed template" do
+      expected = ":warning: **iOS release job failed** :thisisfine: | [:github: Workflow run summary](https://workflow.com)"
+
+      expect(process_template("ios-release-failed", {
+        "workflow_url" => "https://workflow.com"
+      })).to eq(expected)
+    end
+
+    it "processes notarized-build-complete template" do
+      expected = "Notarized macOS app `release` build is ready :goose_honk_tada: | [:github: Workflow run summary](https://workflow.com)"
+
+      expect(process_template("notarized-build-complete", {
+        "release_type" => "release",
+        "workflow_url" => "https://workflow.com"
+      })).to eq(expected)
+    end
+
+    it "processes notarized-build-complete template with Asana task URL" do
+      expected = "Notarized macOS app `release` build is ready :goose_honk_tada: | [:github: Workflow run summary](https://workflow.com) | [:asana: Asana Task](https://asana.com)"
+
+      expect(process_template("notarized-build-complete", {
+        "asana_task_url" => "https://asana.com",
+        "release_type" => "release",
+        "workflow_url" => "https://workflow.com"
+      })).to eq(expected)
+    end
+
+    it "processes notarized-build-failed template" do
+      expected = ":rotating_light: Notarized macOS app `release` build failed | [:github: Workflow run summary](https://workflow.com)"
+
+      expect(process_template("notarized-build-failed", {
+        "release_type" => "release",
+        "workflow_url" => "https://workflow.com"
+      })).to eq(expected)
+    end
+
+    it "processes notarized-build-failed template with Asana task URL" do
+      expected = ":rotating_light: Notarized macOS app `release` build failed | [:github: Workflow run summary](https://workflow.com) | [:asana: Asana Task](https://asana.com)"
+
+      expect(process_template("notarized-build-failed", {
+        "asana_task_url" => "https://asana.com",
+        "release_type" => "release",
+        "workflow_url" => "https://workflow.com"
+      })).to eq(expected)
+    end
+
+    it "processes public-release-complete template" do
+      expected = "macOS app has been successfully uploaded to testflight :goose_honk_tada: | [:github: Workflow run summary](https://workflow.com)"
+
+      expect(process_template("public-release-complete", {
+        "app_platform" => "macOS",
+        "destination" => "testflight",
+        "workflow_url" => "https://workflow.com"
+      })).to eq(expected)
+    end
+
+    it "processes public-release-failed template" do
+      expected = ":rotating_light: macOS app testflight workflow failed | [:github: Workflow run summary](https://workflow.com)"
+
+      expect(process_template("public-release-failed", {
+        "destination" => "testflight",
+        "workflow_url" => "https://workflow.com"
+      })).to eq(expected)
+    end
+
+    it "processes variants-release-failed template" do
+      expected = ":rotating_light: macOS app variants workflow failed | [:github: Workflow run summary](https://workflow.com)"
+
+      expect(process_template("variants-release-failed", {
+        "workflow_url" => "https://workflow.com"
+      })).to eq(expected)
+    end
+
+    it "processes variants-release-published template" do
+      expected = "macOS app variants have been published successfully :goose_honk_tada: | [:github: Workflow run summary](https://workflow.com)"
+
+      expect(process_template("variants-release-published", {
+        "workflow_url" => "https://workflow.com"
+      })).to eq(expected)
+    end
+
+    def process_template(template_name, args)
+      Fastlane::Actions::MattermostSendMessageAction.process_template(template_name, args)
+    end
+  end
+end