remove CYLC_WORKFLOW_NAME from many tests

cylc/flow/cfgspec/workflow.py

@@ -793,7 +793,7 @@
                 before the ``script`` item (just below). It can be an
                 external command or script, or inlined scripting.
             ''' + SCRIPT_COMMON.format(
-                'echo "Hello from workflow ${CYLC_WORKFLOW_NAME}!"'))
+                'echo "Hello from workflow ${CYLC_WORKFLOW_ID}!"'))
 
             Conf('script', VDR.V_STRING, desc='''
                 The main custom script invoked from the task job script. It

cylc/flow/config.py

@@ -111,7 +111,7 @@
 RE_CLOCK_OFFSET = re.compile(r'(' + TaskID.NAME_RE + r')(?:\(\s*(.+)\s*\))?')
 RE_EXT_TRIGGER = re.compile(r'(.*)\s*\(\s*(.+)\s*\)\s*')
 RE_SEC_MULTI_SEQ = re.compile(r'(?![^(]+\)),')
-RE_WORKFLOW_NAME_VAR = re.compile(r'\${?CYLC_WORKFLOW_(REG_)?NAME}?')
+RE_WORKFLOW_ID_VAR = re.compile(r'\${?CYLC_WORKFLOW_(REG_)?ID}?')
 RE_TASK_NAME_VAR = re.compile(r'\${?CYLC_TASK_NAME}?')
 RE_VARNAME = re.compile(r'^[a-zA-Z_][\w]*$')
 
@@ -508,7 +508,7 @@ def __init__(
         #     Cylc8
         # remove at:
         #     Cylc9
-        self.cfg['meta']['URL'] = RE_WORKFLOW_NAME_VAR.sub(
+        self.cfg['meta']['URL'] = RE_WORKFLOW_ID_VAR.sub(
             self.workflow, self.cfg['meta']['URL'])
         for name, cfg in self.cfg['runtime'].items():
             cfg['meta']['URL'] = cfg['meta']['URL'] % {
@@ -520,7 +520,7 @@ def __init__(
             #     Cylc8
             # remove at:
             #     Cylc9
-            cfg['meta']['URL'] = RE_WORKFLOW_NAME_VAR.sub(
+            cfg['meta']['URL'] = RE_WORKFLOW_ID_VAR.sub(
                 self.workflow, cfg['meta']['URL'])
             cfg['meta']['URL'] = RE_TASK_NAME_VAR.sub(
                 name, cfg['meta']['URL'])

cylc/flow/scripts/message.py

@@ -34,14 +34,14 @@
 
 Examples:
   # Single message as an argument:
-  $ cylc message -- "${CYLC_WORKFLOW_NAME}" "${CYLC_TASK_JOB}" 'Hello world!'
+  $ cylc message -- "${CYLC_WORKFLOW_ID}" "${CYLC_TASK_JOB}" 'Hello world!'
 
   # Multiple messages as arguments:
-  $ cylc message -- "${CYLC_WORKFLOW_NAME}" "${CYLC_TASK_JOB}" \
+  $ cylc message -- "${CYLC_WORKFLOW_ID}" "${CYLC_TASK_JOB}" \
   >     'Hello world!' 'Hi' 'WARNING:Hey!'
 
   # Multiple messages on STDIN:
-  $ cylc message -- "${CYLC_WORKFLOW_NAME}" "${CYLC_TASK_JOB}" - <<'__STDIN__'
+  $ cylc message -- "${CYLC_WORKFLOW_ID}" "${CYLC_TASK_JOB}" - <<'__STDIN__'
   > Hello
   > world!
   >
@@ -50,7 +50,7 @@
   > WARNING:Hey!
   >__STDIN__
 
-Note "${CYLC_WORKFLOW_NAME}" and "${CYLC_TASK_JOB}" are available in task job
+Note "${CYLC_WORKFLOW_ID}" and "${CYLC_TASK_JOB}" are available in task job
 environments - you do not need to write their actual values in task scripting.
 
 Each message can be prefixed with a severity level using the syntax 'SEVERITY:
@@ -115,7 +115,7 @@ def main(parser: COP, options: 'Values', *args: str) -> None:
         #     9.0?
         # (As of Dec 2020 some functional tests still use the classic
         # two arg interface)
-        workflow = os.getenv('CYLC_WORKFLOW_NAME')
+        workflow = os.getenv('CYLC_WORKFLOW_ID')
         task_job = os.getenv('CYLC_TASK_JOB')
         message_strs = list(args)
     else:

cylc/flow/workflow_files.py

@@ -271,7 +271,7 @@ class ContactFileFields:
     HOST = 'CYLC_WORKFLOW_HOST'
     """The name of the host the scheduler process is running on."""
 
-    NAME = 'CYLC_WORKFLOW_NAME'
+    NAME = 'CYLC_WORKFLOW_ID'
     """The name of the workflow."""
 
     OWNER = 'CYLC_WORKFLOW_OWNER'
@@ -585,7 +585,7 @@ def get_workflow_srv_dir(reg):
     run_d = os.getenv("CYLC_WORKFLOW_RUN_DIR")
     if (
         not run_d
-        or os.getenv("CYLC_WORKFLOW_NAME") != reg
+        or os.getenv("CYLC_WORKFLOW_ID") != reg
         or os.getenv("CYLC_WORKFLOW_OWNER") != get_user()
     ):
         run_d = get_workflow_run_dir(reg)

tests/flakyfunctional/cylc-poll/03-poll-all/flow.cylc

@@ -36,7 +36,7 @@ trigger, and the workflow to shut down successfully."""
         script = exit 1
     [[poll_check_kill]]
         script = """
-cylc poll "${CYLC_WORKFLOW_NAME}"
+cylc poll "${CYLC_WORKFLOW_ID}"
 
 cylc__job__poll_grep_workflow_log -F \
     "[submit_hold.${CYLC_TASK_CYCLE_POINT}] -preparing => submitted"
@@ -45,7 +45,7 @@ st_file="${CYLC_WORKFLOW_RUN_DIR}/log/job/${CYLC_TASK_CYCLE_POINT}/submit_hold/N
 pkill -g "$(awk -F= '$1 == "CYLC_JOB_ID" {print $2}' "${st_file}")"
 """
     [[poll_now]]
-        script = cylc poll "${CYLC_WORKFLOW_NAME}"
+        script = cylc poll "${CYLC_WORKFLOW_ID}"
 
     [[submit_hold]]
         init-script = sleep 120

tests/flakyfunctional/cylc-show/00-simple/flow.cylc

@@ -33,23 +33,23 @@ done
     [[SHOW]]
     [[show-workflow]]
         inherit = SHOW
-        script = cylc show "$CYLC_WORKFLOW_NAME" >>{{ TEST_OUTPUT_PATH }}-workflow
+        script = cylc show "$CYLC_WORKFLOW_ID" >>{{ TEST_OUTPUT_PATH }}-workflow
     [[show-task]]
         inherit = SHOW
-        script = cylc show "$CYLC_WORKFLOW_NAME" foo >>{{ TEST_OUTPUT_PATH }}-task
+        script = cylc show "$CYLC_WORKFLOW_ID" foo >>{{ TEST_OUTPUT_PATH }}-task
     [[show-taskinstance]]
         inherit = SHOW
-        script = cylc show "$CYLC_WORKFLOW_NAME" foo.20141106T0900Z \
+        script = cylc show "$CYLC_WORKFLOW_ID" foo.20141106T0900Z \
             >>{{ TEST_OUTPUT_PATH }}-taskinstance
     [[show-workflow-json]]
         inherit = SHOW
-        script = cylc show --json "$CYLC_WORKFLOW_NAME" \
+        script = cylc show --json "$CYLC_WORKFLOW_ID" \
             >>{{ TEST_OUTPUT_PATH }}-json-workflow
     [[show-task-json]]
         inherit = SHOW
-        script = cylc show --json "$CYLC_WORKFLOW_NAME" foo \
+        script = cylc show --json "$CYLC_WORKFLOW_ID" foo \
             >>{{ TEST_OUTPUT_PATH }}-json-task
     [[show-taskinstance-json]]
         inherit = SHOW
-        script = cylc show --json "$CYLC_WORKFLOW_NAME" foo.20141106T0900Z \
+        script = cylc show --json "$CYLC_WORKFLOW_ID" foo.20141106T0900Z \
             >>{{ TEST_OUTPUT_PATH }}-json-taskinstance

tests/flakyfunctional/cylc-show/04-multi/flow.cylc

@@ -16,8 +16,8 @@ if [[ "${CYLC_TASK_CYCLE_POINT}" == '2018' ]]; then
     cylc__job__wait_cylc_message_started
     sleep 5
     # Test alternate syntaxes
-    cylc show "${CYLC_WORKFLOW_NAME}" 't1.*' >"${CYLC_WORKFLOW_RUN_DIR}/show1.txt"
-    cylc show "${CYLC_WORKFLOW_NAME}" '*/t1' >"${CYLC_WORKFLOW_RUN_DIR}/show2.txt"
+    cylc show "${CYLC_WORKFLOW_ID}" 't1.*' >"${CYLC_WORKFLOW_RUN_DIR}/show1.txt"
+    cylc show "${CYLC_WORKFLOW_ID}" '*/t1' >"${CYLC_WORKFLOW_RUN_DIR}/show2.txt"
 else
     while [[ ! -s "${CYLC_WORKFLOW_RUN_DIR}/show2.txt" ]]; do
         sleep 1

tests/flakyfunctional/database/01-broadcast/flow.cylc

@@ -12,7 +12,7 @@ t1:start => recover-t1
             HELLO=
     [[recover-t1]]
         script="""
-cylc broadcast -p 1 -n t1 -s'[environment]HELLO=Hello' "${CYLC_WORKFLOW_NAME}"
+cylc broadcast -p 1 -n t1 -s'[environment]HELLO=Hello' "${CYLC_WORKFLOW_ID}"
 sleep 1
-cylc trigger "${CYLC_WORKFLOW_NAME}" 1/t1
+cylc trigger "${CYLC_WORKFLOW_ID}" 1/t1
 """

tests/flakyfunctional/events/39-task-event-template-all/bin/checkargs

@@ -8,7 +8,7 @@ from subprocess import Popen, PIPE
 
 args = dict([arg.split('=', 1) for arg in sys.argv[1:]])
 
-workflow = os.environ['CYLC_WORKFLOW_NAME']
+workflow = os.environ['CYLC_WORKFLOW_ID']
 proc = Popen(['cylc', 'cat-log', '-m', 'p', '-f', 'a', workflow, 'foo.1'],
              stdout=PIPE, stdin=open(os.devnull))
 alog = proc.communicate()[0].decode().strip()

tests/flakyfunctional/events/44-timeout/flow.cylc

@@ -10,4 +10,4 @@
         [[[events]]]
             started handlers = sleeper.sh %(id)s
     [[stopper]]
-        script = cylc stop "${CYLC_WORKFLOW_NAME}"
+        script = cylc stop "${CYLC_WORKFLOW_ID}"

tests/flakyfunctional/hold-release/14-hold-kill/flow.cylc

@@ -7,16 +7,16 @@
     [[killer]]
         script = """
             echo '# killing "sleeper"'
-            cylc kill "${CYLC_WORKFLOW_NAME}" "sleeper.1"
+            cylc kill "${CYLC_WORKFLOW_ID}" "sleeper.1"
             cylc__job__poll_grep_workflow_log -F \
                 '[sleeper.1] -job(01) failed, held' 
             sleep 10  # sleep, should still be held after 10 seconds
-            cylc dump -s -t "${CYLC_WORKFLOW_NAME}" >'cylc-dump.out'
+            cylc dump -s -t "${CYLC_WORKFLOW_ID}" >'cylc-dump.out'
             diff -u 'cylc-dump.out' - <<'__OUT__'
             1, killer, running, unheld, not-queued, not-runahead
             1, sleeper, waiting, held, not-queued, not-runahead
             __OUT__
-            cylc release "${CYLC_WORKFLOW_NAME}" "sleeper.1"
+            cylc release "${CYLC_WORKFLOW_ID}" "sleeper.1"
         """
     [[sleeper]]
         script = """

tests/flakyfunctional/hold-release/15-hold-after/flow.cylc

@@ -20,11 +20,11 @@
         T00, T12 = foo[-PT12H] => foo => bar
 [runtime]
     [[holdafter]]
-        script = cylc hold --after '20140101T12' "${CYLC_WORKFLOW_NAME}"
+        script = cylc hold --after '20140101T12' "${CYLC_WORKFLOW_ID}"
     [[stopper]]
         script = """
             cylc__job__poll_grep_workflow_log '\[bar\.20140101T1200Z\].* (received)succeeded'
-            cylc stop "${CYLC_WORKFLOW_NAME}"
+            cylc stop "${CYLC_WORKFLOW_ID}"
         """
         [[[job]]]
             execution time limit = PT1M

tests/flakyfunctional/job-submission/05-activity-log/flow.cylc

@@ -19,11 +19,11 @@
             failed handlers = echo
     [[t2]]
         script = """
-            cylc kill "${CYLC_WORKFLOW_NAME}" 't1'
+            cylc kill "${CYLC_WORKFLOW_ID}" 't1'
             sleep 1
-            cylc poll "${CYLC_WORKFLOW_NAME}" 't1'
+            cylc poll "${CYLC_WORKFLOW_ID}" 't1'
             sleep 1
-            cylc shutdown "${CYLC_WORKFLOW_NAME}"
+            cylc shutdown "${CYLC_WORKFLOW_ID}"
         """
         [[[job]]]
             execution time limit = PT1M

tests/flakyfunctional/job-submission/19-chatty/flow.cylc

@@ -36,4 +36,4 @@
     [[h0, h1, h2, h3, h4, h5, h6, h7, h8, h9]]
         inherit = HOPEFUL
     [[stopper]]
-        script = cylc stop "${CYLC_WORKFLOW_NAME}"
+        script = cylc stop "${CYLC_WORKFLOW_ID}"

tests/flakyfunctional/restart/14-multicycle/flow.cylc

@@ -34,7 +34,7 @@
     [[shutdown]]
         inherit = OUTPUT
         post-script = """
-            cylc shutdown $CYLC_WORKFLOW_NAME
+            cylc shutdown $CYLC_WORKFLOW_ID
             sleep 5
         """
         [[[meta]]]

tests/flakyfunctional/restart/46-stop-clock-time.t

@@ -52,10 +52,10 @@ init_workflow "${TEST_NAME_BASE}" <<'__FLOW_CONFIG__'
         script = """
 CLOCKTIME="$(($(date +%s) + 60))"
 echo "${CLOCKTIME}" >"${CYLC_WORKFLOW_RUN_DIR}/clocktime"
-cylc stop -w "$(date --date="@${CLOCKTIME}" +%FT%T%:z)" "${CYLC_WORKFLOW_NAME}"
+cylc stop -w "$(date --date="@${CLOCKTIME}" +%FT%T%:z)" "${CYLC_WORKFLOW_ID}"
 """
     [[t<i=2>]]
-        script = cylc stop "${CYLC_WORKFLOW_NAME}"
+        script = cylc stop "${CYLC_WORKFLOW_ID}"
 __FLOW_CONFIG__
 
 run_ok "${TEST_NAME_BASE}-validate" cylc validate "${WORKFLOW_NAME}"

tests/functional/directives/01-at/flow.cylc

@@ -21,4 +21,4 @@
         inherit = ATSETTINGS
         script = "sleep 30"
     [[killer]]
-        script = cylc kill "$CYLC_WORKFLOW_NAME" 'rem2'; sleep 10
+        script = cylc kill "$CYLC_WORKFLOW_ID" 'rem2'; sleep 10

tests/functional/directives/loadleveler/flow.cylc

@@ -26,4 +26,4 @@
         inherit = LLSETTINGS
         script = "sleep 30"
     [[killer]]
-        script = cylc kill "$CYLC_WORKFLOW_NAME" 'rem2'; sleep 10
+        script = cylc kill "$CYLC_WORKFLOW_ID" 'rem2'; sleep 10

tests/functional/directives/pbs/flow.cylc

@@ -24,4 +24,4 @@
         inherit = PBS_SETTINGS
         script = "sleep 30"
     [[killer]]
-        script = cylc kill "$CYLC_WORKFLOW_NAME" 'rem2'; sleep 10
+        script = cylc kill "$CYLC_WORKFLOW_ID" 'rem2'; sleep 10

tests/functional/directives/slurm/flow.cylc

@@ -23,4 +23,4 @@
         inherit = SLURM_SETTINGS
         script = "sleep 30"
     [[killer]]
-        script = cylc kill "$CYLC_WORKFLOW_NAME" 'rem2'; sleep 10
+        script = cylc kill "$CYLC_WORKFLOW_ID" 'rem2'; sleep 10

tests/functional/events/20-workflow-event-handlers/flow.cylc

@@ -1,7 +1,7 @@
 #!jinja2
 [meta]
     title=Workflow Event Mail
-    URL = http://myworkflows.com/${CYLC_WORKFLOW_NAME}.html
+    URL = http://myworkflows.com/${CYLC_WORKFLOW_ID}.html
     workflow-priority = HIGH
 
 [scheduler]

tests/functional/events/23-workflow-stalled-handler/flow.cylc

@@ -14,4 +14,4 @@
     [[bar]]
         script = false
     [[baz]]
-        script = cylc remove $CYLC_WORKFLOW_NAME bar.1
+        script = cylc remove $CYLC_WORKFLOW_ID bar.1

tests/functional/events/42-late-then-restart/flow.cylc

@@ -6,7 +6,7 @@
         R1 = t1 => t2
 [runtime]
     [[t1]]
-        script = cylc stop --now "${CYLC_WORKFLOW_NAME}"; sleep 61
+        script = cylc stop --now "${CYLC_WORKFLOW_ID}"; sleep 61
     [[t2]]
         script = true
         [[[events]]]

tests/functional/events/45-task-event-handler-multi-warning.t

@@ -30,10 +30,10 @@ init_workflow "${TEST_NAME_BASE}" <<'__FLOW_CONFIG__'
 [runtime]
    [[foo]]
       script = """
-cylc message -s WARNING -- ${CYLC_WORKFLOW_NAME} ${CYLC_TASK_JOB} "cat"
-cylc message -s WARNING -- ${CYLC_WORKFLOW_NAME} ${CYLC_TASK_JOB} "dog"
-cylc message -s WARNING -- ${CYLC_WORKFLOW_NAME} ${CYLC_TASK_JOB} "fish"
-cylc message -s WARNING -- ${CYLC_WORKFLOW_NAME} ${CYLC_TASK_JOB} "guinea pig"
+cylc message -s WARNING -- ${CYLC_WORKFLOW_ID} ${CYLC_TASK_JOB} "cat"
+cylc message -s WARNING -- ${CYLC_WORKFLOW_ID} ${CYLC_TASK_JOB} "dog"
+cylc message -s WARNING -- ${CYLC_WORKFLOW_ID} ${CYLC_TASK_JOB} "fish"
+cylc message -s WARNING -- ${CYLC_WORKFLOW_ID} ${CYLC_TASK_JOB} "guinea pig"
 """
       [[[events]]]
         handler events = warning

tests/functional/events/46-task-output-as-event.t

@@ -28,7 +28,7 @@ init_workflow "${TEST_NAME_BASE}" <<'__FLOW_CONFIG__'
 [runtime]
     [[t1]]
         script="""
-cylc message -- ${CYLC_WORKFLOW_NAME} ${CYLC_TASK_JOB} \
+cylc message -- ${CYLC_WORKFLOW_ID} ${CYLC_TASK_JOB} \
     'rose' 'lily' 'iris' 'WARNING:poison ivy'
 """
         [[[outputs]]]

tests/functional/events/48-workflow-aborted/flow.cylc

@@ -16,7 +16,7 @@
     [[modify]]
         script = """
             # Pause the workflow, so it does not shutdown
-            cylc pause "${CYLC_WORKFLOW_NAME}"
+            cylc pause "${CYLC_WORKFLOW_ID}"
             # Extra content in workflow contact file should cause health check to fail
             echo 'TIME=MONEY' >>"${CYLC_WORKFLOW_RUN_DIR}/.service/contact"
         """

tests/functional/events/timeout/flow.cylc

@@ -12,4 +12,4 @@
 
 [runtime]
     [[foo]]
-        script = "cylc pause $CYLC_WORKFLOW_NAME"
+        script = "cylc pause $CYLC_WORKFLOW_ID"

tests/functional/ext-trigger/00-satellite/flow.cylc

@@ -64,7 +64,7 @@
                 ((COUNT += 1))
                 # (required to distinguish fast-arriving messages).
                 # Trigger downstream processing in the workflow.
-                cylc ext-trigger $CYLC_WORKFLOW_NAME \
+                cylc ext-trigger $CYLC_WORKFLOW_ID \
                    "new dataset ready for processing" $DATA_ID
             done
         """

tests/functional/ext-trigger/01-no-nudge/flow.cylc

@@ -30,14 +30,14 @@
 [runtime]
     [[foo]]
         script = """
-            cylc kill "$CYLC_WORKFLOW_NAME" 'bar.1'
+            cylc kill "$CYLC_WORKFLOW_ID" 'bar.1'
             cylc__job__poll_grep_workflow_log '\[bar\.1\].* (internal)failed'
-            cylc release "$CYLC_WORKFLOW_NAME" 'bar.1'
+            cylc release "$CYLC_WORKFLOW_ID" 'bar.1'
         """
     [[bar]]
         script = """
             sleep 5
-            cylc ext-trigger $CYLC_WORKFLOW_NAME "drugs and money" 12345
+            cylc ext-trigger $CYLC_WORKFLOW_ID "drugs and money" 12345
             sleep 60
         """
     [[handler]]

tests/functional/ext-trigger/02-cycle-point/flow.cylc

@@ -21,5 +21,5 @@ cycling workflow.  The workflow will time out and abort if the ext trigger fails
         script = echo $CYLC_EXT_TRIGGER_ID
     [[trig]]
         # Task to do the "external" triggering.
-        script = cylc ext-trigger $CYLC_WORKFLOW_NAME \
+        script = cylc ext-trigger $CYLC_WORKFLOW_ID \
             "cheese on toast for $CYLC_TASK_CYCLE_POINT" "blarghh!"

tests/functional/graph-equivalence/test1/flow.cylc

@@ -5,16 +5,16 @@
 [runtime]
     [[a]]
         script = """
-cylc show "${CYLC_WORKFLOW_NAME}" 'a.1' \
+cylc show "${CYLC_WORKFLOW_ID}" 'a.1' \
     | sed -n "/prerequisites/,/outputs/p" > {{TEST_OUTPUT_PATH}}/a-prereqs
 """
     [[b]]
         script = """
-cylc show "${CYLC_WORKFLOW_NAME}" 'b.1' \
+cylc show "${CYLC_WORKFLOW_ID}" 'b.1' \
     | sed -n "/prerequisites/,/outputs/p" > {{TEST_OUTPUT_PATH}}/b-prereqs
 """
     [[c]]
         script = """
-cylc show "${CYLC_WORKFLOW_NAME}" 'c.1' \
+cylc show "${CYLC_WORKFLOW_ID}" 'c.1' \
     | sed -n "/prerequisites/,/outputs/p" > {{TEST_OUTPUT_PATH}}/c-prereqs
 """