Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1# This file is part of daf_butler. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://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 <http://www.gnu.org/licenses/>. 

21 

22"""Unit tests for daf_butler CLI config-dump command. 

23""" 

24 

25import os 

26import unittest 

27import unittest.mock 

28 

29from lsst.daf.butler.tests import CliCmdTestBase 

30from lsst.daf.butler.cli.cmd import butler_import 

31from lsst.daf.butler.cli.utils import Mocker 

32 

33 

34class ImportTestCase(CliCmdTestBase, unittest.TestCase): 

35 

36 defaultExpected = dict(repo=None, 

37 transfer="auto", 

38 output_run=None, 

39 directory=None, 

40 skip_dimensions=(), 

41 export_file=None) 

42 

43 command = butler_import 

44 

45 def test_minimal(self): 

46 """Test only the required parameters, and omit the optional parameters. 

47 """ 

48 self.run_test(["import", "here", "foo", 

49 "--output-run", "out"], 

50 self.makeExpected(repo="here", directory="foo", 

51 output_run="out")) 

52 

53 def test_almostAll(self): 

54 """Test all the parameters, except export_file which gets its own test 

55 case below. 

56 """ 

57 self.run_test(["import", "here", "foo", 

58 "--output-run", "out", 

59 "--transfer", "symlink"], 

60 self.makeExpected(repo="here", directory="foo", 

61 output_run="out", 

62 transfer="symlink")) 

63 

64 def test_missingArgument(self): 

65 """Verify the command fails if either of the positional arguments, 

66 REPO or DIRECTORY, is missing.""" 

67 self.run_missing(["import", "foo", "--output-run", "out"], 

68 r"Error: Missing argument ['\"]DIRECTORY['\"].") 

69 

70 

71class ExportFileCase(CliCmdTestBase, unittest.TestCase): 

72 

73 didRead = None 

74 

75 defaultExpected = dict(repo=None, 

76 transfer="auto", 

77 output_run=None, 

78 directory=None, 

79 export_file=None) 

80 

81 command = butler_import 

82 

83 def setUp(self): 

84 # add a side effect to Mocker so that it will call our method when it 

85 # is called. 

86 Mocker.mock.side_effect = self.read_test 

87 super().setUp() 

88 

89 def tearDown(self): 

90 # reset the Mocker's side effect on our way out! 

91 Mocker.mock.side_effect = None 

92 super().tearDown() 

93 

94 @staticmethod 

95 def read_test(*args, **kwargs): 

96 """This gets called by the Mocker's side effect when the Mocker is 

97 called. Our export_file argument is a File so Click will open it before 

98 calling the Mocker, and thus before it gets here. A little bit is 

99 written into the file here and that is verified later. 

100 """ 

101 print("in read_test") 

102 ExportFileCase.didRead = kwargs["export_file"].read() 

103 

104 def test_exportFile(self): 

105 """Test all the parameters, except export_file. 

106 """ 

107 # export_file is ANY in makeExpected because that variable is opened by 

108 # click and the open handle is passed to the command function as a 

109 # TestIOWrapper. It doesn't work to test it with 

110 # MagicMock.assert_called_with because if a TextIOWrapper is created 

111 # here it will be a different instance and not compare equal. We test 

112 # that variable via the mocker.side_effect used in self.read_test. 

113 with self.runner.isolated_filesystem(): 

114 with open("output.yaml", "w") as f: 

115 f.write("foobarbaz") 

116 self.run_test(["import", "here", "foo", 

117 "--output-run", "out", 

118 "--skip-dimensions", "instrument", "-s", "detector", 

119 "--export-file", os.path.abspath("output.yaml")], 

120 self.makeExpected(repo="here", directory="foo", 

121 output_run="out", skip_dimensions=("instrument", "detector"), 

122 export_file=unittest.mock.ANY)) 

123 self.assertEqual("foobarbaz", ExportFileCase.didRead) 

124 

125 

126if __name__ == "__main__": 126 ↛ 127line 126 didn't jump to line 127, because the condition on line 126 was never true

127 unittest.main()