Allow 'cylc reload' to reload global configuration

cylc/flow/commands.py

@@ -88,6 +88,7 @@
     RunMode,
     StopMode,
 )
+from cylc.flow.cfgspec.glbl_cfg import glbl_cfg
 
 
 if TYPE_CHECKING:
@@ -329,7 +330,7 @@
 
 
 @_command('reload_workflow')
-async def reload_workflow(schd: 'Scheduler'):
+async def reload_workflow(schd: 'Scheduler', reload_global: bool = False):
     """Reload workflow configuration."""
     yield
     # pause the workflow if not already
@@ -363,6 +364,25 @@
         # give commands time to complete
         sleep(1)  # give any remove-init's time to complete
 
+    if reload_global:
+        # Reload global config if requested
+        LOG.info("Reloading the global configuration.")
+        try:
+            glbl_cfg(reload=True)
+        except (ParsecError, CylcConfigError) as exc:
+            if cylc.flow.flags.verbosity > 1:
+                # log full traceback in debug mode
+                LOG.exception(exc)
+            LOG.critical(
+                f'Reload failed - {exc.__class__.__name__}: {exc}'
+                '\nThis is probably due to an issue with the new'
+                ' configuration.'
+                '\nTo continue with the pre-reload config, un-pause the'
+                ' workflow.'
+                '\nOtherwise, fix the configuration and attempt to reload'
+                ' again.'
+            )
+
     # reload the workflow definition
     schd.reload_pending = 'loading the workflow definition'
     schd.update_data_store()  # update workflow status msg

cylc/flow/network/schema.py

@@ -1886,6 +1886,10 @@ class Meta:
     class Arguments:
         workflows = graphene.List(WorkflowID, required=True)
 
+        reload_global = Boolean(
+            default_value=False,
+            description="Also reload global config")
+
     result = GenericScalar()
 
 

cylc/flow/scripts/reload.py

@@ -69,10 +69,12 @@
 
 MUTATION = '''
 mutation (
-  $wFlows: [WorkflowID]!
+  $wFlows: [WorkflowID]!,
+  $reloadGlobal: Boolean,
 ) {
   reload (
     workflows: $wFlows
+    reloadGlobal: $reloadGlobal
   ) {
     result
   }
@@ -87,6 +89,12 @@
         multiworkflow=True,
         argdoc=[WORKFLOW_ID_MULTI_ARG_DOC],
     )
+
+    parser.add_option(
+        "-g", "--global",
+        help="also reload global configuration.",
+        action="store_true", default=False, dest="reload_global")
+
     return parser
 
 
@@ -97,6 +105,7 @@
         'request_string': MUTATION,
         'variables': {
             'wFlows': [workflow_id],
+            'reloadGlobal': options.reload_global,
         }
     }
 

cylc/flow/task_proxy.py

@@ -344,7 +344,6 @@ def copy_to_reload_successor(
         reload_successor.summary = self.summary
         reload_successor.local_job_file_path = self.local_job_file_path
         reload_successor.try_timers = self.try_timers
-        reload_successor.platform = self.platform
         reload_successor.job_vacated = self.job_vacated
         reload_successor.poll_timer = self.poll_timer
         reload_successor.timeout = self.timeout

tests/integration/test_reload.py

@@ -24,6 +24,7 @@
     TASK_STATUS_PREPARING,
     TASK_STATUS_SUBMITTED,
 )
+from cylc.flow.cfgspec.glbl_cfg import glbl_cfg
 
 
 async def test_reload_waits_for_pending_tasks(
@@ -146,3 +147,72 @@ async def test_reload_failure(
 
         # the config should be unchanged
         assert schd.config.cfg['scheduling']['graph']['R1'] == 'one'
+
+
+async def test_reload_global(
+    flow,
+    one_conf,
+    scheduler,
+    start,
+    log_filter,
+    tmp_path,
+    monkeypatch,
+    ):
+
+    global_config_path = tmp_path / 'global.cylc'
+    monkeypatch.setenv("CYLC_CONF_PATH", str(global_config_path.parent))
+
+    # Original global config file
+    global_config_path.write_text("""
+    [platforms]
+        [[localhost]]
+            [[[meta]]]
+                x = 1
+    """)
+    assert glbl_cfg(reload=True).get(['platforms','localhost','meta','x']) == '1'
+
+    id_ = flow(one_conf)
+    schd = scheduler(id_)
+    async with start(schd):
+
+        # Modify the global config file
+        global_config_path.write_text("""
+        [platforms]
+            [[localhost]]
+                [[[meta]]]
+                    x = 2
+        """)
+
+        # reload the workflow and global config
+        await commands.run_cmd(commands.reload_workflow(schd, reload_global=True))
+
+        # Global config should have been reloaded
+        assert log_filter(
+            contains=(
+                'Reloading the global configuration.'
+            )
+        )
+
+        # Task platforms reflect the new config
+        assert schd.pool.get_tasks()[0].platform['meta']['x'] == '2'
+
+        # Modify the global config file with an error
+        global_config_path.write_text("""
+        [ERROR]
+            [[localhost]]
+                [[[meta]]]
+                    x = 3
+        """)
+
+        # reload the workflow and global config
+        await commands.run_cmd(commands.reload_workflow(schd, reload_global=True))
+
+        # Error is noted in the log
+        assert log_filter(
+            contains=(
+                'This is probably due to an issue with the new configuration.'
+            )
+        )
+
+        # Task platforms should be the last valid value
+        assert schd.pool.get_tasks()[0].platform['meta']['x'] == '2'