mem: Make MemCtrl a ClockedObject
[gem5.git] / ext / testlib / test_util.py
1 # Copyright (c) 2017 Mark D. Hill and David A. Wood
2 # All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met: redistributions of source code must retain the above copyright
7 # notice, this list of conditions and the following disclaimer;
8 # redistributions in binary form must reproduce the above copyright
9 # notice, this list of conditions and the following disclaimer in the
10 # documentation and/or other materials provided with the distribution;
11 # neither the name of the copyright holders nor the names of its
12 # contributors may be used to endorse or promote products derived from
13 # this software without specific prior written permission.
14 #
15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #
27 # Authors: Sean Wilson
28
29 import testlib.helper as helper
30 import testlib.runner as runner_mod
31
32 class TestCase(object):
33 '''
34 Base class for all tests.
35
36 ..note::
37 The :func:`__new__` method enables collection of test cases, it must
38 be called in order for test cases to be collected.
39 '''
40 fixtures = []
41
42 # TODO, remove explicit dependency. Use the loader to set the
43 # default runner
44 runner = runner_mod.TestRunner
45 collector = helper.InstanceCollector()
46
47 def __new__(cls, *args, **kwargs):
48 obj = super(TestCase, cls).__new__(cls)
49 TestCase.collector.collect(obj)
50 return obj
51
52 def __init__(self, name=None, fixtures=tuple(), **kwargs):
53 self.fixtures = self.fixtures + list(fixtures)
54 if name is None:
55 name = self.__class__.__name__
56 self.name = name
57
58 class TestFunction(TestCase):
59 '''
60 TestCase implementation which uses a callable object as a test.
61 '''
62 def __init__(self, function, name=None, **kwargs):
63 self.test_function = function
64 if name is None:
65 name = function.__name__
66 TestCase.__init__(self, name=name, **kwargs)
67
68 def test(self, *args, **kwargs):
69 self.test_function(*args, **kwargs)