Tidy up registration tests.

cylc · Aug 30, 2019 · e1af326 · e1af326
1 parent 2aa1ccf
commit e1af326
Showing 1 changed file with 163 additions and 116 deletions.
diff --git a/tests/registration/00-simple.t b/tests/registration/00-simple.t
@@ -14,176 +14,223 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 #------------------------------------------------------------------------------
 # Test suite registration
 
-. "$(dirname "$0")/test_header"
-set_test_number 34
+export RND_SUITE_NAME
+export RND_SUITE_SOURCE
+export RND_SUITE_RUNDIR
+export CYLC_RUN_DIR="$(cylc get-global-config --print-run-dir)"
+
+function make_rnd_suite() {
+    RND_SUITE_NAME=x$(< /dev/urandom tr -dc _A-Z-a-z-0-9 | head -c6)
+    RND_SUITE_SOURCE="$PWD/${RND_SUITE_NAME}"
+    mkdir -p "${RND_SUITE_SOURCE}"
+    touch "${RND_SUITE_SOURCE}/suite.rc"
+    RND_SUITE_RUNDIR="${CYLC_RUN_DIR}/${RND_SUITE_NAME}"
+}
+
+function purge_rnd_suite() {
+    RND_SUITE_SOURCE=${1:-$RND_SUITE_SOURCE}
+    RND_SUITE_RUNDIR=${2:-$RND_SUITE_RUNDIR}
+    rm -rf "${RND_SUITE_SOURCE}"
+    rm -rf "${RND_SUITE_RUNDIR}"
+}
 
-init_suite "${TEST_NAME_BASE}" <<'__SUITE_RC__'
-[meta]
-    title = the quick brown fox
-[scheduling]
-    [[graph]]
-        R1 = a => b => c
-[runtime]
-    [[a,b,c]]
-        script = true
-__SUITE_RC__
+. "$(dirname "$0")/test_header"
+set_test_number 37
 
-# Unique suite run-dir prefix to avoid messing with real suites.
-PRE="cylctb-${CYLC_TEST_TIME_INIT}"
+# Use $SUITE_NAME and $SUITE_RUN_DIR defined by test_header
 
-# Test fail no suite.rc file.
-CYLC_RUN_DIR="$(cylc get-global --print-run-dir)"
-TEST_NAME="${TEST_NAME_BASE}-noreg"
-run_fail "${TEST_NAME}" cylc register "${SUITE_NAME}" "${PWD}/zilch"
+#------------------------------
+# Test fail no suite source dir
+TEST_NAME="${TEST_NAME_BASE}-nodir"
+make_rnd_suite
+rm -rf "${RND_SUITE_SOURCE}"
+run_fail "${TEST_NAME}" cylc register "${RND_SUITE_NAME}" "${RND_SUITE_SOURCE}"
 contains_ok "${TEST_NAME}.stderr" <<__ERR__
-SuiteServiceFileError: no suite.rc in ${PWD}/zilch
+SuiteServiceFileError: no suite.rc in ${RND_SUITE_SOURCE}
 __ERR__
+purge_rnd_suite
+
+#---------------------------
+# Test fail no suite.rc file
+TEST_NAME="${TEST_NAME_BASE}-nodir"
+make_rnd_suite
+rm -f "${RND_SUITE_SOURCE}/suite.rc"
+run_fail "${TEST_NAME}" cylc register "${RND_SUITE_NAME}" "${RND_SUITE_SOURCE}"
+contains_ok "${TEST_NAME}.stderr" <<__ERR__
+SuiteServiceFileError: no suite.rc in ${RND_SUITE_SOURCE}
+__ERR__
+purge_rnd_suite
 
-CHEESE=${PRE}-cheese
+#-------------------------------------------------------
 # Test default name: "cylc reg" (suite in $PWD, no args)
-TEST_NAME="${TEST_NAME_BASE}-cheese"
-mkdir "${CHEESE}"
-cd "${CHEESE}" || exit 1
-touch 'suite.rc'
+TEST_NAME="${TEST_NAME_BASE}-pwd1"
+make_rnd_suite
+pushd "${RND_SUITE_SOURCE}"
 run_ok "${TEST_NAME}" cylc register
 contains_ok "${TEST_NAME}.stdout" <<__OUT__
-REGISTERED ${CHEESE} -> ${PWD}
+REGISTERED $RND_SUITE_NAME -> ${RND_SUITE_SOURCE}
 __OUT__
-cd .. || exit 1
-rm -rf "${CYLC_RUN_DIR:?}/${CHEESE}"
-
-# Test default name: "cylc reg REG" (suite in $PWD)
-TEST_NAME="${TEST_NAME_BASE}-toast"
-cd "${CHEESE}" || exit 1
-TOAST="${PRE}-toast"
-run_ok "${TEST_NAME}" cylc register "${TOAST}"
+popd
+purge_rnd_suite
+
+#--------------------------------------------------
+# Test default path: "cylc reg REG" (suite in $PWD)
+TEST_NAME="${TEST_NAME_BASE}-pwd2"
+make_rnd_suite
+pushd "${RND_SUITE_SOURCE}"
+run_ok "${TEST_NAME}" cylc register "${RND_SUITE_NAME}"
 contains_ok "${TEST_NAME}.stdout" <<__OUT__
-REGISTERED ${TOAST} -> ${PWD}
+REGISTERED ${RND_SUITE_NAME} -> ${RND_SUITE_SOURCE}
 __OUT__
-cd .. || exit 1
-rm -rf "${CYLC_RUN_DIR:?}/$TOAST"
+popd
+purge_rnd_suite
 
+#-------------------------
 # Test "cylc reg REG PATH"
-TEST_NAME="${TEST_NAME_BASE}-bagels"
-BAGELS="${PRE}-bagels"
-run_ok "${TEST_NAME}" cylc register "${BAGELS}" "${CHEESE}"
+TEST_NAME="${TEST_NAME_BASE}-normal"
+make_rnd_suite
+run_ok "${TEST_NAME}" cylc register "${RND_SUITE_NAME}" "${RND_SUITE_SOURCE}"
 contains_ok "${TEST_NAME}.stdout" <<__OUT__
-REGISTERED ${BAGELS} -> ${PWD}/${CHEESE}
+REGISTERED ${RND_SUITE_NAME} -> ${RND_SUITE_SOURCE}
 __OUT__
-rm -rf "${CYLC_RUN_DIR:?}/${BAGELS}"
-
-# Test "cylc reg REG ~/cylc-run/REG"
-TEST_NAME="${TEST_NAME_BASE}-onion"
-ONION="${PRE}-onion"
-mkdir -p "${CYLC_RUN_DIR}/${ONION}"
-cp -p "${PWD}/suite.rc" "${CYLC_RUN_DIR}/${ONION}/"
-run_ok "${TEST_NAME}" cylc register "${ONION}" "${CYLC_RUN_DIR}/${ONION}"
+purge_rnd_suite
+
+#--------------------------------------------------------------------
+# Test register existing run directory: "cylc reg REG ~/cylc-run/REG"
+TEST_NAME="${TEST_NAME_BASE}-reg-run-dir"
+make_rnd_suite
+mkdir -p "${RND_SUITE_RUNDIR}"
+cp "${RND_SUITE_SOURCE}/suite.rc" "${RND_SUITE_RUNDIR}"
+run_ok "${TEST_NAME}" cylc register "${RND_SUITE_NAME}" "${RND_SUITE_RUNDIR}"
 contains_ok "${TEST_NAME}.stdout" <<__OUT__
-REGISTERED ${ONION} -> ${CYLC_RUN_DIR}/${ONION}
+REGISTERED ${RND_SUITE_NAME} -> ${RND_SUITE_RUNDIR}
 __OUT__
-SOURCE="$(readlink "${CYLC_RUN_DIR}/${ONION}/.service/source")"
+SOURCE="$(readlink "${RND_SUITE_RUNDIR}/.service/source")"
 run_ok "${TEST_NAME}-source" test '..' = "${SOURCE}"
 # Run it twice
-run_ok "${TEST_NAME}-2" cylc register "${ONION}" "${CYLC_RUN_DIR}/${ONION}"
+run_ok "${TEST_NAME}-2" cylc register "${RND_SUITE_NAME}" "${RND_SUITE_RUNDIR}"
 contains_ok "${TEST_NAME}-2.stdout" <<__OUT__
-REGISTERED ${ONION} -> ${CYLC_RUN_DIR}/${ONION}
+REGISTERED ${RND_SUITE_NAME} -> ${RND_SUITE_RUNDIR}
 __OUT__
-SOURCE="$(readlink "${CYLC_RUN_DIR}/${ONION}/.service/source")"
-run_ok "${TEST_NAME}-2-source" test '..' = "${SOURCE}"
-rm -rf "${CYLC_RUN_DIR:?}/${ONION}"
+SOURCE="$(readlink "${RND_SUITE_RUNDIR}/.service/source")"
+run_ok "${TEST_NAME}-source" test '..' = "${SOURCE}"
+purge_rnd_suite
 
+#----------------------------------------------------------------
 # Test fail "cylc reg REG PATH" where REG already points to PATH2
-YOGHURT="${PRE}-YOGHURT"
-cp -r "${CHEESE}" "${YOGHURT}"
-TEST_NAME="${TEST_NAME_BASE}-cheese"
-run_ok "${TEST_NAME}" cylc register "${CHEESE}" "${CHEESE}"
-TEST_NAME="${TEST_NAME_BASE}-repurpose1"
-run_fail "${TEST_NAME}" cylc register "${CHEESE}" "${YOGHURT}"
+TEST_NAME="${TEST_NAME_BASE}-dup1"
+make_rnd_suite
+run_ok "${TEST_NAME}" cylc register "${RND_SUITE_NAME}" "${RND_SUITE_SOURCE}"
+RND_SUITE_NAME1="${RND_SUITE_NAME}"
+RND_SUITE_SOURCE1="${RND_SUITE_SOURCE}"
+RND_SUITE_RUNDIR1="${RND_SUITE_RUNDIR}"
+make_rnd_suite
+TEST_NAME="${TEST_NAME_BASE}-dup2"
+run_fail "${TEST_NAME}" cylc register "${RND_SUITE_NAME1}" "${RND_SUITE_SOURCE}"
 contains_ok "${TEST_NAME}.stderr" <<__ERR__
-SuiteServiceFileError: the name '${CHEESE}' already points to ${PWD}/${CHEESE}.
+SuiteServiceFileError: the name '${RND_SUITE_NAME1}' already points to ${RND_SUITE_SOURCE1}.
 Use --redirect to re-use an existing name and run directory.
 __ERR__
-
-# Test succeed "cylc reg REG PATH" where REG already points to PATH2
-TEST_NAME="${TEST_NAME_BASE}-repurpose2"
-cp -r "${CHEESE}" "${YOGHURT}"
-run_ok "${TEST_NAME}" cylc register --redirect "${CHEESE}" "${YOGHURT}"
+# Now force it
+TEST_NAME="${TEST_NAME_BASE}-dup3"
+run_ok "${TEST_NAME}" cylc register --redirect "${RND_SUITE_NAME1}" "${RND_SUITE_SOURCE}"
 sed -i 's/^\t//; s/^.* WARNING - /WARNING - /' "${TEST_NAME}.stderr"
 contains_ok "${TEST_NAME}.stderr" <<__ERR__
-WARNING - the name '${CHEESE}' points to ${PWD}/${CHEESE}.
-It will now be redirected to ${PWD}/${YOGHURT}.
-Files in the existing ${CHEESE} run directory will be overwritten.
+WARNING - the name '${RND_SUITE_NAME1}' points to ${RND_SUITE_SOURCE1}.
+It will now be redirected to ${RND_SUITE_SOURCE}.
+Files in the existing ${RND_SUITE_NAME1} run directory will be overwritten.
 __ERR__
 contains_ok "${TEST_NAME}.stdout" <<__OUT__
-REGISTERED ${CHEESE} -> ${PWD}/${YOGHURT}
+REGISTERED ${RND_SUITE_NAME1} -> ${RND_SUITE_SOURCE}
 __OUT__
-rm -rf "${CYLC_RUN_DIR:?}/${CHEESE}"
 
-run_ok "${TEST_NAME_BASE}-get-dir" cylc get-directory "${SUITE_NAME}"
+TEST_NAME="${TEST_NAME_BASE}-get-dir"
+run_ok "${TEST_NAME}" cylc get-directory "${RND_SUITE_NAME1}"
+contains_ok "${TEST_NAME}.stdout" <<__ERR__
+${RND_SUITE_SOURCE}
+__ERR__
 
-# necessary so the suite is being validated via the database not filepath
-cd .. || exit 1
-run_ok "${TEST_NAME_BASE}-val" cylc validate "${SUITE_NAME}"
-cd "${OLDPWD}" || exit 1
+purge_rnd_suite
+purge_rnd_suite "${RND_SUITE_SOURCE1}" "${RND_SUITE_RUNDIR1}"
 
-run_ok "${TEST_NAME_BASE}-print" cylc print
-contains_ok "${TEST_NAME_BASE}-print.stdout" <<__OUT__
-${SUITE_NAME} | the quick brown fox | ${TEST_DIR}/${SUITE_NAME}
-__OUT__
-
-# Filter out errors from 'bad' suites in the 'cylc-run' directory
-NONSPECIFIC_ERR2='\[Errno 2\] No such file or directory:'
-SPECIFIC_ERR2="$NONSPECIFIC_ERR2 '$HOME/cylc-run/${SUITE_NAME}/suite.rc'"
-ERR2_COUNT="$(grep -c "$SPECIFIC_ERR2" "${TEST_NAME_BASE}-print.stderr")"
-if ((ERR2_COUNT == 0)); then
-    grep -v -s "$NONSPECIFIC_ERR2" "${TEST_NAME_BASE}-print.stderr" > "${TEST_NAME_BASE}-print-filtered.stderr"
-    cmp_ok "${TEST_NAME_BASE}-print-filtered.stderr" <'/dev/null'
-else
-    fail "${TEST_NAME_BASE}-print.stderr"
-fi
-
-# Test alternate run dir.
+#-----------------------
+# Test alternate run dir
 # 1. Normal case.
 TEST_NAME="${TEST_NAME_BASE}-alt-run-dir"
-SRC_DIR="${PWD}/foo"
-REG="${PRE}/foo"
-RUN_DIR="${CYLC_RUN_DIR}/${REG}"
+make_rnd_suite
 ALT_RUN_DIR="${PWD}/alt"
-mkdir "${SRC_DIR}"; touch "${SRC_DIR}/suite.rc"
-run_ok "${TEST_NAME}" cylc register --run-dir="${ALT_RUN_DIR}" "${REG}" "${SRC_DIR}"
+run_ok "${TEST_NAME}" \
+    cylc register --run-dir="${ALT_RUN_DIR}" "${RND_SUITE_NAME}" "${RND_SUITE_SOURCE}"
 contains_ok "${TEST_NAME}.stdout" <<__OUT__
-REGISTERED ${REG} -> ${SRC_DIR}
+REGISTERED ${RND_SUITE_NAME} -> ${RND_SUITE_SOURCE}
 __OUT__
-run_ok "${TEST_NAME}-check-link" test -L "${RUN_DIR}"
-run_ok "${TEST_NAME}-rm-link" rm "${RUN_DIR}"
+run_ok "${TEST_NAME}-check-link" test -L "${RND_SUITE_RUNDIR}"
+run_ok "${TEST_NAME}-rm-link" rm "${RND_SUITE_RUNDIR}"
 run_ok "${TEST_NAME}-rm-alt-run-dir" rm -r "${ALT_RUN_DIR}"
-rm -r "${SRC_DIR}"
+purge_rnd_suite
 
-# Test alternate run dir.
 # 2. If reg already exists (as a directory).
 TEST_NAME="${TEST_NAME_BASE}-alt-exists1"
-mkdir "${RUN_DIR}"
-mkdir "${SRC_DIR}"; touch "${SRC_DIR}/suite.rc"
-run_fail "${TEST_NAME}" cylc register --run-dir="${ALT_RUN_DIR}" "${REG}" "${SRC_DIR}"
+make_rnd_suite
+ALT_RUN_DIR="${PWD}/alt"
+mkdir -p "${RND_SUITE_RUNDIR}"
+run_fail "${TEST_NAME}" \
+   cylc register --run-dir="${ALT_RUN_DIR}" "${RND_SUITE_NAME}" "${RND_SUITE_SOURCE}"
 contains_ok "${TEST_NAME}.stderr" <<__OUT__
-SuiteServiceFileError: Run directory '${RUN_DIR}' already exists.
+SuiteServiceFileError: Run directory '${RND_SUITE_RUNDIR}' already exists.
 __OUT__
-rm -r "${SRC_DIR}" "${RUN_DIR}"
+purge_rnd_suite
 
-# Test alternate run dir.
 # 3. If reg already exists (as a valid symlink).
 TEST_NAME="${TEST_NAME_BASE}-alt-exists2"
-mkdir "${SRC_DIR}"; touch "${SRC_DIR}/suite.rc"
-mkdir "${PWD}/target"
-ln -s "${PWD}/target" "${RUN_DIR}"
-run_fail "${TEST_NAME}" cylc register --run-dir="${ALT_RUN_DIR}" "${REG}" "${SRC_DIR}"
+make_rnd_suite
+ALT_RUN_DIR="${PWD}/alt"
+TDIR=$(mktemp -d)
+mkdir -p $(dirname "${RND_SUITE_RUNDIR}")
+ln -s "${TDIR}" "${RND_SUITE_RUNDIR}"
+run_fail "${TEST_NAME}" \
+    cylc register --run-dir="${ALT_RUN_DIR}" "${RND_SUITE_NAME}" "${RND_SUITE_SOURCE}"
 contains_ok "${TEST_NAME}.stderr" <<__OUT__
-SuiteServiceFileError: Symlink '${RUN_DIR}' already points to ${PWD}/target.
+SuiteServiceFileError: Symlink '${RND_SUITE_RUNDIR}' already points to ${TDIR}.
 __OUT__
-rm -r "${SRC_DIR}" "${PWD}/target" "${CYLC_RUN_DIR:?}/${PRE}"
+purge_rnd_suite
+rm -rf "${TDIR}"
+
+#-----------------------------------------------------------------------------
+# Now use a real suite
+
+init_suite "${TEST_NAME_BASE}" <<'__SUITE_RC__'
+[meta]
+    title = the quick brown fox
+[scheduling]
+    [[graph]]
+        R1 = a => b => c
+[runtime]
+    [[a,b,c]]
+        script = true
+__SUITE_RC__
+
+run_ok "${TEST_NAME_BASE}-val" cylc validate "${SUITE_NAME}"
+
+run_ok "${TEST_NAME_BASE}-print" cylc print
+contains_ok "${TEST_NAME_BASE}-print.stdout" <<__OUT__
+${SUITE_NAME} | the quick brown fox | ${TEST_DIR}/${SUITE_NAME}
+__OUT__
+
+# Filter out errors from 'bad' suites in the 'cylc-run' directory
+NONSPECIFIC_ERR2='\[Errno 2\] No such file or directory:'
+SPECIFIC_ERR2="$NONSPECIFIC_ERR2 '$HOME/cylc-run/${SUITE_NAME}/suite.rc'"
+ERR2_COUNT="$(grep -c "$SPECIFIC_ERR2" "${TEST_NAME_BASE}-print.stderr")"
+if ((ERR2_COUNT == 0)); then
+    grep -v -s "$NONSPECIFIC_ERR2" "${TEST_NAME_BASE}-print.stderr" > "${TEST_NAME_BASE}-print-filtered.stderr"
+    cmp_ok "${TEST_NAME_BASE}-print-filtered.stderr" <'/dev/null'
+else
+    fail "${TEST_NAME_BASE}-print.stderr"
+fi
 
 purge_suite "${SUITE_NAME}"
 exit