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

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

# This file is part of verify. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (https://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# 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 GNU General Public License 

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

 

import unittest.mock 

 

import astropy.units as u 

from astropy.tests.helper import assert_quantity_allclose 

 

import lsst.utils.tests 

from lsst.pex.config import Config, FieldValidationError 

from lsst.pipe.base import \ 

Task, Struct, PipelineTaskConnections, connectionTypes 

from lsst.verify import Job, Name, Measurement 

from lsst.verify.tasks import MetricComputationError 

from lsst.verify.gen2tasks import \ 

MetricTask, MetricsControllerTask, register, registerMultiple 

 

 

def _metricName(): 

return "misc_tasks.FancyMetric" 

 

 

def _extraMetricName1(): 

return "misc_tasks.SuperfluousMetric" 

 

 

def _extraMetricName2(): 

return "misc_tasks.RedundantMetric" 

 

 

class DemoConnections( 

PipelineTaskConnections, 

dimensions={}): 

inputData = connectionTypes.Input( 

name="metadata", 

storageClass="PropertySet", 

) 

 

 

class DemoMetricConfig(MetricTask.ConfigClass, 

pipelineConnections=DemoConnections): 

metric = lsst.pex.config.Field( 

dtype=str, 

default=_metricName(), 

doc="Metric to target") 

multiplier = lsst.pex.config.Field( 

dtype=float, 

default=1.0, 

doc="Arbitrary factor for measurement") 

 

 

@register("demoMetric") 

class _DemoMetricTask(MetricTask): 

"""A minimal `lsst.verify.gen2tasks.MetricTask`. 

""" 

 

ConfigClass = DemoMetricConfig 

_DefaultName = "test" 

 

def run(self, inputData): 

nData = len(inputData) 

return Struct(measurement=Measurement( 

self.getOutputMetricName(self.config), 

self.config.multiplier * nData * u.second)) 

 

@classmethod 

def getInputDatasetTypes(cls, _config): 

return {'inputData': "metadata"} 

 

@classmethod 

def areInputDatasetsScalar(cls, _config): 

return {'inputData': False} 

 

@classmethod 

def getOutputMetricName(cls, config): 

return Name(config.metric) 

 

 

@registerMultiple("repeatedMetric") 

class _RepeatedMetricTask(MetricTask): 

"""A minimal `lsst.verify.gen2tasks.MetricTask`. 

""" 

 

ConfigClass = DemoMetricConfig 

_DefaultName = "test" 

 

def run(self, inputData): 

nData = len(inputData) 

return Struct(measurement=Measurement( 

self.getOutputMetricName(self.config), 

self.config.multiplier * nData * u.second)) 

 

@classmethod 

def getInputDatasetTypes(cls, _config): 

return {'inputData': "metadata"} 

 

@classmethod 

def areInputDatasetsScalar(cls, _config): 

return {'inputData': False} 

 

@classmethod 

def getOutputMetricName(cls, config): 

return Name(config.metric) 

 

 

def _makeMockDataref(dataId=None): 

"""A dataref-like object with a specific data ID. 

""" 

return unittest.mock.NonCallableMock(dataId=dataId) 

 

 

class _TestMetadataAdder(Task): 

"""Simplest valid non-identity metadata adder. 

""" 

ConfigClass = Config 

 

def run(self, job, **kwargs): 

job.meta["tested"] = True 

return Struct(job=job) 

 

 

def _butlerQuery(_butler, _datasetType, _level="", dataId=None): 

"""Return a number of datarefs corresponding to a (partial) dataId. 

""" 

dataref = _makeMockDataref() 

 

# Simulate a dataset of 3 visits and 2 CCDs 

nRuns = 1 

if "visit" not in dataId: 

nRuns *= 3 

if "ccd" not in dataId: 

nRuns *= 2 

return [dataref] * nRuns 

 

 

@unittest.mock.patch.object(Job, "load_metrics_package", side_effect=Job) 

@unittest.mock.patch("lsst.daf.persistence.searchDataRefs", autospec=True, 

side_effect=_butlerQuery) 

@unittest.mock.patch("lsst.verify.Job.write", autospec=True) 

class MetricsControllerTestSuite(lsst.utils.tests.TestCase): 

 

def setUp(self): 

self.config = MetricsControllerTask.ConfigClass() 

self.config.metadataAdder.retarget(_TestMetadataAdder) 

self.config.measurers = ["demoMetric", "repeatedMetric"] 

 

self.config.measurers["demoMetric"].multiplier = 2.0 

repeated = self.config.measurers["repeatedMetric"] 

repeated.configs["first"] = DemoMetricConfig() 

repeated.configs["first"].metric = _extraMetricName1() 

repeated.configs["second"] = DemoMetricConfig() 

repeated.configs["second"].metric = _extraMetricName2() 

repeated.configs["second"].multiplier = 3.4 

 

self.task = MetricsControllerTask(self.config) 

 

def _allMetricTaskConfigs(self): 

configs = [] 

for name, topConfig in zip(self.config.measurers.names, 

self.config.measurers.active): 

if name != "repeatedMetric": 

configs.append(topConfig) 

else: 

configs.extend(topConfig.configs.values()) 

return configs 

 

def _checkMetric(self, mockWriter, datarefs, unitsOfWork): 

"""Standardized test battery for running a metric. 

 

Parameters 

---------- 

mockWriter : `unittest.mock.CallableMock` 

A queriable placeholder for `lsst.verify.Job.write`. 

datarefs : `list` of `lsst.daf.persistence.ButlerDataRef` 

The inputs to `MetricsControllerTask.runDataRefs`. 

unitsOfWork : `list` of `int` 

The number of science pipeline units of work (i.e., CCD-visit 

pairs) that should be combined to make a metric for each element 

of ``datarefs``. 

""" 

if len(datarefs) != len(unitsOfWork): 

raise ValueError("Test requires matching datarefs " 

"and unitsOfWork") 

 

jobs = self.task.runDataRefs(datarefs).jobs 

self.assertEqual(len(jobs), len(datarefs)) 

for job, dataref, nTimings in zip(jobs, datarefs, unitsOfWork): 

taskConfigs = self._allMetricTaskConfigs() 

self.assertEqual(len(job.measurements), len(taskConfigs)) 

for metricName, metricConfig in zip(job.measurements, taskConfigs): 

self.assertEqual(metricName, Name(metricConfig.metric)) 

assert_quantity_allclose( 

job.measurements[metricConfig.metric].quantity, 

metricConfig.multiplier * float(nTimings) * u.second) 

 

self.assertTrue(job.meta["tested"]) 

 

# Exact arguments to Job.write are implementation detail, don't test 

if not jobs: 

mockWriter.assert_not_called() 

elif len(jobs) == 1: 

mockWriter.assert_called_once() 

else: 

self.assertEqual(mockWriter.call_count, len(jobs)) 

 

def testCcdGrainedMetric(self, mockWriter, _mockButler, 

_mockMetricsLoader): 

dataId = {"visit": 42, "ccd": 101, "filter": "k"} 

datarefs = [_makeMockDataref(dataId)] 

self._checkMetric(mockWriter, datarefs, unitsOfWork=[1]) 

 

def testVisitGrainedMetric(self, mockWriter, _mockButler, 

_mockMetricsLoader): 

dataId = {"visit": 42, "filter": "k"} 

datarefs = [_makeMockDataref(dataId)] 

self._checkMetric(mockWriter, datarefs, unitsOfWork=[2]) 

 

def testDatasetGrainedMetric(self, mockWriter, _mockButler, 

_mockMetricsLoader): 

dataId = {} 

datarefs = [_makeMockDataref(dataId)] 

self._checkMetric(mockWriter, datarefs, unitsOfWork=[6]) 

 

def testMultipleMetrics(self, mockWriter, _mockButler, 

_mockMetricsLoader): 

dataIds = [{"visit": 42, "ccd": 101, "filter": "k"}, 

{"visit": 42, "ccd": 102, "filter": "k"}] 

datarefs = [_makeMockDataref(dataId) for dataId in dataIds] 

self._checkMetric(mockWriter, datarefs, 

unitsOfWork=[1] * len(dataIds)) 

 

def testSkippedMetrics(self, mockWriter, _mockButler, _mockMetricsLoader): 

dataIds = [{"visit": 42, "ccd": 101, "filter": "k"}, 

{"visit": 42, "ccd": 102, "filter": "k"}] 

datarefs = [_makeMockDataref(dataId) for dataId in dataIds] 

 

with unittest.mock.patch("os.path.isfile", side_effect=[True, False]): 

jobs = self.task.runDataRefs(datarefs).jobs 

self.assertEqual(len(jobs), 2) 

self.assertEqual(mockWriter.call_count, 2) 

 

mockWriter.reset_mock() 

 

with unittest.mock.patch("os.path.isfile", side_effect=[True, False]): 

jobs = self.task.runDataRefs(datarefs, skipExisting=True).jobs 

self.assertEqual(len(jobs), 1) 

mockWriter.assert_called_once() 

 

def testInvalidMetricSegregation(self, _mockWriter, _mockButler, 

_mockMetricsLoader): 

self.config.measurers = ["demoMetric"] 

self.task = MetricsControllerTask(self.config) 

with unittest.mock.patch.object(_DemoMetricTask, 

"adaptArgsAndRun") as mockCall: 

# Run _DemoMetricTask twice, with one failure and one result 

mockCall.side_effect = (MetricComputationError, 

unittest.mock.DEFAULT) 

expectedValue = 1.0 * u.second 

mockCall.return_value = Struct(measurement=lsst.verify.Measurement( 

_metricName(), expectedValue)) 

 

dataIds = [{"visit": 42, "ccd": 101, "filter": "k"}, 

{"visit": 42, "ccd": 102, "filter": "k"}] 

datarefs = [_makeMockDataref(dataId) for dataId in dataIds] 

 

jobs = self.task.runDataRefs(datarefs).jobs 

self.assertEqual(len(jobs), len(datarefs)) 

 

# Failed job 

self.assertEqual(len(jobs[0].measurements), 0) 

 

# Successful job 

self.assertTrue(jobs[1].meta["tested"]) 

self.assertEqual(len(jobs[1].measurements), 1) 

assert_quantity_allclose( 

jobs[1].measurements[_metricName()].quantity, 

expectedValue) 

 

def testNoData(self, mockWriter, _mockButler, _mockMetricsLoader): 

datarefs = [] 

self._checkMetric(mockWriter, datarefs, unitsOfWork=[]) 

 

def testBadMetric(self, _mockWriter, _mockButler, _mockMetricsLoader): 

with self.assertRaises(FieldValidationError): 

self.config.measurers = ["totallyAndDefinitelyNotARealMetric"] 

 

def testCustomMetadata(self, _mockWriter, _mockButler, _mockMetricsLoader): 

dataIds = [{"visit": 42, "ccd": 101, "filter": "k"}, 

{"visit": 42, "ccd": 102, "filter": "k"}] 

datarefs = [_makeMockDataref(dataId) for dataId in dataIds] 

extraMetadata = {"test_protocol": 42} 

jobs = self.task.runDataRefs(datarefs, extraMetadata).jobs 

 

for job in jobs: 

self.assertTrue(job.meta["tested"]) 

self.assertEqual(job.meta["test_protocol"], 

extraMetadata["test_protocol"]) 

 

 

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

pass 

 

 

def setup_module(module): 

lsst.utils.tests.init() 

 

 

326 ↛ 327line 326 didn't jump to line 327, because the condition on line 326 was never trueif __name__ == "__main__": 

lsst.utils.tests.init() 

unittest.main()