From 755675c877ae2d555ed67f948ed997045238a0b3 Mon Sep 17 00:00:00 2001
From: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
Date: Fri, 8 Nov 2024 11:48:17 +0000
Subject: [PATCH] Functional tests: allow `grep_fail` to accept options (#6463)

---
 tests/functional/cli/05-colour.t      |  8 +++++---
 tests/functional/lib/bash/test_header | 11 +++++++----
 2 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/tests/functional/cli/05-colour.t b/tests/functional/cli/05-colour.t
index 6d0d22ed14b..e92a8cc946a 100644
--- a/tests/functional/cli/05-colour.t
+++ b/tests/functional/cli/05-colour.t
@@ -23,7 +23,7 @@
 if [[ "$OSTYPE" != "linux-gnu"* ]]; then
     skip_all "Tests not compatibile with $OSTYPE"
 fi
-set_test_number 8
+set_test_number 7
 
 ANSI='\e\['
 
@@ -31,8 +31,10 @@ ANSI='\e\['
 script -q -c "cylc scan -t rich" log > /dev/null 2>&1
 grep_ok "$ANSI" log -P  # color
 
-script -q -c "cylc scan -t rich --color=never" log > /dev/null 2>&1
-grep_fail "$ANSI" log -P  # no color
+# FIXME: this test doesn't work because the output includes a color reset char
+# at the end for some reason: https://github.com/cylc/cylc-flow/issues/6467
+# script -q -c "cylc scan -t rich --color=never" log > /dev/null 2>&1
+# grep_fail "$ANSI" log -P  # no color
 
 # Redirected.
 cylc scan -t rich > log
diff --git a/tests/functional/lib/bash/test_header b/tests/functional/lib/bash/test_header
index ce0dd6165f7..76f52524eb0 100644
--- a/tests/functional/lib/bash/test_header
+++ b/tests/functional/lib/bash/test_header
@@ -69,8 +69,8 @@
 #     named_grep_ok NAME PATTERN FILE [$OPTS]
 #         Run grep_ok with a custom test name.
 #         OPTS: put grep options like '-E' (extended regex) at end of line.
-#     grep_fail PATTERN FILE
-#         Run "grep -q -e PATTERN FILE", expect no match.
+#     grep_fail PATTERN FILE [$OPTS]
+#         Run "grep [$OPTS] -q -e PATTERN FILE", expect no match.
 #     count_ok PATTERN FILE COUNT
 #         Test that PATTERN occurs in exactly COUNT lines of FILE.
 #     exists_ok FILE
@@ -459,7 +459,7 @@ named_grep_ok() {
     local BRE="$2"
     local FILE="$3"
     shift 3
-    OPTS="$*"
+    local OPTS="$*"
     local TEST_NAME
     TEST_NAME="grep-ok: ${NAME}"
     # shellcheck disable=SC2086
@@ -485,13 +485,16 @@ __ERR__
 grep_fail() {
     local BRE="$1"
     local FILE="$2"
+    shift 2
+    local OPTS="$*"
     local TEST_NAME
     TEST_NAME="$(basename "${FILE}")-grep-fail"
     if [[ ! -f "${FILE}" ]]; then
         fail "${TEST_NAME}-file to be grepped does not exist."
         return
     fi
-    if grep -q -e "${BRE}" "${FILE}"; then
+    # shellcheck disable=SC2086
+    if grep ${OPTS} -q -e "${BRE}" "${FILE}"; then
         mkdir -p "${TEST_LOG_DIR}"
         echo "ERROR: Found ${BRE} in ${FILE}" \
           >"${TEST_LOG_DIR}/${TEST_NAME}.stderr"