#!/usr/bin/env python

'''

Python unit testing framework, based on Erich Gamma's JUnit and Kent Beck's

Smalltalk testing framework.

This module contains the core framework classes that form the basis of

specific test cases and suites (TestCase, TestSuite etc.), and also a

text-based utility class for running the tests and reporting the results

 (TextTestRunner).

Simple usage:

    import unittest

    class IntegerArithmenticTestCase(unittest.TestCase):

        def testAdd(self):  ## test method names begin 'test*'

            self.assertEquals((1 + 2), 3)

            self.assertEquals(0 + 1, 1)

        def testMultiply(self):

            self.assertEquals((0 * 10), 0)

            self.assertEquals((5 * 8), 40)

    if __name__ == '__main__':

        unittest.main()

Further information is available in the bundled documentation, and from

  http://docs.python.org/lib/module-unittest.html

Copyright (c) 1999-2003 Steve Purcell

This module is free software, and you may redistribute it and/or modify

it under the same terms as Python itself, so long as this copyright message

and disclaimer are retained in their original form.

IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,

SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF

THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH

DAMAGE.

THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT

LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,

AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,

SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

'''

__author__ = "Steve Purcell"

__email__ = "stephen_purcell at yahoo dot com"

__version__ = "#Revision: 1.63 $"[11:-2]

import time

import sys

import traceback

import os

import types

##############################################################################

# Exported classes and functions

##############################################################################

__all__ = ['TestResult', 'TestCase', 'TestSuite', 'TextTestRunner',

           'TestLoader', 'FunctionTestCase', 'main', 'defaultTestLoader']

# Expose obsolete functions for backwards compatibility

__all__.extend(['getTestCaseNames', 'makeSuite', 'findTestCases'])

##############################################################################

# Backward compatibility

##############################################################################

if sys.version_info[:2] < (2, 2):

    def isinstance(obj, clsinfo):

        import __builtin__

        if type(clsinfo) in (tuple, list):

            for cls in clsinfo:

                if cls is type: cls = types.ClassType

                if __builtin__.isinstance(obj, cls):

                    return 1

            return 0

        else: return __builtin__.isinstance(obj, clsinfo)

def _CmpToKey(mycmp):

    'Convert a cmp= function into a key= function'

    class K(object):

        def __init__(self, obj):

            self.obj = obj

        def __lt__(self, other):

            return mycmp(self.obj, other.obj) == -1

    return K

##############################################################################

# Test framework core

##############################################################################

# All classes defined herein are 'new-style' classes, allowing use of 'super()'

__metaclass__ = type

def _strclass(cls):

    return "%s.%s" % (cls.__module__, cls.__name__)

__unittest = 1

class TestResult:

    """Holder for test result information.

    Test results are automatically managed by the TestCase and TestSuite

    classes, and do not need to be explicitly manipulated by writers of tests.

    Each instance holds the total number of tests run, and collections of

    failures and errors that occurred among those test runs. The collections

    contain tuples of (testcase, exceptioninfo), where exceptioninfo is the

    formatted traceback of the error that occurred.

    """

    def __init__(self):

        self.failures = []

        self.errors = []

        self.testsRun = 0

        self.shouldStop = False

    def startTest(self, test):

        "Called when the given test is about to be run"

        self.testsRun = self.testsRun + 1

    def stopTest(self, test):

        "Called when the given test has been run"

        pass

    def addError(self, test, err):

        """Called when an error has occurred. 'err' is a tuple of values as

        returned by sys.exc_info().

        """

        self.errors.append((test, self._exc_info_to_string(err, test)))

    def addFailure(self, test, err):

        """Called when an error has occurred. 'err' is a tuple of values as

        returned by sys.exc_info()."""

        self.failures.append((test, self._exc_info_to_string(err, test)))

    def addSuccess(self, test):

        "Called when a test has completed successfully"

        pass

    def wasSuccessful(self):

        "Tells whether or not this result was a success"

        return len(self.failures) == len(self.errors) == 0

    def stop(self):

        "Indicates that the tests should be aborted"

        self.shouldStop = True

    def _exc_info_to_string(self, err, test):

        """Converts a sys.exc_info()-style tuple of values into a string."""

        exctype, value, tb = err

        # Skip test runner traceback levels

        while tb and self._is_relevant_tb_level(tb):

            tb = tb.tb_next

        if exctype is test.failureException:

            # Skip assert*() traceback levels

            length = self._count_relevant_tb_levels(tb)

            return ''.join(traceback.format_exception(exctype, value, tb, length))

        return ''.join(traceback.format_exception(exctype, value, tb))

    def _is_relevant_tb_level(self, tb):

        return '__unittest' in tb.tb_frame.f_globals

    def _count_relevant_tb_levels(self, tb):

        length = 0

        while tb and not self._is_relevant_tb_level(tb):

            length += 1

            tb = tb.tb_next

        return length

    def __repr__(self):

        return "<%s run=%i errors=%i failures=%i>" % \

               (_strclass(self.__class__), self.testsRun, len(self.errors),

                len(self.failures))

class TestCase:

    """A class whose instances are single test cases.

    By default, the test code itself should be placed in a method named

    'runTest'.

    If the fixture may be used for many test cases, create as

    many test methods as are needed. When instantiating such a TestCase

    subclass, specify in the constructor arguments the name of the test method

    that the instance is to execute.

    Test authors should subclass TestCase for their own tests. Construction

    and deconstruction of the test's environment ('fixture') can be

    implemented by overriding the 'setUp' and 'tearDown' methods respectively.

    If it is necessary to override the __init__ method, the base class

    __init__ method must always be called. It is important that subclasses

    should not change the signature of their __init__ method, since instances

    of the classes are instantiated automatically by parts of the framework

    in order to be run.

    """

    # This attribute determines which exception will be raised when

    # the instance's assertion methods fail; test methods raising this

    # exception will be deemed to have 'failed' rather than 'errored'

    failureException = AssertionError

    def __init__(self, methodName='runTest'):

        """Create an instance of the class that will use the named test

           method when executed. Raises a ValueError if the instance does

           not have a method with the specified name.

        """

        try:

            self._testMethodName = methodName

            testMethod = getattr(self, methodName)

            self._testMethodDoc = testMethod.__doc__

        except AttributeError:

            raise ValueError, "no such test method in %s: %s" % \

                  (self.__class__, methodName)

    def setUp(self):

        "Hook method for setting up the test fixture before exercising it."

        pass

    def tearDown(self):

        "Hook method for deconstructing the test fixture after testing it."

        pass

    def countTestCases(self):

        return 1

    def defaultTestResult(self):

        return TestResult()

    def shortDescription(self):

        """Returns a one-line description of the test, or None if no

        description has been provided.

        The default implementation of this method returns the first line of

        the specified test method's docstring.

        """

        doc = self._testMethodDoc

        return doc and doc.split("\n")[0].strip() or None

    def id(self):

        return "%s.%s" % (_strclass(self.__class__), self._testMethodName)

    def __eq__(self, other):

        if type(self) is not type(other):

            return False

        return self._testMethodName == other._testMethodName

    def __ne__(self, other):

        return not self == other

    def __hash__(self):

        return hash((type(self), self._testMethodName))

    def __str__(self):

        return "%s (%s)" % (self._testMethodName, _strclass(self.__class__))

    def __repr__(self):

        return "<%s testMethod=%s>" % \

               (_strclass(self.__class__), self._testMethodName)

    def run(self, result=None):

        if result is None: result = self.defaultTestResult()

        result.startTest(self)

        testMethod = getattr(self, self._testMethodName)

        try:

            try:

                self.setUp()

            except KeyboardInterrupt:

                raise

            except:

                result.addError(self, self._exc_info())

                return

            ok = False

            try:

                testMethod()

                ok = True

            except self.failureException:

                result.addFailure(self, self._exc_info())

            except KeyboardInterrupt:

                raise

            except:

                result.addError(self, self._exc_info())

            try:

                self.tearDown()

            except KeyboardInterrupt:

                raise

            except:

                result.addError(self, self._exc_info())

                ok = False

            if ok: result.addSuccess(self)

        finally:

            result.stopTest(self)

    def __call__(self, *args, **kwds):

        return self.run(*args, **kwds)

    def debug(self):

        """Run the test without collecting errors in a TestResult"""

        self.setUp()

        getattr(self, self._testMethodName)()

        self.tearDown()

    def _exc_info(self):

        """Return a version of sys.exc_info() with the traceback frame

           minimised; usually the top level of the traceback frame is not

           needed.

        """

        return sys.exc_info()

    def fail(self, msg=None):

        """Fail immediately, with the given message."""

        raise self.failureException, msg

    def failIf(self, expr, msg=None):

        "Fail the test if the expression is true."

        if expr: raise self.failureException, msg

    def failUnless(self, expr, msg=None):

        """Fail the test unless the expression is true."""

        if not expr: raise self.failureException, msg

    def failUnlessRaises(self, excClass, callableObj, *args, **kwargs):

        """Fail unless an exception of class excClass is thrown

           by callableObj when invoked with arguments args and keyword

           arguments kwargs. If a different type of exception is

           thrown, it will not be caught, and the test case will be

           deemed to have suffered an error, exactly as for an

           unexpected exception.

        """

        try:

            callableObj(*args, **kwargs)

        except excClass:

            return

        else:

            if hasattr(excClass,'__name__'): excName = excClass.__name__

            else: excName = str(excClass)

            raise self.failureException, "%s not raised" % excName

    def failUnlessEqual(self, first, second, msg=None):

        """Fail if the two objects are unequal as determined by the '=='

           operator.

        """

        if not first == second:

            raise self.failureException, \

                  (msg or '%r != %r' % (first, second))

    def failIfEqual(self, first, second, msg=None):

        """Fail if the two objects are equal as determined by the '=='

           operator.

        """

        if first == second:

            raise self.failureException, \

                  (msg or '%r == %r' % (first, second))

    def failUnlessAlmostEqual(self, first, second, places=7, msg=None):

        """Fail if the two objects are unequal as determined by their

           difference rounded to the given number of decimal places

           (default 7) and comparing to zero.

           Note that decimal places (from zero) are usually not the same

           as significant digits (measured from the most signficant digit).

        """

        if round(abs(second-first), places) != 0:

            raise self.failureException, \

                  (msg or '%r != %r within %r places' % (first, second, places))

    def failIfAlmostEqual(self, first, second, places=7, msg=None):

        """Fail if the two objects are equal as determined by their

           difference rounded to the given number of decimal places

           (default 7) and comparing to zero.

           Note that decimal places (from zero) are usually not the same

           as significant digits (measured from the most signficant digit).

        """

        if round(abs(second-first), places) == 0:

            raise self.failureException, \

                  (msg or '%r == %r within %r places' % (first, second, places))

    # Synonyms for assertion methods

    assertEqual = assertEquals = failUnlessEqual

    assertNotEqual = assertNotEquals = failIfEqual

    assertAlmostEqual = assertAlmostEquals = failUnlessAlmostEqual

    assertNotAlmostEqual = assertNotAlmostEquals = failIfAlmostEqual

    assertRaises = failUnlessRaises

    assert_ = assertTrue = failUnless

    assertFalse = failIf

class TestSuite:

    """A test suite is a composite test consisting of a number of TestCases.

    For use, create an instance of TestSuite, then add test case instances.

    When all tests have been added, the suite can be passed to a test

    runner, such as TextTestRunner. It will run the individual test cases

    in the order in which they were added, aggregating the results. When

    subclassing, do not forget to call the base class constructor.

    """

    def __init__(self, tests=()):

        self._tests = []

        self.addTests(tests)

    def __repr__(self):

        return "<%s tests=%s>" % (_strclass(self.__class__), self._tests)

    __str__ = __repr__

    def __eq__(self, other):

        if type(self) is not type(other):

            return False

        return self._tests == other._tests

    def __ne__(self, other):

        return not self == other

    # Can't guarantee hash invariant, so flag as unhashable

    __hash__ = None

    def __iter__(self):

        return iter(self._tests)

    def countTestCases(self):

        cases = 0

        for test in self._tests:

            cases += test.countTestCases()

        return cases

    def addTest(self, test):

        # sanity checks

        if not hasattr(test, '__call__'):

            raise TypeError("the test to add must be callable")

        if (isinstance(test, (type, types.ClassType)) and

            issubclass(test, (TestCase, TestSuite))):

            raise TypeError("TestCases and TestSuites must be instantiated "

                            "before passing them to addTest()")

        self._tests.append(test)

    def addTests(self, tests):

        if isinstance(tests, basestring):

            raise TypeError("tests must be an iterable of tests, not a string")

        for test in tests:

            self.addTest(test)

    def run(self, result):

        for test in self._tests:

            if result.shouldStop:

                break

            test(result)

        return result

    def __call__(self, *args, **kwds):

        return self.run(*args, **kwds)

    def debug(self):

        """Run the tests without collecting errors in a TestResult"""

        for test in self._tests: test.debug()

class FunctionTestCase(TestCase):

    """A test case that wraps a test function.

    This is useful for slipping pre-existing test functions into the

    unittest framework. Optionally, set-up and tidy-up functions can be

    supplied. As with TestCase, the tidy-up ('tearDown') function will

    always be called if the set-up ('setUp') function ran successfully.

    """

    def __init__(self, testFunc, setUp=None, tearDown=None,

                 description=None):

        TestCase.__init__(self)

        self.__setUpFunc = setUp

        self.__tearDownFunc = tearDown

        self.__testFunc = testFunc

        self.__description = description

    def setUp(self):

        if self.__setUpFunc is not None:

            self.__setUpFunc()

    def tearDown(self):

        if self.__tearDownFunc is not None:

            self.__tearDownFunc()

    def runTest(self):

        self.__testFunc()

    def id(self):

        return self.__testFunc.__name__

    def __eq__(self, other):

        if type(self) is not type(other):

            return False

        return self.__setUpFunc == other.__setUpFunc and \

               self.__tearDownFunc == other.__tearDownFunc and \

               self.__testFunc == other.__testFunc and \

               self.__description == other.__description

    def __ne__(self, other):

        return not self == other

    def __hash__(self):

        return hash((type(self), self.__setUpFunc, self.__tearDownFunc,

                                           self.__testFunc, self.__description))

    def __str__(self):

        return "%s (%s)" % (_strclass(self.__class__), self.__testFunc.__name__)

    def __repr__(self):

        return "<%s testFunc=%s>" % (_strclass(self.__class__), self.__testFunc)

    def shortDescription(self):

        if self.__description is not None: return self.__description

        doc = self.__testFunc.__doc__

        return doc and doc.split("\n")[0].strip() or None