Merge pull request #206 from hjoliver/suite-to-workflow

Terminology: suite to workflow.

Author: hjoliver

.github/workflows/update_copyright.yml

@@ -1,4 +1,4 @@
-# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
+# 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

cylc/uiserver/data_store_mgr.py

@@ -46,8 +46,8 @@
     EDGES, DATA_TEMPLATE, ALL_DELTAS, DELTAS_MAP, WORKFLOW,
     apply_delta, generate_checksum, create_delta_store
 )
-from cylc.flow.suite_files import ContactFileFields as CFF
-from cylc.flow.suite_status import SuiteStatus
+from cylc.flow.workflow_files import ContactFileFields as CFF
+from cylc.flow.workflow_status import WorkflowStatus
 
 from .workflows_mgr import workflow_request
 
@@ -90,7 +90,7 @@ def update_contact(self, w_id, contact_data=None):
             flow.port = 0
             # flow.pub_port = 0
             flow.api_version = 0
-            flow.status = SuiteStatus.STOPPED.value
+            flow.status = WorkflowStatus.STOPPED.value
 
         # Apply to existing workflow data
         if 'delta_times' not in self.data[w_id]:

cylc/uiserver/schema.py

@@ -141,19 +141,19 @@ class Arguments:
         )
         hold = Boolean(
             description=sstrip('''
-                Hold suite immediately on starting.
+                Hold workflow immediately on starting.
             ''')
         )
         hold_point = CyclePoint(
             description=sstrip('''
-                Set hold cycle point. Hold suite AFTER all tasks have PASSED
+                Set hold cycle point. Hold workflow AFTER all tasks have PASSED
                 this cycle point.
             ''')
         )
         mode = RunMode()
         host = String(
             description=sstrip('''
-                Specify the host on which to start-up the suite. If not
+                Specify the host on which to start-up the workflow. If not
                 specified, a host will be selected using the
                 `[scheduler]run hosts` global config.
             ''')
@@ -187,7 +187,7 @@ class Arguments:
         set = List(
             String,
             description=sstrip('''
-                Set the value of a Jinja2 template variable in the suite
+                Set the value of a Jinja2 template variable in the workflow
                 definition. Values should be valid Python literals so strings
                 must be quoted e.g. `STR="string"`, `INT=43`, `BOOL=True`.
                 This option can be used multiple  times on the command line.
@@ -198,7 +198,7 @@ class Arguments:
         )
         set_file = String(
             description=sstrip('''
-                Set the value of Jinja2 template variables in the suite
+                Set the value of Jinja2 template variables in the workflow
                 definition from a file containing NAME=VALUE pairs (one per
                 line). As with "set" values should be valid Python literals so
                 strings must be quoted e.g.  `STR='string'`. NOTE: these

cylc/uiserver/tests/test_data_store_mgr.py

@@ -19,7 +19,7 @@
 
 import pytest
 from cylc.flow.network import MSG_TIMEOUT
-from cylc.flow.suite_files import ContactFileFields as CFF
+from cylc.flow.workflow_files import ContactFileFields as CFF
 
 import cylc.uiserver.data_store_mgr as data_store_mgr_module
 from cylc.uiserver.data_store_mgr import DataStoreMgr

cylc/uiserver/tests/test_workflows_mgr.py

@@ -25,8 +25,8 @@
 from cylc.flow import ID_DELIM
 from cylc.flow.exceptions import ClientError, ClientTimeout
 from cylc.flow.network import API
-from cylc.flow.suite_files import (
-    SuiteFiles,
+from cylc.flow.workflow_files import (
+    WorkflowFiles,
     ContactFileFields as CFF,
 )
 
@@ -139,7 +139,7 @@ async def test_est_workflow(
         if x == 'remote' else False
 
     mocked_client = mocker.patch(
-        'cylc.uiserver.workflows_mgr.SuiteRuntimeClient')
+        'cylc.uiserver.workflows_mgr.WorkflowRuntimeClient')
     mocked_client.return_value = async_client
 
     mocked_get_host_ip_by_name = mocker.patch(
@@ -179,9 +179,9 @@ def mk_flow(path, reg, active=True):
 
     """
     run_dir = path / reg
-    srv_dir = run_dir / SuiteFiles.Service.DIRNAME
-    contact = srv_dir / SuiteFiles.Service.CONTACT
-    fconfig = run_dir / SuiteFiles.FLOW_FILE
+    srv_dir = run_dir / WorkflowFiles.Service.DIRNAME
+    contact = srv_dir / WorkflowFiles.Service.CONTACT
+    fconfig = run_dir / WorkflowFiles.FLOW_FILE
     run_dir.mkdir()
     fconfig.touch()  # cylc uses this to identify a dir as a workflow
     srv_dir.mkdir()
@@ -352,8 +352,8 @@ async def test_register(
     )
     # The following functions also depend on a running workflow
     # with pyzmq socket, so we also mock them.
-    mocker.patch('cylc.flow.network.client.SuiteRuntimeClient.start')
-    mocker.patch('cylc.flow.network.client.SuiteRuntimeClient.get_header')
+    mocker.patch('cylc.flow.network.client.WorkflowRuntimeClient.start')
+    mocker.patch('cylc.flow.network.client.WorkflowRuntimeClient.get_header')
     mocker.patch('cylc.uiserver.data_store_mgr.DataStoreMgr.'
                  'start_subscription')
 
@@ -427,8 +427,8 @@ async def test_connect(
     )
     # The following functions also depend on a running workflow
     # with pyzmq socket, so we also mock them.
-    mocker.patch('cylc.flow.network.client.SuiteRuntimeClient.start')
-    mocker.patch('cylc.flow.network.client.SuiteRuntimeClient.get_header')
+    mocker.patch('cylc.flow.network.client.WorkflowRuntimeClient.start')
+    mocker.patch('cylc.flow.network.client.WorkflowRuntimeClient.get_header')
     mocker.patch('cylc.uiserver.data_store_mgr.DataStoreMgr.'
                  'start_subscription')
 
@@ -489,8 +489,8 @@ async def test_disconnect_and_stop(
     )
     # The following functions also depend on a running workflow
     # with pyzmq socket, so we also mock them.
-    mocker.patch('cylc.flow.network.client.SuiteRuntimeClient.start')
-    mocker.patch('cylc.flow.network.client.SuiteRuntimeClient.get_header')
+    mocker.patch('cylc.flow.network.client.WorkflowRuntimeClient.start')
+    mocker.patch('cylc.flow.network.client.WorkflowRuntimeClient.get_header')
     mocker.patch('cylc.uiserver.data_store_mgr.DataStoreMgr.'
                  'start_subscription')
     mocker.patch('cylc.uiserver.data_store_mgr.DataStoreMgr.update_contact')

cylc/uiserver/workflows_mgr.py

@@ -34,15 +34,15 @@
 from cylc.flow.exceptions import ClientError, ClientTimeout
 from cylc.flow.hostuserutil import is_remote_host, get_host_ip_by_name
 from cylc.flow.network import API
-from cylc.flow.network.client import SuiteRuntimeClient
+from cylc.flow.network.client import WorkflowRuntimeClient
 from cylc.flow.network import MSG_TIMEOUT
 from cylc.flow.network.scan import (
     api_version,
     contact_info,
     is_active,
     scan
 )
-from cylc.flow.suite_files import ContactFileFields as CFF
+from cylc.flow.workflow_files import ContactFileFields as CFF
 
 logger = logging.getLogger(__name__)
 CLIENT_TIMEOUT = 2.0
@@ -53,7 +53,7 @@ async def workflow_request(client, command, args=None,
     """Workflow request command.
 
     Args:
-        client (SuiteRuntimeClient): Instantiated workflow client.
+        client (WorkflowRuntimeClient): Instantiated workflow client.
         command (str): Command/Endpoint name.
         args (dict): Endpoint arguments.
         timeout (float): Client request timeout (secs).
@@ -87,11 +87,11 @@ async def est_workflow(reg, host, port, pub_port, context=None, timeout=None):
             logger.error("ERROR: %s: %s\n", exc, host)
             return (reg, host, port, pub_port, None)
 
-    # NOTE: Connect to the suite by host:port. This way the
-    #       SuiteRuntimeClient will not attempt to check the contact file
+    # NOTE: Connect to the workflow by host:port. This way the
+    #       WorkflowRuntimeClient will not attempt to check the contact file
     #       which would be unnecessary as we have already done so.
     # NOTE: This part of the scan *is* IO blocking.
-    client = SuiteRuntimeClient(reg, context=context, timeout=timeout)
+    client = WorkflowRuntimeClient(reg, context=context, timeout=timeout)
     _, result = await workflow_request(client, 'identify')
     return (reg, host, port, pub_port, client, result)
 
@@ -195,7 +195,7 @@ async def _register(self, wid, flow):
     async def _connect(self, wid, flow):
         """Open a connection to a running workflow."""
         self.active[wid] = flow
-        flow['req_client'] = SuiteRuntimeClient(flow['name'])
+        flow['req_client'] = WorkflowRuntimeClient(flow['name'])
         await self.uiserver.data_store_mgr.sync_workflow(
             wid,
             flow

pytest.ini

@@ -1,4 +1,4 @@
-# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
+# 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