lsst-ctrl-bps 29.2025.2400__tar.gz → 29.2025.2600__tar.gz

{lsst_ctrl_bps-29.2025.2400/python/lsst_ctrl_bps.egg-info → lsst_ctrl_bps-29.2025.2600}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsst-ctrl-bps
-Version: 29.2025.2400
+Version: 29.2025.2600
 Summary: Pluggable execution of workflow graphs from Rubin pipelines.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License: BSD 3-Clause License

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600}/doc/lsst.ctrl.bps/CHANGES.rst

@@ -1,3 +1,29 @@
+lsst-ctrl-bps v29.1.0 (2025-06-13)
+==================================
+
+New Features
+------------
+
+- Added ability to enforce workflow job ordering beyond data dependencies. (`DM-46294 <https://rubinobs.atlassian.net/browse/DM-46294>`_)
+- Added partitioning of clusters for when clustering on two dimensions makes too many short jobs but one dimension makes too few long jobs. (`DM-49240 <https://rubinobs.atlassian.net/browse/DM-49240>`_)
+- Added status subcommand to quickly print overall run status. (`DM-50619 <https://rubinobs.atlassian.net/browse/DM-50619>`_)
+
+
+API Changes
+-----------
+
+- The ``check_clustering_config`` function is now public to support testing of clustering configuration YAML files. (`DM-49222 <https://rubinobs.atlassian.net/browse/DM-49222>`_)
+
+
+Other Changes and Additions
+---------------------------
+
+- BPS commands involved in making submissions now exit with the exit codes of the subprocess that BPS spawns to generate or update the run's quantum graph if any failure occurs. (`DM-49744 <https://rubinobs.atlassian.net/browse/DM-49744>`_)
+- Added check that every job label in a group config has at least one job. (`DM-49747 <https://rubinobs.atlassian.net/browse/DM-49747>`_)
+- Ensured all job environment values are strings in the ``GenericWorkflow``. (`DM-50498 <https://rubinobs.atlassian.net/browse/DM-50498>`_)
+- Added logging instructions to documentation. (`DM-50243 <https://rubinobs.atlassian.net/browse/DM-50243>`_)
+- Decreased buffering for writing ``stdout``/``stderr`` to file when generating or updating ``QuantumGraph``. (`DM-50294 <https://rubinobs.atlassian.net/browse/DM-50294>`_)
+
 lsst-ctrl-bps v29.0.0 (2025-03-25)
 ==================================
 

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600}/doc/lsst.ctrl.bps/quickstart.rst

@@ -1497,6 +1497,49 @@ invisible to the user.  ``bps report`` will still show same labels and
 total counts as without ordering.  ``cancel`` and ``restart`` will still
 work the same.
 
+.. _bps-config-generation:
+
+Config Generation
+-----------------
+
+In some rare use cases, the submit yaml depends upon what happened in
+previous runs (e.g., passing pipeline configuration values to the HiPS
+QuantumGraph generation command depending upon colors of generated outputs
+of previous run).  One can wait until a run finishes, query the results,
+and then manually modify the submit yaml for the next run.  To help make
+this easier to automate, two special mechanisms, ``bpsGenerateConfig`` and
+``bpsEval`` have been added to ``bps``.  While different syntax, both take
+two pieces of information.  The first piece describes what to import and
+execute and the second the parameters to pass which typically will
+be config variables (e.g., "{butlerConfig}").
+
+``bpsGenerateConfig`` is a key/value pair where the function returns a
+Mapping to update the config.  It can be used at the root level and can
+return nested dictionaries to replace values across multiple sections.
+It can also be used inside sections (e.g., inside a specific pipetask
+section).  The function is not run when loading the config.  Instead it
+is run during the initialization in the ``bps submit`` (before saving
+the config yaml to the submit directory and before running QuantumGraph
+generation).  Example:
+
+..code::
+
+  bpsGenerateConfig: "lsst.my.package.my_func_1('{butlerConfig}', param3='{output}')"
+
+
+``bpsEval`` is a placeholder in an submit yaml value.  It is executed when
+the corresponding key is requested from the config.  Its function needs
+to return a value whose string representation can replace ``bpsEval``.  Example:
+
+..code::
+
+  extraQgraphOptions: "--dataset-query-constraint off bpsEval(lsst.my.package.my_func_2, '{butlerConfig}', '{output}')
+
+.. warning::
+
+   Quotes must be placed around variables that return strings (e.g., '{butlerConfig}').
+   Forgetting the quotes typically results in an invalid syntax error.
+
 .. _bps-softlink:
 
 WMS-id softlink

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600}/python/lsst/ctrl/bps/bps_config.py

@@ -44,6 +44,8 @@ from lsst.daf.butler import Config
 from lsst.resources import ResourcePath
 from lsst.utils import doImport
 
+from .bps_utils import bps_eval
+
 _LOG = logging.getLogger(__name__)
 
 # Using lsst.daf.butler.Config to resolve possible includes.
@@ -417,4 +419,63 @@ class BpsConfig(Config):
         if default != _NO_SEARCH_DEFAULT_VALUE:
             opt["default"] = default
 
+        # check for bpsEval
+        value = re.sub(
+            r"bpsEval\(([^,)]+), ([^)]+)\)", lambda m: str(bps_eval(m.group(1), m.group(2))), value
+        )
+        if "bpsEval" in value:
+            raise ValueError(f"Unparsable bpsEval in '{value}'")
+
         return value
+
+    def generate_config(self) -> None:
+        """Update config with values generated by bpsGenerateConfig
+        entries.
+        """
+        _LOG.debug("generate_config before: %s", self)
+        self._recursive_generate_config("", self)
+        _LOG.debug("generate_config after: %s", self)
+
+    def _recursive_generate_config(self, recursive_key: str, sub_config: Config) -> None:
+        """Update config with values generated by bpsGenerateConfig
+        entries.
+
+        Parameters
+        ----------
+        recursive_key : `str`
+            Corresponds to a new subconfig in which to search
+            and replace bpsGenerateConfig.
+
+        sub_config : `lsst.daf.butler.Config`
+            The nested config corresponding to the recursive_key.
+
+        Raises
+        ------
+        ValueError
+            If bpsGenerateConfig value isn't parseable.
+        ImportError
+            If problems importing bpsGenerateConfig's method.
+        """
+        _LOG.debug("recursive_key = '%s'", recursive_key)
+        genkey = "bpsGenerateConfig"  # to make it easier to change
+
+        # Save to avoid dictionary changed size during iteration error.
+        orig_keys = list(sub_config)
+        for key in orig_keys:
+            value = Config.__getitem__(sub_config, key)
+            _LOG.debug("key = %s, type(value) = %s", key, type(value))
+            if isinstance(value, Config):
+                self._recursive_generate_config(f"{recursive_key}.{key}", value)
+            elif key == genkey:
+                value = self.replace_vars(value, {"searchobj": sub_config})
+
+                m = re.match(r"(\S+)\((.+)\)", value)
+                if m:
+                    results = bps_eval(m.group(1), m.group(2))
+                    del sub_config[genkey]
+                    sub_config.update(results)
+                    if recursive_key:
+                        self[recursive_key] = sub_config
+                    _LOG.debug("After config = %s", self)
+                else:
+                    raise ValueError(f"Unparsable {genkey} value='{value}'")

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600}/python/lsst/ctrl/bps/bps_utils.py

@@ -31,6 +31,7 @@ __all__ = [
     "_dump_env_info",
     "_dump_pkg_info",
     "_make_id_link",
+    "bps_eval",
     "chdir",
     "create_count_summary",
     "create_job_quantum_graph_filename",
@@ -52,6 +53,7 @@ from typing import Any
 
 import yaml
 
+from lsst.utils import doImport
 from lsst.utils.packages import Packages
 
 _LOG = logging.getLogger(__name__)
@@ -353,3 +355,35 @@ def subset_dimension_values(
             f"{desc_what} missing dimensions ({', '.join(sorted(missing_dims))}) required for {desc_for}"
         )
     return dim_values
+
+
+def bps_eval(func: str, args: str) -> Any:
+    """Evaluate user provided expression/function.
+
+    Parameters
+    ----------
+    func : `str`
+        Importable string or built-in function name.
+    args : `str`
+        Parameters to pass to the function.
+
+    Returns
+    -------
+    results : `~typing.Any`
+        Results of running eval.
+
+    Raises
+    ------
+    ImportError
+        If problems importing.
+    """
+    if "." in func:
+        genfunc = doImport(func)  # noqa: F841
+        func_reference = "genfunc"
+    else:
+        func_reference = func
+    eval_str = f"{func_reference}({args})"
+    _LOG.debug("String passed to eval: '%s'", eval_str)
+    results = eval(eval_str)
+
+    return results

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600}/python/lsst/ctrl/bps/etc/bps_defaults.yaml

@@ -115,6 +115,7 @@ executionButler:
   whenCreate: "NEVER"
 
 finalJob:
+  retryUnlessExit: 2
   updateOutputChain: "--update-output-chain"
   whenSetup: "NEVER"
   whenRun: "ALWAYS"

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600}/python/lsst/ctrl/bps/initialize.py

@@ -130,6 +130,9 @@ def init_submission(
     else:
         _LOG.debug("Skipping submission checks.")
 
+    # Replace all bpsGenerateConfig
+    config.generate_config()
+
     # Make submit directory to contain all outputs.
     submit_path = mkdir(config["submitPath"])
     config[".bps_defined.submitPath"] = str(submit_path)

lsst_ctrl_bps-29.2025.2600/python/lsst/ctrl/bps/tests/config_test_utils.py

@@ -0,0 +1,114 @@
+# This file is part of ctrl_bps.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This software is dual licensed under the GNU General Public License and also
+# under a 3-clause BSD license. Recipients may choose which of these licenses
+# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
+# respectively.  If you choose the GPL option then the following text applies
+# (but note that there is still no warranty even if you opt for BSD instead):
+#
+# 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 <https://www.gnu.org/licenses/>.
+"""BpsConfig-related utilities to support ctrl_bps testing."""
+
+__all__ = ["generate_config_1", "generate_config_2", "generate_config_all"]
+
+from typing import Any
+
+
+def generate_config_1(param1: int, param2: int = -1, param3: int = -2) -> dict[str, Any]:
+    """Return a dictionary for updating a config in unit tests.
+
+    Parameters
+    ----------
+    param1 : `int`
+        First param.
+    param2 : `int`, optional
+        Second param.  Defaults to -1.
+    param3 : `int`, optional
+        Third param.  Defaults to -2.
+
+    Returns
+    -------
+    results : `dict` [`str`, `~typing.Any`]
+        The mocked results.
+    """
+    results = {"gencfg_1": param1, "gencfg_2": param2, "gencfg_3": param3, "p4": 41}
+    return results
+
+
+def generate_config_2(param1: int, param2: int = -3, param3: int = -4) -> dict[str, Any]:
+    """Return a dictionary for updating a config in unit tests.
+
+    Parameters
+    ----------
+    param1 : `int`
+        First param.
+    param2 : `int`, optional
+        Second param.  Defaults to -3.
+    param3 : `int`, optional
+        Third param.  Defaults to -4.
+
+    Returns
+    -------
+    results : `dict` [`str`, `~typing.Any`]
+        The mocked results.
+    """
+    results = {"gencfg_4": param1, "gencfg_5": param2, "gencfg_6": param3, "p4": 42}
+    return results
+
+
+def generate_config_all(param1: str, param2: int = -5, param3: int = -6) -> dict[str, Any]:
+    """Return a dictionary for updating multiple sections in a config.
+
+    Parameters
+    ----------
+    param1 : `str`
+        First param.
+    param2 : `int`, optional
+        Second param.  Defaults to -2.
+    param3 : `int`, optional
+        Third param.  Defaults to -5.
+
+    Returns
+    -------
+    results : `dict` [`str`, `~typing.Any`]
+        The mocked results.
+    """
+    results = {
+        "genall_1": param1,
+        "pipetask": {"ptask1": {"genall_2": param2}},
+        "finalJob": {"genall_3": param3},
+    }
+    return results
+
+
+def generate_value_1(param1: int) -> str:
+    """Return a string for updating a config value in unit tests.
+
+    Parameters
+    ----------
+    param1 : `int`
+        First param.
+
+    Returns
+    -------
+    results : `str`
+        The mocked result.
+    """
+    return f"-c val2:{param1}"

lsst_ctrl_bps-29.2025.2600/python/lsst/ctrl/bps/version.py

@@ -0,0 +1,2 @@
+__all__ = ["__version__"]
+__version__ = "29.2025.2600"

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600/python/lsst_ctrl_bps.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsst-ctrl-bps
-Version: 29.2025.2400
+Version: 29.2025.2600
 Summary: Pluggable execution of workflow graphs from Rubin pipelines.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License: BSD 3-Clause License

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600}/python/lsst_ctrl_bps.egg-info/SOURCES.txt

@@ -44,6 +44,7 @@ python/lsst/ctrl/bps/cli/opt/arguments.py
 python/lsst/ctrl/bps/cli/opt/option_groups.py
 python/lsst/ctrl/bps/cli/opt/options.py
 python/lsst/ctrl/bps/etc/bps_defaults.yaml
+python/lsst/ctrl/bps/tests/config_test_utils.py
 python/lsst/ctrl/bps/tests/gw_test_utils.py
 python/lsst_ctrl_bps.egg-info/PKG-INFO
 python/lsst_ctrl_bps.egg-info/SOURCES.txt
@@ -59,6 +60,7 @@ tests/test_clustered_quantum_graph.py
 tests/test_construct.py
 tests/test_drivers.py
 tests/test_generic_workflow.py
+tests/test_initialize.py
 tests/test_ping.py
 tests/test_pre_transform.py
 tests/test_quantum_clustering_funcs.py

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600}/tests/test_bps_utils.py

@@ -31,7 +31,7 @@ import unittest
 from pathlib import Path
 
 from lsst.ctrl.bps import BpsConfig
-from lsst.ctrl.bps.bps_utils import _make_id_link, chdir, mkdir
+from lsst.ctrl.bps.bps_utils import _make_id_link, bps_eval, chdir, mkdir
 
 
 class TestMkdir(unittest.TestCase):
@@ -224,5 +224,16 @@ class TestMakeIdLink(unittest.TestCase):
         self.assertFalse(link_path.is_symlink())
 
 
+class TestBpsEval(unittest.TestCase):
+    """Test bps_eval function."""
+
+    def testBuiltIn(self):
+        """Test using a built-in function."""
+        with self.assertLogs("lsst.ctrl.bps.bps_utils", level=logging.DEBUG) as cm:
+            results = bps_eval("sum", "[1, 2]")
+        self.assertEqual(results, 3)
+        self.assertEqual(cm.records[-1].getMessage(), "String passed to eval: 'sum([1, 2])'")
+
+
 if __name__ == "__main__":
     unittest.main()

{lsst_ctrl_bps-29.2025.2400 → lsst_ctrl_bps-29.2025.2600}/tests/test_bpsconfig.py

@@ -289,7 +289,6 @@ class TestBpsConfigSearch(unittest.TestCase):
         test_opt = {"expandEnvVars": True, "replaceEnvVars": True, "replaceVars": True}
         found, value = self.config.search("grault", opt=test_opt)
         self.assertEqual(found, True)
-        self.assertEqual(found, True)
         self.assertEqual(value, "garply/waldo/002")
 
     def testRequired(self):
@@ -298,5 +297,138 @@ class TestBpsConfigSearch(unittest.TestCase):
             self.config.search("fred", opt={"required": True})
 
 
+class TestBpsConfigGenerateConfig(unittest.TestCase):
+    """Test BpsConfig.generate_config and bpsEval methods."""
+
+    def setUp(self):
+        # Just to shorten string length in tests
+        self.test_prefix = "lsst.ctrl.bps.tests.config_test_utils"
+
+        filename = os.path.join(TESTDIR, "data/initialize_config.yaml")
+        self.config = BpsConfig(filename, BPS_SEARCH_ORDER, defaults={})
+
+    def testUnparsableValue(self):
+        config = BpsConfig(
+            {
+                "p1": 3,
+                "p3": 16,
+            },
+            BPS_SEARCH_ORDER,
+        )
+        # invalid function name
+        config["bpsGenerateConfig"] = "not a valid name({p1}, param3={p3})"
+        with self.assertRaisesRegex(ValueError, "Unparsable bpsGenerateConfig value='not a valid"):
+            config.generate_config()
+
+    def testMissingParen(self):
+        config = BpsConfig(
+            {
+                "p1": 3,
+                "p3": 16,
+            },
+            BPS_SEARCH_ORDER,
+        )
+        # invalid function name
+        config["bpsGenerateConfig"] = self.test_prefix + ".generate_config_1(1, param3=2"
+        with self.assertRaisesRegex(ValueError, "Unparsable bpsGenerateConfig value='"):
+            config.generate_config()
+
+    def testBadFunctionName(self):
+        config = BpsConfig(
+            {
+                "p1": 3,
+                "p3": 16,
+            },
+            BPS_SEARCH_ORDER,
+        )
+        # invalid function name
+        config["bpsGenerateConfig"] = self.test_prefix + ".notthere({p1}, param3={p3})"
+        with self.assertRaisesRegex(ImportError, "notthere"):
+            config.generate_config()
+
+    def testBadModuleName(self):
+        config = BpsConfig(
+            {
+                "p1": 3,
+                "p3": 16,
+            },
+            BPS_SEARCH_ORDER,
+        )
+        # invalid module name
+        config["bpsGenerateConfig"] = "lsst.ctrl.bps.notthere.generate_config(1, 2)"
+        with self.assertRaisesRegex(ImportError, "notthere"):
+            config.generate_config()
+
+    def testBadParamName(self):
+        config = BpsConfig(
+            {"p1": 3, "p3": 16, "bpsGenerateConfig": self.test_prefix + ".generate_config_1(1, param5=2)"},
+            BPS_SEARCH_ORDER,
+        )
+        with self.assertRaisesRegex(TypeError, "unexpected keyword argument 'param5'"):
+            config.generate_config()
+
+    def testExtraParam(self):
+        config = BpsConfig(
+            {
+                "p1": 3,
+                "p3": 16,
+                "bpsGenerateConfig": self.test_prefix + ".generate_config_1({p1}, 2, {p3}, 4)",
+            },
+            BPS_SEARCH_ORDER,
+        )
+        with self.assertRaisesRegex(TypeError, "positional arguments"):
+            config.generate_config()
+
+    def testWithSearchOrder(self):
+        # Check that bpsGenerateConfig is replaced in search sections
+        #     (e.g., pipetask) And when replacing vars in subsections
+        #     config ordering is used.
+        # Ditto for finalJob (which isn't a search section).
+        # Checking all in single function to ensure doesn't quit early.
+        self.config.generate_config()
+
+        filename = os.path.join(TESTDIR, "data/initialize_config_truth.yaml")
+        truth = BpsConfig(filename, BPS_SEARCH_ORDER, defaults={})
+
+        self.assertEqual(self.config, truth)
+
+    def testBpsEval(self):
+        """Test replacing bpsEval when need to import module."""
+        test_opt = {
+            "expandEnvVars": True,
+            "replaceEnvVars": True,
+            "replaceVars": True,
+            "curvals": {"curr_pipetask": "ptask1"},
+        }
+        found, value = self.config.search("genval1", opt=test_opt)
+        self.assertEqual(found, True)
+        self.assertEqual(value, "-c val1:0.1 -c val2:3")
+
+    def testBpsEvalBuiltin(self):
+        """Test replacing bpsEval with builtin function."""
+        test_opt = {
+            "expandEnvVars": True,
+            "replaceEnvVars": True,
+            "replaceVars": True,
+            "curvals": {"curr_pipetask": "ptask1"},
+        }
+        found, value = self.config.search("genval2", opt=test_opt)
+        self.assertEqual(found, True)
+        self.assertEqual(value, "-c val1:32")
+
+    def testBpsEvalInvalid(self):
+        """Test reporting not replacing bpsEval."""
+        test_opt = {
+            "expandEnvVars": True,
+            "replaceEnvVars": True,
+            "replaceVars": True,
+            "curvals": {"curr_pipetask": "ptask1"},
+        }
+
+        self.config["badkey1"] = "badval1 bpsEval('sum([1,2]') blah"
+        with self.assertRaisesRegex(ValueError, "Unparsable bpsEval in 'badval1 bpsEval"):
+            _ = self.config.search("badkey1", opt=test_opt)
+
+
 if __name__ == "__main__":
     unittest.main()

lsst_ctrl_bps-29.2025.2600/tests/test_initialize.py

@@ -0,0 +1,180 @@
+# This file is part of ctrl_bps.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This software is dual licensed under the GNU General Public License and also
+# under a 3-clause BSD license. Recipients may choose which of these licenses
+# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
+# respectively.  If you choose the GPL option then the following text applies
+# (but note that there is still no warranty even if you opt for BSD instead):
+#
+# 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 <https://www.gnu.org/licenses/>.
+
+"""Unit tests for initialize.py"""
+
+import logging
+import os
+import tempfile
+import unittest
+from pathlib import Path
+
+from lsst.ctrl.bps import BpsConfig
+from lsst.ctrl.bps.initialize import (
+    init_submission,
+    out_collection_validator,
+    output_run_validator,
+    submit_path_validator,
+)
+
+TESTDIR = os.path.abspath(os.path.dirname(__file__))
+
+
+class TestOutCollectionValidator(unittest.TestCase):
+    """Checks that 'outCollection' is *not* specified in config.
+
+    Assumes BpsConfig tests cover whether it finds values.
+    """
+
+    def testSuccess(self):
+        config = BpsConfig({}, defaults={})
+        out_collection_validator(config)
+
+    def testFailure(self):
+        config = BpsConfig({"outCollection": "dummy_collection"}, defaults={})
+        with self.assertRaisesRegex(
+            KeyError, "'outCollection' is deprecated. Replace all references to it with 'outputRun'"
+        ):
+            out_collection_validator(config)
+
+
+class TestOutputRunValidator(unittest.TestCase):
+    """Checks that 'outputRun' is specified in config.
+
+    Assumes BpsConfig tests cover whether it finds values.
+    """
+
+    def testSuccess(self):
+        config = BpsConfig({"outputRun": "dummy_run_value"}, defaults={})
+        output_run_validator(config)
+
+    def testFailure(self):
+        config = BpsConfig({}, defaults={})
+        with self.assertRaisesRegex(KeyError, "Must specify the output run collection using 'outputRun'"):
+            output_run_validator(config)
+
+
+class TestSubmitPathValidator(unittest.TestCase):
+    """Check that 'submitPath' is specified in BPS config.
+
+    Assumes BpsConfig tests cover whether it finds values.
+    """
+
+    def testSuccess(self):
+        config = BpsConfig({"submitPath": "submit/dummy/path"}, defaults={})
+        submit_path_validator(config)
+
+    def testFailure(self):
+        config = BpsConfig({}, defaults={})
+        with self.assertRaisesRegex(
+            KeyError, "Must specify the submit-side run directory using 'submitPath'"
+        ):
+            submit_path_validator(config)
+
+
+class TestInitSubmission(unittest.TestCase):
+    """Check init_submission_function."""
+
+    def setUp(self):
+        self.temp_dir = tempfile.TemporaryDirectory()
+
+    def tearDown(self):
+        self.temp_dir.cleanup()
+
+    def testBasicSuccess(self):
+        filename = os.path.join(TESTDIR, "data/initialize_config.yaml")
+        validators = [submit_path_validator, output_run_validator, out_collection_validator]
+        config = init_submission(
+            filename,
+            validators=validators,
+            compute_site="local",
+            runWmsSubmissionChecks=False,
+            wms_service="wms_test_utils.WmsServiceSuccess",
+            tempDir=self.temp_dir.name,
+            multVal=["a", "b", "c"],
+        )
+        self.assertIn(".bps_defined.timestamp", config)
+        self.assertIn(".bps_defined.operator", config)
+        self.assertIn(".bps_defined.uniqProcName", config)
+        self.assertIn(".bps_defined.submitPath", config)
+        self.assertEqual(config[".bps_cmdline.computeSite"], "local")
+        self.assertEqual(config[".bps_cmdline.multVal"], "a,b,c")
+        uniq_proc_name = config[".bps_defined.uniqProcName"]
+        submit_path = Path(config[".bps_defined.submitPath"]).resolve()
+        files = [f.name for f in submit_path.iterdir() if f.is_file()]
+        self.assertIn("initialize_config.yaml", files)
+        self.assertIn(f"{uniq_proc_name}_config.yaml", files)
+        self.assertIn(f"{uniq_proc_name}.env.info.yaml", files)
+        self.assertIn(f"{uniq_proc_name}.pkg.info.yaml", files)
+
+        # generate_config tested elsewhere so just
+        # check a couple values that shows it ran.
+        self.assertEqual(config[".genall_1"], "/repo/test")
+        self.assertEqual(config[".pipetask.ptask1.p3"], 32)
+        self.assertEqual(config[".finalJob.gencfg_4"], 9)
+
+    @unittest.mock.patch("lsst.ctrl.bps.initialize.BPS_DEFAULTS", {})
+    def testMissingWmsServiceClass(self):
+        filename = os.path.join(TESTDIR, "data/initialize_config.yaml")
+
+        with self.assertRaisesRegex(KeyError, "Missing wmsServiceClass in bps config.  Aborting."):
+            _ = init_submission(filename, runWmsSubmissionChecks=True, tempDir=self.temp_dir.name)
+
+    @unittest.mock.patch("lsst.ctrl.bps.initialize.BPS_DEFAULTS", {})
+    def testSubmissionChecksNotImplemented(self):
+        filename = os.path.join(TESTDIR, "data/initialize_config.yaml")
+
+        with self.assertLogs("lsst.ctrl.bps.initialize", level=logging.DEBUG) as cm:
+            config = init_submission(
+                filename,
+                runWmsSubmissionChecks=True,
+                tempDir=self.temp_dir.name,
+                wms_service="wms_test_utils.WmsServiceSuccess",
+            )
+        output = " ".join(cm.output)
+        self.assertIn("run_submission_checks is not implemented in wms_test_utils.WmsServiceSuccess.", output)
+        self.assertIn(".bps_defined.timestamp", config)
+        uniq_proc_name = config[".bps_defined.uniqProcName"]
+        submit_path = Path(config[".bps_defined.submitPath"]).resolve()
+        files = [f.name for f in submit_path.iterdir() if f.is_file()]
+        self.assertIn("initialize_config.yaml", files)
+        self.assertIn(f"{uniq_proc_name}_config.yaml", files)
+        self.assertIn(f"{uniq_proc_name}.env.info.yaml", files)
+        self.assertIn(f"{uniq_proc_name}.pkg.info.yaml", files)
+
+    @unittest.mock.patch(
+        "lsst.ctrl.bps.initialize.BPS_DEFAULTS", {"operator": "testuser", "uniqProcName": "uniqval"}
+    )
+    def testAlreadySet(self):
+        """Test if operator and uniqProcName already set."""
+        filename = os.path.join(TESTDIR, "data/initialize_config.yaml")
+
+        config = init_submission(filename, runWmsSubmissionChecks=False, tempDir=self.temp_dir.name)
+        self.assertEqual(config["operator"], "testuser")
+        self.assertNotIn(".bps_defined.operator", config)
+        self.assertEqual(config["uniqProcName"], "uniqval")
+        self.assertNotIn(".bps_defined.uniqProcName", config)

lsst_ctrl_bps-29.2025.2400/python/lsst/ctrl/bps/version.py

@@ -1,2 +0,0 @@
-__all__ = ["__version__"]
-__version__ = "29.2025.2400"