Coverage for python/lsst/ctrl/bps/ping.py: 67%
9 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-01 16:05 -0700
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-01 16:05 -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 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"""Supporting functions for pinging WMS service.
29"""
31__all__ = ["ping"]
33import logging
35from lsst.utils import doImport
37_LOG = logging.getLogger(__name__)
40def ping(wms_service, pass_thru=None):
41 """Check whether WMS services are up, reachable, and any authentication,
42 if needed, succeeds.
44 The services to be checked are those needed for submit, report, cancel,
45 restart, but ping cannot guarantee whether jobs would actually run
46 successfully.
48 Parameters
49 ----------
50 wms_service : `str`
51 Name of the class.
52 pass_thru : `str`
53 A string to pass directly to the WMS service class.
55 Returns
56 -------
57 status : `int`
58 Services are available (0) or problems (not 0).
59 message : `str`
60 Any message from WMS (e.g., error details).
61 """
62 wms_service_class = doImport(wms_service)
63 wms_service = wms_service_class({})
65 return wms_service.ping(pass_thru)