Merge pull request #6944 from wxtim/feat.WORKFLOW_SRC_DIR-template-var

Make a new standard template variable "CYLC_SOURCE_DIRECTORY"

Author: wxtim

changes.d/6944.feat.md

@@ -0,0 +1 @@
+Make CYLC_WORKFLOW_SRC_DIR available as a template variable.

cylc/flow/parsec/fileparse.py

@@ -471,6 +471,11 @@ def read_and_proc(
     template_vars = merge_template_vars(template_vars, extra_vars)
     template_vars['CYLC_TEMPLATE_VARS'] = template_vars
 
+    # Add CYLC_WORKFLOW_SRC_DIR to template variables.
+    sourcepath = get_workflow_source_dir(Path(fpath).parent)[1]
+    template_vars['CYLC_WORKFLOW_SRC_DIR'] = (
+        sourcepath.readlink() if sourcepath else Path(fpath).parent)
+
     # Fail if templating_detected ≠ hashbang
     process_with = hashbang_and_plugin_templating_clash(
         extra_vars[TEMPLATING_DETECTED], flines

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

@@ -0,0 +1,65 @@
+#!/usr/bin/env bash
+# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE.
+# Copyright (C) NIWA & British Crown (Met Office) & Contributors.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# 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 `CYLC_WORKFLOW_SRC_DIR.t` is set
+
+. "$(dirname "$0")/test_header"
+
+set_test_number 6
+
+WORKFLOW_NAME="cylctb-x$(< /dev/urandom tr -dc _A-Z-a-z-0-9 | head -c6)"
+
+cat > flow.cylc <<__HERE__
+#!jinja2
+# TEST: {{ CYLC_WORKFLOW_SRC_DIR }}
+[scheduler]
+    allow implicit tasks = true
+[scheduling]
+    [[graph]]
+        R1 = foo
+__HERE__
+
+run_ok "${TEST_NAME_BASE}-view" cylc view -p .
+
+named_grep_ok "src-path-in-view-p" "TEST: $PWD" \
+    "${TEST_NAME_BASE}-view.stdout"
+
+# It starts playing:
+run_ok "${TEST_NAME_BASE}-vip" \
+    cylc vip \
+        --pause \
+        --no-run-name \
+        --workflow-name "${WORKFLOW_NAME}"
+
+# It can get CYLC_WORKFLOW_SRC_DIR
+named_grep_ok "src-path-available" \
+    "TEST: $PWD" "${RUN_DIR}/${WORKFLOW_NAME}/log/config/flow-processed.cylc"
+
+# It can be updated with Cylc VR
+echo "[meta]" >> flow.cylc
+run_ok "${TEST_NAME_BASE}-vr" \
+    cylc vr "${WORKFLOW_NAME}"
+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" \
+    "TEST: $PWD" "${RUN_DIR}/${WORKFLOW_NAME}/log/config/flow-processed.cylc"
+
+cylc stop "${WORKFLOW_NAME}"
+
+purge "${WORKFLOW_NAME}"

tests/functional/validate/75-CYLC_TEMPLATE_VARS.t

@@ -33,5 +33,5 @@ cat > 'flow.cylc' <<__HEREDOC__
 __HEREDOC__
 
 run_ok "${TEST_NAME_BASE}-validate" cylc validate . --debug
-grep_ok "CYLC_TEMPLATE_VARS={'CYLC_VERSION': '.*', 'CYLC_TEMPLATE_VARS': {...}}" \
+grep_ok "CYLC_TEMPLATE_VARS={'CYLC_VERSION': '.*', 'CYLC_TEMPLATE_VARS': {...}" \
     "${TEST_NAME_BASE}-validate.stderr"

tests/integration/test_config.py

@@ -31,6 +31,7 @@
     XtriggerConfigError,
 )
 from cylc.flow.parsec.exceptions import ListValueError
+from cylc.flow.parsec.fileparse import read_and_proc
 from cylc.flow.pathutil import get_workflow_run_pub_db_path
 
 Fixture = Any
@@ -673,6 +674,47 @@ async def test_invalid_starttask(one_conf, flow, scheduler, start):
             pass
 
 
+async def test_CYLC_WORKFLOW_SRC_DIR_correctly_set(tmp_path, install, run_dir):
+    """CYLC_WORKFLOW_SRC_DIR is set correctly:
+
+    * In source dir
+    * In installed dir (Not testing different permutations of installed
+      dir as these are covered by testing of `get_workflow_source_dir`)
+    * Created directly in the run dir.
+
+    """
+    def process_file(target):
+        """Run config through read_and_proc (~= cylc view --process)
+        """
+        return read_and_proc(
+            target,
+            viewcfg={
+                'mark': False,
+                'single': False,
+                'label': False,
+                'jinja2': True,
+                'contin': True,
+                'inline': True,
+            },
+        )
+
+    # Setup a source directory:
+    (tmp_path / 'flow.cylc').write_text(
+        '#!jinja2\n{{ CYLC_WORKFLOW_SRC_DIR }}'
+    )
+
+    # Check that the CYLC_SRC_DIRECTORY
+    # points to the source directory (tmp_path):
+    processed = process_file(tmp_path / 'flow.cylc')
+    assert processed[0] == str(tmp_path)
+
+    # After installation the CYLC_WORKFLOW_SRC_DIR
+    # *still* points back to tmp_path:
+    wid = await install(tmp_path)
+    processed = process_file(run_dir / wid / 'flow.cylc')
+    assert processed[0] == str(tmp_path)
+
+
 async def test_task_event_bad_custom_template(
     flow, validate, scheduler, start, log_filter
 ):