test.py revision 12882 
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
29import functools
30
31import helper
32import runner as runner_mod
33
34class TestCase(object):
35    '''
36    Base class for all tests.
37
38    ..note::
39        The :func:`__new__` method enables collection of test cases, it must
40        be called in order for test cases to be collected.
41    '''
42    fixtures = []
43
44    # TODO, remove explicit dependency. Use the loader to set the
45    # default runner
46    runner = runner_mod.TestRunner
47    collector = helper.InstanceCollector()
48
49    def __new__(cls, *args, **kwargs):
50        obj = super(TestCase, cls).__new__(cls, *args, **kwargs)
51        TestCase.collector.collect(obj)
52        return obj
53
54    def __init__(self, name=None, fixtures=tuple(), **kwargs):
55        self.fixtures = self.fixtures + list(fixtures)
56        if name is None:
57            name = self.__class__.__name__
58        self.name = name
59
60class TestFunction(TestCase):
61    '''
62    TestCase implementation which uses a callable object as a test.
63    '''
64    def __init__(self, function, name=None, **kwargs):
65        self.test_function = function
66        if name is None:
67            name = function.__name__
68        TestCase.__init__(self, name=name, **kwargs)
69
70    def test(self, *args, **kwargs):
71        self.test_function(*args, **kwargs)
72
73# TODO Change the decorator to make this easier to create copy tests.
74# Good way to do so might be return by reference.
75def testfunction(function=None, name=None, fixtures=tuple()):
76    '''
77    A decorator used to wrap a function as a TestFunction.
78    '''
79    def testfunctiondecorator(function):
80        '''Decorator used to mark a function as a test case.'''
81        kwargs = {}
82        if name is not None:
83            kwargs['name'] = name
84        if fixtures is not None:
85            kwargs['fixtures'] = fixtures
86        TestFunction(function, **kwargs)
87        return function
88    if function is not None:
89        return testfunctiondecorator(function)
90    else:
91        return testfunctiondecorator