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