Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions services/tasks/TaskRunner_logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ func (t *TaskRunner) SetStatus(status task_logger.TaskStatus) {
t.sendMicrosoftTeamsAlert()
t.sendDingTalkAlert()
t.sendGotifyAlert()
t.sendLarkAlert()
}

for _, l := range t.statusListeners {
Expand Down
78 changes: 78 additions & 0 deletions services/tasks/alert.go
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,69 @@ func (t *TaskRunner) sendGotifyAlert() {
}
}

func (t *TaskRunner) sendLarkAlert() {
if !util.Config.LarkAlert || !t.alert {
return
}

if t.Template.SuppressSuccessAlerts && t.Task.Status == task_logger.TaskSuccessStatus {
return
}

body := bytes.NewBufferString("")
author, version := t.alertInfos()

alert := Alert{
Name: t.Template.Name,
Author: author,
Color: t.alertColor("lark"),
Task: alertTask{
ID: strconv.Itoa(t.Task.ID),
URL: t.taskLink(),
Result: t.Task.Status.Format(),
Version: version,
Desc: t.Task.Message,
},
}

tpl, err := template.ParseFS(templates, "templates/lark.tmpl")

if err != nil {
t.Log("Can't parse lark alert template!")
panic(err)
}

if err := tpl.Execute(body, alert); err != nil {
t.Log("Can't generate lark alert template!")
panic(err)
}

if body.Len() == 0 {
t.Log("Buffer for lark alert is empty")
return
}

t.Log("Attempting to send lark alert")

resp, err := http.Post(
util.Config.LarkUrl,
"application/json",
body,
)

if err != nil {
t.Log("Can't send lark alert! Error: " + err.Error())
} else if resp.StatusCode != 200 {
t.Log("Can't send lark alert! Response code: " + strconv.Itoa(resp.StatusCode))
} else {
t.Log("Sent successfully lark alert")
}

if resp != nil {
defer resp.Body.Close() //nolint:errcheck
}
}

func (t *TaskRunner) alertInfos() (string, string) {
version := ""

Expand Down Expand Up @@ -567,6 +630,21 @@ func (t *TaskRunner) alertColor(kind string) string {
case task_logger.TaskStoppedStatus:
return "#5B5B5B"
}
case "lark":
switch t.Task.Status {
case task_logger.TaskSuccessStatus:
return "green"
case task_logger.TaskFailStatus:
return "red"
case task_logger.TaskRunningStatus:
return "blue"
case task_logger.TaskWaitingStatus:
return "yellow"
case task_logger.TaskStoppingStatus:
return "grey"
case task_logger.TaskStoppedStatus:
return "black"
}
}

return ""
Expand Down
1 change: 1 addition & 0 deletions services/tasks/alert_test_sender.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ func SendProjectTestAlerts(project db.Project, store db.Store) (err error) {
tr.sendDingTalkAlert()
tr.sendGotifyAlert()
tr.sendMailAlert()
tr.sendLarkAlert()

return
}
26 changes: 26 additions & 0 deletions services/tasks/templates/lark.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"msg_type": "interactive",
"card": {
"header": {
"title": {
"tag": "plain_text",
"content": "Task: {{ .Name }}"
},
"template": "{{ .Color }}"
},
"elements": [
{
"tag": "div",
"fields": [
{
"is_short": true,
"text": {
"tag": "lark_md",
"content": "**Execution : ** {{ .Task.ID }} \n**Status: **{{ .Task.Result }} \n**Author: **{{ .Author }} \n{{ if .Task.Version }}**Version: **{{ .Task.Version }} \n{{ end }}[Task Link]({{ .Task.URL }})"
}
}
]
}
]
}
}
4 changes: 3 additions & 1 deletion util/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ type ConfigType struct {
LdapMappings *LdapMappings `json:"ldap_mappings,omitempty"`
LdapNeedTLS bool `json:"ldap_needtls,omitempty" env:"SEMAPHORE_LDAP_NEEDTLS"`

// Telegram, Slack, Rocket.Chat, Microsoft Teams, DingTalk, and Gotify alerting
// Telegram, Slack, Rocket.Chat, Microsoft Teams, DingTalk, Gotify and Lark alerting
TelegramAlert bool `json:"telegram_alert,omitempty" env:"SEMAPHORE_TELEGRAM_ALERT"`
TelegramChat string `json:"telegram_chat,omitempty" env:"SEMAPHORE_TELEGRAM_CHAT"`
TelegramToken string `json:"telegram_token,omitempty" env:"SEMAPHORE_TELEGRAM_TOKEN"`
Expand All @@ -294,6 +294,8 @@ type ConfigType struct {
GotifyAlert bool `json:"gotify_alert,omitempty" env:"SEMAPHORE_GOTIFY_ALERT"`
GotifyUrl string `json:"gotify_url,omitempty" env:"SEMAPHORE_GOTIFY_URL"`
GotifyToken string `json:"gotify_token,omitempty" env:"SEMAPHORE_GOTIFY_TOKEN"`
LarkAlert bool `json:"lark_alert,omitempty" env:"SEMAPHORE_LARK_ALERT"`
LarkUrl string `json:"lark_url,omitempty" env:"SEMAPHORE_LARK_URL"`

// oidc settings
OidcProviders map[string]OidcProvider `json:"oidc_providers,omitempty" env:"SEMAPHORE_OIDC_PROVIDERS"`
Expand Down
Loading