Coverage for tests/test_formatter.py: 10%

121 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-04-04 02:55 -0700

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 DimensionUniverse, 

40 FileDescriptor, 

41 Formatter, 

42 FormatterFactory, 

43 Location, 

44 StorageClass, 

45) 

46from lsst.daf.butler.tests import DatasetTestHelper 

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

48 DoNothingFormatter, 

49 MultipleExtensionsFormatter, 

50 SingleExtensionFormatter, 

51) 

52 

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

54 

55 

56class FormatterFactoryTestCase(unittest.TestCase, DatasetTestHelper): 

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

58 

59 def setUp(self): 

60 self.id = 0 

61 self.factory = FormatterFactory() 

62 self.universe = DimensionUniverse() 

63 self.dataId = DataCoordinate.make_empty(self.universe) 

64 

65 # Dummy FileDescriptor for testing getFormatter 

66 self.fileDescriptor = FileDescriptor( 

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

68 ) 

69 

70 def assertIsFormatter(self, formatter): 

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

72 or Formatter class. 

73 """ 

74 if inspect.isclass(formatter): 

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

76 else: 

77 self.assertIsInstance(formatter, Formatter) 

78 

79 def testFormatter(self): 

80 """Check basic parameter exceptions""" 

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

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

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

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

85 

86 with self.assertRaises(TypeError): 

87 DoNothingFormatter() 

88 

89 with self.assertRaises(ValueError): 

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

91 

92 with self.assertRaises(RuntimeError): 

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

94 

95 with self.assertRaises(NotImplementedError): 

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

97 

98 with self.assertRaises(NotImplementedError): 

99 f.write("str") 

100 

101 def testExtensionValidation(self): 

102 """Test extension validation""" 

103 for file, single_ok, multi_ok in ( 

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

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

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

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

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

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

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

111 ): 

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

113 

114 for formatter, passes in ( 

115 (SingleExtensionFormatter, single_ok), 

116 (MultipleExtensionsFormatter, multi_ok), 

117 ): 

118 if passes: 

119 formatter.validateExtension(loc) 

120 else: 

121 with self.assertRaises(ValueError): 

122 formatter.validateExtension(loc) 

123 

124 def testRegistry(self): 

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

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

127 storageClassName = "Image" 

128 self.factory.registerFormatter(storageClassName, formatterTypeName) 

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

130 self.assertIsFormatter(f) 

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

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

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

134 

135 fcls = self.factory.getFormatterClass(storageClassName) 

136 self.assertIsFormatter(fcls) 

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

138 # it on demand previously 

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

140 

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

142 

143 with self.assertRaises(TypeError): 

144 # Requires a constructor parameter 

145 self.factory.getFormatter(storageClassName) 

146 

147 with self.assertRaises(KeyError): 

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

149 

150 # Check that a bad formatter path fails 

151 storageClassName = "BadImage" 

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

153 with self.assertRaises(ImportError): 

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

155 

156 def testRegistryWithStorageClass(self): 

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

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

159 storageClassName = "TestClass" 

160 sc = StorageClass(storageClassName, dict, None) 

161 

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

163 

164 # Store using an instance 

165 self.factory.registerFormatter(sc, formatterTypeName) 

166 

167 # Retrieve using the class 

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

169 self.assertIsFormatter(f) 

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

171 

172 # Retrieve using the DatasetType 

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

174 self.assertIsFormatter(f2) 

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

176 

177 # Class directly 

178 f2cls = self.factory.getFormatterClass(datasetType) 

179 self.assertIsFormatter(f2cls) 

180 

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

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

183 

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

185 

186 with self.assertRaises(KeyError): 

187 # Attempt to overwrite using a different value 

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

189 

190 def testRegistryConfig(self): 

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

192 config = Config(configFile) 

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

194 

195 # Create a DatasetRef with and without instrument matching the 

196 # one in the config file. 

197 dimensions = self.universe.conform(("visit", "physical_filter", "instrument")) 

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

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

200 refPviHsc = self.makeDatasetRef( 

201 "pvi", 

202 dimensions, 

203 sc, 

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

205 ) 

206 refPviHscFmt = self.factory.getFormatterClass(refPviHsc) 

207 self.assertIsFormatter(refPviHscFmt) 

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

209 

210 refPviNotHsc = self.makeDatasetRef( 

211 "pvi", 

212 dimensions, 

213 sc, 

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

215 ) 

216 refPviNotHscFmt = self.factory.getFormatterClass(refPviNotHsc) 

217 self.assertIsFormatter(refPviNotHscFmt) 

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

219 

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

221 refPvixHsc = self.makeDatasetRef( 

222 "pvix", 

223 dimensions, 

224 sc, 

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

226 ) 

227 refPvixNotHscFmt = self.factory.getFormatterClass(refPvixHsc) 

228 self.assertIsFormatter(refPvixNotHscFmt) 

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

230 

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

232 dimensionsNoV = self.universe.conform(("physical_filter", "instrument")) 

233 refPvixNotHscDims = self.makeDatasetRef( 

234 "pvix", 

235 dimensionsNoV, 

236 sc, 

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

238 ) 

239 refPvixNotHscDims_fmt = self.factory.getFormatterClass(refPvixNotHscDims) 

240 self.assertIsFormatter(refPvixNotHscDims_fmt) 

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

242 

243 # Check that parameters are stored 

244 refParam = self.makeDatasetRef( 

245 "paramtest", 

246 dimensions, 

247 sc, 

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

249 ) 

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

251 self.assertIn("writeParameters", kwargs) 

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

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

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

255 

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

257 self.assertEqual(f.writeParameters, expected) 

258 

259 f = self.factory.getFormatter( 

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

261 ) 

262 self.assertEqual( 

263 f.writeParameters, 

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

265 ) 

266 

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

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

269 

270 with self.assertRaises(ValueError): 

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

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

273 

274 with self.assertRaises(RuntimeError): 

275 # "mode" is a required recipe parameter 

276 self.factory.getFormatter( 

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

278 ) 

279 

280 

281if __name__ == "__main__": 

282 unittest.main()