Merge pull request #1155 from mumoshu/describe-locks-format-test

Refactor and test `describe locks` output format

deploy/format.go

@@ -0,0 +1,38 @@
+package deploy
+
+import "strings"
+
+func FormatProjectDescs(projects []ProjectDesc) string {
+	var buf strings.Builder
+	for _, pj := range projects {
+		var wroteProjectHeader bool
+		for _, lock := range pj.Phases {
+			if !lock.Locked {
+				continue
+			}
+
+			if !wroteProjectHeader {
+				project := pj.Name
+				buf.WriteString(project)
+				buf.WriteString("\n")
+				wroteProjectHeader = true
+			}
+
+			env := lock.Name
+			buf.WriteString("  ")
+			buf.WriteString(env)
+			buf.WriteString(": ")
+			buf.WriteString("Locked")
+			if len(lock.LockHistory) > 0 {
+				buf.WriteString(" (by ")
+				buf.WriteString(lock.LockHistory[len(lock.LockHistory)-1].User)
+				buf.WriteString(", for ")
+				buf.WriteString(lock.LockHistory[len(lock.LockHistory)-1].Reason)
+				buf.WriteString(")")
+			}
+			buf.WriteString("\n")
+		}
+	}
+
+	return buf.String()
+}

deploy/format_test.go

@@ -0,0 +1,79 @@
+package deploy
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestFormatProjectDescs(t *testing.T) {
+	projects := []ProjectDesc{
+		{
+			Name: "myproject1",
+			Phases: []PhaseDesc{
+				{
+					Name: "prod",
+					Phase: Phase{
+						Locked: true,
+						LockHistory: []LockHistoryItem{
+							{
+								User:   "user1",
+								Reason: "for deployment of revision a",
+							},
+						},
+					},
+				},
+			},
+		},
+		{
+			Name: "myproject1-api",
+			Phases: []PhaseDesc{
+				{
+					Name: "staging",
+					Phase: Phase{
+						Locked: true,
+						LockHistory: []LockHistoryItem{
+							{
+								User:   "user2",
+								Reason: "for deployment of revision b",
+							},
+						},
+					},
+				},
+			},
+		},
+		{
+			Name: "myproject2",
+			Phases: []PhaseDesc{
+				{
+					Name: "prod",
+					Phase: Phase{
+						Locked: true,
+						// There should be 1 or more LockHistoryItem if Locked is true.
+						// But we intentionally omit it here to test the case where
+						// some bug causes LockHistoryItem to be empty.
+					},
+				},
+			},
+		},
+		{
+			Name: "myproject3",
+			Phases: []PhaseDesc{
+				{
+					Name: "staging",
+					Phase: Phase{
+						Locked: false,
+					},
+				},
+			},
+		},
+	}
+
+	require.Equal(t, `myproject1
+  prod: Locked (by user1, for for deployment of revision a)
+myproject1-api
+  staging: Locked (by user2, for for deployment of revision b)
+myproject2
+  prod: Locked
+`, FormatProjectDescs(projects))
+}

slack.go

@@ -335,38 +335,9 @@ func (s *SlackListener) describeLocks() slack.MsgOption {
 		return s.errorMessage(err.Error())
 	}
 
-	var buf strings.Builder
-	for _, pj := range projects {
-		var wroteProjectHeader bool
-		for _, lock := range pj.Phases {
-			if !lock.Locked {
-				continue
-			}
-
-			if !wroteProjectHeader {
-				project := pj.Name
-				buf.WriteString(project)
-				buf.WriteString("\n")
-				wroteProjectHeader = true
-			}
-
-			env := lock.Name
-			buf.WriteString("  ")
-			buf.WriteString(env)
-			buf.WriteString(": ")
-			buf.WriteString("Locked")
-			if len(lock.LockHistory) > 0 {
-				buf.WriteString(" (by ")
-				buf.WriteString(lock.LockHistory[len(lock.LockHistory)-1].User)
-				buf.WriteString(", for ")
-				buf.WriteString(lock.LockHistory[len(lock.LockHistory)-1].Reason)
-				buf.WriteString(")")
-			}
-			buf.WriteString("\n")
-		}
-	}
+	msg := deploy.FormatProjectDescs(projects)
 
-	return s.infoMessage(buf.String())
+	return s.infoMessage(msg)
 }
 
 func (s *SlackListener) checkDeploymentLock(projectID, env string, triggeredBy string, replyIn string) (slack.MsgOption, bool) {