Hide keyboard shortcuts

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

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

# 

# LSST Data Management System 

# Copyright 2016 LSST Corporation. 

# 

# This product includes software developed by the 

# LSST Project (http://www.lsst.org/). 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <http://www.lsstcorp.org/LegalNotices/>. 

# 

import os 

import shutil 

import tempfile 

import unittest 

import yaml 

 

import lsst.daf.persistence as dp 

import lsst.daf.persistence.test as dpTest 

import lsst.utils.tests 

 

# Define the root of the tests relative to this file 

ROOT = os.path.abspath(os.path.dirname(__file__)) 

 

 

class TestCfgRelationship(unittest.TestCase): 

 

def setUp(self): 

self.testDir = tempfile.mkdtemp(dir=ROOT, 

prefix="TestCfgRelationship-") 

 

def tearDown(self): 

43 ↛ exitline 43 didn't return from function 'tearDown', because the condition on line 43 was never false if os.path.exists(self.testDir): 

shutil.rmtree(self.testDir) 

 

def testRWModes(self): 

args = dp.RepositoryArgs(mode='w', mapper=dpTest.EmptyTestMapper, 

root=self.testDir) 

butler = dp.Butler(outputs=args) 

# inputs must be read-only or read-write and not write-only 

args = dp.RepositoryArgs(mode='r', mapper=dpTest.EmptyTestMapper, 

root=self.testDir) 

butler = dp.Butler(inputs=args) 

args = dp.RepositoryArgs(mode='rw', mapper=dpTest.EmptyTestMapper, 

root=self.testDir) 

butler = dp.Butler(inputs=args) 

args = dp.RepositoryArgs(mode='w', mapper=dpTest.EmptyTestMapper, 

root=self.testDir) 

self.assertRaises(RuntimeError, dp.Butler, inputs=args) 

 

# outputs must be write-only or read-write and not read-only 

args = dp.RepositoryArgs(mode='w', mapper=dpTest.EmptyTestMapper, 

root=self.testDir) 

butler = dp.Butler(outputs=args) 

args = dp.RepositoryArgs(mode='rw', mapper=dpTest.EmptyTestMapper, 

root=self.testDir) 

butler = dp.Butler(outputs=args) 

self.assertIsInstance(butler, dp.Butler) 

args = dp.RepositoryArgs(mode='r', mapper=dpTest.EmptyTestMapper, 

root=self.testDir) 

self.assertRaises(RuntimeError, dp.Butler, outputs=args) 

 

def testExistingParents(self): 

# parents of inputs should be added to the inputs list 

butler = dp.Butler(outputs=dp.RepositoryArgs(mode='w', 

mapper=dpTest.EmptyTestMapper, 

root=os.path.join(self.testDir, 'a'))) 

del butler 

butler = dp.Butler(inputs=os.path.join(self.testDir, 'a'), 

outputs=os.path.join(self.testDir, 'b')) 

del butler 

butler = dp.Butler(inputs=os.path.join(self.testDir, 'b')) 

self.assertEqual(len(butler._repos.inputs()), 2) 

# verify serach order: 

self.assertEqual(butler._repos.inputs()[0].cfg.root, 

os.path.join(self.testDir, 'b')) 

self.assertEqual(butler._repos.inputs()[1].cfg.root, 

os.path.join(self.testDir, 'a')) 

self.assertEqual(len(butler._repos.outputs()), 0) 

 

butler = dp.Butler(outputs=dp.RepositoryArgs(cfgRoot=os.path.join(self.testDir, 'b'), 

mode='rw')) 

# verify serach order: 

self.assertEqual(butler._repos.inputs()[0].cfg.root, os.path.join(self.testDir, 'b')) 

self.assertEqual(butler._repos.inputs()[1].cfg.root, os.path.join(self.testDir, 'a')) 

self.assertEqual(len(butler._repos.outputs()), 1) 

self.assertEqual(butler._repos.outputs()[0].cfg.root, os.path.join(self.testDir, 'b')) 

 

butler = dp.Butler(inputs=os.path.join(self.testDir, 'a'), 

outputs=dp.RepositoryArgs(cfgRoot=os.path.join(self.testDir, 'b'), 

mode='rw')) 

self.assertEqual(len(butler._repos.inputs()), 2) 

# verify serach order: 

self.assertEqual(butler._repos.inputs()[0].cfg.root, os.path.join(self.testDir, 'b')) 

self.assertEqual(butler._repos.inputs()[1].cfg.root, os.path.join(self.testDir, 'a')) 

self.assertEqual(len(butler._repos.outputs()), 1) 

self.assertEqual(butler._repos.outputs()[0].cfg.root, os.path.join(self.testDir, 'b')) 

 

# parents of write-only outputs must be be listed with the inputs 

with self.assertRaises(RuntimeError): 

butler = dp.Butler(outputs=os.path.join(self.testDir, 'b')) 

butler = dp.Butler(inputs=os.path.join(self.testDir, 'a'), 

outputs=os.path.join(self.testDir, 'b')) 

self.assertEqual(len(butler._repos.inputs()), 1) 

self.assertEqual(len(butler._repos.outputs()), 1) 

self.assertEqual(butler._repos.outputs()[0].cfg.root, os.path.join(self.testDir, 'b')) 

 

# add a new parent to an existing output 

butler = dp.Butler(outputs=dp.RepositoryArgs(mode='w', 

mapper=dpTest.EmptyTestMapper, 

root=os.path.join(self.testDir, 'c'))) 

butler = dp.Butler(inputs=(os.path.join(self.testDir, 'a'), 

os.path.join(self.testDir, 'c')), 

outputs=os.path.join(self.testDir, 'b')) 

 

# should raise if the input order gets reversed: 

with self.assertRaises(RuntimeError): 

butler = dp.Butler(inputs=(os.path.join(self.testDir, 'c'), 

os.path.join(self.testDir, 'a')), 

outputs=os.path.join(self.testDir, 'b')) 

 

def testSymLinkInPath(self): 

"""Test that when a symlink is in an output repo path that the repoCfg 

stored in the output repo has a parent path from the actual output 

lcoation to the input repo.""" 

# create a repository at 'a' 

repoADir = os.path.join(self.testDir, 'a') 

repoBDir = os.path.join(self.testDir, 'b') 

butler = dp.Butler(outputs=dp.RepositoryArgs( 

mode='w', mapper=dpTest.EmptyTestMapper, 

root=repoADir)) 

# create a symlink from 'b' to a temporary directory 

tmpDir = tempfile.mkdtemp() 

os.symlink(tmpDir, repoBDir) 

# create an output repo at 'b' with the input repo 'a' 

butler = dp.Butler(inputs=repoADir, outputs=repoBDir) 

self.assertIsInstance(butler, dp.Butler) 

# verify a repoCfg in the tmp dir with a proper parent path from tmp 

# to 'a' (not from 'b' to 'a') 

cfg = dp.PosixStorage.getRepositoryCfg(tmpDir) 

# verify that the parent link gotten via the symlink target is a path 

# to A 

self.assertEqual(repoADir, cfg.parents[0]) 

cfg = dp.PosixStorage.getRepositoryCfg(repoBDir) 

# also verify that the parent gotten via the symlink is a path to A 

self.assertEqual(repoADir, cfg.parents[0]) 

 

def testStorageRepoCfgCache(self): 

"""Tests that when a cfg is gotten from storage it is cached.""" 

butler = dp.Butler(outputs=dp.RepositoryArgs(mode='w', 

mapper=dpTest.EmptyTestMapper, 

root=os.path.join(self.testDir, 'a'))) 

del butler 

storage = dp.Storage() 

self.assertEqual(0, len(storage.repositoryCfgs)) 

cfg = storage.getRepositoryCfg(os.path.join(self.testDir, 'a')) 

self.assertEqual(cfg, storage.repositoryCfgs[os.path.join(self.testDir, 'a')]) 

 

 

class TestNestedCfg(unittest.TestCase): 

 

def setUp(self): 

self.testDir = tempfile.mkdtemp(dir=ROOT, 

prefix="TestNestedCfg-") 

 

def tearDown(self): 

177 ↛ exitline 177 didn't return from function 'tearDown', because the condition on line 177 was never false if os.path.exists(self.testDir): 

shutil.rmtree(self.testDir) 

 

def test(self): 

parentCfg = dp.RepositoryCfg(root=os.path.join(self.testDir, 'parent'), 

mapper='lsst.daf.persistence.SomeMapper', 

mapperArgs={}, 

parents=None, 

policy=None) 

cfg = dp.RepositoryCfg(root=self.testDir, 

mapper='lsst.daf.persistence.SomeMapper', 

mapperArgs={}, 

parents=[parentCfg], 

policy=None) 

dp.PosixStorage.putRepositoryCfg(cfg) 

reloadedCfg = dp.PosixStorage.getRepositoryCfg(self.testDir) 

self.assertEqual(cfg, reloadedCfg) 

self.assertEqual(cfg.parents[0], parentCfg) 

 

 

# "fake" repository version 0 

class RepositoryCfg(yaml.YAMLObject): 

yaml_tag = u"!RepositoryCfg_v0" 

 

def __init__(self, mapper, mapperArgs): 

self._mapper = mapper 

self._mapperArgs = mapperArgs 

 

@staticmethod 

def v0Constructor(loader, node): 

d = loader.construct_mapping(node) 

return dp.RepositoryCfg(root=d['_root'], mapper=None, mapperArgs=None, parents=None, policy=None) 

 

 

yaml.add_constructor(u"!RepositoryCfg_v0", RepositoryCfg.v0Constructor) 

 

 

class TestCfgFileVersion(unittest.TestCase): 

"""Proof-of-concept test case for a fictitious version 0 of a persisted repository cfg. 

""" 

 

def setUp(self): 

self.testDir = tempfile.mkdtemp(dir=ROOT, 

prefix="TestCfgFileVersion-") 

 

def tearDown(self): 

223 ↛ exitline 223 didn't return from function 'tearDown', because the condition on line 223 was never false if os.path.exists(self.testDir): 

shutil.rmtree(self.testDir) 

 

def test(self): 

with open(os.path.join(self.testDir, 'repositoryCfg.yaml'), 'w') as f: 

f.write("""!RepositoryCfg_v0 

_root: 'foo/bar'""") 

cfg = dp.PosixStorage.getRepositoryCfg(self.testDir) 

self.assertIsInstance(cfg, dp.RepositoryCfg) 

 

 

class TestExtendParents(unittest.TestCase): 

"""Test for the RepositoryCfg.extendParents function. 

""" 

 

def test(self): 

cfg = dp.RepositoryCfg(root='.', mapper='my.mapper.class', mapperArgs=None, 

parents=['bar', 'baz'], policy=None) 

cfg.extendParents(['bar', 'baz', 'qux']) 

with self.assertRaises(dp.ParentsMismatch): 

cfg.extendParents(['bar', 'baz', 'corge']) 

 

# todo include a repositoryCfg in parents lists in this test 

 

 

class TestMapperArgsNone(unittest.TestCase): 

"""Tests that the RepositoryCfg.mapperArgs is converted to a dict if None is passed in. 

""" 

def test(self): 

cfg = dp.RepositoryCfg(root='foo', mapper='foo', mapperArgs=None, parents=None, policy=None) 

self.assertIsInstance(cfg.mapperArgs, dict) 

 

 

class MemoryTester(lsst.utils.tests.MemoryTestCase): 

pass 

 

 

def setup_module(module): 

lsst.utils.tests.init() 

 

 

264 ↛ 265line 264 didn't jump to line 265, because the condition on line 264 was never trueif __name__ == '__main__': 

lsst.utils.tests.init() 

unittest.main()