From 41a03738d63b94366d96dfc3e5cfb052c0ad5e2a Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Tue, 16 Jul 2024 01:54:12 +0200
Subject: [PATCH] tests/functional: Also keep plain grep calls safe from
 newlines

---
 tests/functional/common/vars-and-functions.sh | 20 ++++++++++++++++---
 tests/functional/test-infra.sh                |  4 ++++
 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 6cce08fbc..7a399f6d4 100644
--- a/tests/functional/common/vars-and-functions.sh
+++ b/tests/functional/common/vars-and-functions.sh
@@ -351,9 +351,12 @@ checkGrepArgs() {
 #
 # `!` normally doesn't work well with `set -e`, but when we wrap in a
 # function it *does*.
+#
+# `command grep` lets us avoid re-checking the args by going directly to the
+# executable.
 grepInverse() {
     checkGrepArgs "$@" && \
-      ! grep "$@"
+      ! command grep "$@"
 }
 
 # A shorthand, `> /dev/null` is a bit noisy.
@@ -367,15 +370,26 @@ grepInverse() {
 # the closing of the pipe, the buffering of the pipe, and the speed of
 # the producer into the pipe. But rest assured we've seen it happen in
 # CI reliably.
+#
+# `command grep` lets us avoid re-checking the args by going directly to the
+# executable.
 grepQuiet() {
     checkGrepArgs "$@" && \
-      grep "$@" > /dev/null
+      command grep "$@" > /dev/null
 }
 
 # The previous two, combined
 grepQuietInverse() {
     checkGrepArgs "$@" && \
-      ! grep "$@" > /dev/null
+      ! command grep "$@" > /dev/null
+}
+
+# Wrap grep to remove its newline footgun; see checkGrepArgs.
+# Note that we keep the checkGrepArgs calls in the other helpers, because some
+# of them are negated and that would defeat this check.
+grep() {
+    checkGrepArgs "$@" && \
+      command grep "$@"
 }
 
 # Return the number of arguments
diff --git a/tests/functional/test-infra.sh b/tests/functional/test-infra.sh
index 983b4e860..1dab069fb 100755
--- a/tests/functional/test-infra.sh
+++ b/tests/functional/test-infra.sh
@@ -113,3 +113,7 @@ unset res
 # 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'
+
+# We took the blue pill and woke up in a world where `grep` is moderately safe.
+expectStderr -101 grep $'foo\nbar' \
+  | grepQuiet -E 'test-infra\.sh:[0-9]+: in call to grep: newline not allowed in arguments; grep would try each line individually as if connected by an OR operator'