Merge pull request #6181 from MetRonnie/handlers

`cylc stop --now`: fix flaky test & clarify docs

Author: oliver-sanders

cylc/flow/scripts/stop.py

@@ -53,9 +53,9 @@
      CCYYMMDDThh:mm, CCYY-MM-DDThh, etc).
 
 Tasks that become ready after the shutdown is ordered will be submitted
-immediately if the workflow is restarted.  Remaining task event handlers and
-job poll and kill commands, however, will be executed prior to shutdown, unless
---now is used.
+immediately if the workflow is restarted. Remaining task event handlers and
+job poll and kill commands will be executed prior to shutdown, unless
+--now is used twice.
 
 This command exits immediately unless --max-polls is greater than zero, in
 which case it polls to wait for workflow shutdown.

tests/functional/shutdown/08-now1.t

@@ -18,7 +18,7 @@
 # Test "cylc stop --now" will wait for event handler.
 . "$(dirname "$0")/test_header"
 
-set_test_number 6
+set_test_number 5
 
 install_workflow "${TEST_NAME_BASE}" "${TEST_NAME_BASE}"
 run_ok "${TEST_NAME_BASE}-validate" cylc validate "${WORKFLOW_NAME}"
@@ -27,10 +27,6 @@ LOGD="$RUN_DIR/${WORKFLOW_NAME}/log"
 grep_ok 'INFO - Workflow shutting down - REQUEST(NOW)' "${LOGD}/scheduler/log"
 JLOGD="${LOGD}/job/1/t1/01"
 # Check that 1/t1 event handler runs
-run_ok "${TEST_NAME_BASE}-activity-log-succeeded" \
-    grep -q -F \
-    "[(('event-handler-00', 'succeeded'), 1) out] Well done 1/t1 succeeded" \
-    "${JLOGD}/job-activity.log"
 run_ok "${TEST_NAME_BASE}-activity-log-started" \
     grep -q -F \
     "[(('event-handler-00', 'started'), 1) out] Hello 1/t1 started" \

tests/functional/shutdown/08-now1/flow.cylc

@@ -3,7 +3,7 @@
         abort on stall timeout = True
         stall timeout = PT0S
         abort on inactivity timeout = True
-        inactivity timeout = PT3M
+        inactivity timeout = PT1M
 
 [scheduling]
     [[graph]]
@@ -14,6 +14,5 @@
         script = cylc__job__wait_cylc_message_started; cylc stop --now "${CYLC_WORKFLOW_ID}"
         [[[events]]]
             started handlers = sleep 10 && echo 'Hello %(id)s %(event)s'
-            succeeded handlers = echo 'Well done %(id)s %(event)s'
     [[t2]]
         script = true