fix: use toast formatting for terraform test results

Author: osterman

cmd/terraform/test.go

@@ -18,6 +18,7 @@ import (
 	"github.com/cloudposse/atmos/pkg/flags"
 	h "github.com/cloudposse/atmos/pkg/hooks"
 	"github.com/cloudposse/atmos/pkg/ui"
+	"github.com/cloudposse/atmos/pkg/ui/theme"
 )
 
 // testParser handles flag parsing for the test command.
@@ -172,25 +173,33 @@ func formatTerraformTestStatusLine(line string) string {
 	if len(body) != len(line) {
 		ending = terraformTestOutputNewline
 	}
-	if !strings.Contains(ansi.Strip(body), "...") {
+	plain := ansi.Strip(body)
+	if !strings.Contains(plain, "...") {
 		return line
 	}
-	match := terraformTestStatusSuffixRE.FindStringSubmatchIndex(body)
+	match := terraformTestStatusSuffixRE.FindStringSubmatchIndex(plain)
 	if match == nil {
 		return line
 	}
-	status := body[match[2]:match[3]]
-	prefix := body[:match[0]]
+	status := plain[match[2]:match[3]]
+	text := strings.TrimLeft(plain, " \t")
 	switch status {
 	case "pass":
-		return prefix + ui.FormatSuccess(status) + ending
+		return formatTerraformTestToast(theme.IconCheckmark, text, ending, line)
 	case "fail", "error":
-		return prefix + ui.FormatError(status) + ending
+		return formatTerraformTestToast(theme.IconXMark, text, ending, line)
 	default:
 		return line
 	}
 }
 
+func formatTerraformTestToast(icon, text, ending, fallback string) string {
+	if ui.Format == nil {
+		return fallback
+	}
+	return strings.TrimSuffix(ui.Format.Toast(icon, text), terraformTestOutputNewline) + ending
+}
+
 // appendJSONFlag adds `-json` to the terraform test pass-through flags unless it
 // is already present, so CI runs emit the machine-readable event stream. Both
 // Terraform and OpenTofu support `test -json`, so this is tool-agnostic and does

cmd/terraform/test_test.go

@@ -2,14 +2,42 @@ package terraform
 
 import (
 	"bytes"
+	stdio "io"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	"github.com/cloudposse/atmos/pkg/ansi"
+	iolib "github.com/cloudposse/atmos/pkg/io"
+	"github.com/cloudposse/atmos/pkg/ui"
 )
 
+type terraformTestStreams struct {
+	stdin  stdio.Reader
+	stdout stdio.Writer
+	stderr stdio.Writer
+}
+
+func (s *terraformTestStreams) Input() stdio.Reader     { return s.stdin }
+func (s *terraformTestStreams) Output() stdio.Writer    { return s.stdout }
+func (s *terraformTestStreams) Error() stdio.Writer     { return s.stderr }
+func (s *terraformTestStreams) RawOutput() stdio.Writer { return s.stdout }
+func (s *terraformTestStreams) RawError() stdio.Writer  { return s.stderr }
+
+func initTerraformTestUI(t *testing.T) {
+	t.Helper()
+	streams := &terraformTestStreams{
+		stdin:  &bytes.Buffer{},
+		stdout: &bytes.Buffer{},
+		stderr: &bytes.Buffer{},
+	}
+	ioCtx, err := iolib.NewContext(iolib.WithStreams(streams))
+	require.NoError(t, err)
+	ui.InitFormatter(ioCtx)
+	t.Cleanup(ui.Reset)
+}
+
 func TestAppendJSONFlag(t *testing.T) {
 	t.Run("appends when missing", func(t *testing.T) {
 		got := appendJSONFlag([]string{"-run=smoke"})
@@ -44,22 +72,22 @@ func TestFormatTerraformTestStatusLine(t *testing.T) {
 		{
 			name: "success",
 			line: "  run \"ok\"... pass\n",
-			want: "  run \"ok\"... ✓ pass\n",
+			want: "✓ run \"ok\"... pass\n",
 		},
 		{
 			name: "failure",
 			line: "  run \"broken\"... fail\n",
-			want: "  run \"broken\"... ✗ fail\n",
+			want: "✗ run \"broken\"... fail\n",
 		},
 		{
 			name: "error",
 			line: "tests/app.tftest.hcl... error\n",
-			want: "tests/app.tftest.hcl... ✗ error\n",
+			want: "✗ tests/app.tftest.hcl... error\n",
 		},
 		{
 			name: "strips terraform status color",
 			line: "tests/app.tftest.hcl... \x1b[32mpass\x1b[0m\n",
-			want: "tests/app.tftest.hcl... ✓ pass\n",
+			want: "✓ tests/app.tftest.hcl... pass\n",
 		},
 		{
 			name: "in progress unchanged",
@@ -75,12 +103,14 @@ func TestFormatTerraformTestStatusLine(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+			initTerraformTestUI(t)
 			assert.Equal(t, tt.want, ansi.Strip(formatTerraformTestStatusLine(tt.line)))
 		})
 	}
 }
 
 func TestTerraformTestStatusWriterBuffersPartialLines(t *testing.T) {
+	initTerraformTestUI(t)
 	var out bytes.Buffer
 	w := newTerraformTestStatusWriter(&out)
 
@@ -92,5 +122,5 @@ func TestTerraformTestStatusWriterBuffersPartialLines(t *testing.T) {
 	n, err = w.Write([]byte("ss\n  run \"broken\"... fail\n"))
 	require.NoError(t, err)
 	assert.Equal(t, len("ss\n  run \"broken\"... fail\n"), n)
-	assert.Equal(t, "  run \"ok\"... ✓ pass\n  run \"broken\"... ✗ fail\n", ansi.Strip(out.String()))
+	assert.Equal(t, "✓ run \"ok\"... pass\n✗ run \"broken\"... fail\n", ansi.Strip(out.String()))
 }