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
33class ImportTestCase(CliCmdTestBase, unittest.TestCase):
35 mockFuncName = "lsst.daf.butler.cli.cmd.commands.script.butlerImport"
37 @staticmethod
38 def defaultExpected():
39 return dict(repo=None,
40 transfer="auto",
41 directory=None,
42 skip_dimensions=(),
43 export_file=None)
45 @staticmethod
46 def command():
47 return butler_import
49 def test_minimal(self):
50 """Test only the required parameters, and omit the optional parameters.
51 """
52 self.run_test(["import", "here", "foo"],
53 self.makeExpected(repo="here", directory="foo"))
55 def test_almostAll(self):
56 """Test all the parameters, except export_file which gets its own test
57 case below.
58 """
59 self.run_test(["import", "here", "foo",
60 "--transfer", "symlink"],
61 self.makeExpected(repo="here", directory="foo",
62 transfer="symlink"))
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"],
68 r"Error: Missing argument ['\"]DIRECTORY['\"].")
71class ExportFileCase(CliCmdTestBase, unittest.TestCase):
73 mockFuncName = "lsst.daf.butler.cli.cmd.commands.script.butlerImport"
75 @property
76 def mock(self):
77 return unittest.mock.MagicMock(side_effect=self.read_test)
79 didRead = None
81 @staticmethod
82 def defaultExpected():
83 return dict(repo=None,
84 transfer="auto",
85 directory=None,
86 export_file=None)
88 @staticmethod
89 def command():
90 return butler_import
92 @staticmethod
93 def read_test(*args, **kwargs):
94 """This gets called by the MagicMock's side effect when the MagicMock
95 is called. Our export_file argument is a File so Click will open it
96 before calling the MagicMock, and thus before it gets here. A little
97 bit is 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 MagicMock.side_effect used in self.read_test.
111 with self.runner.isolated_filesystem():
112 with open("output.yaml", "w") as f:
113 f.write("foobarbaz")
114 self.run_test(["import", "here", "foo",
115 "--skip-dimensions", "instrument", "-s", "detector",
116 "--export-file", os.path.abspath("output.yaml")],
117 self.makeExpected(repo="here", directory="foo",
118 skip_dimensions=("instrument", "detector"),
119 export_file=unittest.mock.ANY))
120 self.assertEqual("foobarbaz", ExportFileCase.didRead)
123if __name__ == "__main__": 123 ↛ 124line 123 didn't jump to line 124, because the condition on line 123 was never true
124 unittest.main()