lsst.obs.base  19.0.0-62-g3425666
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 
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  @staticmethod
40  @abc.abstractmethod
42  """Get the fully qualified instrument class.
43 
44  Returns
45  -------
46  `str`
47  The fully qualified instrument class.
48  """
49  pass
50 
51  @staticmethod
52  @abc.abstractmethod
54  """Get the instrument name.
55 
56  Returns
57  -------
58  `str`
59  The name of the instrument.
60  """
61  pass
62 
63  def test_cli(self):
64  runner = click.testing.CliRunner()
65  with runner.isolated_filesystem():
66  result = runner.invoke(butler.cli, ["create", "here"])
67  self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
68  result = runner.invoke(butler.cli, ["register-instrument",
69  "here",
70  "-i", self.instrumentClass()])
71  self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
72  result = runner.invoke(butler.cli, ["write-curated-calibrations",
73  "here",
74  "-i", self.instrumentName(),
75  "--output-run", "output_run"])
76  self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
butler_cmd_test.ButlerCmdTestBase.instrumentName
def instrumentName()
Definition: butler_cmd_test.py:53
butler_cmd_test.ButlerCmdTestBase.instrumentClass
def instrumentClass()
Definition: butler_cmd_test.py:41
butler_cmd_test.ButlerCmdTestBase.test_cli
def test_cli(self)
Definition: butler_cmd_test.py:63
butler_cmd_test.ButlerCmdTestBase
Definition: butler_cmd_test.py:34