Provided a single source of truth for symlinkable dirs

cylc · Jun 27, 2024 · eb945d5 · eb945d5
1 parent b09005a
commit eb945d5
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 12 deletions.
diff --git a/cylc/flow/pathutil.py b/cylc/flow/pathutil.py
@@ -47,11  47,11 @@
 SHELL_ENV_VARS = re.compile(r'\$[^$/]*')
 SYMLINKABLE_LOCATIONS: Dict[str, str] = {
     # Location: Version Added
-    'log': '8.0.0',
-    'log/job': '8.4.0',
     'share': '8.0.0',
     'share/cycle': '8.0.0',
-    'work': '8.0.0'
     'log': '8.0.0',
     'log/job': '8.4.0',
     'work': '8.0.0',
 }
 
 

diff --git a/cylc/flow/workflow_files.py b/cylc/flow/workflow_files.py
@@ -59,6  59,7 @@
     is_remote_host,
 )
 from cylc.flow.pathutil import (
     SYMLINKABLE_LOCATIONS,
     expand_path,
     get_cylc_run_dir,
     get_workflow_run_dir,
@@ -263,9  264,7 @@ class Install:
     RESERVED_NAMES = frozenset([FLOW_FILE, SUITE_RC, *RESERVED_DIRNAMES])
     """Reserved filenames that cannot be used as run names."""
 
-    SYMLINK_DIRS = frozenset([
-        SHARE_CYCLE_DIR, SHARE_DIR, LogDir.DIRNAME, LOG_JOB_DIR, WORK_DIR, ''
-    ])
     SYMLINK_DIRS = frozenset(list(SYMLINKABLE_LOCATIONS.keys())   [''])
     """The paths of the symlink dirs that may be set in
     global.cylc[install][symlink dirs], relative to the run dir
     ('' represents the run dir)."""

diff --git a/tests/functional/cylc-clean/01-remote.t b/tests/functional/cylc-clean/01-remote.t
@@ -82,16  82,22 @@ ${TEST_DIR}/${SYM_NAME}/cycle/cylc-run/${CYLC_TEST_REG_BASE}
 |           \`-- share
 |               \`-- cycle
 \`-- leave-me-alone
 ${TEST_DIR}/${SYM_NAME}/job/cylc-run/${CYLC_TEST_REG_BASE}
 \`-- ${FUNCTIONAL_DIR}
     \`-- cylc-clean
         \`-- ${TEST_NAME_BASE}
             \`-- log
                 \`-- job
                     \`-- 1
                         \`-- santa
                             |-- 01
                             \`-- NN -> 01
 ${TEST_DIR}/${SYM_NAME}/other/cylc-run/${CYLC_TEST_REG_BASE}
 \`-- ${FUNCTIONAL_DIR}
     \`-- cylc-clean
         \`-- ${TEST_NAME_BASE}
             |-- log
-            |   \`-- job
-            |       \`-- 1
-            |           \`-- santa
-            |               |-- 01
-            |               \`-- NN -> 01
             |   \`-- job -> ${TEST_DIR}/${SYM_NAME}/job/cylc-run/${WORKFLOW_NAME}/log/job
             |-- share
             |   \`-- cycle -> ${TEST_DIR}/${SYM_NAME}/cycle/cylc-run/${WORKFLOW_NAME}/share/cycle
             \`-- work

diff --git a/tests/functional/remote/04-symlink-dirs.t b/tests/functional/remote/04-symlink-dirs.t
@@ -106,7  106,7 @@ fi
 
 # shellcheck disable=SC2016
 LINK="$(${SSH} "${CYLC_TEST_HOST}" 'readlink "$HOME/cylc-run/'"$WORKFLOW_NAME"/log/job'"')"
-if [[ "$LINK" == *"/test_cylc_symlink/cylctb_tmp_log_job_dir/cylc-run/${WORKFLOW_NAME}/log/job" ]]; then
 if [[ "$LINK" == *"/cylctb_tmp_log_job_dir/cylc-run/${WORKFLOW_NAME}/log/job" ]]; then
     ok "${TEST_NAME_BASE}-log/job-symlink-exists-ok.remotehost"
 else
     fail "${TEST_NAME_BASE}-log/job-symlink-exists-ok.remotehost"