Coverage for python/lsst/ctrl/bps/cancel.py: 19%
18 statements
« prev ^ index » next coverage.py v7.2.1, created at 2023-03-12 03:01 -0700
« prev ^ index » next coverage.py v7.2.1, created at 2023-03-12 03:01 -0700
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 program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
22"""API for cancelling runs submitted to a WMS.
23"""
25import logging
27from lsst.utils import doImport
30_LOG = logging.getLogger(__name__)
33def cancel(wms_service, wms_id=None, user=None, require_bps=True, pass_thru=None):
34 """Cancel submitted workflows.
36 Parameters
37 ----------
38 wms_service : `str` or `lsst.ctrl.bps.BaseWmsService`
39 Name of the Workload Management System service class.
40 wms_id : `str`, optional
41 ID or path of job that should be canceled.
42 user : `str`, optional
43 User whose submitted jobs should be canceled.
44 require_bps : `bool`, optional
45 Whether to require given run_id/user to be a bps submitted job.
46 pass_thru : `str`, optional
47 Information to pass through to WMS.
48 """
49 _LOG.debug("Cancel params: wms_id=%s, user=%s, require_bps=%s, pass_thru=%s",
50 wms_id, user, require_bps, pass_thru)
52 if isinstance(wms_service, str):
53 wms_service_class = doImport(wms_service)
54 service = wms_service_class({})
55 else:
56 service = wms_service
58 jobs = service.list_submitted_jobs(wms_id, user, require_bps, pass_thru)
59 if len(jobs) == 0:
60 print("0 jobs found matching arguments.")
61 else:
62 for job_id in sorted(jobs):
63 results = service.cancel(job_id, pass_thru)
64 if results[0]:
65 print(f"Successfully canceled: {job_id}")
66 else:
67 print(f"Couldn't cancel job with id = {job_id} ({results[1]})")