[1.8.x] command: when generating envoy bootstrap configs to stdout do not mix informational logs into the json (#9985)

Backport of #9980 to `1.8.x`

Conflicts:
- just the generated golden command/ files
- envoy.go and envoy_test.go

.changelog/9980.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+command: when generating envoy bootstrap configs to stdout do not mix informational logs into the json
+```

command/connect/envoy/envoy.go

@@ -23,13 +23,6 @@ import (
 )
 
 func New(ui cli.Ui) *cmd {
-	ui = &cli.PrefixedUi{
-		OutputPrefix: "==> ",
-		InfoPrefix:   "    ",
-		ErrorPrefix:  "==> ",
-		Ui:           ui,
-	}
-
 	c := &cmd{UI: ui}
 	c.init()
 	return c
@@ -352,7 +345,11 @@ func (c *cmd) run(args []string) int {
 			return 1
 		}
 
-		c.UI.Output(fmt.Sprintf("Registered service: %s", svc.Name))
+		if !c.bootstrap {
+			// We need stdout to be reserved exclusively for the JSON blob, so
+			// we omit logging this to Info which also writes to stdout.
+			c.UI.Info(fmt.Sprintf("Registered service: %s", svc.Name))
+		}
 	}
 
 	// Generate config
@@ -364,7 +361,7 @@ func (c *cmd) run(args []string) int {
 
 	if c.bootstrap {
 		// Just output it and we are done
-		os.Stdout.Write(bootstrapJson)
+		c.UI.Output(string(bootstrapJson))
 		return 0
 	}
 
@@ -523,7 +520,6 @@ func (c *cmd) grpcAddress(httpCfg *api.Config) (GRPC, error) {
 			// This is the dev mode default and recommended production setting if
 			// enabled.
 			port = 8502
-			c.UI.Info(fmt.Sprintf("Defaulting to grpc port = %d", port))
 		}
 		addr = fmt.Sprintf("localhost:%v", port)
 	}

command/connect/envoy/envoy_test.go

@@ -3,7 +3,6 @@ package envoy
 import (
 	"encoding/json"
 	"flag"
-	"github.com/stretchr/testify/assert"
 	"io/ioutil"
 	"net"
 	"net/http"
@@ -13,12 +12,14 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/mitchellh/cli"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
 	"github.com/hashicorp/consul/agent"
 	"github.com/hashicorp/consul/agent/xds"
 	"github.com/hashicorp/consul/api"
 	"github.com/hashicorp/consul/sdk/testutil"
-	"github.com/mitchellh/cli"
-	"github.com/stretchr/testify/require"
 )
 
 var update = flag.Bool("update", false, "update golden files")
@@ -770,10 +771,7 @@ func TestGenerateConfig(t *testing.T) {
 			require.NoError(err) // Error cases should have returned above
 			require.Equal(&tc.WantArgs, got)
 
-			// Actual template output goes to stdout direct to avoid prefix in UI, so
+			actual := ui.OutputWriter.Bytes()
-			// generate it again here to assert on.
-			actual, err := c.generateConfig()
-			require.NoError(err)
 
 			// If we got the arg handling write, verify output
 			golden := filepath.Join("testdata", tc.Name+".golden")

command/connect/envoy/testdata/CONSUL_HTTP_ADDR-with-https-scheme-enables-tls.golden

@@ -123,3 +123,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/access-log-path.golden

@@ -114,3 +114,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/custom-bootstrap.golden

@@ -13,4 +13,4 @@
     "id": "test-proxy"
   },
   "custom_field": "foo"
-}
+}

command/connect/envoy/testdata/defaults.golden

@@ -114,3 +114,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/existing-ca-file.golden

@@ -123,3 +123,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/existing-ca-path.golden

@@ -123,3 +123,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/extra_-multiple.golden

@@ -136,3 +136,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/extra_-single.golden

@@ -127,3 +127,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/grpc-addr-config.golden

@@ -114,3 +114,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/grpc-addr-env.golden

@@ -114,3 +114,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/grpc-addr-flag.golden

@@ -114,3 +114,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/grpc-addr-unix.golden

@@ -113,3 +113,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/ingress-gateway-address-specified.golden

@@ -187,3 +187,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/ingress-gateway-no-auto-register.golden

@@ -187,3 +187,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/ingress-gateway-register-with-service-and-proxy-id.golden

@@ -187,3 +187,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/ingress-gateway-register-with-service-without-proxy-id.golden

@@ -187,3 +187,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/ingress-gateway.golden

@@ -187,3 +187,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/stats-config-override.golden

@@ -72,3 +72,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/token-arg.golden

@@ -114,3 +114,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/token-env.golden

@@ -114,3 +114,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/token-file-arg.golden

@@ -114,3 +114,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/token-file-env.golden

@@ -114,3 +114,4 @@
     ]
   }
 }
+

command/connect/envoy/testdata/zipkin-tracing-config.golden

@@ -147,3 +147,4 @@
     ]
   }
 }
+