test(commands): snapshot representative output contracts (#69)

Author: matoous

internal/commands/members/members_output_internal_test.go

@@ -2,6 +2,8 @@ package members
 
 import (
 	"bytes"
+	"regexp"
+	"strings"
 	"testing"
 	"time"
 
@@ -23,7 +25,7 @@ func TestRenderDeleteMemberResult(t *testing.T) {
 		err := renderDeleteMemberResult(appCtx)
 
 		require.NoError(t, err)
-		assert.Contains(t, out.String(), `"status": "deleted"`)
+		assert.Equal(t, "{\n  \"status\": \"deleted\"\n}\n", out.String())
 	})
 
 	t.Run("writes status message in human mode", func(t *testing.T) {
@@ -34,7 +36,7 @@ func TestRenderDeleteMemberResult(t *testing.T) {
 		err := renderDeleteMemberResult(appCtx)
 
 		require.NoError(t, err)
-		assert.Contains(t, statusOut.String(), "Member deleted")
+		assert.Equal(t, "✓ Member deleted\n", statusOut.String())
 	})
 }
 
@@ -56,7 +58,22 @@ func TestRenderMember(t *testing.T) {
 		err := renderMember(&app.Context{Output: &out, ExactTimestamps: true}, &out, member)
 
 		require.NoError(t, err)
-		assert.Contains(t, out.String(), createdAt.In(time.Local).Format(time.RFC3339))
-		assert.Contains(t, out.String(), updatedAt.In(time.Local).Format(time.RFC3339))
+		assert.Equal(t, "ID: member-1\nEmail: member@example.com\nRoles: role_employee\nStatus: Accepted\nNickname: -\nCreated At: "+createdAt.In(time.Local).Format(time.RFC3339)+"\nUpdated At: "+updatedAt.In(time.Local).Format(time.RFC3339), normalizeOutput(out.String()))
 	})
 }
+
+var ansiPattern = regexp.MustCompile(`\x1b\[[0-9;]*m`)
+
+func normalizeOutput(value string) string {
+	value = ansiPattern.ReplaceAllString(strings.ReplaceAll(value, "\r\n", "\n"), "")
+	lines := strings.Split(value, "\n")
+	normalized := make([]string, 0, len(lines))
+	for _, line := range lines {
+		line = strings.TrimSpace(line)
+		if line == "" {
+			continue
+		}
+		normalized = append(normalized, line)
+	}
+	return strings.Join(normalized, "\n")
+}

internal/commands/roles/roles_output_test.go

@@ -0,0 +1,49 @@
+package roles_test
+
+import (
+	"bytes"
+	"context"
+	"regexp"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/sumup/sumup-cli/internal/app"
+	"github.com/sumup/sumup-cli/internal/commands/roles"
+)
+
+func TestNewCommand(t *testing.T) {
+	t.Run("list renders the human output contract", func(t *testing.T) {
+		var out bytes.Buffer
+
+		cmd := roles.NewCommand()
+		cmd.Commands[0].Metadata = map[string]any{
+			app.ContextKey: &app.Context{Output: &out},
+		}
+
+		listCmd := cmd.Commands[0]
+
+		err := listCmd.Action(context.Background(), listCmd)
+
+		require.NoError(t, err)
+		assert.Equal(t, "Roles\nRole Display Name Description\nrole_owner Owner Full administrative access to the merchant account\nrole_admin Admin Administrative access with some restrictions\nrole_employee Employee Standard employee access for daily operations\nrole_manager Manager Management access with elevated permissions\nrole_cashier Cashier Limited access for point-of-sale operations", normalizeOutput(out.String()))
+	})
+}
+
+var ansiPattern = regexp.MustCompile(`\x1b\[[0-9;]*m`)
+
+func normalizeOutput(value string) string {
+	value = ansiPattern.ReplaceAllString(strings.ReplaceAll(value, "\r\n", "\n"), "")
+	lines := strings.Split(value, "\n")
+	normalized := make([]string, 0, len(lines))
+	for _, line := range lines {
+		line = strings.Join(strings.Fields(line), " ")
+		if line == "" {
+			continue
+		}
+		normalized = append(normalized, line)
+	}
+	return strings.Join(normalized, "\n")
+}

internal/commands/transactions/transactions_output_internal_test.go

@@ -18,7 +18,7 @@ func TestRenderRefundResult(t *testing.T) {
 		err := renderRefundResult(appCtx)
 
 		require.NoError(t, err)
-		assert.Contains(t, statusOut.String(), "Transaction refunded")
+		assert.Equal(t, "✓ Transaction refunded\n", statusOut.String())
 	})
 
 	t.Run("prints json acknowledgement when requested", func(t *testing.T) {
@@ -32,6 +32,6 @@ func TestRenderRefundResult(t *testing.T) {
 		err := renderRefundResult(appCtx)
 
 		require.NoError(t, err)
-		assert.Contains(t, out.String(), `"status": "refunded"`)
+		assert.Equal(t, "{\n  \"status\": \"refunded\"\n}\n", out.String())
 	})
 }