Coverage for tests/test_cliCmdImport.py : 53%

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 @staticmethod
37 def defaultExpected():
38 return dict(repo=None,
39 transfer="auto",
40 directory=None,
41 skip_dimensions=(),
42 export_file=None)
44 @staticmethod
45 def command():
46 return butler_import
48 def test_minimal(self):
49 """Test only the required parameters, and omit the optional parameters.
50 """
51 self.run_test(["import", "here", "foo"],
52 self.makeExpected(repo="here", directory="foo"))
54 def test_almostAll(self):
55 """Test all the parameters, except export_file which gets its own test
56 case below.
57 """
58 self.run_test(["import", "here", "foo",
59 "--transfer", "symlink"],
60 self.makeExpected(repo="here", directory="foo",
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"],
67 r"Error: Missing argument ['\"]DIRECTORY['\"].")
70class ExportFileCase(CliCmdTestBase, unittest.TestCase):
72 didRead = None
74 @staticmethod
75 def defaultExpected():
76 return dict(repo=None,
77 transfer="auto",
78 directory=None,
79 export_file=None)
81 @staticmethod
82 def command():
83 return butler_import
85 def setUp(self):
86 # add a side effect to Mocker so that it will call our method when it
87 # is called.
88 Mocker.mock.side_effect = self.read_test
89 super().setUp()
91 def tearDown(self):
92 # reset the Mocker's side effect on our way out!
93 Mocker.mock.side_effect = None
94 super().tearDown()
96 @staticmethod
97 def read_test(*args, **kwargs):
98 """This gets called by the Mocker's side effect when the Mocker is
99 called. Our export_file argument is a File so Click will open it before
100 calling the Mocker, and thus before it gets here. A little bit is
101 written into the file here and that is verified later.
102 """
103 print("in read_test")
104 ExportFileCase.didRead = kwargs["export_file"].read()
106 def test_exportFile(self):
107 """Test all the parameters, except export_file.
108 """
109 # export_file is ANY in makeExpected because that variable is opened by
110 # click and the open handle is passed to the command function as a
111 # TestIOWrapper. It doesn't work to test it with
112 # MagicMock.assert_called_with because if a TextIOWrapper is created
113 # here it will be a different instance and not compare equal. We test
114 # that variable via the mocker.side_effect used in self.read_test.
115 with self.runner.isolated_filesystem():
116 with open("output.yaml", "w") as f:
117 f.write("foobarbaz")
118 self.run_test(["import", "here", "foo",
119 "--skip-dimensions", "instrument", "-s", "detector",
120 "--export-file", os.path.abspath("output.yaml")],
121 self.makeExpected(repo="here", directory="foo",
122 skip_dimensions=("instrument", "detector"),
123 export_file=unittest.mock.ANY))
124 self.assertEqual("foobarbaz", ExportFileCase.didRead)
127if __name__ == "__main__": 127 ↛ 128line 127 didn't jump to line 128, because the condition on line 127 was never true
128 unittest.main()