Merge pull request #1377 from snyk/feat/improve_snyk_piping

Improve snyk piping

Author: eliecharra

main.go

@@ -17,6 +17,7 @@ import (
 	"github.com/snyk/driftctl/pkg/config"
 	"github.com/snyk/driftctl/pkg/version"
 	"github.com/snyk/driftctl/sentry"
+	"github.com/spf13/viper"
 )
 
 func init() {
@@ -33,12 +34,20 @@ func run() int {
 	config.Init()
 	logger.Init()
 	build := build.Build{}
+	// Check whether driftCTL is run under Snyk CLI
+	isSnyk := viper.GetBool("IS_SNYK")
 	logrus.WithFields(logrus.Fields{
 		"isRelease":               fmt.Sprintf("%t", build.IsRelease()),
 		"isUsageReportingEnabled": fmt.Sprintf("%t", build.IsUsageReportingEnabled()),
 		"version":                 version.Current(),
+		"isSnyk":                  fmt.Sprintf("%t", isSnyk),
 	}).Debug("Build info")
 
+	// Enable colorization when driftctl is launched under snyk cli (piped)
+	if isSnyk {
+		color.NoColor = false
+	}
+
 	driftctlCmd := cmd.NewDriftctlCmd(build)
 
 	checkVersion := driftctlCmd.ShouldCheckVersion()

pkg/cmd/scan/output/output.go

@@ -80,19 +80,10 @@ func GetPrinter(config OutputConfig, quiet bool) output.Printer {
 
 	switch config.Key {
 	case JSONOutputType:
-		if isStdOut(config.Path) {
-			return &output.VoidPrinter{}
-		}
 		fallthrough
 	case PlanOutputType:
-		if isStdOut(config.Path) {
-			return &output.VoidPrinter{}
-		}
 		fallthrough
 	case HTMLOutputType:
-		if isStdOut(config.Path) {
-			return &output.VoidPrinter{}
-		}
 		fallthrough
 	case ConsoleOutputType:
 		fallthrough

pkg/cmd/scan/output/output_test.go

@@ -573,13 +573,13 @@ func TestGetPrinter(t *testing.T) {
 			name: "json stdout output",
 			path: "stdout",
 			key:  JSONOutputType,
-			want: &output.VoidPrinter{},
+			want: &output.ConsolePrinter{},
 		},
 		{
 			name: "json /dev/stdout output",
 			path: "/dev/stdout",
 			key:  JSONOutputType,
-			want: &output.VoidPrinter{},
+			want: &output.ConsolePrinter{},
 		},
 		{
 			name: "console stdout output",
@@ -604,25 +604,25 @@ func TestGetPrinter(t *testing.T) {
 			name: "jsonplan stdout output",
 			path: "stdout",
 			key:  PlanOutputType,
-			want: &output.VoidPrinter{},
+			want: &output.ConsolePrinter{},
 		},
 		{
 			name: "jsonplan /dev/stdout output",
 			path: "/dev/stdout",
 			key:  PlanOutputType,
-			want: &output.VoidPrinter{},
+			want: &output.ConsolePrinter{},
 		},
 		{
 			name: "html stdout output",
 			path: "stdout",
 			key:  HTMLOutputType,
-			want: &output.VoidPrinter{},
+			want: &output.ConsolePrinter{},
 		},
 		{
 			name: "html /dev/stdout output",
 			path: "/dev/stdout",
 			key:  HTMLOutputType,
-			want: &output.VoidPrinter{},
+			want: &output.ConsolePrinter{},
 		},
 	}
 	for _, tt := range tests {
@@ -645,14 +645,14 @@ func TestShouldPrint(t *testing.T) {
 		want    bool
 	}{
 		{
-			name: "test stdout prevents printing",
+			name: "test stdout should not prevents printing",
 			outputs: []OutputConfig{
 				{
 					Path: "stdout",
 					Key:  JSONOutputType,
 				},
 			},
-			want: false,
+			want: true,
 		},
 		{
 			name: "test output to file doesn't prevent printing",
@@ -665,7 +665,18 @@ func TestShouldPrint(t *testing.T) {
 			want: true,
 		},
 		{
-			name: "test stdout prevents printing",
+			name: "test quiet should prevents printing",
+			outputs: []OutputConfig{
+				{
+					Path: "result.json",
+					Key:  JSONOutputType,
+				},
+			},
+			quiet: true,
+			want:  false,
+		},
+		{
+			name: "test stdout should not prevents printing",
 			outputs: []OutputConfig{
 				{
 					Path: "result.json",
@@ -676,7 +687,7 @@ func TestShouldPrint(t *testing.T) {
 					Key:  PlanOutputType,
 				},
 			},
-			want: false,
+			want: true,
 		},
 	}
 	for _, tt := range tests {

pkg/output/printer.go

@@ -1,6 +1,9 @@
 package output
 
-import "fmt"
+import (
+	"fmt"
+	"os"
+)
 
 var globalPrinter Printer = &VoidPrinter{}
 
@@ -23,7 +26,7 @@ func NewConsolePrinter() *ConsolePrinter {
 }
 
 func (c *ConsolePrinter) Printf(format string, args ...interface{}) {
-	fmt.Printf(format, args...)
+	_, _ = fmt.Fprintf(os.Stderr, format, args...)
 }
 
 type VoidPrinter struct{}