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

# 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/>. 

 

__all__ = ["MetadataMetricTestCase", "ApdbMetricTestCase"] 

 

import abc 

 

import unittest.mock 

from unittest.mock import patch 

 

import lsst.utils.tests 

from lsst.daf.base import PropertySet 

from lsst.dax.apdb import ApdbConfig 

 

import lsst.verify.gen2tasks.testUtils as gen2Utils 

from lsst.verify.tasks import MetricComputationError 

 

 

class MetricTaskTestCase(lsst.utils.tests.TestCase, metaclass=abc.ABCMeta): 

"""Unit test base class for tests of `tasks.MetricTask`. 

 

This class provides tests of the generic ``MetricTask`` API. Subclasses 

must override `taskFactory`, and may add extra tests for class-specific 

functionality. If subclasses override `setUp`, they must call 

`MetricTaskTestCase.setUp`. 

""" 

@classmethod 

@abc.abstractmethod 

def makeTask(cls): 

"""Construct the task to be tested. 

 

This overridable method will be called during test setup. 

 

Returns 

------- 

task : `lsst.verify.tasks.MetricTask` 

A new MetricTask object to test. 

""" 

 

task = None 

"""The ``MetricTask`` being tested by this object 

(`tasks.MetricTask`). 

 

This attribute is initialized automatically. 

""" 

 

taskClass = None 

"""The type of `task` (`tasks.MetricTask`-type). 

 

This attribute is initialized automatically. 

""" 

 

def setUp(self): 

"""Setup common to all MetricTask tests. 

 

Notes 

----- 

This implementation calls `taskFactory`, then initializes `task` 

and `taskClass`. 

""" 

self.task = self.makeTask() 

self.taskClass = type(self.task) 

 

def testOutputDatasetName(self): 

config = self.task.config 

connections = config.connections.ConnectionsClass(config=config) 

dataset = connections.measurement.name 

 

self.assertTrue(dataset.startswith("metricvalue_")) 

self.assertNotIn(".", dataset) 

 

self.assertIn(config.connections.package, dataset) 

self.assertIn(config.connections.metric, dataset) 

 

def testConfigValidation(self): 

config = self.task.config 

config.connections.metric = "verify.DummyMetric" 

with self.assertRaises(ValueError): 

config.validate() 

 

 

class MetadataMetricTestCase(gen2Utils.MetricTaskTestCase, MetricTaskTestCase): 

"""Unit test base class for tests of `MetadataMetricTask`. 

 

Notes 

----- 

Subclasses must override 

`~lsst.verify.gen2tasks.MetricTaskTestCase.makeTask` for the concrete task 

being tested. 

""" 

 

@staticmethod 

def _takesScalarMetadata(task): 

return task.areInputDatasetsScalar(task.config)['metadata'] 

 

def testValidRun(self): 

"""Test how run delegates to the abstract methods. 

""" 

mockKey = "unitTestKey" 

with patch.object(self.task, "getInputMetadataKeys", 

return_value={"unused": mockKey}), \ 

patch.object(self.task, "makeMeasurement") as mockWorkhorse: 

if self._takesScalarMetadata(self.task): 

metadata1 = PropertySet() 

metadata1[mockKey] = 42 

 

self.task.run(metadata1) 

mockWorkhorse.assert_called_once_with({"unused": 42}) 

mockWorkhorse.reset_mock() 

self.task.run(None) 

mockWorkhorse.assert_called_once_with({"unused": None}) 

else: 

metadata1 = PropertySet() 

metadata1[mockKey] = 42 

metadata2 = PropertySet() 

metadata2[mockKey] = "Sphere" 

self.task.run([metadata1, None, metadata2]) 

mockWorkhorse.assert_called_once_with( 

[{"unused": value} for value in [42, None, "Sphere"]]) 

 

def testAmbiguousRun(self): 

mockKey = "unitTestKey" 

with patch.object(self.task, "getInputMetadataKeys", 

return_value={"unused": mockKey}): 

metadata = PropertySet() 

metadata[mockKey + "1"] = 42 

metadata[mockKey + "2"] = "Sphere" 

with self.assertRaises(MetricComputationError): 

if self._takesScalarMetadata(self.task): 

self.task.run(metadata) 

else: 

self.task.run([metadata]) 

 

def testPassThroughRun(self): 

with patch.object(self.task, "makeMeasurement", 

side_effect=MetricComputationError): 

with self.assertRaises(MetricComputationError): 

if self._takesScalarMetadata(self.task): 

self.task.run(None) 

else: 

self.task.run([None]) 

 

 

class ApdbMetricTestCase(gen2Utils.MetricTaskTestCase, MetricTaskTestCase): 

"""Unit test base class for tests of `ApdbMetricTask`. 

 

Notes 

----- 

Subclasses must override 

`~lsst.verify.gen2tasks.MetricTaskTestCase.makeTask` for the concrete task 

being tested. Subclasses that use a custom DbLoader should also 

override `makeDbInfo`. 

""" 

 

@classmethod 

def makeDbInfo(cls): 

"""Return an object that can be passed as input to an `ApdbMetricTask`. 

 

This method is intended for generic tests that simply need to call 

``run`` on some valid input. If a test depends on specific input, it 

should create that input directly. 

 

The default implementation creates a `~lsst.pex.config.Config` that 

will be accepted by `~lsst.verify.tasks.DirectApdbLoader`. Test suites 

that use a different loader should override this method. 

""" 

return ApdbConfig() 

 

def testValidRun(self): 

info = self.makeDbInfo() 

with patch.object(self.task, "makeMeasurement") as mockWorkhorse: 

self.task.run([info]) 

mockWorkhorse.assert_called_once() 

 

def testDataIdRun(self): 

info = self.makeDbInfo() 

with patch.object(self.task, "makeMeasurement") as mockWorkhorse: 

dataId = {'visit': 42} 

self.task.run([info], outputDataId=dataId) 

mockWorkhorse.assert_called_once_with( 

unittest.mock.ANY, {'visit': 42}) 

 

def testPassThroughRun(self): 

with patch.object(self.task, "makeMeasurement", 

side_effect=MetricComputationError): 

info = self.makeDbInfo() 

with self.assertRaises(MetricComputationError): 

self.task.run([info])