Coverage for tests/test_formatter.py: 10%

121 statements  

« prev     ^ index     » next       coverage.py v7.3.1, created at 2023-10-02 08:00 +0000

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 software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

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

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

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

18# (at your option) any later version. 

19# 

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

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

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27 

28"""Tests related to the formatter infrastructure. 

29""" 

30 

31import inspect 

32import os.path 

33import unittest 

34 

35from lsst.daf.butler import ( 

36 Config, 

37 DataCoordinate, 

38 DatasetType, 

39 DimensionGraph, 

40 DimensionUniverse, 

41 FileDescriptor, 

42 Formatter, 

43 FormatterFactory, 

44 Location, 

45 StorageClass, 

46) 

47from lsst.daf.butler.tests import DatasetTestHelper 

48from lsst.daf.butler.tests.testFormatters import ( 

49 DoNothingFormatter, 

50 MultipleExtensionsFormatter, 

51 SingleExtensionFormatter, 

52) 

53 

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

55 

56 

57class FormatterFactoryTestCase(unittest.TestCase, DatasetTestHelper): 

58 """Tests of the formatter factory infrastructure.""" 

59 

60 def setUp(self): 

61 self.id = 0 

62 self.factory = FormatterFactory() 

63 self.universe = DimensionUniverse() 

64 self.dataId = DataCoordinate.makeEmpty(self.universe) 

65 

66 # Dummy FileDescriptor for testing getFormatter 

67 self.fileDescriptor = FileDescriptor( 

68 Location("/a/b/c", "d"), StorageClass("DummyStorageClass", dict, None) 

69 ) 

70 

71 def assertIsFormatter(self, formatter): 

72 """Check that the supplied parameter is either a Formatter instance 

73 or Formatter class. 

74 """ 

75 if inspect.isclass(formatter): 

76 self.assertTrue(issubclass(formatter, Formatter), f"Is {formatter} a Formatter") 

77 else: 

78 self.assertIsInstance(formatter, Formatter) 

79 

80 def testFormatter(self): 

81 """Check basic parameter exceptions""" 

82 f = DoNothingFormatter(self.fileDescriptor, self.dataId) 

83 self.assertEqual(f.writeRecipes, {}) 

84 self.assertEqual(f.writeParameters, {}) 

85 self.assertIn("DoNothingFormatter", repr(f)) 

86 

87 with self.assertRaises(TypeError): 

88 DoNothingFormatter() 

89 

90 with self.assertRaises(ValueError): 

91 DoNothingFormatter(self.fileDescriptor, self.dataId, writeParameters={"param1": 0}) 

92 

93 with self.assertRaises(RuntimeError): 

94 DoNothingFormatter(self.fileDescriptor, self.dataId, writeRecipes={"label": "value"}) 

95 

96 with self.assertRaises(NotImplementedError): 

97 f.makeUpdatedLocation(Location("a", "b")) 

98 

99 with self.assertRaises(NotImplementedError): 

100 f.write("str") 

101 

102 def testExtensionValidation(self): 

103 """Test extension validation""" 

104 for file, single_ok, multi_ok in ( 

105 ("e.fits", True, True), 

106 ("e.fit", False, True), 

107 ("e.fits.fz", False, True), 

108 ("e.txt", False, False), 

109 ("e.1.4.fits", True, True), 

110 ("e.3.fit", False, True), 

111 ("e.1.4.fits.gz", False, True), 

112 ): 

113 loc = Location("/a/b/c", file) 

114 

115 for formatter, passes in ( 

116 (SingleExtensionFormatter, single_ok), 

117 (MultipleExtensionsFormatter, multi_ok), 

118 ): 

119 if passes: 

120 formatter.validateExtension(loc) 

121 else: 

122 with self.assertRaises(ValueError): 

123 formatter.validateExtension(loc) 

124 

125 def testRegistry(self): 

126 """Check that formatters can be stored in the registry.""" 

127 formatterTypeName = "lsst.daf.butler.tests.deferredFormatter.DeferredFormatter" 

128 storageClassName = "Image" 

129 self.factory.registerFormatter(storageClassName, formatterTypeName) 

130 f = self.factory.getFormatter(storageClassName, self.fileDescriptor, self.dataId) 

131 self.assertIsFormatter(f) 

132 self.assertEqual(f.name(), formatterTypeName) 

133 self.assertIn(formatterTypeName, str(f)) 

134 self.assertIn(self.fileDescriptor.location.path, str(f)) 

135 

136 fcls = self.factory.getFormatterClass(storageClassName) 

137 self.assertIsFormatter(fcls) 

138 # Defer the import so that we ensure that the infrastructure loaded 

139 # it on demand previously 

140 from lsst.daf.butler.tests.deferredFormatter import DeferredFormatter 

141 

142 self.assertEqual(type(f), DeferredFormatter) 

143 

144 with self.assertRaises(TypeError): 

145 # Requires a constructor parameter 

146 self.factory.getFormatter(storageClassName) 

147 

148 with self.assertRaises(KeyError): 

149 self.factory.getFormatter("Missing", self.fileDescriptor) 

150 

151 # Check that a bad formatter path fails 

152 storageClassName = "BadImage" 

153 self.factory.registerFormatter(storageClassName, "lsst.daf.butler.tests.deferredFormatter.Unknown") 

154 with self.assertRaises(ImportError): 

155 self.factory.getFormatter(storageClassName, self.fileDescriptor, self.dataId) 

156 

157 def testRegistryWithStorageClass(self): 

158 """Test that the registry can be given a StorageClass object.""" 

159 formatterTypeName = "lsst.daf.butler.formatters.yaml.YamlFormatter" 

160 storageClassName = "TestClass" 

161 sc = StorageClass(storageClassName, dict, None) 

162 

163 datasetType = DatasetType("calexp", self.universe.empty, sc) 

164 

165 # Store using an instance 

166 self.factory.registerFormatter(sc, formatterTypeName) 

167 

168 # Retrieve using the class 

169 f = self.factory.getFormatter(sc, self.fileDescriptor, self.dataId) 

170 self.assertIsFormatter(f) 

171 self.assertEqual(f.fileDescriptor, self.fileDescriptor) 

172 

173 # Retrieve using the DatasetType 

174 f2 = self.factory.getFormatter(datasetType, self.fileDescriptor, self.dataId) 

175 self.assertIsFormatter(f2) 

176 self.assertEqual(f.name(), f2.name()) 

177 

178 # Class directly 

179 f2cls = self.factory.getFormatterClass(datasetType) 

180 self.assertIsFormatter(f2cls) 

181 

182 # This might defer the import, pytest may have already loaded it 

183 from lsst.daf.butler.formatters.yaml import YamlFormatter 

184 

185 self.assertEqual(type(f), YamlFormatter) 

186 

187 with self.assertRaises(KeyError): 

188 # Attempt to overwrite using a different value 

189 self.factory.registerFormatter(storageClassName, "lsst.daf.butler.formatters.json.JsonFormatter") 

190 

191 def testRegistryConfig(self): 

192 configFile = os.path.join(TESTDIR, "config", "basic", "posixDatastore.yaml") 

193 config = Config(configFile) 

194 self.factory.registerFormatters(config["datastore", "formatters"], universe=self.universe) 

195 

196 # Create a DatasetRef with and without instrument matching the 

197 # one in the config file. 

198 dimensions = self.universe.extract(("visit", "physical_filter", "instrument")) 

199 constant_dataId = {"physical_filter": "v", "visit": 1} 

200 sc = StorageClass("DummySC", dict, None) 

201 refPviHsc = self.makeDatasetRef( 

202 "pvi", 

203 dimensions, 

204 sc, 

205 {"instrument": "DummyHSC", **constant_dataId}, 

206 ) 

207 refPviHscFmt = self.factory.getFormatterClass(refPviHsc) 

208 self.assertIsFormatter(refPviHscFmt) 

209 self.assertIn("JsonFormatter", refPviHscFmt.name()) 

210 

211 refPviNotHsc = self.makeDatasetRef( 

212 "pvi", 

213 dimensions, 

214 sc, 

215 {"instrument": "DummyNotHSC", **constant_dataId}, 

216 ) 

217 refPviNotHscFmt = self.factory.getFormatterClass(refPviNotHsc) 

218 self.assertIsFormatter(refPviNotHscFmt) 

219 self.assertIn("PickleFormatter", refPviNotHscFmt.name()) 

220 

221 # Create a DatasetRef that should fall back to using Dimensions 

222 refPvixHsc = self.makeDatasetRef( 

223 "pvix", 

224 dimensions, 

225 sc, 

226 {"instrument": "DummyHSC", **constant_dataId}, 

227 ) 

228 refPvixNotHscFmt = self.factory.getFormatterClass(refPvixHsc) 

229 self.assertIsFormatter(refPvixNotHscFmt) 

230 self.assertIn("PickleFormatter", refPvixNotHscFmt.name()) 

231 

232 # Create a DatasetRef that should fall back to using StorageClass 

233 dimensionsNoV = DimensionGraph(self.universe, names=("physical_filter", "instrument")) 

234 refPvixNotHscDims = self.makeDatasetRef( 

235 "pvix", 

236 dimensionsNoV, 

237 sc, 

238 {"instrument": "DummyHSC", "physical_filter": "v"}, 

239 ) 

240 refPvixNotHscDims_fmt = self.factory.getFormatterClass(refPvixNotHscDims) 

241 self.assertIsFormatter(refPvixNotHscDims_fmt) 

242 self.assertIn("YamlFormatter", refPvixNotHscDims_fmt.name()) 

243 

244 # Check that parameters are stored 

245 refParam = self.makeDatasetRef( 

246 "paramtest", 

247 dimensions, 

248 sc, 

249 {"instrument": "DummyNotHSC", **constant_dataId}, 

250 ) 

251 lookup, refParam_fmt, kwargs = self.factory.getFormatterClassWithMatch(refParam) 

252 self.assertIn("writeParameters", kwargs) 

253 expected = {"max": 5, "min": 2, "comment": "Additional commentary", "recipe": "recipe1"} 

254 self.assertEqual(kwargs["writeParameters"], expected) 

255 self.assertIn("FormatterTest", refParam_fmt.name()) 

256 

257 f = self.factory.getFormatter(refParam, self.fileDescriptor, self.dataId) 

258 self.assertEqual(f.writeParameters, expected) 

259 

260 f = self.factory.getFormatter( 

261 refParam, self.fileDescriptor, self.dataId, writeParameters={"min": 22, "extra": 50} 

262 ) 

263 self.assertEqual( 

264 f.writeParameters, 

265 {"max": 5, "min": 22, "comment": "Additional commentary", "extra": 50, "recipe": "recipe1"}, 

266 ) 

267 

268 self.assertIn("recipe1", f.writeRecipes) 

269 self.assertEqual(f.writeParameters["recipe"], "recipe1") 

270 

271 with self.assertRaises(ValueError): 

272 # "new" is not allowed as a write parameter 

273 self.factory.getFormatter(refParam, self.fileDescriptor, self.dataId, writeParameters={"new": 1}) 

274 

275 with self.assertRaises(RuntimeError): 

276 # "mode" is a required recipe parameter 

277 self.factory.getFormatter( 

278 refParam, self.fileDescriptor, self.dataId, writeRecipes={"recipe3": {"notmode": 1}} 

279 ) 

280 

281 

282if __name__ == "__main__": 

283 unittest.main()