Files
gem5/ext/testlib/fixture.py
Nikos Nikoleris 8282b7408b tests: Refactor the Gem5Fixture to derive from UniqueFixture
Gem5Fixture is used to define a fixture for building the gem5
binary. Most tests are expected to define their own Gem5Fixture,
however, as some might depend on the same binary (e.g.,
./build/ARM/gem5.opt), they will try to re-define a fixture for the
same target. This patchset changes Gem5Fixture to derive from
UniqueFixture.

In addition, this patchset changes the way global fixtures are
discovered to work with the new Gem5Fixture class. Instead of
enumerating them when test definitions are loaded, we do so after the
tests have been filtered according to specified tags (e.g., include
opt variant, exclude fast, debug variants).

Change-Id: Ie868a7e18ef6c3271f3c8a658229657cd43997cb
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/19251
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Giacomo Travaglini <giacomo.travaglini@arm.com>
Maintainer: Giacomo Travaglini <giacomo.travaglini@arm.com>
2019-08-09 14:03:21 +00:00

98 lines
3.4 KiB
Python

# Copyright (c) 2017 Mark D. Hill and David A. Wood
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# Authors: Sean Wilson
import copy
import traceback
import helper
import log
class SkipException(Exception):
def __init__(self, fixture, testitem):
self.fixture = fixture
self.testitem = testitem
self.msg = 'Fixture "%s" raised SkipException for "%s".' % (
fixture.name, testitem.name
)
super(SkipException, self).__init__(self.msg)
class Fixture(object):
'''
Base Class for a test Fixture.
Fixtures are items which possibly require setup and/or tearing down after
a TestCase, TestSuite, or the Library has completed.
Fixtures are the prefered method of carrying incremental results or
variables between TestCases in TestSuites. (Rather than using globals.)
Using fixtures rather than globals ensures that state will be maintained
when executing tests in parallel.
.. note:: In order for Fixtures to be enumerated by the test system this
class' :code:`__new__` method must be called.
'''
collector = helper.InstanceCollector()
def __new__(klass, *args, **kwargs):
obj = super(Fixture, klass).__new__(klass, *args, **kwargs)
Fixture.collector.collect(obj)
return obj
def __init__(self, name=None, **kwargs):
if name is None:
name = self.__class__.__name__
self.name = name
self._is_global = False
def skip(self, testitem):
raise SkipException(self.name, testitem.metadata)
def init(self, *args, **kwargs):
pass
def setup(self, testitem):
pass
def teardown(self, testitem):
pass
def skip_cleanup(self):
'''
If this method is called, then we should make sure that nothing is
done when the teardown() function is called.
'''
pass
def set_global(self):
self._is_global = True
def is_global(self):
return self._is_global