Ensure command prints to stdout (#245)

Author: bplunkett-stripe

cmd/pg-schema-diff/apply_cmd.go

@@ -59,12 +59,12 @@ func buildApplyCmd() *cobra.Command {
 		if err != nil {
 			return err
 		} else if len(plan.Statements) == 0 {
-			cmd.Println("Schema matches expected. No plan generated")
+			cmdPrintln(cmd, "Schema matches expected. No plan generated")
 			return nil
 		}
 
-		cmd.Println(header("Review plan"))
-		cmd.Print(planToPrettyS(plan), "\n\n")
+		cmdPrintln(cmd, header("Review plan"))
+		cmdPrint(cmd, planToPrettyS(plan), "\n\n")
 
 		if err := failIfHazardsNotAllowed(plan, *allowedHazardsTypesStrs); err != nil {
 			return err
@@ -84,7 +84,7 @@ func buildApplyCmd() *cobra.Command {
 		if err := runPlan(cmd.Context(), cmd, connConfig, plan); err != nil {
 			return err
 		}
-		cmd.Println("Schema applied successfully")
+		cmdPrintln(cmd, "Schema applied successfully")
 		return nil
 	}
 
@@ -143,8 +143,8 @@ func runPlan(ctx context.Context, cmd *cobra.Command, connConfig *pgx.ConnConfig
 	// must be executed within its own transaction block. Postgres will error if you try to set a TRANSACTION-level
 	// timeout for it. SESSION-level statement_timeouts are respected by `ADD INDEX CONCURRENTLY`
 	for i, stmt := range plan.Statements {
-		cmd.Println(header(fmt.Sprintf("Executing statement %d", getDisplayableStmtIdx(i))))
-		cmd.Printf("%s\n\n", statementToPrettyS(stmt))
+		cmdPrintln(cmd, header(fmt.Sprintf("Executing statement %d", getDisplayableStmtIdx(i))))
+		cmdPrintf(cmd, "%s\n\n", statementToPrettyS(stmt))
 		start := time.Now()
 		if _, err := conn.ExecContext(ctx, fmt.Sprintf("SET SESSION statement_timeout = %d", stmt.Timeout.Milliseconds())); err != nil {
 			return fmt.Errorf("setting statement timeout: %w", err)
@@ -155,9 +155,9 @@ func runPlan(ctx context.Context, cmd *cobra.Command, connConfig *pgx.ConnConfig
 		if _, err := conn.ExecContext(ctx, stmt.ToSQL()); err != nil {
 			return fmt.Errorf("executing migration statement. the database maybe be in a dirty state: %s: %w", stmt, err)
 		}
-		cmd.Printf("Finished executing statement. Duration: %s\n", time.Since(start))
+		cmdPrintf(cmd, "Finished executing statement. Duration: %s\n", time.Since(start))
 	}
-	cmd.Println(header("Complete"))
+	cmdPrintln(cmd, header("Complete"))
 
 	return nil
 }

cmd/pg-schema-diff/cli.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	"github.com/manifoldco/promptui"
+	"github.com/spf13/cobra"
 )
 
 func header(header string) string {
@@ -44,3 +45,18 @@ func mustContinuePrompt(continueLabel string) error {
 	}
 	return nil
 }
+
+// cmdPrint writes the arguments to stdout using cmd.OutOrStdout() to ensure consistent output behavior
+func cmdPrint(cmd *cobra.Command, a ...interface{}) {
+	fmt.Fprint(cmd.OutOrStdout(), a...)
+}
+
+// cmdPrintf writes the formatted string to stdout using cmd.OutOrStdout() to ensure consistent output behavior
+func cmdPrintf(cmd *cobra.Command, format string, a ...interface{}) {
+	fmt.Fprintf(cmd.OutOrStdout(), format, a...)
+}
+
+// cmdPrintln writes the arguments to stdout with a newline using cmd.OutOrStdout() to ensure consistent output behavior
+func cmdPrintln(cmd *cobra.Command, a ...interface{}) {
+	fmt.Fprintln(cmd.OutOrStdout(), a...)
+}

cmd/pg-schema-diff/plan_cmd.go

@@ -99,7 +99,7 @@ func buildPlanCmd() *cobra.Command {
 			return err
 		}
 
-		cmd.Println(outputFmt.convertToOutputString(plan))
+		cmdPrintln(cmd, outputFmt.convertToOutputString(plan))
 		return nil
 	}
 

cmd/pg-schema-diff/version_cmd.go

@@ -17,7 +17,7 @@ func buildVersionCmd() *cobra.Command {
 		if !ok {
 			return fmt.Errorf("build information not available")
 		}
-		cmd.Printf("version=%s\n", buildInfo.Main.Version)
+		cmdPrintf(cmd, "version=%s\n", buildInfo.Main.Version)
 
 		return nil
 	}