From d282f33a22072525db102ba5b2f5952f001f70ed Mon Sep 17 00:00:00 2001
From: Denis Bilenko <denis.bilenko@databricks.com>
Date: Mon, 10 Feb 2025 14:00:49 +0100
Subject: [PATCH] Append newline to "-o json" for validate/summary/run (#2326)

## Changes
- Insert newline after rendering indented JSON in bundle
validate/summary/run.
- This prevents "No newline at end of file" message in various cases,
for example when switching between recording raw output of the command
to output processed by jq, since jq does add a newline or when running
diff in acceptance tests.

## Tests
Manually running validate:

```
~/work/dabs_cuj_brickfood % ../cli/cli-main bundle validate -o json | tail -n 2  # without change
Error: root_path must start with '~/' or contain the current username to ensure uniqueness when using 'mode: development'

  }
}%
~/work/dabs_cuj_brickfood % ../cli/cli bundle validate -o json | tail -n 2  # with change
Error: root_path must start with '~/' or contain the current username to ensure uniqueness when using 'mode: development'

  }
}
~/work/dabs_cuj_brickfood %
```

Via #2316 -- see cleaner output there.
---
 acceptance/bundle/variables/host/output.txt | 1 +
 cmd/bundle/run.go                           | 1 +
 cmd/bundle/summary.go                       | 1 +
 cmd/bundle/validate.go                      | 4 +++-
 4 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/acceptance/bundle/variables/host/output.txt b/acceptance/bundle/variables/host/output.txt
index 63c41426a..df0a4527a 100644
--- a/acceptance/bundle/variables/host/output.txt
+++ b/acceptance/bundle/variables/host/output.txt
@@ -23,6 +23,7 @@ Error: failed during request visitor: parse "https://${var.host}": invalid chara
     "host": "${var.host}"
   }
 }
+
 Exit code: 1
 
 >>> errcode [CLI] bundle validate
diff --git a/cmd/bundle/run.go b/cmd/bundle/run.go
index df35d7222..ffb9c1b88 100644
--- a/cmd/bundle/run.go
+++ b/cmd/bundle/run.go
@@ -173,6 +173,7 @@ task or a Python wheel task, the second example applies.
 				if err != nil {
 					return err
 				}
+				_, _ = cmd.OutOrStdout().Write([]byte{'\n'})
 			default:
 				return fmt.Errorf("unknown output type %s", root.OutputType(cmd))
 			}
diff --git a/cmd/bundle/summary.go b/cmd/bundle/summary.go
index 7c669c845..2871c82ff 100644
--- a/cmd/bundle/summary.go
+++ b/cmd/bundle/summary.go
@@ -74,6 +74,7 @@ func newSummaryCommand() *cobra.Command {
 				return err
 			}
 			_, _ = cmd.OutOrStdout().Write(buf)
+			_, _ = cmd.OutOrStdout().Write([]byte{'\n'})
 		default:
 			return fmt.Errorf("unknown output type %s", root.OutputType(cmd))
 		}
diff --git a/cmd/bundle/validate.go b/cmd/bundle/validate.go
index 41fa87f30..c45453af6 100644
--- a/cmd/bundle/validate.go
+++ b/cmd/bundle/validate.go
@@ -20,7 +20,9 @@ func renderJsonOutput(cmd *cobra.Command, b *bundle.Bundle) error {
 	if err != nil {
 		return err
 	}
-	_, _ = cmd.OutOrStdout().Write(buf)
+	out := cmd.OutOrStdout()
+	_, _ = out.Write(buf)
+	_, _ = out.Write([]byte{'\n'})
 	return nil
 }