home *** CD-ROM | disk | FTP | other *** search
/ PC World 2001 April / PCWorld_2001-04_cd.bin / Software / TemaCD / webclean / !!!python!!! / PyXML-0.6.3.win32-py2.0.exe / xmldoc / test / unittest.py < prev   
Text File  |  2000-05-20  |  12KB  |  360 lines
  1. #!/usr/bin/env python
  2. """
  3. Python unit testing framework, based on Erich Gamma's JUnit and Kent Beck's
  4. Smalltalk testing framework.
  5.  
  6. For further information on the above, refer to:-
  7.  
  8.      http://members.pingnet.ch/gamma/junit.htm
  9.      http://www.XProgramming.com/testfram.htm
  10.  
  11. This module contains the core framework classes that form the basis of
  12. specific test cases and suites (TestCase, TestSuite etc.), and also a
  13. text-based utility class for running the tests and reporting the results
  14. (TextTestRunner).
  15.  
  16. Copyright (c) 1999 Steve Purcell
  17. This module is free software, and you may redistribute it and/or modify
  18. it under the same terms as Python itself, so long as this copyright message
  19. and disclaimer are retained in their original form.
  20.  
  21. IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
  22. SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF
  23. THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  24. DAMAGE.
  25.  
  26. THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
  27. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  28. PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,
  29. AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
  30. SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  31. """
  32.  
  33. __author__ = "Steve Purcell (stephen_purcell@yahoo.com)"
  34. __version__ = "$Revision: 1.1 $"[11:-2]
  35.  
  36. import time
  37. import sys
  38. import traceback
  39. import string
  40. import os
  41.  
  42. ##############################################################################
  43. # Test framework core
  44. ##############################################################################
  45.  
  46. class TestResult:
  47.     """Holder for test result information.
  48.  
  49.     Test results are automatically managed by the TestCase and TestSuite
  50.     classes, and do not need to be explicitly manipulated by writers of tests.
  51.  
  52.     Each instance holds the total number of tests run, and collections of
  53.     failures and errors that occurred among those test runs. The collections
  54.     contain tuples of (testcase, exceptioninfo), where exceptioninfo is a
  55.     tuple of values as returned by sys.exc_info().
  56.     """
  57.     def __init__(self):
  58.         self.failures = []
  59.         self.errors = []
  60.         self.testsRun = 0
  61.         self.shouldStop = 0
  62.  
  63.     def startTest(self, test):
  64.         self.testsRun = self.testsRun + 1
  65.  
  66.     def stopTest(self, test):
  67.         pass
  68.  
  69.     def addError(self, test, err):
  70.         self.errors.append((test, err))
  71.  
  72.     def addFailure(self, test, err):
  73.         self.failures.append((test, err))
  74.  
  75.     def wasSuccessful(self):
  76.         return len(self.failures) == len(self.errors) == 0
  77.  
  78.     def stop(self):
  79.         self.shouldStop = 1
  80.     
  81.     def __repr__(self):
  82.         return "<%s run=%i errors=%i failures=%i>" % \
  83.                (self.__class__, self.testsRun, len(self.errors),
  84.                 len(self.failures))
  85.  
  86. class TestCase:
  87.     """A class whose instances are single test case.
  88.  
  89.     Test authors should subclass TestCase for their own tests. Construction 
  90.     and deconstruction of the test's environment ('fixture') can be
  91.     implemented by overriding the 'setUp' and 'tearDown' methods respectively.
  92.  
  93.     By default, the test code itself should be placed in a method named
  94.     'runTest'.
  95.     
  96.     If the fixture may be used for many test cases, create as 
  97.     many test methods as are needed. When instantiating such a TestCase
  98.     subclass, specify in the constructor arguments the name of the test method
  99.     that the instance is to execute.
  100.     """
  101.     def __init__(self, methodName='runTest'):
  102.         try:
  103.             self._testMethod = getattr(self,methodName)
  104.         except AttributeError:
  105.             raise ValueError,"no such test method: %s" % methodName
  106.  
  107.     def setUp(self):
  108.         pass
  109.  
  110.     def tearDown(self):
  111.         pass
  112.  
  113.     def countTestCases(self):
  114.         return 1
  115.  
  116.     def defaultTestResult(self):
  117.         return TestResult()
  118.  
  119.     def __str__(self):
  120.         return "%s.%s" % (self.__class__, self._testMethod.__name__)
  121.  
  122.     def run(self, result=None):
  123.         return self(result)
  124.  
  125.     def __call__(self, result=None):
  126.         if result is None: result = self.defaultTestResult()
  127.         result.startTest(self)
  128.         try:
  129.             try:
  130.                 self.setUp()
  131.             except:
  132.                 result.addError(self,self.__exc_info())
  133.                 return
  134.  
  135.             try:
  136.                 self._testMethod()
  137.             except AssertionError, e:
  138.                 result.addFailure(self,self.__exc_info())
  139.             except:
  140.                 result.addError(self,self.__exc_info())
  141.  
  142.             try:
  143.                 self.tearDown()
  144.             except:
  145.                 result.addError(self,self.__exc_info())
  146.         finally:
  147.             result.stopTest(self)
  148.  
  149.     def assert_(self, expr, msg=None):
  150.         if not expr:
  151.             raise AssertionError, msg
  152.  
  153.     failUnless = assert_
  154.  
  155.     def failIf(self, expr, msg=None):
  156.         apply(self.assert_,(not expr,msg))
  157.  
  158.     def __exc_info(self):
  159.         """Return a version of sys.exc_info() with the traceback frame
  160.            minimised; usually the top level of the traceback frame is not
  161.            needed.
  162.         """
  163.         exctype, excvalue, tb = sys.exc_info()
  164.         newtb = tb.tb_next
  165.         if newtb is None:
  166.             return (exctype, excvalue, tb)
  167.         return (exctype, excvalue, newtb)
  168.  
  169.  
  170. class TestSuite:
  171.     """A test suite is a composite test consisting of a number of TestCases.
  172.  
  173.     For use, create an instance of TestSuite, then add test case instances.
  174.     When all tests have been added, the suite can be passed to a test
  175.     runner, such as TextTestRunner. It will run the individual test cases
  176.     in the order in which they were added, aggregating the results.
  177.     """
  178.     def __init__(self, tests=()):
  179.         self._tests = list(tests)
  180.  
  181.     def __str__(self):
  182.         return "<%s tests=%s>" % (self.__class__, self._tests)
  183.  
  184.     def countTestCases(self):
  185.         cases = 0
  186.         for test in self._tests:
  187.             cases = cases + test.countTestCases()
  188.         return cases
  189.  
  190.     def addTest(self, test):
  191.         self._tests.append(test)
  192.  
  193.     def addTests(self, tests):
  194.         for test in tests:
  195.             self.addTest(test)
  196.  
  197.     def run(self, result):
  198.         return self(result)
  199.  
  200.     def __call__(self, result):
  201.         for test in self._tests:
  202.             if result.shouldStop:
  203.                 break
  204.             test(result)
  205.         return result
  206.         
  207. ##############################################################################
  208. # Text UI
  209. ##############################################################################
  210.  
  211. class _WritelnDecorator:
  212.     """Used to decorate file-like objects with a handy 'writeln' method"""
  213.     def __init__(self,stream):
  214.         self.stream = stream
  215.     def __getattr__(self, attr):
  216.         return getattr(self.stream,attr)
  217.     def writeln(self, *args):
  218.         if args: apply(self.write, args)
  219.         self.write(os.linesep)
  220.         
  221. class TextTestResult(TestResult):
  222.     """A test result class that can print formatted text results to a stream.
  223.     """
  224.     def __init__(self, stream):
  225.         self.stream = stream
  226.         TestResult.__init__(self)
  227.  
  228.     def addError(self, test, error):
  229.         TestResult.addError(self,test,error)
  230.         self.stream.write('E')
  231.         self.stream.flush()
  232.         
  233.     def addFailure(self, test, error):
  234.         TestResult.addFailure(self,test,error)
  235.         self.stream.write('F')
  236.         self.stream.flush()
  237.         
  238.     def startTest(self, test):
  239.         TestResult.startTest(self,test)
  240.         self.stream.write('.')
  241.         self.stream.flush()
  242.  
  243.     def printNumberedErrors(self,errFlavour,errors):
  244.         if not errors: return
  245.         if len(errors) == 1:
  246.             self.stream.writeln("There was 1 %s:" % errFlavour)
  247.         else:
  248.             self.stream.writeln("There were %i %ss:" %
  249.                                 (len(errors), errFlavour))
  250.         i = 1
  251.         for test,error in errors:
  252.             errString = string.join(apply(traceback.format_exception,error),"")
  253.             self.stream.writeln("%i) %s" % (i, test))
  254.             self.stream.writeln(errString)
  255.             i = i + 1
  256.             
  257.     def printErrors(self):
  258.         self.printNumberedErrors('error',self.errors)
  259.  
  260.     def printFailures(self):
  261.         self.printNumberedErrors('failure',self.failures)
  262.  
  263.     def printHeader(self):
  264.         self.stream.writeln()
  265.         if self.wasSuccessful():
  266.             self.stream.writeln("OK (%i tests)" % self.testsRun)
  267.         else:
  268.             self.stream.writeln("!!!FAILURES!!!")
  269.             self.stream.writeln("Test Results")
  270.             self.stream.writeln()
  271.             self.stream.writeln("Run: %i Failures: %i Errors: %i" %
  272.                                 (self.testsRun, len(self.failures),
  273.                                  len(self.errors)))
  274.             
  275.     def printResult(self):
  276.         self.printHeader()
  277.         self.printErrors()
  278.         self.printFailures()
  279.  
  280.  
  281. class TextTestRunner:
  282.     """A test runner class that displays results in textual form.
  283.     
  284.     Uses TextTestResult.
  285.     """
  286.     def __init__(self, stream=sys.stderr):
  287.         self.stream = _WritelnDecorator(stream)
  288.  
  289.     def run(self, test):
  290.         """Run the given test case or test suite.
  291.         """
  292.         result = TextTestResult(self.stream)
  293.         startTime = time.time()
  294.         test(result)
  295.         stopTime = time.time()
  296.         self.stream.writeln()
  297.         self.stream.writeln("Time: %.3fs" % float(stopTime - startTime))
  298.         result.printResult()
  299.         return result
  300.  
  301. def createTestInstance(name):
  302.     """Looks up and calls a callable object by its string name, which should
  303.        include its module name, e.g. 'widgettests.WidgetTestSuite'.
  304.     """
  305.     if '.' not in name:
  306.         raise ValueError,"No package given"
  307.     dotPos = string.rfind(name,'.')
  308.     last = name[dotPos+1:]
  309.     if not len(last):
  310.         raise ValueError,"Malformed classname"
  311.     pkg = name[:dotPos]
  312.     try:
  313.         testCreator = getattr(__import__(pkg,globals(),locals(),[last]),last)
  314.     except AttributeError, e:
  315.         print sys.exc_info()
  316.         raise ImportError, \
  317.               "No object '%s' found in package '%s'" % (last,pkg)
  318.     try:
  319.         test = testCreator()
  320.     except:
  321.         raise TypeError, \
  322.               "Error making a test instance by calling '%s'" % testCreator
  323.     if not hasattr(test,"countTestCases"):
  324.         raise TypeError, \
  325.               "Calling '%s' returned '%s', which is not a test case or suite" \
  326.               % (name,test)
  327.     return test
  328.  
  329. def collectNames(testCaseClass, prefix):
  330.     testFnNames = filter(lambda n,p=prefix: n[:len(p)] == p,
  331.                          dir(testCaseClass))
  332.     for baseClass in testCaseClass.__bases__:
  333.         testFnNames = testFnNames + collectNames(baseClass, prefix)
  334.     return testFnNames
  335.  
  336. def makeSuite(testCaseClass, prefix='test'):
  337.     """Returns a TestSuite instance built from all of the test cases
  338.        in the given test case class whose names begin with the given
  339.        prefix
  340.     """
  341.     return TestSuite(map(testCaseClass, collectNames(testCaseClass, prefix)))
  342.  
  343.  
  344. ##############################################################################
  345. # Command-line usage
  346. ##############################################################################
  347.  
  348. if __name__ == "__main__":
  349.     if len(sys.argv) == 2 and sys.argv[1] not in ('-help','-h','--help'):
  350.         testClass = createTestInstance(sys.argv[1])
  351.         result = TextTestRunner().run(testClass)
  352.         if result.wasSuccessful():
  353.             sys.exit(0)
  354.         else:
  355.             sys.exit(1)
  356.     else:
  357.         print "usage:", sys.argv[0], "package1.YourTestSuite"
  358.         sys.exit(2)
  359.  
  360.