remove Cylc 7 compat mode

* Addresses cylc/cylc-flow#6849

Author: oliver-sanders

cylc/rose/__init__.py

@@ -65,9 +65,8 @@
 
 .. note::
 
-   For compatibility with Cylc 7, section ``[suite.rc:jinja2]`` will be
-   processed, but is deprecated and provided for ease of porting Cylc 7
-   workflows.
+   The legacy ``[suite.rc:jinja2]`` section remains supported, but is
+   deprecated, please rename it to ``[template variables]``.
 
 
 The ``global.cylc`` file

cylc/rose/platform_utils.py

@@ -19,7 +19,6 @@
 """Interfaces for Cylc Platforms for use by rose apps."""
 
 from optparse import Values
-from pathlib import Path
 import sqlite3
 import subprocess
 import sys
@@ -28,15 +27,13 @@
     Any,
     Dict,
     Tuple,
-    Union,
 )
 
 from cylc.flow.config import WorkflowConfig
 from cylc.flow.exceptions import PlatformLookupError
 from cylc.flow.id_cli import parse_id
 from cylc.flow.pathutil import (
     get_workflow_run_config_log_dir,
-    get_workflow_run_dir,
     get_workflow_run_pub_db_path,
 )
 from cylc.flow.platforms import (
@@ -67,11 +64,7 @@ def get_platform_from_task_def(flow: str, task: str) -> Dict[str, Any]:
         WorkflowFiles.FLOW_FILE_PROCESSED,
     )
 
-    config = WorkflowConfig(
-        flow,
-        flow_file, Values(),
-        force_compat_mode=get_compat_mode(get_workflow_run_dir(workflow_id))
-    )
+    config = WorkflowConfig(flow, flow_file, Values())
     # Get entire task spec to allow Cylc 7 platform from host guessing.
     task_spec = config.pcfg.get(['runtime', task])
     # check for subshell and evaluate
@@ -90,17 +83,6 @@ def get_platform_from_task_def(flow: str, task: str) -> Dict[str, Any]:
     return platform
 
 
-def get_compat_mode(run_dir: Union[str, Path]) -> bool:
-    """Check whether this is a Cylc 7 Back compatibility mode workflow:
-
-    See https://github.com/cylc/cylc-rose/issues/319
-
-    Args:
-        run_dir: Cylc workflow run directory.
-    """
-    return (Path(run_dir) / WorkflowFiles.SUITE_RC).exists()
-
-
 def eval_subshell(platform):
     """Evaluates platforms/hosts defined as subshell"""
     match = HOST_REC_COMMAND.match(platform)

cylc/rose/utilities.py

@@ -36,7 +36,6 @@
 
 from cylc.flow import LOG
 from cylc.flow.exceptions import CylcError
-from cylc.flow.flags import cylc7_back_compat
 from cylc.flow.cfgspec.glbl_cfg import glbl_cfg
 from cylc.flow.hostuserutil import get_host
 from metomi.isodatetime.datetimeoper import DateTimeOperator
@@ -65,8 +64,6 @@
 ROSE_ORIG_HOST_INSTALLED_OVERRIDE_STRING = (
     ' ROSE_ORIG_HOST set by cylc install.'
 )
-MESSAGE = 'message'
-ALL_MODES = 'all modes'
 STANDARD_VARS = [
     ('ROSE_ORIG_HOST', get_host()),
     ('ROSE_VERSION', ROSE_VERSION),
@@ -774,42 +771,30 @@ def deprecation_warnings(config_tree):
         - "root-dir"
         - "jinja2:suite.rc"
         - root-dir
-
-    If ALL_MODES is True this deprecation will ignore whether there is a
-    flow.cylc or suite.rc in the workflow directory.
     """
-
-    deprecations = {
-        'jinja2:suite.rc': {
-            MESSAGE: (
-                "'rose-suite.conf[jinja2:suite.rc]' is deprecated."
-                " Use [template variables] instead."
-            ),
-            ALL_MODES: False,
-        },
-        'jinja2:flow.cylc': {
-            MESSAGE: (
-                "'rose-suite.conf[jinja2:flow.cylc]' is not used by Cylc."
-                " Use [template variables] instead."
-            ),
-            ALL_MODES: False,
-        },
-        'root-dir': {
-            MESSAGE: (
-                'You have set "rose-suite.conf[root-dir]", '
-                'which is not supported at '
-                'Cylc 8. Use `[install] symlink dirs` in global.cylc '
-                'instead.'
-            ),
-            ALL_MODES: True,
-        },
-    }
+    deprecations = (
+        (
+            'jinja2:suite.rc',
+            "'rose-suite.conf[jinja2:suite.rc]' is deprecated."
+            " Use [template variables] instead.",
+        ),
+        (
+            'jinja2:flow.cylc',
+            "'rose-suite.conf[jinja2:flow.cylc]' is not used by Cylc."
+            " Use [template variables] instead.",
+        ),
+        (
+            'root-dir',
+            'You have set "rose-suite.conf[root-dir]", '
+            'which is not supported at '
+            'Cylc 8. Use `[install] symlink dirs` in global.cylc '
+            'instead.',
+        ),
+    )
     for string in list(config_tree.node):
-        for name, info in deprecations.items():
-            if (
-                info[ALL_MODES] or not cylc7_back_compat
-            ) and name in string.lower():
-                LOG.warning(info[MESSAGE])
+        for name, info in deprecations:
+            if name in string.lower():
+                LOG.warning(info)
 
 
 def load_rose_config(

tests/conftest.py

@@ -187,16 +187,12 @@ def _pytest_passed(request: pytest.FixtureRequest) -> bool:
 def _cylc_inspection_cli(capsys, caplog, script, gop):
     """Access the CLI for cylc scripts inspecting configurations
     """
-    async def _inner(srcpath, args=None, n_args=3):
+    async def _inner(srcpath, args=None):
         parser = gop()
         options = Options(parser, args)()
         output = SimpleNamespace()
 
-        if n_args == 3:
-            await script(parser, options, str(srcpath))
-        if n_args == 2:
-            # Don't include the parser:
-            await script(options, str(srcpath))
+        await script(options, str(srcpath))
 
         output.logging = '\n'.join([i.message for i in caplog.records])
         output.out, output.err = capsys.readouterr()
@@ -310,13 +306,13 @@ async def _inner(wid, args):
         results = {}
 
         # Handle scripts taking a parser or just the output of the parser:
-        for script_name, n_args in {
-            'config': 3,
-            'list': 2,
-            'graph': 2,
-            'view': 2,
-            'validate': 3,
-        }.items():
+        for script_name in (
+            'config',
+            'list',
+            'graph',
+            'view',
+            'validate',
+        ):
 
             # Import the script modules:
             script_module = importlib.import_module(
@@ -330,7 +326,7 @@ async def _inner(wid, args):
                 script = script_module.run
             else:
                 raise UsageError(
-                    f'Script "{script}\'s" module does not contain a '
+                    f'"{script_name}\" does not contain a '
                     '"_main" or "run" function'
                 )
 
@@ -343,7 +339,7 @@ async def _inner(wid, args):
                 caplog,
                 script,
                 script_module.get_option_parser,
-            )(wid, args, n_args=n_args)
+            )(wid, args)
 
         # Return results for more checking if required:
         return results

tests/functional/test_pre_configure.py

@@ -110,34 +110,19 @@ def test_warn_if_root_dir_set(root_dir_config, tmp_path, caplog):
     assert msg in caplog.records[0].msg
 
 
-@pytest.mark.parametrize(
-    'compat_mode',
-    [
-        pytest.param(True, id='back-compat'),
-        pytest.param(False, id='no-back-compat')
-    ]
-)
 @pytest.mark.parametrize(
     'rose_config', [
         'jinja2:suite.rc',
         'jinja2:flow.cylc',
         'JinjA2:flOw.cylC',
     ]
 )
-def test_warn_if_old_templating_set(
-    compat_mode, rose_config, tmp_path, caplog, monkeypatch
-):
+def test_warn_if_old_templating_set(rose_config, tmp_path, caplog):
     """Test using unsupported root-dir config raises error."""
-    monkeypatch.setattr(
-        'cylc.rose.utilities.cylc7_back_compat', compat_mode
-    )
     (tmp_path / 'rose-suite.conf').write_text(f'[{rose_config}]')
     load_rose_config(tmp_path)
     msg = "Use [template variables]"
-    if compat_mode:
-        assert not caplog.records
-    else:
-        assert msg in caplog.records[0].message
+    assert msg in caplog.records[0].message
 
 
 @pytest.mark.parametrize(

tests/unit/test_config_node.py

@@ -281,27 +281,8 @@ def test_ROSE_ORIG_HOST_replacement_behaviour(
         assert node['env']['ROSE_ORIG_HOST'].value == 'IMPLAUSIBLE_HOST_NAME'
 
 
-@pytest.mark.parametrize(
-    'compat_mode, must_include, must_exclude',
-    (
-        (True, None, 'Use [template variables]'),
-        (True, 'root-dir', None),
-        (False, 'Use [template variables]', None),
-        (False, 'root-dir', None),
-    )
-)
-def test_deprecation_warnings(
-    caplog, monkeypatch, compat_mode, must_include, must_exclude
-):
-    """Method logs warnings correctly.
-
-    Two node items are set:
-
-    * ``jinja2:suite.rc`` should not cause a warning in compatibility mode.
-    * ``root-dir=/somewhere`` should always lead to a warning being logged.
-
-    Error messages about
-    """
+def test_deprecation_warnings(caplog):
+    """It should warn over deprecated Rose config sections."""
     # Create a node to pass to the method
     # (It's not a tree test because we can use a simpleNamespace in place of
     # a tree object):
@@ -310,16 +291,13 @@ def test_deprecation_warnings(
     node.set(['root-dir', '~foo'])
     tree = SimpleNamespace(node=node)
 
-    # Patch compatibility mode flag and run the function under test:
-    monkeypatch.setattr('cylc.rose.utilities.cylc7_back_compat', compat_mode)
     deprecation_warnings(tree)
 
     # Check that warnings have/not been logged:
-    records = '\n'.join([i.message for i in caplog.records])
-    if must_include:
-        assert must_include in records
-    else:
-        assert must_exclude not in records
+    records = '\n'.join(i.message for i in caplog.records)
+
+    assert 'root-dir' in records
+    assert 'Use [template variables]' in records
 
 
 @pytest.mark.parametrize(

tests/unit/test_platform_utils.py

@@ -25,7 +25,6 @@
 from uuid import uuid4
 
 from cylc.rose.platform_utils import (
-    get_compat_mode,
     get_platform_from_task_def,
     get_platforms_from_task_jobs,
 )
@@ -215,24 +214,6 @@ def test_get_platform_from_task_def_subshell(
     assert platform['name'] == expected
 
 
-@pytest.mark.parametrize(
-    'create, expect',
-    (
-        (['suite.rc', 'log/conf/flow-processed.cylc'], True),
-        (['suite.rc', 'foo/bar/any-old.file'], True),
-        (['flow.cylc', 'log/conf/flow-processed.cylc'], False),
-        (['flow.cylc', 'where/flow-processed.cylc'], False),
-    )
-)
-def test_get_compat_mode(tmp_path, create, expect):
-    """It checks whether there is a suite.rc two directories up."""
-    for file in create:
-        file = tmp_path / file
-        file.parent.mkdir(parents=True, exist_ok=True)
-        file.touch()
-    assert get_compat_mode(tmp_path) == expect
-
-
 @pytest.mark.parametrize(
     'task, cycle, expect',
     [