Make sure that all the standard templates are embedded correctly

Signed-off-by: Jan Dubois <[email protected]>

Author: jandubois

hack/test-port-forwarding.pl

@@ -211,11 +211,11 @@ sub JoinHostPort {
 # "ipv4" and "ipv6" will be replaced by the actual host ipv4 and ipv6 addresses.
 __DATA__
 portForwards:
-  # We can't test that port 22 will be blocked because the guestagent has
-  # been ignoring it since startup, so the log message is in the part of
-  # the log we skipped.
-  # skip: 127.0.0.1 22 → 127.0.0.1 2222
-  # ignore: 127.0.0.1 sshLocalPort
+# We can't test that port 22 will be blocked because the guestagent has
+# been ignoring it since startup, so the log message is in the part of
+# the log we skipped.
+# skip: 127.0.0.1 22 → 127.0.0.1 2222
+# ignore: 127.0.0.1 sshLocalPort
 
 - guestIP: 127.0.0.2
   guestPortRange: [3000, 3009]

hack/test-templates.sh

@@ -104,6 +104,9 @@ if [[ -n ${CHECKS["port-forwards"]} ]]; then
 	limactl validate "$FILE"
 fi
 
+INFO "Make sure template embedding copies \"$FILE\" exactly"
+diff -u <(echo -n "base: $FILE" | limactl tmpl copy --embed - -) "$FILE"
+
 function diagnose() {
 	NAME="$1"
 	set -x +e

pkg/limatmpl/embed.go

@@ -1,6 +1,7 @@
 package limatmpl
 
 import (
+	"bytes"
 	"context"
 	"fmt"
 	"os"
@@ -130,10 +131,12 @@ func (tmpl *Template) embedBase(ctx context.Context, baseLocator limayaml.Locato
 
 // evalExprImpl evaluates tmpl.expr against one or more documents.
 // Called by evalExpr() and embedAllScripts() for single documents and merge() for 2 documents.
-func (tmpl *Template) evalExprImpl(prefix string, bytes []byte) error {
+func (tmpl *Template) evalExprImpl(prefix string, b []byte) error {
 	var err error
 	expr := prefix + tmpl.expr.String() + "| $a"
-	tmpl.Bytes, err = yqutil.EvaluateExpression(expr, bytes)
+	tmpl.Bytes, err = yqutil.EvaluateExpression(expr, b)
+	// Make sure the YAML ends with just a single newline
+	tmpl.Bytes = append(bytes.TrimRight(tmpl.Bytes, "\n"), '\n')
 	tmpl.Config = nil
 	tmpl.expr.Reset()
 	return tmpl.ClearOnError(err)