Coverage for tests/test_cliCmdImport.py : 58%

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