Coverage for python / lsst / ctrl / bps / submit.py: 44%

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/>. 

27 

28"""Driver for submitting a prepared WMS-specific workflow.""" 

29 

30import logging 

31 

32from lsst.ctrl.bps import BaseWmsService, BaseWmsWorkflow, BpsConfig 

33from lsst.utils import doImport 

34from lsst.utils.logging import VERBOSE 

35from lsst.utils.timer import time_this, timeMethod 

36 

37_LOG = logging.getLogger(__name__) 

38 

39 

40@timeMethod(logger=_LOG, logLevel=VERBOSE) 

41def submit( 

42 config: BpsConfig, wms_workflow: BaseWmsWorkflow, wms_service: BaseWmsService | None = None, **kwargs 

43) -> BaseWmsWorkflow: 

44 """Convert generic workflow to a workflow for a particular WMS. 

45 

46 Parameters 

47 ---------- 

48 config : `lsst.ctrl.bps.BpsConfig` 

49 Configuration values to be used by submission. 

50 wms_workflow : `lsst.ctrl.bps.BaseWmsWorkflow` 

51 The workflow to submit. 

52 wms_service : `lsst.ctrl.bps.BaseWmsService`, optional 

53 The workflow management service to which the workflow should be 

54 submitted. 

55 **kwargs : `~typing.Any` 

56 Additional modifiers to submit a workflow. 

57 

58 Returns 

59 ------- 

60 wms_workflow : `lsst.ctrl.bps.BaseWmsWorkflow` 

61 WMS-specific workflow. 

62 """ 

63 if wms_service is None: 

64 wms_service_class = doImport(config["wmsServiceClass"]) 

65 wms_service = wms_service_class(config) 

66 

67 kwargs["config"] = config 

68 

69 _LOG.info("Submitting run to a workflow management system for execution") 

70 with time_this( 

71 log=_LOG, level=logging.INFO, prefix=None, msg="Completed submitting to a workflow management system" 

72 ): 

73 workflow = wms_service.submit(wms_workflow, **kwargs) 

74 return workflow