'''
Exposes the :class:`~Fixture` class.
'''
from helper import cacheresult
[docs]class Fixture(object):
'''
Base Class for a test Fixture.
Fixtures are items which possibly require setup and/or tearing down after
a TestCase or a TestSuite has run.
Fixtures are the prefered method of carrying incremental results or
variables between TestCases in TestSuites. (Rather than using globals.)
The test system assumes that TestSuites are self contained so
paralellization is possible in the future. Using global variables will
likely cause things to break unexpectedly.
.. note:: no_collect function is provided by the :mod:`~whimsy.loader` to
remove a fixture that should not be collected.
.. note:: In order for Fixtures to be enumerated by the test system this
class' :code:`__new__` method must be called. The loader class will
monkey patch (modify at runtime) this method in order to enmerate
tests.
'''
def __init__(self, name, build_once=False, lazy_init=True):
'''
:param name: Name of the fixture.
:param lazy_init: If True, wait until test cases that use this fixture
are ran to setup this fixture. Otherwise init the fixture before
the first test case is ran.
:param build_once: This fixture will only be built once. This is
particularly useful for gem5 targets or build systems.
:var requires: List of fixtures which require this Fixture. Before
they can be built.
:var required_by: List of fixtures this Fixture requires.
:var built: Indicates that this fixture has been built.
'''
self.requires = []
self.required_by = []
self.name = name
self._built = False
self.lazy_init = lazy_init
if build_once:
self.setup = cacheresult(self.setup)
@property
def built(self):
return self._built
[docs] def require(self, other_fixture):
'''
Require that the other_fixture be built before us.
This is particularly useful for build targets.
.. seealso:: :class:`~whimsy.gem5.fixture.SConsTarget`
'''
self.requires.append(other_fixture)
other_fixture.required_by.append(self)
[docs] def setup(self):
'''Call setup of fixtures we require.'''
self._built = True
for fixture in self.requires:
fixture.setup()
[docs] def teardown(self):
'''Empty method, meant to be overriden if fixture requires teardown.'''
pass
if __debug__:
# This is a method that will be created by the test loader in order to
# manually remove a fixture.
__no_collect__ = NotImplemented