feat: slack dashboard uri

jmpargana · Oct 3, 2023 · 085f650 · 085f650
1 parent 9d16931
commit 085f650
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 7 deletions.
diff --git a/cmd/api-server/main.go b/cmd/api-server/main.go
@@ -603,7 +603,8 @@ func newSlackLoader(cfg *config.Config, envs map[string]string) (*slack.SlackLoa
 		return nil, err
 	}
 
-	return slack.NewSlackLoader(slackTemplate, slackConfig, cfg.TestkubeClusterName, testkube.AllEventTypes, envs), nil
+	return slack.NewSlackLoader(slackTemplate, slackConfig, cfg.TestkubeClusterName, cfg.TestkubeDashboardURI,
+		testkube.AllEventTypes, envs), nil
 }
 
 // getMongoSSLConfig builds the necessary SSL connection info from the settings in the environment variables

diff --git a/config/slack-template.json b/config/slack-template.json
@@ -145,8 +145,43 @@
 				"text": "`kubectl testkube get execution {{ .ExecutionName }} `\n"
 			}
 		},
+		{{ if eq .TestType "Test Suite" }}
+		{
+			"type": "button",
+			"text": {
+				"type": "mrkdwn",
+				"text": "Test Suite URI"
+			},
+			"url": "{{ .DashboardURI }}/test-suites/{{ .TestName }}"
+		},
+		{
+			"type": "button",
+			"text": {
+				"type": "mrkdwn",
+				"text": "Test Suite Execution URI"
+			},
+			"url": "{{ .DashboardURI }}/test-suites/{{ .TestName }}/executions/{{ .ExecutionID }}"
+		},
+		{{ else }}
+		{
+			"type": "button",
+			"text": {
+				"type": "mrkdwn",
+				"text": "Test URI"
+			},
+			"url": "{{ .DashboardURI }}/tests/{{ .TestName }}"
+		},
+		{
+			"type": "button",
+			"text": {
+				"type": "mrkdwn",
+				"text": "Test Execution URI"
+			},
+			"url": "{{ .DashboardURI }}/tests/{{ .TestName }}/executions/{{ .ExecutionID }}"
+		},
+		{{ end }}
 		{
 			"type": "divider"
 		}
 	]
-}
+}
diff --git a/pkg/event/kind/slack/loader.go b/pkg/event/kind/slack/loader.go
@@ -13,12 +13,13 @@ import (
 
 var _ common.ListenerLoader = (*SlackLoader)(nil)
 
-func NewSlackLoader(messageTemplate, configString, clusterName string, events []testkube.EventType, envs map[string]string) *SlackLoader {
+func NewSlackLoader(messageTemplate, configString, clusterName, dashboardURI string,
+	events []testkube.EventType, envs map[string]string) *SlackLoader {
 	var config []slack.NotificationsConfig
 	if err := json.Unmarshal([]byte(configString), &config); err != nil {
 		log.DefaultLogger.Errorw("error unmarshalling slack config", "error", err)
 	}
-	slackNotifier := slack.NewNotifier(messageTemplate, clusterName, config, envs)
+	slackNotifier := slack.NewNotifier(messageTemplate, clusterName, dashboardURI, config, envs)
 	return &SlackLoader{
 		Log:           log.DefaultLogger,
 		events:        events,

diff --git a/pkg/event/kind/slack/loader_test.go b/pkg/event/kind/slack/loader_test.go
@@ -14,7 +14,7 @@ func TestSlackLoader_Load(t *testing.T) {
 		t.Parallel()
 		// given
 		// default slack notifier is not ready by default
-		l := NewSlackLoader("", "", "", testkube.AllEventTypes, nil)
+		l := NewSlackLoader("", "", "", "", testkube.AllEventTypes, nil)
 
 		// when
 		listeners, err := l.Load()

diff --git a/pkg/slack/slack.go b/pkg/slack/slack.go
@@ -27,6 +27,7 @@ type MessageArgs struct {
 	EndTime       string
 	Duration      string
 	ClusterName   string
+	DashboardURI  string
 	Envs          map[string]string
 }
 
@@ -36,12 +37,14 @@ type Notifier struct {
 	Ready           bool
 	messageTemplate string
 	clusterName     string
+	dashboardURI    string
 	config          *Config
 	envs            map[string]string
 }
 
-func NewNotifier(template, clusterName string, config []NotificationsConfig, envs map[string]string) *Notifier {
-	notifier := Notifier{messageTemplate: template, clusterName: clusterName, config: NewConfig(config), envs: envs}
+func NewNotifier(template, clusterName, dashboardURI string, config []NotificationsConfig, envs map[string]string) *Notifier {
+	notifier := Notifier{messageTemplate: template, clusterName: clusterName, dashboardURI: dashboardURI,
+		config: NewConfig(config), envs: envs}
 	notifier.timestamps = make(map[string]string)
 	if token, ok := os.LookupEnv("SLACK_TOKEN"); ok {
 		log.DefaultLogger.Infow("initializing slack client", "SLACK_TOKEN", token)
@@ -187,6 +190,7 @@ func (s *Notifier) composeTestsuiteMessage(execution *testkube.TestSuiteExecutio
 		TotalSteps:    len(execution.ExecuteStepResults),
 		FailedSteps:   execution.FailedStepsCount(),
 		ClusterName:   s.clusterName,
+		DashboardURI:  s.dashboardURI,
 		Envs:          s.envs,
 	}
 
@@ -223,6 +227,7 @@ func (s *Notifier) composeTestMessage(execution *testkube.Execution, eventType t
 		TotalSteps:    len(execution.ExecutionResult.Steps),
 		FailedSteps:   execution.ExecutionResult.FailedStepsCount(),
 		ClusterName:   s.clusterName,
+		DashboardURI:  s.dashboardURI,
 		Envs:          s.envs,
 	}