Coverage for tests/test_cliCmdRetrieveArtifacts.py: 33%

Shortcuts 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

61 statements  

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/>. 

21 

22"""Unit tests for daf_butler CLI retrieve-artifacts command. 

23""" 

24 

25import os 

26import unittest 

27from typing import List 

28 

29from lsst.daf.butler.cli.butler import cli 

30from lsst.daf.butler.cli.utils import clickResultMsg, LogCliRunner 

31from lsst.daf.butler import StorageClassFactory, ButlerURI 

32from lsst.daf.butler.tests.utils import ButlerTestHelper, makeTestTempDir, MetricTestRepo, removeTestTempDir 

33 

34 

35TESTDIR = os.path.abspath(os.path.dirname(__file__)) 

36 

37 

38class CliRetrieveArtifactsTest(unittest.TestCase, ButlerTestHelper): 

39 

40 configFile = os.path.join(TESTDIR, "config/basic/butler.yaml") 

41 storageClassFactory = StorageClassFactory() 

42 

43 def setUp(self): 

44 self.root = makeTestTempDir(TESTDIR) 

45 self.testRepo = MetricTestRepo(self.root, 

46 configFile=self.configFile) 

47 

48 def tearDown(self): 

49 removeTestTempDir(self.root) 

50 

51 @staticmethod 

52 def find_files(root: str) -> List[ButlerURI]: 

53 return list(ButlerURI.findFileResources([root])) 

54 

55 def testRetrieveAll(self): 

56 runner = LogCliRunner() 

57 with runner.isolated_filesystem(): 

58 

59 # When preserving the path the run will be in the directory along 

60 # with a . in the component name. When not preserving paths the 

61 # filename will have an underscore rather than dot. 

62 for counter, (preserve_path, prefix) in enumerate((("--preserve-path", 

63 "ingest/run/test_metric_comp."), 

64 ("--no-preserve-path", 

65 "test_metric_comp_"))): 

66 destdir = f"tmp{counter}/" 

67 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir, preserve_path]) 

68 self.assertEqual(result.exit_code, 0, clickResultMsg(result)) 

69 self.assertTrue(result.stdout.endswith(": 6\n"), f"Expected 6 got: {result.stdout}") 

70 

71 artifacts = self.find_files(destdir) 

72 self.assertEqual(len(artifacts), 6, f"Expected 6 artifacts: {artifacts}") 

73 self.assertIn(f"{destdir}{prefix}", str(artifacts[1])) 

74 

75 def testRetrieveSubset(self): 

76 runner = LogCliRunner() 

77 with runner.isolated_filesystem(): 

78 destdir = "tmp1/" 

79 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir, 

80 "--where", "instrument='DummyCamComp' AND visit=423"]) 

81 self.assertEqual(result.exit_code, 0, clickResultMsg(result)) 

82 self.assertTrue(result.stdout.endswith(": 3\n"), f"Expected 3 got: {result.stdout}") 

83 artifacts = self.find_files(destdir) 

84 self.assertEqual(len(artifacts), 3, f"Expected 3 artifacts: {artifacts}") 

85 

86 def testOverwriteLink(self): 

87 runner = LogCliRunner() 

88 with runner.isolated_filesystem(): 

89 destdir = "tmp2/" 

90 # Force hardlink -- if this fails assume that it is because 

91 # hardlinks are not supported (/tmp and TESTDIR are on 

92 # different file systems) and skip the test. There are other 

93 # tests for the command line itself. 

94 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir, "--transfer", "hardlink"]) 

95 if result.exit_code != 0: 

96 raise unittest.SkipTest("hardlink not supported between these directories for this test:" 

97 f" {clickResultMsg(result)}") 

98 

99 # Running again should pass because hard links are the same 

100 # file. 

101 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir]) 

102 self.assertEqual(result.exit_code, 0, clickResultMsg(result)) 

103 

104 def testClobber(self): 

105 runner = LogCliRunner() 

106 with runner.isolated_filesystem(): 

107 destdir = "tmp2/" 

108 # Force copy so we can ensure that overwrite tests will trigger. 

109 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir, "--transfer", "copy"]) 

110 self.assertEqual(result.exit_code, 0, clickResultMsg(result)) 

111 

112 # Running again should fail 

113 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir]) 

114 self.assertNotEqual(result.exit_code, 0, clickResultMsg(result)) 

115 

116 # But with clobber should pass 

117 result = runner.invoke(cli, ["retrieve-artifacts", self.root, destdir, "--clobber"]) 

118 self.assertEqual(result.exit_code, 0, clickResultMsg(result)) 

119 

120 

121if __name__ == "__main__": 121 ↛ 122line 121 didn't jump to line 122, because the condition on line 121 was never true

122 unittest.main()