feat(campaing): use diffefrent namespaced names in steps and scripts

Author: tcjennings

examples/example_standard_elements.yaml

@@ -83,7 +83,7 @@
                     output: "{step_public_output}"
       child_config:
           spec_block: group
-# Campagin Template, runs a campaign
+# Campaign Template, runs a campaign
 # This will tag the input data, create the ancillary collection, run the steps and then collect the outputs
 # Note that the steps are not defined here.
 - SpecBlock:
@@ -147,7 +147,7 @@
       data:
           lsst_version: MUST_OVERRIDE
           lsst_distrib_dir: /cvmfs/sw.lsst.eu/linux-x86_64/lsst_distrib
-# Campagin Template for fixed inputs
+# Campaign Template for fixed inputs
 # This assumes that the input data is already set, it will run the steps and then collect the outputs
 # Note that the steps are not defined here.
 - SpecBlock:

src/lsst/cmservice/client/loaders.py

@@ -143,21 +143,41 @@ def _upsert_spec_block(
                 },
             )
 
+        # scripts and steps are lists, not mappings
         if "scripts" in block_data:
-            # scripts and steps are lists, not mappings
+            # the 'name' of the script should be namespaced; the 'spec_block'
+            # of the script is a key to its specification alias within the
+            # campaign, which itself references a namespaced spec_block.
             block_data["scripts"] = [
                 deep_update(
                     s,
-                    {"Script": {"spec_block": str(uuid5(namespace, s["Script"]["spec_block"]))}},
+                    {
+                        "Script": {
+                            "name": str(uuid5(namespace, s["Script"]["name"])),
+                            "spec_block": s["Script"]["spec_block"],
+                        }
+                    },
                 )
                 for s in block_data["scripts"]
             ]
 
         if "steps" in block_data:
+            # steps are found in a campaign spec_block; the 'spec_block' should
+            # be namespaced but the 'name' is a descriptor not used to refer-
+            # ence other objects. Any names used in a prerequisites should be
+            # namespaced.
             block_data["steps"] = [
                 deep_update(
                     s,
-                    {"Step": {"spec_block": str(uuid5(namespace, s["Step"]["spec_block"]))}},
+                    {
+                        "Step": {
+                            "name": s["Step"]["name"],  # str(uuid5(namespace, s["Step"]["name"])),
+                            "spec_block": str(uuid5(namespace, s["Step"]["spec_block"])),
+                            "prerequisites": [
+                                str(uuid5(namespace, prereq)) for prereq in s["Step"].get("prerequisites", [])
+                            ],
+                        }
+                    },
                 )
                 for s in block_data["steps"]
             ]

src/lsst/cmservice/db/node.py

@@ -137,12 +137,10 @@ async def get_handler(
         self,
         session: async_scoped_session,
     ) -> Handler:
-        """Get the Handler object associated to a particular row
+        """Get the Handler object associated with a particular row
 
-        This will check if the handler class is defined
-        for that particular row, if it is not, it
-        will use the class as defined in the associated
-        `SpecBlock`
+        Check if a handler class is defined for a particular row; if not, use
+        the class as defined in the associated `SpecBlock`.
 
         Parameters
         ----------
@@ -382,13 +380,10 @@ async def get_spec_aliases(
         self,
         session: async_scoped_session,
     ) -> dict:
-        """Get the spec_alises
-        associated to a particular node
+        """Get the spec_aliases associated with a particular node
 
-        This will start with the spec_aliases
-        configuration in the associated `SpecBlock`
-        and override it with with the data
-        configuration in the row
+        This will start with the spec_aliases configuration in the associated
+        `SpecBlock` and override it with with the data configuration in the row
 
         Parameters
         ----------
@@ -463,8 +458,7 @@ async def update_collections(
         session: async_scoped_session,
         **kwargs: Any,
     ) -> NodeMixin:
-        """Update the collection configuration
-        associated to this Node
+        """Update the collection configuration associated with this Node
 
         Parameters
         ----------
@@ -506,8 +500,7 @@ async def update_spec_aliases(
         session: async_scoped_session,
         **kwargs: Any,
     ) -> NodeMixin:
-        """Update the spec_alisases configuration
-        associated to this Node
+        """Update the spec_alisases configuration associated with this Node
 
         Parameters
         ----------
@@ -550,8 +543,7 @@ async def update_data_dict(
         session: async_scoped_session,
         **kwargs: Any,
     ) -> NodeMixin:
-        """Update the data configuration
-        associated to this Node
+        """Update the data configuration associated with this Node
 
         Parameters
         ----------
@@ -593,9 +585,8 @@ async def check_prerequisites(
         self,
         session: async_scoped_session,
     ) -> bool:
-        """Check if the prerequisties
-        for processing a particular row
-        are completed
+        """Check if the prerequisties for processing a particular node are
+        completed.
 
         Parameters
         ----------
@@ -719,8 +710,7 @@ async def process(
     ) -> tuple[bool, StatusEnum]:
         """Process this `Node` as much as possible
 
-        This will create a `Handler` and
-        pass this node to it for processing
+        This will create a `Handler` and pass this node to it for processing
 
         Parameters
         ----------
@@ -745,8 +735,7 @@ async def run_check(
     ) -> tuple[bool, StatusEnum]:
         """Check on this Nodes's status
 
-        This will create a `Handler` and
-        pass this node to it for checking
+        This will create a `Handler` and pass this node to it for checking
 
         Parameters
         ----------

src/lsst/cmservice/handlers/element_handler.py

@@ -129,8 +129,7 @@ async def prepare(
     ) -> tuple[bool, StatusEnum]:
         """Prepare `Element` for processing
 
-        This means creating database entries for scripts and
-        dependencies between them
+        Creates database entries for scripts and their inter-dependencies
 
         Parameters
         ----------
@@ -164,6 +163,7 @@ async def prepare(
                 script_name = script_vals.pop("name")
             except KeyError as msg:
                 raise CMYamlParseError(f"Unnnamed Script block {script_vals}") from msg
+
             script_spec_block_name = script_vals.get("spec_block", None)
             if script_spec_block_name is None:  # pragma: no cover
                 raise CMYamlParseError(f"Script block {script_name} does not contain spec_block")