Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Send mattermost action #14

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
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]

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

template_file = Helper::DdgAppleAutomationHelper.path_for_asset_file("mattermost_send_message/templates/#{template_name}.yml")
template_content = YAML.safe_load(Helper::DdgAppleAutomationHelper.load_file(template_file))
text = template_content["text"].gsub(/\$\{(\w+)\}/) { ENV.fetch($1, '') }

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?
puts("Message sent successfully!")
else
puts("Failed to send message: #{response.body}")
end
kshann marked this conversation as resolved.
Show resolved Hide resolved
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.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_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
Original file line number Diff line number Diff line change
@@ -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"
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
text: ":warning: **iOS release job failed** :thisisfine: | [:github: Workflow run summary](${WORKFLOW_URL})"
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
text: "**Notarized macOS app `${RELEASE_TYPE}` build is ready** :goose_honk_tada: | [:github: Workflow run summary](${WORKFLOW_URL})${ASANA_LINK}",
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
text: ":rotating_light: **Notarized macOS app `${RELEASE_TYPE}` build failed** | [:github: Workflow run summary](${WORKFLOW_URL})${ASANA_LINK}"
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
text: "**${APP_PLATFORM} app has been successfully uploaded to ${DESTINATION}** :goose_honk_tada: | [:github: Workflow run summary](${WORKFLOW_URL})"
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
text: ":rotating_light: **macOS app ${DESTINATION} workflow failed** | [:github: Workflow run summary](${WORKFLOW_URL})"
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
text: ":rotating_light: **macOS app variants workflow failed** | [:github: Workflow run summary](${WORKFLOW_URL})"
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
text: "**macOS app variants have been published successfully** :goose_honk_tada: | [:github: Workflow run summary](${WORKFLOW_URL})"
56 changes: 56 additions & 0 deletions spec/mattermost_send_message_action_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
describe Fastlane::Actions::MattermostSendMessageAction 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}" } }

before do
allow(YAML).to receive(:load_file).with(anything).and_return(user_mapping)
allow(YAML).to receive(:safe_load).and_return(template_content)
allow(ENV).to receive(:fetch).with("NAME", "").and_return("World")
allow(HTTParty).to receive(:post).and_return(double(success?: true))

allow(Fastlane::Helper::DdgAppleAutomationHelper).to receive(:path_for_asset_file).and_return("mock_path")
allow(Fastlane::Helper::DdgAppleAutomationHelper).to receive(:load_file).and_return("mock_content")
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 output(/Failed to send message: Error message/).to_stdout
end
end