summaryrefslogtreecommitdiff
path: root/lib/testscenarios/testcase.py
blob: 712d543afeae22032c2a2f0920d7bf7c8390f732 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#  testscenarios: extensions to python unittest to allow declarative
#  dependency injection ('scenarios') by tests.
#  Copyright (C) 2009  Robert Collins <robertc@robertcollins.net>
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program; if not, write to the Free Software
#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#

__all__ = [
    'TestWithScenarios',
    ]

import unittest

from testtools.testcase import clone_test_with_new_id

from testscenarios.scenarios import generate_scenarios

class TestWithScenarios(unittest.TestCase):
    """A TestCase with support for scenarios via a scenarios attribute.
    
    When a test object which is an instance of TestWithScenarios is run,
    and there is a non-empty scenarios attribute on the object, the test is
    multiplied by the run method into one test per scenario. For this to work
    reliably the TestWithScenarios.run method must not be overriden in a
    subclass (or overridden compatibly with TestWithScenarios).
    """

    def run(self, result=None):
        scenarios = getattr(self, 'scenarios', None)
        if scenarios:
            for test in generate_scenarios(self):
                test.run(result)
            return
        else:
            return super(TestWithScenarios, self).run(result)