cylc vr: fix bug with icp = now/next/previous (#6316)

changes.d/6316.fix.md

@@ -0,0 +1 @@
+Fixed bug in `cylc vr` where an initial cycle point of `now`/`next()`/`previous()` would result in an error.

cylc/flow/config.py

@@ -690,7 +690,7 @@ def process_initial_cycle_point(self) -> None:
         Sets:
             self.initial_point
             self.cfg['scheduling']['initial cycle point']
-            self.options.icp
+            self.evaluated_icp
         Raises:
             WorkflowConfigError - if it fails to validate
         """
@@ -710,10 +710,11 @@ def process_initial_cycle_point(self) -> None:
                     icp = ingest_time(orig_icp, get_current_time_string())
                 except IsodatetimeError as exc:
                     raise WorkflowConfigError(str(exc))
-        if orig_icp != icp:
+        self.evaluated_icp = None
+        if icp != orig_icp:
             # now/next()/previous() was used, need to store
             # evaluated point in DB
-            self.options.icp = icp
+            self.evaluated_icp = icp
         self.initial_point = get_point(icp).standardise()
         self.cfg['scheduling']['initial cycle point'] = str(self.initial_point)
 

cylc/flow/workflow_db_mgr.py

@@ -327,8 +327,16 @@ def put_workflow_params(self, schd: 'Scheduler') -> None:
             {"key": self.KEY_STOP_CLOCK_TIME, "value": schd.stop_clock_time},
             {"key": self.KEY_STOP_TASK, "value": schd.stop_task},
         ])
-        for key in (
+
+        # Store raw initial cycle point in the DB.
+        value = schd.config.evaluated_icp
+        value = None if value == 'reload' else value
+        self.put_workflow_params_1(
             self.KEY_INITIAL_CYCLE_POINT,
+            value or str(schd.config.initial_point)
+        )
+
+        for key in (
             self.KEY_FINAL_CYCLE_POINT,
             self.KEY_START_CYCLE_POINT,
             self.KEY_STOP_CYCLE_POINT

tests/flakyfunctional/database/00-simple.t

@@ -46,7 +46,7 @@ UTC_mode|0
 cycle_point_format|
 cylc_version|$(cylc --version)
 fcp|
-icp|
+icp|1
 is_paused|0
 n_restart|0
 run_mode|

tests/functional/cylc-combination-scripts/09-vr-icp-now.t

@@ -0,0 +1,39 @@
+#!/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/>.
+
+#------------------------------------------------------------------------------
+# Ensure that validate step of Cylc VR cannot change the options object.
+# See https://github.com/cylc/cylc-flow/issues/6262
+
+. "$(dirname "$0")/test_header"
+set_test_number 2
+
+WORKFLOW_ID=$(workflow_id)
+
+cp -r "${TEST_SOURCE_DIR}/${TEST_NAME_BASE}/flow.cylc" .
+
+run_ok "${TEST_NAME_BASE}-vip" \
+    cylc vip . \
+        --workflow-name "${WORKFLOW_ID}" \
+        --no-detach \
+        --no-run-name
+
+echo "# Some Comment" >> flow.cylc
+
+run_ok "${TEST_NAME_BASE}-vr" \
+    cylc vr "${WORKFLOW_ID}" \
+        --stop-cycle-point 2020-01-01T00:02Z

tests/functional/cylc-combination-scripts/09-vr-icp-now/flow.cylc

@@ -0,0 +1,9 @@
+[scheduling]
+    initial cycle point = 2020
+    stop after cycle point = 2020-01-01T00:01Z
+    [[graph]]
+        PT1M = foo
+[runtime]
+    [[foo]]
+        [[[simulation]]]
+            default run length = PT0S

tests/functional/data-store/00-prune-optional-break.t

@@ -27,25 +27,25 @@ init_workflow "${TEST_NAME_BASE}" << __FLOW__
     final cycle point = 1
     [[graph]]
         P1 = """
-a? => b? => c?
-d => e
-"""
+            a => b? => c?
+            a => d => e
+        """
 [runtime]
     [[a,c,e]]
         script = true
     [[b]]
         script = false
     [[d]]
         script = """
-cylc workflow-state \${CYLC_WORKFLOW_ID}//1/b:failed --interval=2
-cylc pause \$CYLC_WORKFLOW_ID
-"""
+            cylc workflow-state \${CYLC_WORKFLOW_ID}//1/b:failed --interval=2 --max-polls=20 -v
+            cylc pause \$CYLC_WORKFLOW_ID
+        """
 __FLOW__
 
 # run workflow
 run_ok "${TEST_NAME_BASE}-run" cylc play "${WORKFLOW_NAME}"
 
-cylc workflow-state "${WORKFLOW_NAME}/1/d:succeeded" --interval=2 --max-polls=60
+cylc workflow-state "${WORKFLOW_NAME}//1/d:succeeded" --interval=2 --max-polls=60 -v
 
 # query workflow
 TEST_NAME="${TEST_NAME_BASE}-prune-optional-break"

tests/functional/flow-triggers/10-specific-flow.t

@@ -1,7 +1,7 @@
 #!/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
@@ -15,6 +15,7 @@
 # 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 targeting a specific flow, with trigger --wait.
 
 . "$(dirname "$0")/test_header"
 set_test_number 2

tests/functional/flow-triggers/10-specific-flow/flow.cylc

@@ -17,6 +17,10 @@
    [[trigger-happy]]
       script = """
          cylc trigger --flow=2 --wait ${CYLC_WORKFLOW_ID}//1/f
-         cylc__job__poll_grep_workflow_log "1/d/01:submitted.*running"
-         cylc trigger --flow=2 ${CYLC_WORKFLOW_ID}//1/b
+      """
+   [[d]]
+      script = """
+         if [[ "$CYLC_TASK_SUBMIT_NUMBER" == "1" ]]; then
+            cylc trigger --flow=2 ${CYLC_WORKFLOW_ID}//1/b
+         fi
       """

tests/functional/reload/26-stalled.t

@@ -26,7 +26,7 @@ init_workflow "${TEST_NAME_BASE}" <<'__FLOW__'
 [scheduler]
     [[events]]
         stall handlers = cylc reload %(workflow)s
-        stall timeout = PT10S
+        stall timeout = PT30S
         abort on stall timeout = True
         # Prevent infinite loop if the bug resurfaces
         workflow timeout = PT3M

tests/functional/triggering/08-fam-finish-any.t

@@ -1,7 +1,7 @@
 #!/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
@@ -17,6 +17,7 @@
 #-------------------------------------------------------------------------------
 # Test correct expansion of 'FAM:finish-any'
 . "$(dirname "$0")/test_header"
+skip_macos_gh_actions
 set_test_number 2
 reftest
 exit

tests/unit/test_config.py

@@ -267,7 +267,7 @@ def test_family_inheritance_and_quotes(
 
 
 @pytest.mark.parametrize(
-    ('cycling_type', 'scheduling_cfg', 'expected_icp', 'expected_opt_icp',
+    ('cycling_type', 'scheduling_cfg', 'expected_icp', 'expected_eval_icp',
      'expected_err'),
     [
         pytest.param(
@@ -356,7 +356,7 @@ def test_process_icp(
     cycling_type: str,
     scheduling_cfg: Dict[str, Any],
     expected_icp: Optional[str],
-    expected_opt_icp: Optional[str],
+    expected_eval_icp: Optional[str],
     expected_err: Optional[Tuple[Type[Exception], str]],
     monkeypatch: pytest.MonkeyPatch, set_cycling_type: Fixture
 ) -> None:
@@ -368,7 +368,7 @@ def test_process_icp(
         cycling_type: Workflow cycling type.
         scheduling_cfg: 'scheduling' section of workflow config.
         expected_icp: The expected icp value that gets set.
-        expected_opt_icp: The expected value of options.icp that gets set
+        expected_eval_icp: The expected value of options.icp that gets set
             (this gets stored in the workflow DB).
         expected_err: Exception class expected to be raised plus the message.
     """
@@ -396,10 +396,10 @@ def test_process_icp(
         assert mocked_config.cfg[
             'scheduling']['initial cycle point'] == expected_icp
         assert str(mocked_config.initial_point) == expected_icp
-        opt_icp = mocked_config.options.icp
-        if opt_icp is not None:
-            opt_icp = str(loader.get_point(opt_icp).standardise())
-        assert opt_icp == expected_opt_icp
+        eval_icp = mocked_config.evaluated_icp
+        if eval_icp is not None:
+            eval_icp = str(loader.get_point(eval_icp).standardise())
+        assert eval_icp == expected_eval_icp
 
 
 @pytest.mark.parametrize(