Coverage for tests/test_cliCmdRetrieveArtifacts.py: 30%
62 statements
« prev ^ index » next coverage.py v6.5.0, created at 2023-02-28 02:30 -0800
« prev ^ index » next coverage.py v6.5.0, created at 2023-02-28 02:30 -0800
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 retrieve-artifacts command.
23"""
25import os
26import unittest
27from typing import List
29from lsst.daf.butler import StorageClassFactory
30from lsst.daf.butler.cli.butler import cli
31from lsst.daf.butler.cli.utils import LogCliRunner, clickResultMsg
32from lsst.daf.butler.tests.utils import ButlerTestHelper, MetricTestRepo, makeTestTempDir, removeTestTempDir
33from lsst.resources import ResourcePath
35TESTDIR = os.path.abspath(os.path.dirname(__file__))
38class CliRetrieveArtifactsTest(unittest.TestCase, ButlerTestHelper):
39 configFile = os.path.join(TESTDIR, "config/basic/butler.yaml")
40 storageClassFactory = StorageClassFactory()
42 def setUp(self):
43 self.root = makeTestTempDir(TESTDIR)
44 self.testRepo = MetricTestRepo(self.root, configFile=self.configFile)
46 def tearDown(self):
47 removeTestTempDir(self.root)
49 @staticmethod
50 def find_files(root: str) -> List[ResourcePath]:
51 return list(ResourcePath.findFileResources([root]))
53 def testRetrieveAll(self):
54 runner = LogCliRunner()
55 with runner.isolated_filesystem():
56 # When preserving the path the run will be in the directory along
57 # with a . in the component name. When not preserving paths the
58 # filename will have an underscore rather than dot.
59 for counter, (preserve_path, prefix) in enumerate(
60 (
61 ("--preserve-path", "ingest/run/test_metric_comp."),
62 ("--no-preserve-path", "test_metric_comp_"),
63 )
64 ):
65 destdir = f"tmp{counter}/"
66 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir, preserve_path])
67 self.assertEqual(result.exit_code, 0, clickResultMsg(result))
68 self.assertTrue(result.stdout.endswith(": 6\n"), f"Expected 6 got: {result.stdout}")
70 artifacts = self.find_files(destdir)
71 self.assertEqual(len(artifacts), 6, f"Expected 6 artifacts: {artifacts}")
72 self.assertIn(f"{destdir}{prefix}", str(artifacts[1]))
74 def testRetrieveSubset(self):
75 runner = LogCliRunner()
76 with runner.isolated_filesystem():
77 destdir = "tmp1/"
78 result = runner.invoke(
79 cli,
80 [
81 "retrieve-artifacts",
82 self.root,
83 destdir,
84 "--where",
85 "instrument='DummyCamComp' AND visit=423",
86 ],
87 )
88 self.assertEqual(result.exit_code, 0, clickResultMsg(result))
89 self.assertTrue(result.stdout.endswith(": 3\n"), f"Expected 3 got: {result.stdout}")
90 artifacts = self.find_files(destdir)
91 self.assertEqual(len(artifacts), 3, f"Expected 3 artifacts: {artifacts}")
93 def testOverwriteLink(self):
94 runner = LogCliRunner()
95 with runner.isolated_filesystem():
96 destdir = "tmp2/"
97 # Force hardlink -- if this fails assume that it is because
98 # hardlinks are not supported (/tmp and TESTDIR are on
99 # different file systems) and skip the test. There are other
100 # tests for the command line itself.
101 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir, "--transfer", "hardlink"])
102 if result.exit_code != 0:
103 raise unittest.SkipTest(
104 "hardlink not supported between these directories for this test:"
105 f" {clickResultMsg(result)}"
106 )
108 # Running again should pass because hard links are the same
109 # file.
110 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir])
111 self.assertEqual(result.exit_code, 0, clickResultMsg(result))
113 def testClobber(self):
114 runner = LogCliRunner()
115 with runner.isolated_filesystem():
116 destdir = "tmp2/"
117 # Force copy so we can ensure that overwrite tests will trigger.
118 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir, "--transfer", "copy"])
119 self.assertEqual(result.exit_code, 0, clickResultMsg(result))
121 # Running again should fail
122 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir])
123 self.assertNotEqual(result.exit_code, 0, clickResultMsg(result))
125 # But with clobber should pass
126 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir, "--clobber"])
127 self.assertEqual(result.exit_code, 0, clickResultMsg(result))
130if __name__ == "__main__": 130 ↛ 131line 130 didn't jump to line 131, because the condition on line 130 was never true
131 unittest.main()