From 1bec90e3c4792289b960875d050ec65fd273a780 Mon Sep 17 00:00:00 2001
From: Goldstein <root@goldstein.rs>
Date: Mon, 15 Jul 2024 23:11:26 +0300
Subject: [PATCH] tests/functional/repl.sh: fail test on wrong stdout

Previous test implementation assumed that grep supports newlines
in patterns. It doesn't, so tests spuriously passed, even though
some tests outputs were broken.

This patches output (and expected output) before grepping,
so there're no newlines in pattern.
---
 tests/functional/repl.sh | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)

diff --git a/tests/functional/repl.sh b/tests/functional/repl.sh
index c1f265df3..4f5bb36aa 100755
--- a/tests/functional/repl.sh
+++ b/tests/functional/repl.sh
@@ -74,21 +74,31 @@ testReplResponseGeneral () {
     local grepMode commands expectedResponse response
     grepMode="$1"; shift
     commands="$1"; shift
-    expectedResponse="$1"; shift
-    response="$(nix repl "$@" <<< "$commands" | stripColors)"
-    echo "$response" | grepQuiet "$grepMode" -s "$expectedResponse" \
-      || fail "repl command set:
+    # Expected response can contain newlines.
+    # grep can't handle multiline patterns, so replace newlines with TEST_NEWLINE
+    # in both expectedResponse and response.
+    # awk ORS always adds a trailing record separator, so we strip it with sed.
+    expectedResponse="$(printf '%s' "$1" | awk 1 ORS=TEST_NEWLINE | sed 's/TEST_NEWLINE$//')"; shift
+    # We don't need to strip trailing record separator here, since extra data is ok.
+    response="$(nix repl "$@" <<< "$commands" 2>&1 | stripColors | awk 1 ORS=TEST_NEWLINE)"
+    printf '%s' "$response" | grepQuiet "$grepMode" -s "$expectedResponse" \
+      || fail "$(echo "repl command set:
 
 $commands
 
 does not respond with:
 
+---
 $expectedResponse
+---
 
 but with:
 
+---
 $response
-"
+---
+
+" | sed 's/TEST_NEWLINE/\n/g')"
 }
 
 testReplResponse () {
@@ -190,7 +200,7 @@ testReplResponseNoRegex '
 let x = { y = { a = 1; }; inherit x; }; in x
 ' \
 '{
-  x = { ... };
+  x = «repeated»;
   y = { ... };
 }
 '
@@ -242,7 +252,7 @@ testReplResponseNoRegex '
 ' \
 '{
   x = «repeated»;
-  y = { a = 1 };
+  y = { a = 1; };
 }
 '
 
@@ -256,7 +266,7 @@ runRepl () {
 
   # That is right, we are also filtering out the testdir _without underscores_.
   # This is crazy, but without it, GHA will fail to run the tests, showing paths
-  # _with_ underscores in the set -x log, but _without_ underscores in the 
+  # _with_ underscores in the set -x log, but _without_ underscores in the
   # supposed nix repl output. I have looked in a number of places, but I cannot
   # find a mechanism that could cause this to happen.
   local testDirNoUnderscores