单元测试框架 – API

---

本章讨论了 unittest 模块中定义的类和方法。这个模块有五个主要的类。

测试用例类

此类的对象表示最小的可测试单元。它保存测试例程并提供用于准备每个例程和之后清理的钩子。

TestCase 类中定义了以下方法 –

Sr.No.	方法和说明
1	setUp() 调用方法来准备测试夹具。这在调用测试方法之前立即调用
2	tearDown() 在调用测试方法并记录结果后立即调用方法。即使测试方法引发异常，也会调用它，
3	setUpClass() 在单个类中运行测试之前调用的类方法。
4	tearDownClass() 在单个类中的测试运行后调用的类方法。
5	run(result = None) 运行测试，将结果收集到作为result传递的测试结果对象中。
6	skipTest(reason) 在测试方法或 setUp() 期间调用它会跳过当前测试。
7	debug() 运行测试而不收集结果。
8	shortDescription() 返回测试的单行描述。

灯具

在 TestCase 类中可以编写大量测试。这些测试方法可能需要数据库连接、临时文件或其他资源进行初始化。这些被称为夹具。TestCase 包括一个特殊的钩子来配置和清理测试所需的任何装置。要配置灯具，请覆盖 setUp()。要清理，请覆盖 tearDown()。

在以下示例中，在 TestCase 类中编写了两个测试。他们测试两个值的加减结果。setup() 方法根据每个测试的 shortDescription() 初始化参数。teardown() 方法将在每次测试结束时执行。

import unittest

class simpleTest2(unittest.TestCase):
   def setUp(self):
      self.a = 10
      self.b = 20
      name = self.shortDescription()
      if name == "Add":
         self.a = 10
         self.b = 20
         print name, self.a, self.b
      if name == "sub":
         self.a = 50
         self.b = 60
         print name, self.a, self.b
   def tearDown(self):
      print '\nend of test',self.shortDescription()

   def testadd(self):
      """Add"""
      result = self.a+self.b
      self.assertTrue(result == 100)
   def testsub(self):
      """sub"""
      result = self.a-self.b
      self.assertTrue(result == -10)
      
if __name__ == '__main__':
   unittest.main()

从命令行运行上面的代码。它提供以下输出 –

C:\Python27>python test2.py
Add 10 20
F
end of test Add
sub 50 60
end of test sub
.
================================================================
FAIL: testadd (__main__.simpleTest2)
Add
----------------------------------------------------------------------
Traceback (most recent call last):
   File "test2.py", line 21, in testadd
      self.assertTrue(result == 100)
AssertionError: False is not true
----------------------------------------------------------------------
Ran 2 tests in 0.015s

FAILED (failures = 1)

课件

TestCase 类有一个 setUpClass() 方法，该方法可以在 TestCase 类中的单个测试执行之前被覆盖以执行。同样，tearDownClass() 方法将在类中的所有测试之后执行。这两种方法都是类方法。因此，它们必须用@classmethod 指令装饰。

以下示例演示了这些类方法的使用 –

import unittest

class TestFixtures(unittest.TestCase):

   @classmethod
   def setUpClass(cls):
      print 'called once before any tests in class'

   @classmethod
   def tearDownClass(cls):
      print '\ncalled once after all tests in class'

   def setUp(self):
      self.a = 10
      self.b = 20
      name = self.shortDescription()
      print '\n',name
   def tearDown(self):
      print '\nend of test',self.shortDescription()

   def test1(self):
      """One"""
      result = self.a+self.b
      self.assertTrue(True)
   def test2(self):
      """Two"""
      result = self.a-self.b
      self.assertTrue(False)
      
if __name__ == '__main__':
unittest.main()

测试套件类

Python 的测试框架提供了一种有用的机制，通过该机制，测试用例实例可以根据它们测试的特性组合在一起。该机制由 unittest 模块中的 TestSuite 类提供。

创建和运行测试套件涉及以下步骤。

步骤 1 – 创建 TestSuite 类的实例。

suite = unittest.TestSuite()

第 2 步– 在套件的 TestCase 类中添加测试。

suite.addTest(testcase class)

第 3 步– 您还可以使用 makeSuite() 方法从类中添加测试

suite = unittest.makeSuite(test case class)

步骤 4 – 也可以在套件中添加单独的测试。

suite.addTest(testcaseclass(""testmethod")

第 5 步– 创建 TestTestRunner 类的对象。

runner = unittest.TextTestRunner()

第 6 步– 调用 run() 方法来运行套件中的所有测试

runner.run (suite)

TestSuite 类中定义了以下方法 –

Sr.No.	方法和说明
1	addTest() 在测试套件中添加测试方法。
2	addTests() 添加来自多个 TestCase 类的测试。
3	run() 运行与此套件关联的测试，将结果收集到测试结果对象中
4	debug() 运行与此套件关联的测试而不收集结果。
5	countTestCases() 返回此测试对象表示的测试数量

以下示例显示了如何使用 TestSuite 类 –

import unittest
class suiteTest(unittest.TestCase):
   def setUp(self):
      self.a = 10
      self.b = 20
      
   def testadd(self):
      """Add"""
      result = self.a+self.b
      self.assertTrue(result == 100)
   def testsub(self):
      """sub"""
      result = self.a-self.b
      self.assertTrue(result == -10)
      
def suite():
   suite = unittest.TestSuite()
##   suite.addTest (simpleTest3("testadd"))
##   suite.addTest (simpleTest3("testsub"))
   suite.addTest(unittest.makeSuite(simpleTest3))
   return suite
   
if __name__ == '__main__':
   runner = unittest.TextTestRunner()
   test_suite = suite()
   runner.run (test_suite)

您可以通过取消注释行和具有 makeSuite() 方法的注释语句来试验 addTest() 方法。

测试加载器类

unittest 包具有 TestLoader 类，用于从类和模块创建测试套件。默认情况下，当调用 unittest.main(0 方法时会自动创建 unittest.defaultTestLoader 实例。显式实例，但是可以自定义某些属性。

在以下代码中，使用 TestLoader 对象将来自两个类的测试收集到一个列表中。

import unittest
testList = [Test1, Test2]
testLoad = unittest.TestLoader()

TestList = []
for testCase in testList:
   testSuite = testLoad.loadTestsFromTestCase(testCase)
   TestList.append(testSuite)
   
newSuite = unittest.TestSuite(TestList)
runner = unittest.TextTestRunner()
runner.run(newSuite)

下表显示了 TestLoader 类中的方法列表 –

Sr.No	方法和说明
1	loadTestsFromTestCase() 返回包含在 TestCase 类中的所有测试用例的套件
2	loadTestsFromModule() 返回给定模块中包含的所有测试用例的套件。
3	loadTestsFromName() 返回一组给定字符串说明符的所有测试用例。
4	discover() 通过从指定的起始目录递归到子目录中找到所有测试模块，并返回一个 TestSuite 对象

测试结果类

此类用于编译有关已成功测试和已失败测试的信息。TestResult 对象存储一组测试的结果。TestRunner.run() 方法返回一个 TestResult 实例。

TestResult 实例具有以下属性 –

Sr.No.	属性和描述
1	Errors 一个包含 2 元组 TestCase 实例和保存格式化回溯的字符串的列表。每个元组代表一个引发意外异常的测试。
2	Failures 一个包含两元组 TestCase 实例和保存格式化回溯的字符串的列表。每个元组代表一个测试，其中使用 TestCase.assert*() 方法明确表示失败。
3	Skipped 一个包含两元组 TestCase 实例和包含跳过测试原因的字符串的列表。
4	wasSuccessful() 如果到目前为止运行的所有测试都已通过，则返回 True，否则返回 False。
5	stop() 可以调用此方法来表示应中止正在运行的测试集。
6	startTestRun() 在执行任何测试之前调用一次。
7	stopTestRun() 在所有测试执行后调用一次。
8	testsRun 到目前为止运行的测试总数。
9	Buffer 如果设置为 true，sys.stdout和sys.stderr将在两者之间进行缓冲startTest() 和 stopTest() 被调用。

以下代码执行测试套件 –

if __name__ == '__main__':
   runner = unittest.TextTestRunner()
   test_suite = suite()
   result = runner.run (test_suite)
   
   print "---- START OF TEST RESULTS"
   print result

   print "result::errors"
   print result.errors

   print "result::failures"
   print result.failures

   print "result::skipped"
   print result.skipped

   print "result::successful"
   print result.wasSuccessful()
   
   print "result::test-run"
   print result.testsRun
   print "---- END OF TEST RESULTS"

执行时的代码显示以下输出 –

---- START OF TEST RESULTS
<unittest.runner.TextTestResult run = 2 errors = 0 failures = 1>
result::errors
[]
result::failures
[(<__main__.suiteTest testMethod = testadd>, 'Traceback (most recent call last):\n
   File "test3.py", line 10, in testadd\n 
   self.assertTrue(result == 100)\nAssert
   ionError: False is not true\n')]
result::skipped
[]
result::successful
False
result::test-run
2
---- END OF TEST RESULTS