lsst.sconsUtils.tests.Control Class Reference

A class to control unit tests. More...

Inheritance diagram for lsst.sconsUtils.tests.Control:

Public Member Functions
def	__init__
	Create an object to run tests. More...
def	args
def	ignore
def	messages
def	run

Public Attributes
	runExamples

Private Attributes
	_env
	_tmpDir
	_cwd
	_verbose
	_info
	_args

Static Private Attributes
string	_IGNORE = "IGNORE"
string	_EXPECT_FAILURE = "EXPECT_FAILURE"

Detailed Description

A class to control unit tests.

This class is unchanged from previous versions of sconsUtils, but it will now generally be called via scripts.BasicSConscript.tests().

Definition at line 17 of file tests.py.

Constructor & Destructor Documentation

def lsst.sconsUtils.tests.Control.__init__	(		self,
			env,
			ignoreList = None,
			expectedFailures = None,
			args = None,
			tmpDir = ".tests",
			verbose = False
	)

Create an object to run tests.

Parameters

env	An SCons Environment (almost always lsst.sconsUtils.env).
ignoreList	A list of tests that should NOT be run — useful in conjunction with glob patterns. If a file is listed as "@fileName", the @ is stripped and we don't bother to check if fileName exists (useful for machine-generated files).
expectedFalures	A dictionary; the keys are tests that are known to fail; the values are strings to print.
args	A dictionary with testnames as keys, and argument strings as values. As scons always runs from the top-level directory, tests has to fiddle with paths. If an argument is a file this is done automatically; if it's e.g. just a basename then you have to tell tests that it's really (part of a) filename by prefixing the name by "file:".
tmpDir	The location of the test outputs.
verbose	How chatty you want the test code to be.

 tests = lsst.tests.Control(
     env,
     args={
          "MaskIO_1" :      "data/871034p_1_MI_msk.fits",
          "MaskedImage_1" : "file:data/871034p_1_MI foo",
     },
     ignoreList=["Measure_1"],
     expectedFailures={"BBox_1": "Problem with single-pixel BBox"}
)

Definition at line 52 of file tests.py.

                 tmpDir=".tests", verbose=False):
        if 'PYTHONPATH' in os.environ:
            env.AppendENVPath('PYTHONPATH', os.environ['PYTHONPATH'])

        self._env = env

        self._tmpDir = tmpDir
        self._cwd = os.path.abspath(os.path.curdir)

        self._verbose = verbose

        self._info = {}                 # information about processing targets
        if ignoreList:
            for f in ignoreList:
                if re.search(r"^@", f):    # @dfilename => don't complain if filename doesn't exist
                    f = f[1:]
                else:
                    if not os.path.exists(f):
                        state.log.warn("You're ignoring a non-existent file, %s" % f)
                self._info[f] = (self._IGNORE, None)

        if expectedFailures:
            for f in expectedFailures:
                self._info[f] = (self._EXPECT_FAILURE, expectedFailures[f])

        if args:
            self._args = args           # arguments for tests
        else:
            self._args = {}

        self.runExamples = True                      # should I run the examples?
        try:
            self.runExamples = (os.stat(self._tmpDir).st_mode & 0o700) != 0 # file is user read/write/executable
        except OSError:
            pass

        if not self.runExamples:
            print("Not running examples; \"chmod 755 %s\" to run them again" % self._tmpDir,
                  file=sys.stderr)