Coverage for python/lsst/ctrl/bps/submit.py: 30%
25 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-03 10:06 +0000
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-03 10:06 +0000
1# This file is part of ctrl_bps.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <https://www.gnu.org/licenses/>.
28"""Driver for submitting a prepared WMS-specific workflow.
29"""
30import logging
32from lsst.ctrl.bps.bps_utils import _create_execution_butler
33from lsst.utils import doImport
34from lsst.utils.logging import VERBOSE
35from lsst.utils.timer import time_this, timeMethod
37_LOG = logging.getLogger(__name__)
40@timeMethod(logger=_LOG, logLevel=VERBOSE)
41def submit(config, wms_workflow, wms_service=None, **kwargs):
42 """Convert generic workflow to a workflow for a particular WMS.
44 Parameters
45 ----------
46 config : `lsst.ctrl.bps.BpsConfig`
47 Configuration values to be used by submission.
48 wms_workflow : `lsst.ctrl.bps.BaseWmsWorkflow`
49 The workflow to submit.
50 wms_service : `lsst.ctrl.bps.BaseWmsService`, optional
51 The workflow management service to which the workflow should be
52 submitted.
53 **kwargs : `~typing.Any`
54 Additional modifiers to submit a workflow.
56 Returns
57 -------
58 wms_workflow : `lsst.ctrl.bps.BaseWmsWorkflow`
59 WMS-specific workflow.
60 """
61 if wms_service is None:
62 wms_service_class = doImport(config["wmsServiceClass"])
63 wms_service = wms_service_class(config)
65 remote_build = kwargs["remote_build"] if "remote_build" in kwargs else None
66 kwargs["config"] = config
68 if not remote_build:
69 _, when_create = config.search(".executionButler.whenCreate")
70 if when_create.upper() == "SUBMIT":
71 _, execution_butler_dir = config.search(".bps_defined.executionButlerDir")
72 _LOG.info("Creating execution butler in '%s'", execution_butler_dir)
73 with time_this(
74 log=_LOG, level=logging.INFO, prefix=None, msg="Completed creating execution butler"
75 ):
76 _create_execution_butler(
77 config, config["runQgraphFile"], execution_butler_dir, config["submitPath"]
78 )
80 _LOG.info("Submitting run to a workflow management system for execution")
81 with time_this(
82 log=_LOG, level=logging.INFO, prefix=None, msg="Completed submitting to a workflow management system"
83 ):
84 workflow = wms_service.submit(wms_workflow, **kwargs)
85 return workflow