Coverage for python/lsst/ctrl/bps/cli/cmd/commands.py: 87%
63 statements
« prev ^ index » next coverage.py v6.5.0, created at 2023-02-21 01:31 -0800
« prev ^ index » next coverage.py v6.5.0, created at 2023-02-21 01:31 -0800
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/>.
21"""Subcommand definitions.
22"""
23import click
24from lsst.daf.butler.cli.utils import MWCommand
26from ...drivers import (
27 acquire_qgraph_driver,
28 cancel_driver,
29 cluster_qgraph_driver,
30 ping_driver,
31 prepare_driver,
32 report_driver,
33 restart_driver,
34 submit_driver,
35 transform_driver,
36)
37from .. import opt
40class BpsCommand(MWCommand):
41 """Command subclass with bps-command specific overrides."""
43 extra_epilog = "See 'bps --help' for more options."
46@click.command(cls=BpsCommand)
47@opt.config_file_argument(required=True)
48@opt.submission_options()
49def acquire(*args, **kwargs):
50 """Create a new quantum graph or read existing one from a file."""
51 acquire_qgraph_driver(*args, **kwargs)
54@click.command(cls=BpsCommand)
55@opt.config_file_argument(required=True)
56@opt.submission_options()
57def cluster(*args, **kwargs):
58 """Create a clustered quantum graph."""
59 cluster_qgraph_driver(*args, **kwargs)
62@click.command(cls=BpsCommand)
63@opt.config_file_argument(required=True)
64@opt.submission_options()
65def transform(*args, **kwargs):
66 """Transform a quantum graph to a generic workflow."""
67 transform_driver(*args, **kwargs)
70@click.command(cls=BpsCommand)
71@opt.config_file_argument(required=True)
72@opt.wms_service_option()
73@opt.submission_options()
74def prepare(*args, **kwargs):
75 """Prepare a workflow for submission."""
76 prepare_driver(*args, **kwargs)
79@click.command(cls=BpsCommand)
80@opt.config_file_argument(required=True)
81@opt.wms_service_option()
82@opt.compute_site_option()
83@opt.submission_options()
84def submit(*args, **kwargs):
85 """Submit a workflow for execution."""
86 submit_driver(*args, **kwargs)
89@click.command(cls=BpsCommand)
90@opt.wms_service_option()
91@click.option("--id", "run_id", help="Run id of workflow to restart.")
92def restart(*args, **kwargs):
93 """Restart a failed workflow."""
94 restart_driver(*args, **kwargs)
97@click.command(cls=BpsCommand)
98@opt.wms_service_option()
99@click.option("--id", "run_id", help="Restrict report to specific WMS run id.")
100@click.option("--user", help="Restrict report to specific user.")
101@click.option("--hist", "hist_days", default=0.0, help="Search WMS history X days for completed info.")
102@click.option("--pass-thru", help="Pass the given string to the WMS service class.")
103@click.option(
104 "--global/--no-global",
105 "is_global",
106 default=False,
107 help="Query all available job queues for job information.",
108)
109def report(*args, **kwargs):
110 """Display execution status for submitted workflows."""
111 report_driver(*args, **kwargs)
114@click.command(cls=BpsCommand)
115@opt.wms_service_option()
116@click.option("--id", "run_id", help="Run id of workflow to cancel.")
117@click.option("--user", help="User for which to cancel all submitted workflows.")
118@click.option(
119 "--require-bps/--skip-require-bps",
120 "require_bps",
121 default=True,
122 show_default=True,
123 help="Only cancel jobs submitted via bps.",
124)
125@click.option("--pass-thru", "pass_thru", default=str(), help="Pass the given string to the WMS service.")
126@click.option(
127 "--global/--no-global",
128 "is_global",
129 default=False,
130 help="Cancel jobs matching the search criteria from all job queues.",
131)
132def cancel(*args, **kwargs):
133 """Cancel submitted workflow(s)."""
134 cancel_driver(*args, **kwargs)
137@click.command(cls=BpsCommand)
138@opt.wms_service_option()
139@click.option("--pass-thru", "pass_thru", default=str(), help="Pass the given string to the WMS service.")
140def ping(*args, **kwargs):
141 """Ping workflow services."""
142 # Note: Using return statement doesn't actually return the value
143 # to the shell. Using click function instead.
144 click.get_current_context().exit(ping_driver(*args, **kwargs))