slack: teach ns to post updates to Slack.

Author: hugosantos

go.mod

@@ -87,6 +87,7 @@ require (
 	github.com/protocolbuffers/txtpbfmt v0.0.0-20220608084003-fc78c767cd6a
 	github.com/rs/zerolog v1.20.0
 	github.com/sirupsen/logrus v1.9.3
+	github.com/slack-go/slack v0.12.3
 	github.com/soheilhy/cmux v0.1.5
 	github.com/spf13/cobra v1.7.0
 	github.com/spf13/pflag v1.0.5

go.sum

@@ -411,6 +411,8 @@ github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LB
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0/go.mod h1:fyg7847qk6SyHyPtNmDHnmrv/HOrqktSC+C9fM+CJOE=
 github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI=
+github.com/go-test/deep v1.0.4 h1:u2CU3YKy9I2pmu9pX0eq50wCgjfGIt539SqR7FbHiho=
+github.com/go-test/deep v1.0.4/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA=
 github.com/gobuffalo/logger v1.0.6 h1:nnZNpxYo0zx+Aj9RfMPBm+x9zAU2OayFh/xrAWi34HU=
 github.com/gobuffalo/packd v1.0.1 h1:U2wXfRr4E9DH8IdsDLlRFwTZTK7hLfq9qT/QHXGVe/0=
 github.com/gobuffalo/packr/v2 v2.8.3 h1:xE1yzvnO56cUC0sTpKR3DIbxZgB54AftTFMhB2XEWlY=
@@ -974,6 +976,8 @@ github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic
 github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
 github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
+github.com/slack-go/slack v0.12.3 h1:92/dfFU8Q5XP6Wp5rr5/T5JHLM5c5Smtn53fhToAP88=
+github.com/slack-go/slack v0.12.3/go.mod h1:hlGi5oXA+Gt+yWTPP0plCdRKmjsDxecdHxYQdlMQKOw=
 github.com/soheilhy/cmux v0.1.5 h1:jjzc5WVemNEDTLwv9tlmemhC73tI08BNOIGwBOo10Js=
 github.com/soheilhy/cmux v0.1.5/go.mod h1:T7TcVDs9LWfQgPlPsdngu6I6QIoyIFZDDC6sNE1GqG0=
 github.com/spdx/tools-golang v0.5.1 h1:fJg3SVOGG+eIva9ZUBm/hvyA7PIPVFjRxUKe6fdAgwE=

internal/cli/fncobra/ns/main.go

@@ -225,6 +225,10 @@ func DoMain(name string, autoUpdate bool, registerCommands func(*cobra.Command))
 				"If set to true, ns uses the incluster orchestrator for deployment.")
 			rootCmd.PersistentFlags().BoolVar(&orchestration.RenderOrchestratorDeployment, "render_orchestrator_deployment", orchestration.RenderOrchestratorDeployment,
 				"If set to true, we print a render wait block while deploying the orchestrator itself.")
+			rootCmd.PersistentFlags().StringVar(&orchestration.SlackToken, "slack_token", "",
+				"Token used to call Slack.")
+			rootCmd.PersistentFlags().StringVar(&orchestration.DeployUpdateSlackChannel, "deploy_update_slack_channel", "",
+				"Slack channel to send deployment notifications to.")
 			rootCmd.PersistentFlags().BoolVar(&gcloud.UseHostGCloudBinary, "gcloud_use_host_binary", gcloud.UseHostGCloudBinary,
 				"If set to true, uses a gcloud binary that is available at the host, rather than ns's builtin.")
 			rootCmd.PersistentFlags().BoolVar(&filewatcher.FileWatcherUsePolling, "filewatcher_use_polling",
@@ -267,6 +271,8 @@ func DoMain(name string, autoUpdate bool, registerCommands func(*cobra.Command))
 				"filewatcher_use_polling",
 				"k3d_ignore_docker_version",
 				"kubernetes_force_apply",
+				"slack_token",
+				"slack_channel",
 				// Hidden for M0
 				"testing_use_namespace_cloud",
 				"testing_use_namespace_cloud_build",

orchestration/migration.go

@@ -7,7 +7,10 @@ package orchestration
 import (
 	"context"
 	"fmt"
+	"os"
+	"time"
 
+	"github.com/slack-go/slack"
 	"namespacelabs.dev/foundation/internal/console"
 	"namespacelabs.dev/foundation/internal/fnerrors"
 	"namespacelabs.dev/foundation/internal/planning/deploy"
@@ -24,6 +27,7 @@ import (
 const orchestratorVersion = 25
 
 var DeployWithOrchestrator = false
+var DeployUpdateSlackChannel, SlackToken string
 
 func ExecuteOpts() execution.ExecuteOpts {
 	return execution.ExecuteOpts{
@@ -38,14 +42,36 @@ func Deploy(ctx context.Context, env cfg.Context, cluster runtime.ClusterNamespa
 			return fnerrors.BadInputError("waiting is mandatory without the orchestrator")
 		}
 
+		observeError := func(context.Context, error) {}
+		if DeployUpdateSlackChannel != "" {
+			if SlackToken == "" {
+				return fnerrors.BadInputError("a slack token is required to be able to update a channel")
+			}
+
+			start := time.Now()
+			slackcli := slack.New(os.ExpandEnv(SlackToken))
+			chid, ts, err := slackcli.PostMessageContext(ctx, os.ExpandEnv(DeployUpdateSlackChannel), slack.MsgOptionBlocks(renderSlackMessage(plan, start, time.Time{}, nil)...))
+			if err != nil {
+				fmt.Fprintf(console.Warnings(ctx), "Failed to post to Slack: %v\n", err)
+			} else {
+				observeError = func(ctx context.Context, err error) {
+					if _, _, _, err := slackcli.UpdateMessageContext(ctx, chid, ts, slack.MsgOptionBlocks(renderSlackMessage(plan, start, time.Now(), err)...)); err != nil {
+						fmt.Fprintf(console.Warnings(ctx), "Failed to update Slack: %v\n", err)
+					}
+				}
+			}
+		}
+
 		p := execution.NewPlan(plan.Program.Invocation...)
 
 		// Make sure that the cluster is accessible to a serialized invocation implementation.
-		return execution.ExecuteExt(ctx, "deployment.execute", p,
+		execErr := execution.ExecuteExt(ctx, "deployment.execute", p,
 			deploy.MaybeRenderBlock(env, cluster, outputProgress),
 			ExecuteOpts(),
 			execution.FromContext(env),
 			runtime.InjectCluster(cluster))
+		observeError(ctx, execErr)
+		return execErr
 	}
 
 	return tasks.Action("orchestrator.deploy").Scope(schema.PackageNames(plan.FocusServer...)...).

orchestration/slack.go

@@ -0,0 +1,112 @@
+// Copyright 2022 Namespace Labs Inc; All rights reserved.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+
+package orchestration
+
+import (
+	"fmt"
+	"os"
+	"strings"
+	"time"
+
+	"github.com/slack-go/slack"
+	"k8s.io/utils/strings/slices"
+	"namespacelabs.dev/foundation/schema"
+)
+
+func renderSlackMessage(plan *schema.DeployPlan, start, end time.Time, err error) []slack.Block {
+	var blocks []slack.Block
+	blocks = append(blocks, slack.NewHeaderBlock(slack.NewTextBlockObject(slack.PlainTextType, timeEmoji(end, err)+" "+deployLabel(end), true, false)))
+	blocks = append(blocks, slack.NewSectionBlock(slack.NewTextBlockObject(slack.MarkdownType,
+		fmt.Sprintf("%s *%s*%s with:",
+			workingLabel(end, err),
+			plan.GetEnvironment().GetName(),
+			maybeFrom()), false, false), nil, nil))
+	blocks = append(blocks, slack.NewSectionBlock(slack.NewTextBlockObject(slack.MarkdownType,
+		strings.Join(servers(plan), "\n"), false, false), nil, nil))
+	if !end.IsZero() {
+		blocks = append(blocks, slack.NewSectionBlock(slack.NewTextBlockObject(slack.MarkdownType,
+			maybeTook(start, end), false, false), nil, nil))
+	}
+	if err != nil {
+		blocks = append(blocks, slack.NewSectionBlock(slack.NewTextBlockObject(slack.MarkdownType,
+			fmt.Sprintf("*Error* %v", err), false, false), nil, nil))
+	}
+	return blocks
+}
+
+func deployLabel(end time.Time) string {
+	if end.IsZero() {
+		return "Deploying"
+	}
+
+	return "Deployed"
+}
+
+func workingLabel(end time.Time, err error) string {
+	if end.IsZero() {
+		return "Updating"
+	}
+
+	if err != nil {
+		return "Failed to update"
+	}
+
+	return "Updated"
+}
+
+func servers(plan *schema.DeployPlan) []string {
+	var fo []string
+
+	for _, ent := range plan.Stack.Entry {
+		srv := ent.GetPackageName().String()
+		if slices.Contains(plan.FocusServer, srv) {
+			srv = fmt.Sprintf("*%s*", srv)
+		}
+		fo = append(fo, " · "+srv)
+	}
+
+	return fo
+}
+
+func timeEmoji(end time.Time, err error) string {
+	if end.IsZero() {
+		return ":hourglass_flowing_sand:"
+	}
+
+	if err != nil {
+		return ":boom:"
+	}
+
+	return ":white_check_mark:"
+}
+
+func maybeTook(start, end time.Time) string {
+	if end.IsZero() {
+		return ""
+	}
+
+	return fmt.Sprintf("took %v", end.Sub(start))
+}
+
+func maybeFrom() string {
+	if bkUrl := os.Getenv("BUILDKITE_BUILD_URL"); bkUrl != "" {
+		name := os.Getenv("BUILDKITE_PIPELINE_NAME")
+		if name == "" {
+			name = "Buildkite"
+		} else {
+			if number := os.Getenv("BUILDKITE_BUILD_NUMBER"); number != "" {
+				name += " #" + number
+			}
+		}
+
+		if jobId := os.Getenv("BUILDKITE_JOB_ID"); jobId != "" {
+			bkUrl += "#" + jobId
+		}
+
+		return fmt.Sprintf(" from <%s|%s>", bkUrl, name)
+	}
+
+	return ""
+}