From 644b97ce2574fe22a3fe14daeb6a3d0711d75731 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Tue, 16 Jul 2024 01:41:22 +0200
Subject: [PATCH] tests/functional: Make our grep* helpers reject newlines in
 the query

Newlines behave like *OR*; not "and then".
---
 tests/functional/common/vars-and-functions.sh | 19 ++++++++++++++++---
 tests/functional/test-infra.sh                |  5 +++++
 2 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/tests/functional/common/vars-and-functions.sh b/tests/functional/common/vars-and-functions.sh
index 062f3d9f9..6cce08fbc 100644
--- a/tests/functional/common/vars-and-functions.sh
+++ b/tests/functional/common/vars-and-functions.sh
@@ -336,13 +336,24 @@ callerPrefix() {
   done
 }
 
+checkGrepArgs() {
+    local arg
+    for arg in "$@"; do
+        if [[ "$arg" != "${arg//$'\n'/_}" ]]; then
+            echo "$(callerPrefix)newline not allowed in arguments; grep would try each line individually as if connected by an OR operator" >&2
+            return -101
+        fi
+    done
+}
+
 # `grep -v` doesn't work well for exit codes. We want `!(exist line l. l
 # matches)`. It gives us `exist line l. !(l matches)`.
 #
 # `!` normally doesn't work well with `set -e`, but when we wrap in a
 # function it *does*.
 grepInverse() {
-    ! grep "$@"
+    checkGrepArgs "$@" && \
+      ! grep "$@"
 }
 
 # A shorthand, `> /dev/null` is a bit noisy.
@@ -357,12 +368,14 @@ grepInverse() {
 # the producer into the pipe. But rest assured we've seen it happen in
 # CI reliably.
 grepQuiet() {
-    grep "$@" > /dev/null
+    checkGrepArgs "$@" && \
+      grep "$@" > /dev/null
 }
 
 # The previous two, combined
 grepQuietInverse() {
-    ! grep "$@" > /dev/null
+    checkGrepArgs "$@" && \
+      ! grep "$@" > /dev/null
 }
 
 # Return the number of arguments
diff --git a/tests/functional/test-infra.sh b/tests/functional/test-infra.sh
index 93e0bd64b..983b4e860 100755
--- a/tests/functional/test-infra.sh
+++ b/tests/functional/test-infra.sh
@@ -108,3 +108,8 @@ unset res
 res=$(set -eu -o pipefail; echo foo | expect 1 grepQuietInverse foo | wc -c)
 (( res == 0 ))
 unset res
+
+# `grepQuiet` does not allow newlines in its arguments, because grep quietly
+# treats them as multiple queries.
+( echo foo; echo bar; ) | expectStderr -101 grepQuiet $'foo\nbar' \
+  | grepQuiet -E 'test-infra\.sh:[0-9]+: in call to grepQuiet: newline not allowed in arguments; grep would try each line individually as if connected by an OR operator'