fix(commands): run tests in ./commands/... without ANSI color

Steve Moyer created 2 years ago

Resolves #926

Change summary

commands/bug/testenv/testenv.go | 17 +++++++++++++++++
1 file changed, 17 insertions(+)

Detailed changes

commands/bug/testenv/testenv.go

@@ -3,6 +3,7 @@ package testenv
 import (
 	"testing"
 
+	"github.com/fatih/color"
 	"github.com/stretchr/testify/require"
 
 	"github.com/MichaelMure/git-bug/commands/execenv"
@@ -17,6 +18,22 @@ const (
 func NewTestEnvAndUser(t *testing.T) (*execenv.Env, entity.Id) {
 	t.Helper()
 
+	// The Go testing framework either uses os.Stdout directly or a buffer
+	// depending on how the command is initially launched.  This results
+	// in os.Stdout.Fd() sometimes being a Terminal, and other times not
+	// being a Terminal which determines whether the ANSI library sends
+	// escape sequences to colorize the text.
+	//
+	// The line below disables all colorization during testing so that the
+	// git-bug command output is consistent in all test scenarios.
+	//
+	// See:
+	// - https://github.com/MichaelMure/git-bug/issues/926
+	// - https://github.com/golang/go/issues/57671
+	// - https://github.com/golang/go/blob/f721fa3be9bb52524f97b409606f9423437535e8/src/cmd/go/internal/test/test.go#L1180-L1208
+	// - https://github.com/golang/go/issues/34877
+	color.NoColor = true
+
 	testEnv := execenv.NewTestEnv(t)
 
 	i, err := testEnv.Backend.Identities().New(testUserName, testUserEmail)