Coverage for tests/test_cliCmdImport.py : 56%

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/>.
22"""Unit tests for daf_butler CLI config-dump command.
23"""
25import unittest
26import unittest.mock
28from lsst.daf.butler.tests import CliCmdTestBase
29from lsst.daf.butler.cli.cmd import butler_import
30from lsst.daf.butler.cli.utils import Mocker
33class ImportTestCase(CliCmdTestBase, unittest.TestCase):
35 defaultExpected = dict(repo=None,
36 transfer="auto",
37 output_run=None,
38 directory=None,
39 export_file=None)
41 command = butler_import
43 def test_minimal(self):
44 """Test only the required parameters, and omit the optional parameters.
45 """
46 self.run_test(["import", "here", "foo",
47 "--output-run", "out"],
48 self.makeExpected(repo="here", directory="foo",
49 output_run="out"))
51 def test_almostAll(self):
52 """Test all the parameters, except export_file which gets its own test
53 case below.
54 """
55 self.run_test(["import", "here", "foo",
56 "--output-run", "out",
57 "--transfer", "symlink"],
58 self.makeExpected(repo="here", directory="foo",
59 output_run="out",
60 transfer="symlink"))
62 def test_missingArgument(self):
63 """Verify the command fails if either of the positional arguments,
64 REPO or DIRECTORY, is missing."""
65 self.run_missing(["import", "foo", "--output-run", "out"],
66 'Error: Missing argument "DIRECTORY".')
69class ExportFileCase(CliCmdTestBase, unittest.TestCase):
71 didRead = None
73 defaultExpected = dict(repo=None,
74 transfer="auto",
75 output_run=None,
76 directory=None,
77 export_file=None)
79 command = butler_import
81 def setUp(self):
82 # add a side effect to Mocker so that it will call our method when it
83 # is called.
84 Mocker.mock.side_effect = self.read_test
85 super().setUp()
87 def tearDown(self):
88 # reset the Mocker's side effect on our way out!
89 Mocker.mock.side_effect = None
90 super().tearDown()
92 @staticmethod
93 def read_test(*args, **kwargs):
94 """This gets called by the Mocker's side effect when the Mocker is
95 called. Our export_file argument is a File so Click will open it before
96 calling the Mocker, and thus before it gets here. A little bit is
97 written into the file here and that is verified later.
98 """
99 print("in read_test")
100 ExportFileCase.didRead = kwargs["export_file"].read()
102 def test_exportFile(self):
103 """Test all the parameters, except export_file.
104 """
105 # export_file is ANY in makeExpected because that variable is opened by
106 # click and the open handle is passed to the command function as a
107 # TestIOWrapper. It doesn't work to test it with
108 # MagicMock.assert_called_with because if a TextIOWrapper is created
109 # here it will be a different instance and not compare equal. We test
110 # that variable via the mocker.side_effect used in self.read_test.
111 with self.runner.isolated_filesystem():
112 f = open("output.yaml", "w")
113 f.write("foobarbaz")
114 f.close()
115 self.run_test(["import", "here", "foo",
116 "--output-run", "out",
117 "--export-file", "output.yaml"],
118 self.makeExpected(repo="here", directory="foo",
119 output_run="out",
120 export_file=unittest.mock.ANY))
121 self.assertEqual("foobarbaz", ExportFileCase.didRead)
124if __name__ == "__main__": 124 ↛ 125line 124 didn't jump to line 125, because the condition on line 124 was never true
125 unittest.main()