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

# 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 

from lsst.pipe.base import Task, Struct 

from lsst.verify import Job, MetricComputationError 

from lsst.verify.compatibility import MetricTask, MetricsControllerTask 

 

 

def _metricName(): 

"""The metric to be hypothetically measured using the mock task. 

""" 

return "misc_tasks.FancyMetric" 

 

 

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): 

controllerConfig = MetricsControllerTask.ConfigClass() 

controllerConfig.metadataAdder.retarget(_TestMetadataAdder) 

self.task = MetricsControllerTask(controllerConfig) 

 

self.metricTask = unittest.mock.create_autospec( 

MetricTask, instance=True) 

self.task.measurers = [self.metricTask] 

# For some reason can't set these in create_autospec call 

self.metricTask.config = None 

self.metricTask.getInputDatasetTypes.return_value = \ 

{"input": "metadata"} 

 

def returnMeasurement(inputData, _inputDataIds, _outputDataIds): 

nData = len(inputData["input"]) 

return Struct(measurement=lsst.verify.Measurement( 

_metricName(), nData * u.second)) 

self.metricTask.adaptArgsAndRun.side_effect = returnMeasurement 

 

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

"""Standardized test battery for running a timing 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, nTimings in zip(jobs, unitsOfWork): 

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

assert_quantity_allclose( 

job.measurements[_metricName()].quantity, 

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: 

mockWriter.assert_called() 

 

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 testInvalidMetricSegregation(self, _mockWriter, _mockButler, 

_mockMetricsLoader): 

self.metricTask.adaptArgsAndRun.side_effect = ( 

MetricComputationError, unittest.mock.DEFAULT) 

self.metricTask.adaptArgsAndRun.return_value = Struct( 

measurement=lsst.verify.Measurement(_metricName(), 

1.0 * u.second)) 

 

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)) 

 

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

for job in jobs: 

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

for job in jobs[1:]: 

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

assert_quantity_allclose( 

job.measurements[_metricName()].quantity, 

float(1.0) * u.second) 

 

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

datarefs = [] 

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

 

 

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

pass 

 

 

def setup_module(module): 

lsst.utils.tests.init() 

 

 

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

lsst.utils.tests.init() 

unittest.main()