#3601: Review rose-app.conf files in recipe test workflow

Co-authored-by: Emma Hogan <[email protected]>

.github/workflows/check-rtw.yml

@@ -77,3 +77,9 @@ jobs:
         run: |
           cd esmvaltool/utils/recipe_test_workflow/doc
           make linkcheck
+
+      - name: Lint shell scripts
+        run: |
+          cd esmvaltool/utils/recipe_test_workflow
+          output=$(find . -name "*.sh" -exec shellcheck {} \;)
+          if [ "$output" ]; then echo "${output}" && exit 1; fi

esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/app/compare/rose-app.conf

@@ -1,5 +1,4 @@
 [command]
-default=rtw-env compare_task_runner.sh
-
-[env]
-KGO_ROOT_PATH=${KGO_ROOT_PATH}
+default=BASH_XTRACEFD=1  # Send the output from 'set -x' to 'stdout' rather than 'stderr'.
+       =set -euxo pipefail
+       =rtw-env python ${COMPARE_SCRIPT} ${KGO_DIR} ${COMPARISON_OUTPUT_DIR} --verbose

esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/app/install_env_file/rose-app.conf

@@ -1,5 +1,11 @@
+# Copy the site specific environment file to the 'share/bin' directory in the
+# installed Cylc workflow (this directory is automatically added to the
+# ${PATH} by Cylc).
+
 [command]
-default=install_env_file.sh
+default=BASH_XTRACEFD=1  # Send the output from 'set -x' to 'stdout' rather than 'stderr'.
+       =set -euxo pipefail
+       =cp ${ENV_FILE_SITE_PATH} ${SHARE_BIN_DIR}/${ENV_FILE}
 
-[env]
-SITE=${SITE}
+[file:${SHARE_BIN_DIR}]
+mode=mkdir

esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/flow.cylc

@@ -44,6 +44,9 @@
         platform = localhost
         [[[environment]]]
             SITE = {{ SITE }}
+            ENV_FILE=rtw-env
+            ENV_FILE_SITE_PATH=${CYLC_WORKFLOW_RUN_DIR}/site/${SITE}-env
+            SHARE_BIN_DIR=${CYLC_WORKFLOW_SHARE_DIR}/bin
 
     [[get_esmval]]
         [[[environment]]]
@@ -88,23 +91,30 @@
             ROSE_TASK_APP = process
             RECIPE_PATH = "${CYLC_TASK_PARAM_medium//--//}.yml"
 
+    [[COMPARE]]
+        inherit = None, COMPUTE
+        [[[environment]]]
+            ROSE_TASK_APP = compare
+            KGO_ROOT_PATH = {{ KGO_ROOT_PATH }}
+            COMPARE_SCRIPT=${ESMVALTOOL_DIR}/esmvaltool/utils/testing/regression/compare.py
+
     # Bash variable manipulation `##*--` below strips leading path from recipe
     # parameter to obtain RECIPE_NAME.
     # RECIPE_NAME is the recipe file basename without yml extension, as used by
     # ESMValTool for naming output directories. E.g. for the recipe
     # examples/recipe_python.yml, RECIPE_NAME=recipe_python
     [[compare<fast>]]
-        inherit = None, COMPUTE
+        inherit = COMPARE
         [[[environment]]]
-            ROSE_TASK_APP = compare
             RECIPE_NAME = "${CYLC_TASK_PARAM_fast##*--}"
-            KGO_ROOT_PATH = {{ KGO_ROOT_PATH }}
+            COMPARISON_OUTPUT_DIR=${OUTPUT_DIR}/${RECIPE_NAME}*
+            KGO_DIR=${KGO_ROOT_PATH}/${RECIPE_NAME}*
 
     [[compare<medium>]]
-        inherit = None, COMPUTE
+        inherit = COMPARE
         [[[environment]]]
-            ROSE_TASK_APP = compare
             RECIPE_NAME = "${CYLC_TASK_PARAM_medium##*--}"
-            KGO_ROOT_PATH = {{ KGO_ROOT_PATH }}
+            COMPARISON_OUTPUT_DIR=${OUTPUT_DIR}/${RECIPE_NAME}*
+            KGO_DIR=${KGO_ROOT_PATH}/${RECIPE_NAME}*
 
 {% include 'site/' ~ SITE ~ '.cylc' %}