tests/f: fix test IDs

* Test IDs should be prefixed with "$TEST_NAME_BASE".
* Test IDs should be valid for use as file names (no ":", "/", " ", etc).
* `named_grep_ok` was broken by default :(

Author: oliver-sanders

tests/functional/cylc-combination-scripts/10-CYLC_WORKFLOW_SRC_DIR.t

@@ -36,7 +36,7 @@ __HERE__
 
 run_ok "${TEST_NAME_BASE}-view" cylc view -p .
 
-named_grep_ok "src-path-in-view-p" "TEST: $PWD" \
+named_grep_ok "${TEST_NAME_BASE}-src-path-in-view-p" "TEST: $PWD" \
     "${TEST_NAME_BASE}-view.stdout"
 
 # It starts playing:
@@ -47,7 +47,7 @@ run_ok "${TEST_NAME_BASE}-vip" \
         --workflow-name "${WORKFLOW_NAME}"
 
 # It can get CYLC_WORKFLOW_SRC_DIR
-named_grep_ok "src-path-available" \
+named_grep_ok "${TEST_NAME_BASE}-src-path-available" \
     "TEST: $PWD" "${RUN_DIR}/${WORKFLOW_NAME}/log/config/flow-processed.cylc"
 
 # It can be updated with Cylc VR
@@ -57,7 +57,7 @@ run_ok "${TEST_NAME_BASE}-vr" \
 poll_grep "meta" "${RUN_DIR}/${WORKFLOW_NAME}/log/config/flow-processed.cylc"
 
 # It can get CYLC_WORKFLOW_SRC_DIR
-named_grep_ok "src-path-available" \
+named_grep_ok "${TEST_NAME_BASE}-src-path-available" \
     "TEST: $PWD" "${RUN_DIR}/${WORKFLOW_NAME}/log/config/flow-processed.cylc"
 
 cylc stop "${WORKFLOW_NAME}"

tests/functional/cylc-lint/00.lint.t

@@ -30,15 +30,15 @@ rm etc/global.cylc
 
 TEST_NAME="${TEST_NAME_BASE}.vanilla"
 run_fail "${TEST_NAME}" cylc lint .
-named_grep_ok "check-for-error-code" "S004" "${TEST_NAME}.stdout"
+named_grep_ok "${TEST_NAME_BASE}-check-for-error-code" "S004" "${TEST_NAME}.stdout"
 
 TEST_NAME="${TEST_NAME_BASE}.pick-a-ruleset"
 run_fail "${TEST_NAME}" cylc lint . -r 728
-named_grep_ok "check-for-error-code" "U998" "${TEST_NAME}.stdout"
+named_grep_ok "${TEST_NAME_BASE}-check-for-error-code" "U998" "${TEST_NAME}.stdout"
 
 TEST_NAME="${TEST_NAME_BASE}.inplace"
 run_fail "${TEST_NAME}" cylc lint . -i
-named_grep_ok "check-for-error-code-in-file" "U998" flow.cylc
+named_grep_ok "${TEST_NAME_BASE}-check-for-error-code-in-file" "U998" flow.cylc
 
 rm flow.cylc
 
@@ -49,7 +49,7 @@ __HERE__
 
 TEST_NAME="${TEST_NAME_BASE}.pick-a-ruleset-728"
 run_fail "${TEST_NAME}" cylc lint . -r 728
-named_grep_ok "do-not-upgrade-check-if-compat-mode" "Lint after renaming" "${TEST_NAME}.stderr"
+named_grep_ok "${TEST_NAME_BASE}-do-not-upgrade-check-if-compat-mode" "Lint after renaming" "${TEST_NAME}.stderr"
 
 TEST_NAME="${TEST_NAME_BASE}.pick-a-ruleset-728-exit-zero"
 run_ok "${TEST_NAME}" cylc lint . -r 728 --exit-zero
@@ -69,15 +69,15 @@ __HERE__
 
 TEST_NAME="${TEST_NAME_BASE}.zero-issues"
 run_ok "${TEST_NAME}" cylc lint .
-named_grep_ok "message on no errors" "found no issues" "${TEST_NAME}.stdout"
+named_grep_ok "${TEST_NAME_BASE}-message-on-no-errors" "found no issues" "${TEST_NAME}.stdout"
 
 # It returns an error message if you attempt to lint a non-existant location
 TEST_NAME="it-fails-if-not-target"
-run_fail ${TEST_NAME} cylc lint "a-$(uuidgen)"
+run_fail "${TEST_NAME}" cylc lint "a-$(uuidgen)"
 grep_ok "Workflow ID not found" "${TEST_NAME}.stderr"
 
 # It returns a reference in reference mode
-TEST_NAME="it-returns-a-reference"
+TEST_NAME="${TEST_NAME_BASE}-it-returns-a-reference"
 run_ok "${TEST_NAME}" cylc lint --list-codes
 named_grep_ok "${TEST_NAME}-contains-style-codes" "^S001:" "${TEST_NAME}.stdout"
 TEST_NAME="it-returns-a-reference-style"

tests/functional/cylc-lint/01.lint-toml.t

@@ -48,12 +48,12 @@ __HERE__
 
 
 # Control tests
-TEST_NAME="it lints without toml file"
+TEST_NAME='it-lints-without-toml-file'
 run_fail "${TEST_NAME}" cylc lint
 TESTOUT="${TEST_NAME}.stdout"
-named_grep_ok "it returns error code" "S004" "${TESTOUT}"
-named_grep_ok "it returns error from subdirectory" "niwa.cylc" "${TESTOUT}"
-named_grep_ok "it returns a 728 upgrade code" "^\[U" "${TESTOUT}"
+named_grep_ok "${TEST_NAME_BASE}-returns-error-code" "S004" "${TESTOUT}"
+named_grep_ok "${TEST_NAME_BASE}-returns-error-from-subdirectory" "niwa.cylc" "${TESTOUT}"
+named_grep_ok "${TEST_NAME_BASE}-returns-728-upgrade-code" "^\[U" "${TESTOUT}"
 
 
 # Add a pyproject.toml file
@@ -75,7 +75,7 @@ exclude = [
 __HERE__
 
 # Test that results are different:
-TEST_NAME="it_lints_with_toml_file"
+TEST_NAME='it-lints-with-toml-file'
 run_fail "${TEST_NAME}" cylc lint
 TESTOUT="${TEST_NAME}.stdout"
 grep_fail "S004" "${TESTOUT}"
@@ -93,13 +93,13 @@ cat > flow.cylc <<__HERE__
         """
 __HERE__
 
-TEST_NAME="it_fails_if_max-line-length_set"
+TEST_NAME="${TEST_NAME_BASE}-it-fails-if-max-line-length-set"
 run_fail "${TEST_NAME}" cylc lint
 named_grep_ok "${TEST_NAME}-line-too-long-message" \
     "\[${LINE_LEN_NO}\] flow.cylc:2: line > 4 characters." \
     "${TEST_NAME}.stdout"
 
-TEST_NAME="it_does_not_fail_if_max-line-length_set_but_ignored"
+TEST_NAME='it-does-not-fail-if-max-line-length-set-but-ignored'
 cat > pyproject.toml <<__HERE__
 [tool.cylc.lint]
 # Check against these rules

tests/functional/intelligent-host-selection/00-mixedhost.t

@@ -56,7 +56,7 @@ workflow_run_ok "${TEST_NAME_BASE}-run" \
 # Run a bunch of tests on the workflow logs to ensure that warning messages
 # produced by Intelligent Host Selection Logic have happened.
 
-named_grep_ok "unreachable host warning" \
+named_grep_ok "${TEST_NAME_BASE}-unreachable-host-warning" \
     'unreachable_host has been added to the list of unreachable hosts' \
     "${WORKFLOW_RUN_DIR}/log/scheduler/log"
 

tests/functional/intelligent-host-selection/02-badhosts.t

@@ -67,16 +67,16 @@ workflow_run_ok "${TEST_NAME_BASE}-run" \
 LOGFILE="${WORKFLOW_RUN_DIR}/log/scheduler/log"
 
 # Check that badhosttask has submit failed, but not good or mixed
-named_grep_ok "badhost task submit failed" \
+named_grep_ok "${TEST_NAME_BASE}-badhost-task-submit-failed" \
     "1/badhosttask.* submit-failed" "${LOGFILE}"
-named_grep_ok "goodhost suceeded" \
+named_grep_ok "${TEST_NAME_BASE}-goodhost-suceeded" \
     "1/mixedhosttask.* succeeded" "${LOGFILE}"
-named_grep_ok "mixedhost task suceeded" \
+named_grep_ok "${TEST_NAME_BASE}-mixedhost-task-suceeded" \
     "1/goodhosttask.* succeeded" "${LOGFILE}"
 
 # Check that when a task fail badhosts associated with that task's platform
 # are removed from the badhosts set.
-named_grep_ok "remove task platform bad hosts after submit-fail" \
+named_grep_ok "${TEST_NAME_BASE}-remove-task-platform-bad-hosts-after-submit-fail" \
     "initialisation did not complete (no hosts were reachable)" \
     "${LOGFILE}"
 

tests/functional/intelligent-host-selection/03-polling.t

@@ -75,11 +75,12 @@ LOGFILE="${WORKFLOW_RUN_DIR}/log/scheduler/log"
 # Check that when a task fail badhosts associated with that task's platform
 # are removed from the badhosts set.
 named_grep_ok \
-    "job poll fails" \
+    "${TEST_NAME_BASE}-job-poll-fails" \
     "unreachable_host has been added to the list of unreachable hosts" \
     "${LOGFILE}"
 
-named_grep_ok "job poll retries & succeeds" \
+named_grep_ok \
+    "${TEST_NAME_BASE}-job-poll-retries-and-succeeds" \
     "\[jobs-poll out\] \[TASK JOB SUMMARY\].*1/mixedhosttask/01" \
     "${LOGFILE}"
 

tests/functional/intelligent-host-selection/06-from-platform-group-fails.t

@@ -53,7 +53,7 @@ logfile="${WORKFLOW_RUN_DIR}/log/scheduler/log"
 
 # Check workflow fails for the reason we want it to fail
 named_grep_ok \
-    "Workflow stalled with 1/bad (submit-failed)" \
+    "${TEST_NAME_BASE}-workflow-stalled-with-bad-submit-failed" \
     "1/bad did not complete the required outputs" \
     "$logfile"
 
@@ -80,7 +80,7 @@ done
 
 # Look for message indicating that remote init has failed.
 named_grep_ok \
-    "platform: badhostplatform. - initialisation did not complete (no hosts were reachable)" \
+    "${TEST_NAME_BASE}-initialisation-did-not-complete" \
     "platform: badhostplatform. - initialisation did not complete (no hosts were reachable)" \
     "${logfile}"
 

tests/functional/job-kill/00-local.t

@@ -29,7 +29,7 @@ TEST_NAME="${TEST_NAME_BASE}-run"
 workflow_run_ok "${TEST_NAME}" \
     cylc play --reference-test --debug --no-detach "${WORKFLOW_NAME}"
 #-------------------------------------------------------------------------------
-TEST_NAME=${TEST_NAME_BASE}-ps
+TEST_NAME="${TEST_NAME_BASE}-ps"
 for DIR in "${WORKFLOW_RUN_DIR}"/work/*/t*; do
     run_fail "${TEST_NAME}.$(basename "$DIR")" ps "$(cat "${DIR}/file")"
 done

tests/functional/lib/bash/test_header

@@ -457,13 +457,11 @@ __ERR__
 
 named_grep_ok() {
     # (Put extra grep options like '-E' at end of the command line)
-    local NAME="$1"
+    local TEST_NAME="$1"
     local BRE="$2"
     local FILE="$3"
     shift 3
     local OPTS="$*"
-    local TEST_NAME
-    TEST_NAME="$(basename "${FILE}")-grep-ok"
     # shellcheck disable=SC2086
     if grep ${OPTS} -q -e "${BRE}" "${FILE}"; then
         ok "${TEST_NAME}"

tests/functional/platforms/12-ping-pong.t

@@ -30,11 +30,13 @@ install_workflow "${TEST_NAME_BASE}" "${TEST_NAME_BASE}"
 workflow_run_ok "${TEST_NAME_BASE}-run" \
     cylc play "${WORKFLOW_NAME}" --debug --no-detach
 
-named_grep_ok "1/remote_task submits to ${CYLC_TEST_PLATFORM}" \
+named_grep_ok \
+    "${TEST_NAME_BASE}-remote_task-submits-to-${CYLC_TEST_PLATFORM}" \
     "\[1/remote_task/01:preparing\] submitted to ${CYLC_TEST_PLATFORM}" \
     "${WORKFLOW_RUN_DIR}/log/scheduler/log"
 
-named_grep_ok "2/remote_task submits to localhost" \
+named_grep_ok \
+    "${TEST_NAME_BASE}-remote_task-submits-to-localhost" \
     "\[2/remote_task/01:preparing\] submitted to localhost" \
     "${WORKFLOW_RUN_DIR}/log/scheduler/log"