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

# 

# This file is part of verify. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://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 <http://www.gnu.org/licenses/>. 

# 

 

__all__ = ["MetricTaskTestCase"] 

 

import abc 

import unittest.mock 

import inspect 

 

import lsst.utils.tests 

 

from lsst.pipe.base import Struct 

from lsst.verify import Measurement 

 

 

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) 

 

# Implementation classes will override run. Can't implement most tests if 

# it's mocked, risk excessive runtime if it isn't. 

 

def testInputDatasetTypesKeys(self): 

defaultInputs = self.taskClass.getInputDatasetTypes(self.task.config) 

runParams = inspect.signature(self.taskClass.run).parameters 

# Filter out keywords with defaults 

runParams = {name: param for name, param in runParams.items() 

if param.default is param.empty} 

 

# Only way to check if run has been overridden? 

if runParams.keys() != ['kwargs']: 

self.assertSetEqual( 

set(defaultInputs.keys()).union({'self'}), 

set(runParams.keys()).union({'self'}), 

"getInputDatasetTypes keys do not match run parameters") 

 

def testAddStandardMetadata(self): 

measurement = Measurement('foo.bar', 0.0) 

dataId = {'tract': 42, 'patch': 3, 'filter': 'Ic'} 

self.task.addStandardMetadata(measurement, dataId) 

# Nothing to test until addStandardMetadata adds something 

 

def testCallAddStandardMetadata(self): 

dummy = Measurement('foo.bar', 0.0) 

with unittest.mock.patch.multiple( 

self.taskClass, autospec=True, 

run=unittest.mock.DEFAULT, 

addStandardMetadata=unittest.mock.DEFAULT) as mockDict: 

mockDict['run'].return_value = Struct(measurement=dummy) 

 

inputScalars = self.taskClass.areInputDatasetsScalar( 

self.task.config) 

# Probably won't satisfy all adaptArgsAndRun specs, 

# but hopefully works with most of them 

dataId = {} 

result = self.task.adaptArgsAndRun( 

{key: (None if scalar else [None]) 

for key, scalar in inputScalars.items()}, 

{key: (dataId if scalar else [dataId]) 

for key, scalar in inputScalars.items()}, 

{'measurement': dataId}) 

mockDict['addStandardMetadata'].assert_called_once_with( 

self.task, result.measurement, dataId)