lsst.obs.base  20.0.0-27-g22bab1b+18279e6773
butler_cmd_test.py
Go to the documentation of this file.
1 # This file is part of obs_base.
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 
22 """Base class for writing CLI butler command tests.
23 """
24 
25 __all__ = ("ButlerCmdTestBase",)
26 
27 import abc
28 
29 from lsst.daf.butler.cli import butler
30 from lsst.daf.butler.cli.utils import LogCliRunner
31 from lsst.utils import doImport
32 
33 
34 class ButlerCmdTestBase(metaclass=abc.ABCMeta):
35  """Base class for tests of butler command line interface subcommands.
36  Subclass from this, then `unittest.TestCase` to get a working test suite.
37  """
38 
39  @property
40  @abc.abstractmethod
42  """The fully qualified instrument class name.
43 
44  Returns
45  -------
46  `str`
47  The fully qualified instrument class name.
48  """
49  pass
50 
51  @property
53  """Optional; if provided the register-instrument test will try to
54  register two instruments.
55 
56  Returns
57  -------
58  `str` or `None`
59  The fully qualified instrument class name.
60  """
61 
62  @property
63  def instrument(self):
64  """The instrument class."""
65  return doImport(self.instrumentClassName)
66 
67  @property
68  def instrumentName(self):
69  """The name of the instrument.
70 
71  Returns
72  -------
73  `str`
74  The name of the instrument.
75  """
76  return self.instrument.getName()
77 
78  def test_cli(self):
79  runner = LogCliRunner()
80  with runner.isolated_filesystem():
81  result = runner.invoke(butler.cli, ["create", "here"])
82  self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
83  registerInstrumentArgs = ["register-instrument", "here", self.instrumentClassName]
84  if self.secondInstrumentClassName is not None:
85  registerInstrumentArgs.append(self.secondInstrumentClassName)
86  result = runner.invoke(butler.cli, registerInstrumentArgs)
87  self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
88  result = runner.invoke(butler.cli, ["write-curated-calibrations",
89  "here",
90  "--instrument", self.instrumentName,
91  "--output-run", "output_run"])
92  self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
butler_cmd_test.ButlerCmdTestBase.instrumentName
def instrumentName(self)
Definition: butler_cmd_test.py:68
butler_cmd_test.ButlerCmdTestBase.instrumentClassName
def instrumentClassName(self)
Definition: butler_cmd_test.py:41
lsst::utils
butler_cmd_test.ButlerCmdTestBase.test_cli
def test_cli(self)
Definition: butler_cmd_test.py:78
butler_cmd_test.ButlerCmdTestBase.secondInstrumentClassName
def secondInstrumentClassName(self)
Definition: butler_cmd_test.py:52
butler_cmd_test.ButlerCmdTestBase.instrument
def instrument(self)
Definition: butler_cmd_test.py:63
butler_cmd_test.ButlerCmdTestBase
Definition: butler_cmd_test.py:34