diff --git a/changes.d/6554.feat.md b/changes.d/6554.feat.md new file mode 100644 index 00000000000..1abebb4e369 --- /dev/null +++ b/changes.d/6554.feat.md @@ -0,0 +1 @@ +`cylc show` now displays when a task has been set to skip mode diff --git a/cylc/flow/broadcast_mgr.py b/cylc/flow/broadcast_mgr.py index b9329114302..3738b730098 100644 --- a/cylc/flow/broadcast_mgr.py +++ b/cylc/flow/broadcast_mgr.py @@ -32,6 +32,8 @@ from cylc.flow.exceptions import PointParsingError from cylc.flow.parsec.util import listjoin, pdeepcopy, poverride from cylc.flow.parsec.validate import BroadcastConfigValidator +from cylc.flow.run_modes import WORKFLOW_ONLY_MODES + if TYPE_CHECKING: from cylc.flow.id import Tokens @@ -62,7 +64,8 @@ class BroadcastMgr: REC_SECTION = re.compile(r"\[([^\]]+)\]") - def __init__(self, workflow_db_mgr, data_store_mgr): + def __init__(self, workflow_db_mgr, data_store_mgr, run_mode): + self.workflow_run_mode = run_mode self.workflow_db_mgr = workflow_db_mgr self.data_store_mgr = data_store_mgr self.linearized_ancestors = {} @@ -289,6 +292,19 @@ def put_broadcast( SPEC['runtime']['__MANY__'], ) + # Skip and warn if a run mode is broadcast to a workflow + # running in simulation or dummy mode. + if ( + 'run mode' in coerced_setting + and self.workflow_run_mode.value in WORKFLOW_ONLY_MODES + ): + LOG.warning( + f'Broadcasting {coerced_setting} to a workflow' + f' running in {self.workflow_run_mode.value} mode' + ' will have no effect, and will not be actioned.' + ) + continue + for point_string in point_strings or []: # Standardise the point and check its validity. bad_point = False diff --git a/cylc/flow/config.py b/cylc/flow/config.py index dbf9316218f..08653b78ca1 100644 --- a/cylc/flow/config.py +++ b/cylc/flow/config.py @@ -81,6 +81,7 @@ is_relative_to, ) from cylc.flow.task_qualifiers import ALT_QUALIFIERS +from cylc.flow.run_modes import WORKFLOW_ONLY_MODES from cylc.flow.run_modes.simulation import configure_sim_mode from cylc.flow.run_modes.skip import skip_mode_validate from cylc.flow.subprocctx import SubFuncContext @@ -2447,6 +2448,13 @@ def _get_taskdef(self, name: str) -> TaskDef: try: rtcfg = self.cfg['runtime'][name] + + # If the workflow mode is simulation or dummy always + # override the task config: + workflow_run_mode = RunMode.get(self.options) + if workflow_run_mode.value in WORKFLOW_ONLY_MODES: + rtcfg['run mode'] = workflow_run_mode.value + except KeyError: raise WorkflowConfigError("Task not defined: %s" % name) from None # We may want to put in some handling for cases of changing the diff --git a/cylc/flow/network/schema.py b/cylc/flow/network/schema.py index 8a5237ddd83..9a62048f86c 100644 --- a/cylc/flow/network/schema.py +++ b/cylc/flow/network/schema.py @@ -72,7 +72,7 @@ ) from cylc.flow.id import Tokens from cylc.flow.run_modes import ( - TASK_CONFIG_RUN_MODES, WORKFLOW_RUN_MODES, RunMode) + WORKFLOW_RUN_MODES, RunMode) from cylc.flow.task_outputs import SORT_ORDERS from cylc.flow.task_state import ( TASK_STATUS_DESC, @@ -634,7 +634,7 @@ class Meta: # The run mode for the task. TaskRunMode = graphene.Enum( 'TaskRunMode', - [(m.capitalize(), m) for m in TASK_CONFIG_RUN_MODES], + [(k.capitalize(), k.lower()) for k in RunMode.__members__.keys()], description=lambda x: RunMode(x.value).describe() if x else None, ) diff --git a/cylc/flow/run_modes/__init__.py b/cylc/flow/run_modes/__init__.py index 2f094631380..70f0d42ea83 100644 --- a/cylc/flow/run_modes/__init__.py +++ b/cylc/flow/run_modes/__init__.py @@ -85,6 +85,14 @@ def get(options: 'Values') -> "RunMode": return RunMode(run_mode) return RunMode.LIVE + @classmethod + def _missing_(cls, value): + value = value.lower() + for member in cls: + if member.value.lower() == value: + return member + return None + def get_submit_method(self) -> 'Optional[SubmissionInterface]': """Return the job submission method for this run mode. diff --git a/cylc/flow/scheduler.py b/cylc/flow/scheduler.py index 888280b2681..a1364bd6e47 100644 --- a/cylc/flow/scheduler.py +++ b/cylc/flow/scheduler.py @@ -403,7 +403,7 @@ async def initialise(self): """ self.data_store_mgr = DataStoreMgr(self) self.broadcast_mgr = BroadcastMgr( - self.workflow_db_mgr, self.data_store_mgr) + self.workflow_db_mgr, self.data_store_mgr, self.get_run_mode()) self.server = WorkflowRuntimeServer(self) diff --git a/cylc/flow/scripts/show.py b/cylc/flow/scripts/show.py index c387a3f3fcf..bb1665a2b8d 100755 --- a/cylc/flow/scripts/show.py +++ b/cylc/flow/scripts/show.py @@ -52,6 +52,7 @@ from cylc.flow.id import Tokens from cylc.flow.id_cli import parse_ids from cylc.flow.network.client_factory import get_client +from cylc.flow.run_modes import RunMode from cylc.flow.task_outputs import TaskOutputs from cylc.flow.task_state import ( TASK_STATUSES_ORDERED, @@ -145,6 +146,7 @@ } runtime { completion + runMode } } } @@ -346,9 +348,13 @@ async def prereqs_and_outputs_query( attrs.append("queued") if t_proxy['isRunahead']: attrs.append("runahead") + run_mode = t_proxy['runtime']['runMode'] + if run_mode and RunMode(run_mode) != RunMode.LIVE: + attrs.append(f"run mode={run_mode}") state_msg = state if attrs: state_msg += f" ({','.join(attrs)})" + ansiprint(f'state: {state_msg}') # flow numbers, if not just 1 diff --git a/tests/flakyfunctional/cylc-show/00-simple.t b/tests/flakyfunctional/cylc-show/00-simple.t index d0a700dd865..471515de6b0 100644 --- a/tests/flakyfunctional/cylc-show/00-simple.t +++ b/tests/flakyfunctional/cylc-show/00-simple.t @@ -113,7 +113,10 @@ cmp_json "${TEST_NAME}-taskinstance" "${TEST_NAME}-taskinstance" \ } } }, - "runtime": {"completion": "(started and succeeded)"}, + "runtime": { + "completion": "(started and succeeded)", + "runMode": "Live" + }, "prerequisites": [ { "expression": "0", diff --git a/tests/integration/run_modes/test_simulation.py b/tests/integration/run_modes/test_simulation.py index de8a3f53031..aee9f1585d0 100644 --- a/tests/integration/run_modes/test_simulation.py +++ b/tests/integration/run_modes/test_simulation.py @@ -16,6 +16,7 @@ """Test the workings of simulation mode""" +import logging from pathlib import Path import pytest from pytest import param @@ -371,7 +372,7 @@ async def test_settings_reload( async def test_settings_broadcast( - flow, scheduler, start, monkeytime + flow, scheduler, start, monkeytime, log_filter ): """Assert that broadcasting a change in the settings for a task affects subsequent psuedo-submissions. @@ -415,12 +416,22 @@ async def test_settings_broadcast( # Change a setting using broadcast: schd.broadcast_mgr.put_broadcast( ['1066'], ['one'], [{ - 'simulation': {'fail cycle points': ''} + 'simulation': {'fail cycle points': ''}, }]) # Submit again - result is different: schd.task_job_mgr.submit_nonlive_task_jobs([itask], RunMode.SIMULATION) assert itask.mode_settings.sim_task_fails is False + # Assert that setting run mode on a simulation mode task fails with + # warning: + schd.broadcast_mgr.put_broadcast( + ['1066'], ['one'], [{ + 'run mode': 'live', + }]) + record = log_filter(contains='will not be actioned')[0] + assert record[0] == logging.WARNING + assert 'run mode' not in schd.broadcast_mgr.broadcasts + # Assert Clearing the broadcast works schd.broadcast_mgr.clear_broadcast() schd.task_job_mgr.submit_nonlive_task_jobs([itask], RunMode.SIMULATION) diff --git a/tests/integration/scripts/test_show.py b/tests/integration/scripts/test_show.py index 627c40fd65d..e4490164752 100644 --- a/tests/integration/scripts/test_show.py +++ b/tests/integration/scripts/test_show.py @@ -16,16 +16,21 @@ import json import pytest +import re from types import SimpleNamespace from colorama import init as colour_init from cylc.flow.id import Tokens from cylc.flow.scripts.show import ( + ShowOptions, show, ) +RE_STATE = re.compile('state:.*') + + @pytest.fixture(scope='module') def mod_my_conf(): """A workflow configuration with some workflow metadata.""" @@ -59,8 +64,8 @@ def mod_my_conf(): 'destroyedtheworldyet.com/' ), 'question': 'mutually exclusive', - } - } + }, + }, }, } @@ -128,6 +133,7 @@ async def test_task_meta_query(mod_my_schd, capsys): ) assert ret == 0 out, err = capsys.readouterr() + assert out.splitlines() == [ 'title: Task Title', 'question: mutually exclusive', @@ -170,9 +176,9 @@ async def test_task_instance_query( 'scheduling': { 'graph': {'R1': 'zed & dog & cat & ant'}, }, - } + }, ), - paused_start=False + paused_start=False, ) async with start(schd): await schd.update_data_structure() @@ -195,22 +201,31 @@ async def test_task_instance_query( ] +@pytest.mark.parametrize( + 'workflow_run_mode, run_mode_info', + ( + ('live', 'Skip'), + ('dummy', 'Dummy'), + ('simulation', 'Simulation'), + ) +) @pytest.mark.parametrize( 'attributes_bool, flow_nums, expected_state, expected_flows', [ pytest.param( - False, [1], 'state: waiting', None, + False, [1], 'state: waiting (run mode={})', None, ), pytest.param( True, [1, 2], - 'state: waiting (held,queued,runahead)', + 'state: waiting (held,queued,runahead,run mode={})', 'flows: [1,2]', ) ] ) async def test_task_instance_state_flows( flow, scheduler, start, capsys, + workflow_run_mode, run_mode_info, attributes_bool, flow_nums, expected_state, expected_flows ): """It should print task instance state, attributes, and flows.""" @@ -228,9 +243,13 @@ async def test_task_instance_state_flows( 'scheduling': { 'graph': {'R1': 'a'}, }, - } + 'runtime': { + 'a': {'run mode': 'skip'} + } + }, ), - paused_start=True + paused_start=True, + run_mode=workflow_run_mode, ) async with start(schd): @@ -260,7 +279,7 @@ async def test_task_instance_state_flows( line for line in out.splitlines() if line.startswith("state:") ] == [ - expected_state, + expected_state.format(run_mode_info), ] if expected_flows is not None: @@ -270,3 +289,42 @@ async def test_task_instance_state_flows( ] == [ expected_flows, ] + + +async def test_task_run_mode_changes(flow, scheduler, start, capsys): + """Broadcasting a change of run mode changes run mode shown by cylc show. + """ + opts = ShowOptions() + schd = scheduler( + flow({'scheduling': {'graph': {'R1': 'a'}}}), + run_mode='live' + ) + + async with start(schd): + # Control: No mode set, the Run Mode setting is not shown: + await schd.update_data_structure() + ret = await show( + schd.workflow, + [Tokens('//1/a')], + opts, + ) + assert ret == 0 + out, _ = capsys.readouterr() + state, = RE_STATE.findall(out) + assert 'waiting' in state + + # Broadcast change task to skip mode: + schd.broadcast_mgr.put_broadcast(['1'], ['a'], [{'run mode': 'skip'}]) + await schd.update_data_structure() + + # show now shows skip mode: + ret = await show( + schd.workflow, + [Tokens('//1/a')], + opts, + ) + assert ret == 0 + + out, _ = capsys.readouterr() + state, = RE_STATE.findall(out) + assert 'run mode=Skip' in state diff --git a/tests/integration/tui/screenshots/test_show.success.html b/tests/integration/tui/screenshots/test_show.success.html index c0aaf20a9e7..40b4f779248 100644 --- a/tests/integration/tui/screenshots/test_show.success.html +++ b/tests/integration/tui/screenshots/test_show.success.html @@ -13,7 +13,7 @@ │ description: The first metasyntactic │ │ variable. │ │ URL: (not given) │ - │ state: waiting (queued) │ + │ state: waiting (queued,run mode=Simulation) │ │ prerequisites: (None) │ │ outputs: ('⨯': not completed) │ │ ⨯ 1/foo expired │ diff --git a/tests/unit/run_modes/test_run_modes.py b/tests/unit/run_modes/test_run_modes.py index 57d245016d1..cf4587fc161 100644 --- a/tests/unit/run_modes/test_run_modes.py +++ b/tests/unit/run_modes/test_run_modes.py @@ -16,6 +16,8 @@ """Tests for utilities supporting run modes. """ +import pytest + from cylc.flow.run_modes import RunMode @@ -28,3 +30,18 @@ def test_run_mode_desc(): def test_get_default_live(): """RunMode.get() => live""" assert RunMode.get({}) == RunMode.LIVE + + +@pytest.mark.parametrize('str_', ('LIVE', 'Dummy', 'SkIp', 'siMuLATioN')) +def test__missing_(str_): + """The RunMode enumeration works when fed a string in the wrong case""" + assert RunMode(str_).value == str_.lower() + + +def test__missing_still_doesnt_work(): + """ + The RunMode enumeration raises an error when fed a string + that is not a mode. + """ + with pytest.raises(ValueError): + RunMode('garbage')