Coverage for python/lsst/obs/base/cli/butler_cmd_test.py: 60%

32 statements  

« prev     ^ index     » next       coverage.py v7.3.2, created at 2023-11-02 10:32 +0000

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 

27import abc 

28 

29from lsst.daf.butler.cli import butler 

30from lsst.daf.butler.cli.utils import LogCliRunner 

31from lsst.utils import doImportType 

32 

33 

34class 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 

41 def instrumentClassName(self): 

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 

52 def secondInstrumentClassName(self) -> str | None: 

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 return None 

62 

63 @property 

64 def instrument(self): 

65 """The instrument class.""" 

66 return doImportType(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 = LogCliRunner() 

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( 

90 butler.cli, 

91 ["write-curated-calibrations", "here", self.instrumentName, "--collection", "collection"], 

92 ) 

93 self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")