Coverage for tests/test_location.py: 11%

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

192 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 

22import copy 

23import unittest 

24import os.path 

25import posixpath 

26import pickle 

27import pathlib 

28 

29from lsst.daf.butler import LocationFactory, Location, ButlerURI 

30from lsst.daf.butler.core._butlerUri.utils import os2posix, posix2os 

31 

32 

33class LocationTestCase(unittest.TestCase): 

34 """Tests for Location within datastore 

35 """ 

36 

37 def testButlerUri(self): 

38 """Tests whether ButlerURI instantiates correctly given different 

39 arguments. 

40 """ 

41 # Root to use for relative paths 

42 testRoot = "/tmp/" 

43 

44 # uriStrings is a list of tuples containing test string, forceAbsolute, 

45 # forceDirectory as arguments to ButlerURI and scheme, netloc and path 

46 # as expected attributes. Test asserts constructed equals to expected. 

47 # 1) no determinable schemes (ensures schema and netloc are not set) 

48 osRelFilePath = os.path.join(testRoot, "relative/file.ext") 

49 uriStrings = [ 

50 ("relative/file.ext", True, False, "", "", osRelFilePath), 

51 ("relative/file.ext", False, False, "", "", "relative/file.ext"), 

52 ("test/../relative/file.ext", True, False, "", "", osRelFilePath), 

53 ("test/../relative/file.ext", False, False, "", "", "relative/file.ext"), 

54 ("relative/dir", False, True, "", "", "relative/dir/") 

55 ] 

56 # 2) implicit file scheme, tests absolute file and directory paths 

57 uriStrings.extend(( 

58 ("/rootDir/absolute/file.ext", True, False, "file", "", '/rootDir/absolute/file.ext'), 

59 ("~/relative/file.ext", True, False, "file", "", os.path.expanduser("~/relative/file.ext")), 

60 ("~/relative/file.ext", False, False, "file", "", os.path.expanduser("~/relative/file.ext")), 

61 ("/rootDir/absolute/", True, False, "file", "", "/rootDir/absolute/"), 

62 ("/rootDir/absolute", True, True, "file", "", "/rootDir/absolute/"), 

63 ("~/rootDir/absolute", True, True, "file", "", os.path.expanduser("~/rootDir/absolute/")) 

64 )) 

65 # 3) explicit file scheme, absolute and relative file and directory URI 

66 posixRelFilePath = posixpath.join(testRoot, "relative/file.ext") 

67 uriStrings.extend(( 

68 ("file:///rootDir/absolute/file.ext", True, False, "file", "", "/rootDir/absolute/file.ext"), 

69 ("file:relative/file.ext", True, False, "file", "", posixRelFilePath), 

70 ("file:///absolute/directory/", True, False, "file", "", "/absolute/directory/"), 

71 ("file:///absolute/directory", True, True, "file", "", "/absolute/directory/") 

72 )) 

73 # 4) S3 scheme (ensured Keys as dirs and fully specified URIs work) 

74 uriStrings.extend(( 

75 ("s3://bucketname/rootDir/", True, False, "s3", "bucketname", "/rootDir/"), 

76 ("s3://bucketname/rootDir", True, True, "s3", "bucketname", "/rootDir/"), 

77 ("s3://bucketname/rootDir/relative/file.ext", True, False, "s3", 

78 "bucketname", "/rootDir/relative/file.ext") 

79 )) 

80 # 5) HTTPS scheme 

81 uriStrings.extend(( 

82 ("https://www.lsst.org/rootDir/", True, False, "https", "www.lsst.org", "/rootDir/"), 

83 ("https://www.lsst.org/rootDir", True, True, "https", "www.lsst.org", "/rootDir/"), 

84 ("https://www.lsst.org/rootDir/relative/file.ext", True, False, "https", 

85 "www.lsst.org", "/rootDir/relative/file.ext") 

86 )) 

87 

88 for uriInfo in uriStrings: 

89 uri = ButlerURI(uriInfo[0], root=testRoot, forceAbsolute=uriInfo[1], 

90 forceDirectory=uriInfo[2]) 

91 with self.subTest(uri=uriInfo[0]): 

92 self.assertEqual(uri.scheme, uriInfo[3], "test scheme") 

93 self.assertEqual(uri.netloc, uriInfo[4], "test netloc") 

94 self.assertEqual(uri.path, uriInfo[5], "test path") 

95 

96 # test root becomes abspath(".") when not specified, note specific 

97 # file:// scheme case 

98 uriStrings = ( 

99 ("file://relative/file.ext", True, False, "file", "relative", "/file.ext"), 

100 ("file:relative/file.ext", False, False, "file", "", os.path.abspath("relative/file.ext")), 

101 ("file:relative/dir/", True, True, "file", "", os.path.abspath("relative/dir")+"/"), 

102 ("relative/file.ext", True, False, "", "", os.path.abspath("relative/file.ext")) 

103 ) 

104 

105 for uriInfo in uriStrings: 

106 uri = ButlerURI(uriInfo[0], forceAbsolute=uriInfo[1], forceDirectory=uriInfo[2]) 

107 with self.subTest(uri=uriInfo[0]): 

108 self.assertEqual(uri.scheme, uriInfo[3], "test scheme") 

109 self.assertEqual(uri.netloc, uriInfo[4], "test netloc") 

110 self.assertEqual(uri.path, uriInfo[5], "test path") 

111 

112 # File replacement 

113 uriStrings = ( 

114 ("relative/file.ext", "newfile.fits", "relative/newfile.fits"), 

115 ("relative/", "newfile.fits", "relative/newfile.fits"), 

116 ("https://www.lsst.org/butler/", "butler.yaml", "/butler/butler.yaml"), 

117 ("s3://amazon/datastore/", "butler.yaml", "/datastore/butler.yaml"), 

118 ("s3://amazon/datastore/mybutler.yaml", "butler.yaml", "/datastore/butler.yaml") 

119 ) 

120 

121 for uriInfo in uriStrings: 

122 uri = ButlerURI(uriInfo[0], forceAbsolute=False).updatedFile(uriInfo[1]) 

123 with self.subTest(uri=uriInfo[0]): 

124 self.assertEqual(uri.path, uriInfo[2]) 

125 

126 # Check that schemeless can become file scheme 

127 schemeless = ButlerURI("relative/path.ext") 

128 filescheme = ButlerURI("/absolute/path.ext") 

129 self.assertFalse(schemeless.scheme) 

130 self.assertEqual(filescheme.scheme, "file") 

131 self.assertNotEqual(type(schemeless), type(filescheme)) 

132 

133 # Copy constructor 

134 uri = ButlerURI("s3://amazon/datastore", forceDirectory=True) 

135 uri2 = ButlerURI(uri) 

136 self.assertEqual(uri, uri2) 

137 uri = ButlerURI("file://amazon/datastore/file.txt") 

138 uri2 = ButlerURI(uri) 

139 self.assertEqual(uri, uri2) 

140 

141 # Copy constructor using subclass 

142 uri3 = type(uri)(uri) 

143 self.assertEqual(type(uri), type(uri3)) 

144 

145 # Explicit copy 

146 uri4 = copy.copy(uri3) 

147 self.assertEqual(uri4, uri3) 

148 uri4 = copy.deepcopy(uri3) 

149 self.assertEqual(uri4, uri3) 

150 

151 def testUriRoot(self): 

152 osPathRoot = pathlib.Path(__file__).absolute().root 

153 rootUris = (osPathRoot, "s3://bucket", "file://localhost/", "https://a.b.com") 

154 for uri_str in rootUris: 

155 uri = ButlerURI(uri_str, forceDirectory=True) 

156 self.assertEqual(uri.relativeToPathRoot, "./", f"Testing uri: {uri}") 

157 self.assertTrue(uri.is_root, f"Testing URI {uri} is a root URI") 

158 

159 exampleLocalFile = os.path.join(osPathRoot, "a", "b", "c") 

160 uriStrings = ( 

161 ("file://localhost/file.ext", "file.ext"), 

162 (exampleLocalFile, os.path.join("a", "b", "c")), 

163 ("s3://bucket/path/file.ext", "path/file.ext"), 

164 ("https://host.com/a/b/c.d", "a/b/c.d"), 

165 ) 

166 

167 for uri_str, result in uriStrings: 

168 uri = ButlerURI(uri_str) 

169 self.assertEqual(uri.relativeToPathRoot, result) 

170 

171 def testUriJoin(self): 

172 uri = ButlerURI("a/b/c/d", forceDirectory=True, forceAbsolute=False) 

173 uri2 = uri.join("e/f/g.txt") 

174 self.assertEqual(str(uri2), "a/b/c/d/e/f/g.txt", f"Checking joined URI {uri} -> {uri2}") 

175 

176 uri = ButlerURI("a/b/c/d/old.txt", forceAbsolute=False) 

177 uri2 = uri.join("e/f/g.txt") 

178 self.assertEqual(str(uri2), "a/b/c/d/e/f/g.txt", f"Checking joined URI {uri} -> {uri2}") 

179 

180 uri = ButlerURI("a/b/c/d", forceDirectory=True, forceAbsolute=True) 

181 uri2 = uri.join("e/f/g.txt") 

182 self.assertTrue(str(uri2).endswith("a/b/c/d/e/f/g.txt"), f"Checking joined URI {uri} -> {uri2}") 

183 

184 uri = ButlerURI("s3://bucket/a/b/c/d", forceDirectory=True) 

185 uri2 = uri.join("newpath/newfile.txt") 

186 self.assertEqual(str(uri2), "s3://bucket/a/b/c/d/newpath/newfile.txt") 

187 

188 uri = ButlerURI("s3://bucket/a/b/c/d/old.txt") 

189 uri2 = uri.join("newpath/newfile.txt") 

190 self.assertEqual(str(uri2), "s3://bucket/a/b/c/d/newpath/newfile.txt") 

191 

192 def testButlerUriSerialization(self): 

193 """Test that we can pickle and yaml""" 

194 uri = ButlerURI("a/b/c/d") 

195 uri2 = pickle.loads(pickle.dumps(uri)) 

196 self.assertEqual(uri, uri2) 

197 self.assertFalse(uri2.dirLike) 

198 

199 uri = ButlerURI("a/b/c/d", forceDirectory=True) 

200 uri2 = pickle.loads(pickle.dumps(uri)) 

201 self.assertEqual(uri, uri2) 

202 self.assertTrue(uri2.dirLike) 

203 

204 def testUriExtensions(self): 

205 """Test extension extraction.""" 

206 

207 files = (("file.fits.gz", ".fits.gz"), 

208 ("file.fits", ".fits"), 

209 ("file.fits.xz", ".fits.xz"), 

210 ("file.fits.tar", ".tar"), 

211 ("file", ""), 

212 ("flat_i_sim_1.4_blah.fits.gz", ".fits.gz"), 

213 ("flat_i_sim_1.4_blah.txt", ".txt"), 

214 ("flat_i_sim_1.4_blah.fits.fz", ".fits.fz"), 

215 ("flat_i_sim_1.4_blah.fits.txt", ".txt"), 

216 ("s3://bucket/c/a.b/", ""), 

217 ("s3://bucket/c/a.b", ".b"), 

218 ("file://localhost/c/a.b.gz", ".b.gz"), 

219 ) 

220 

221 for file, expected in files: 

222 test_string = file 

223 if ":" not in test_string: 

224 test_string = f"a/b/{test_string}" 

225 uri = ButlerURI(test_string) 

226 self.assertEqual(uri.getExtension(), expected) 

227 

228 def testFileLocation(self): 

229 root = os.path.abspath(os.path.curdir) 

230 factory = LocationFactory(root) 

231 print(f"Factory created: {factory}") 

232 

233 pathInStore = "relative/path/file.ext" 

234 loc1 = factory.fromPath(pathInStore) 

235 

236 self.assertEqual(loc1.path, os.path.join(root, pathInStore)) 

237 self.assertEqual(loc1.pathInStore.path, pathInStore) 

238 self.assertTrue(loc1.uri.geturl().startswith("file:///")) 

239 self.assertTrue(loc1.uri.geturl().endswith("file.ext")) 

240 loc1.updateExtension("fits") 

241 self.assertTrue(loc1.uri.geturl().endswith("file.fits"), 

242 f"Checking 'fits' extension in {loc1.uri}") 

243 loc1.updateExtension("fits.gz") 

244 self.assertEqual(loc1.uri.basename(), "file.fits.gz") 

245 self.assertTrue(loc1.uri.geturl().endswith("file.fits.gz"), 

246 f"Checking 'fits.gz' extension in {loc1.uri}") 

247 self.assertEqual(loc1.getExtension(), ".fits.gz") 

248 loc1.updateExtension(".jpeg") 

249 self.assertTrue(loc1.uri.geturl().endswith("file.jpeg"), 

250 f"Checking 'jpeg' extension in {loc1.uri}") 

251 loc1.updateExtension(None) 

252 self.assertTrue(loc1.uri.geturl().endswith("file.jpeg"), 

253 f"Checking unchanged extension in {loc1.uri}") 

254 loc1.updateExtension("") 

255 self.assertTrue(loc1.uri.geturl().endswith("file"), f"Checking no extension in {loc1.uri}") 

256 self.assertEqual(loc1.getExtension(), "") 

257 

258 loc2 = factory.fromPath(pathInStore) 

259 loc3 = factory.fromPath(pathInStore) 

260 self.assertEqual(loc2, loc3) 

261 

262 def testAbsoluteLocations(self): 

263 """Using a pathInStore that refers to absolute URI.""" 

264 loc = Location(None, "file:///something.txt") 

265 self.assertEqual(loc.pathInStore.path, "/something.txt") 

266 self.assertEqual(str(loc.uri), "file:///something.txt") 

267 

268 with self.assertRaises(ValueError): 

269 Location(None, "relative.txt") 

270 

271 def testRelativeRoot(self): 

272 root = os.path.abspath(os.path.curdir) 

273 factory = LocationFactory(os.path.curdir) 

274 

275 pathInStore = "relative/path/file.ext" 

276 loc1 = factory.fromPath(pathInStore) 

277 

278 self.assertEqual(loc1.path, os.path.join(root, pathInStore)) 

279 self.assertEqual(loc1.pathInStore.path, pathInStore) 

280 self.assertEqual(loc1.uri.scheme, "file") 

281 

282 with self.assertRaises(ValueError): 

283 factory.fromPath("../something") 

284 

285 def testQuotedRoot(self): 

286 """Test we can handle quoted characters.""" 

287 root = "/a/b/c+1/d" 

288 factory = LocationFactory(root) 

289 

290 pathInStore = "relative/path/file.ext.gz" 

291 

292 for pathInStore in ("relative/path/file.ext.gz", 

293 "relative/path+2/file.ext.gz", 

294 "relative/path+3/file&.ext.gz"): 

295 loc1 = factory.fromPath(pathInStore) 

296 

297 self.assertEqual(loc1.pathInStore.path, pathInStore) 

298 self.assertEqual(loc1.path, os.path.join(root, pathInStore)) 

299 self.assertIn("%", str(loc1.uri)) 

300 self.assertEqual(loc1.getExtension(), ".ext.gz") 

301 

302 def testHttpLocation(self): 

303 root = "https://www.lsst.org/butler/datastore" 

304 factory = LocationFactory(root) 

305 print(f"Factory created: {factory}") 

306 

307 pathInStore = "relative/path/file.ext" 

308 loc1 = factory.fromPath(pathInStore) 

309 

310 self.assertEqual(loc1.path, posixpath.join("/butler/datastore", pathInStore)) 

311 self.assertEqual(loc1.pathInStore.path, pathInStore) 

312 self.assertEqual(loc1.uri.scheme, "https") 

313 self.assertEqual(loc1.uri.basename(), "file.ext") 

314 loc1.updateExtension("fits") 

315 self.assertTrue(loc1.uri.basename(), "file.fits") 

316 

317 def testPosix2OS(self): 

318 """Test round tripping of the posix to os.path conversion helpers.""" 

319 testPaths = ("/a/b/c.e", "a/b", "a/b/", "/a/b", "/a/b/", "a/b/c.e") 

320 for p in testPaths: 

321 with self.subTest(path=p): 

322 self.assertEqual(os2posix(posix2os(p)), p) 

323 

324 def testSplit(self): 

325 """Tests split functionality.""" 

326 testRoot = "/tmp/" 

327 

328 testPaths = ("/absolute/file.ext", "/absolute/", 

329 "file:///absolute/file.ext", "file:///absolute/", 

330 "s3://bucket/root/file.ext", "s3://bucket/root/", 

331 "https://www.lsst.org/root/file.ext", "https://www.lsst.org/root/", 

332 "relative/file.ext", "relative/") 

333 

334 osRelExpected = os.path.join(testRoot, "relative") 

335 expected = (("file:///absolute/", "file.ext"), ("file:///absolute/", ""), 

336 ("file:///absolute/", "file.ext"), ("file:///absolute/", ""), 

337 ("s3://bucket/root/", "file.ext"), ("s3://bucket/root/", ""), 

338 ("https://www.lsst.org/root/", "file.ext"), ("https://www.lsst.org/root/", ""), 

339 (f"file://{osRelExpected}/", "file.ext"), (f"file://{osRelExpected}/", "")) 

340 

341 for p, e in zip(testPaths, expected): 

342 with self.subTest(path=p): 

343 uri = ButlerURI(p, testRoot) 

344 head, tail = uri.split() 

345 self.assertEqual((head.geturl(), tail), e) 

346 

347 # explicit file scheme should force posixpath, check os.path is ignored 

348 posixRelFilePath = posixpath.join(testRoot, "relative") 

349 uri = ButlerURI("file:relative/file.ext", testRoot) 

350 head, tail = uri.split() 

351 self.assertEqual((head.geturl(), tail), (f"file://{posixRelFilePath}/", "file.ext")) 

352 

353 # check head can be empty and we do not get an absolute path back 

354 uri = ButlerURI("file.ext", forceAbsolute=False) 

355 head, tail = uri.split() 

356 self.assertEqual((head.geturl(), tail), ("./", "file.ext")) 

357 

358 # ensure empty path splits to a directory URL 

359 uri = ButlerURI("", forceAbsolute=False) 

360 head, tail = uri.split() 

361 self.assertEqual((head.geturl(), tail), ("./", "")) 

362 

363 uri = ButlerURI(".", forceAbsolute=False) 

364 head, tail = uri.split() 

365 self.assertEqual((head.geturl(), tail), ("./", "")) 

366 

367 

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

369 unittest.main()