lsst.obs.base  16.0-19-g302af01
tests.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2016 LSST Corporation.
4 #
5 # This product includes software developed by the
6 # LSST Project (http://www.lsst.org/).
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the LSST License Statement and
19 # the GNU General Public License along with this program. If not,
20 # see <http://www.lsstcorp.org/LegalNotices/>.
21 #
22 """
23 Test aggregator for obs_* packages.
24 
25 The intention is for each obs package to have a single test class that inherits
26 from this collector class, thus "automatically" getting all new tests. If those
27 tests require setup that isn't defined in a given obs package, that obs package
28 will be broken until updated. This is intentional, as a way to prevent obs
29 packages from falling behind out of neglect.
30 """
31 
32 from . import butler_tests
33 from . import mapper_tests
34 from . import camera_tests
35 
36 __all__ = ["ObsTests"]
37 
38 
41  """
42  Aggregator class for all of the obs_* test classes.
43 
44  Inherit from this class, then lsst.utils.tests.TestCase, in that order.
45 
46  Example subclass::
47 
48  class TestObsExample(lsst.obs.base.tests.ObsTests, lsst.utils.tests.TestCase):
49  def setUp(self):
50  self.setUp_tests(...)
51  self.setUp_butler_get(...)
52  self.setUp_mapper(...)
53  self.setUp_camera(...)
54  """
55 
56  def setUp_tests(self, butler, mapper, dataIds):
57  """
58  Set up the necessary shared variables used by multiple tests.
59 
60  Parameters
61  ----------
62  butler: lsst.daf.persistence.Butler
63  A butler object, instantiated on the testdata repository for the
64  obs package being tested.
65  mapper: lsst.obs.CameraMapper
66  A CameraMapper object for your camera, instantiated on the testdata
67  repository the obs package being tested.
68  dataIds: dict
69  dictionary of (exposure name): (dataId of that exposure in the
70  testdata repository), with unittest.SkipTest as the value for any
71  exposures you do not have/do not want to test. It must contain a
72  valid 'raw' dataId, in addition to 'bias','flat','dark', which may
73  be set to SkipTest. For example::
74  self.dataIds = {'raw': {'visit': 1, 'filter': 'g'},
75  'bias': {'visit': 1},
76  'flat': {'visit': 1},
77  'dark': unittest.SkipTest
78  }
79  """
80  self.butler = butler
81  self.mapper = mapper
82  self.dataIds = dataIds
83 
84  def tearDown(self):
85  del self.butler
86  del self.mapper
87  super(ObsTests, self).tearDown()
def setUp_tests(self, butler, mapper, dataIds)
Definition: tests.py:56