快捷導(dǎo)航

Python單元測試unittest的具體使用示例

更新時間：2018年12月17日 11:30:33 作者：塵世風(fēng)

本篇文章主要介紹了Python單元測試unittest，詳細的介紹了unittest的概念和簡單的使用示例，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

Python中有一個自帶的單元測試框架是unittest模塊，用它來做單元測試，它里面封裝好了一些校驗返回的結(jié)果方法和一些用例執(zhí)行前的初始化操作。

unittest是python的標準測試庫，相比于其他測試框架是python目前使用最廣的測試框架。

unittest有四個比較重要的概念是test fixture, test case, test suite, test runner, 。

在說unittest之前，先說幾個概念：

TestCase 也就是測試用例

TestSuite 多個測試用例集合在一起，就是TestSuite

TestLoader是用來加載TestCase到TestSuite中的

TestRunner是來執(zhí)行測試用例的,測試的結(jié)果會保存到TestResult實例中，包括運行了多少測試用例，成功了多少，失敗了多少等信息

通過dir(unittest)，我們可以看到unittest全部的屬性和方法，他們的關(guān)系如下圖所示。

unittest主要類關(guān)系

正常調(diào)用unittest的流程是，TestLoader 自動將測試用例TestCase中加載到TestSuite里，TextTestRunner調(diào)用TestSuite的run方法，順序執(zhí)行里面的TestCase中以test開頭的方法，并得到測試結(jié)果TestResult。在執(zhí)行TestCase過程中，先進行SetUp()環(huán)境準備，執(zhí)行測試代碼，最后tearDown()進行測試的還原。

其中TestLoader在加載過程中，進行添加的TestCase是沒有順序的。一個TestCase里如果存在多個驗證方法的話，會按照方法中test后方首字母的ascii碼從小到大排序后執(zhí)行。

可以通過手動調(diào)用TestSuite的addTest、addTests方法來動態(tài)添加TestCase，這樣既可以確定添加用例的執(zhí)行順序，也可避免TestCase中的驗證方法一定要用test開頭。

下面寫一個簡單的單元測試用例

import unittest

class MyTest(unittest.TestCase): # 繼承unittest.TestCase
  def tearDown(self):
    # 每個測試用例執(zhí)行之后做操作
    print('111')

  def setUp(self):
    # 每個測試用例執(zhí)行之前做操作
    print('22222')

  @classmethod
  def tearDownClass(self):
  # 必須使用 @ classmethod裝飾器, 所有test運行完后運行一次
     print('4444444')
  @classmethod
  def setUpClass(self):
  # 必須使用@classmethod 裝飾器,所有test運行前運行一次
    print('33333')

  def test_a_run(self):
    self.assertEqual(1, 1) # 測試用例
    
  def test_b_run(self):
    self.assertEqual(2, 2) # 測試用例
    
if __name__ == '__main__':
  unittest.main()#運行所有的測試用例

下面是一些常用的斷言，也就是校驗結(jié)果

    assertEqual(a, b)   a == b   
    assertNotEqual(a, b)   a != b   
    assertTrue(x)   bool(x) is True   
    assertFalse(x)   bool(x) is False   
    assertIsNone(x)   x is None   
    assertIsNotNone(x)   x is not None  
    assertIn(a, b)   a in b  
    assertNotIn(a, b)   a not in b

那如何生成一個測試報告呢，需要加入另外一個模塊了，HTMLTestRunner，這個模塊需要自己安裝，使用執(zhí)行測試用例就會生成一個html的測試報告，里面會有每個測試用例的執(zhí)行結(jié)果，代碼如下：

    import HTMLTestRunner    
    import unittest
    class MyTest(unittest.TestCase):#繼承unittest.TestCase
      def tearDown(self):
        #每個測試用例執(zhí)行之后做操作
        print('111')
      def setUp(self):
        #每個測試用例執(zhí)行之前做操作
        print(22222)
      def test_run(self):
        # self.assertEqual(1,1)
        self.assertIs(1,1)
        #測試用例
      def test_run2(self):
        # self.assertEqual(1,1)
        self.assertIs(1,1)
        #測試用例
      def test_run3(self):
        # self.assertEqual(1,1)
        self.assertIs(1,1)
        #測試用例
      def test_run1(self):
        # self.assertEqual(1,1)
        self.assertIs(1,1)
        #測試用例
    if __name__ == '__main__':
      test_suite = unittest.TestSuite()#創(chuàng)建一個測試集合
      test_suite.addTest(MyTest('test_run1'))#測試套件中添加測試用例
      #test_suite.addTest(unittest.makeSuite(MyTest))#使用makeSuite方法添加所有的測試方法
      fp = open('res.html','wb')#打開一個保存結(jié)果的html文件
      runner = HTMLTestRunner.HTMLTestRunner(stream=fp,title='api測試報告',description='測試情況')
      #生成執(zhí)行用例的對象
      runner.run(test_suite)
      #執(zhí)行測試套件

如果我們有很多個模塊，每個模塊下面都寫了很多python文件，每個python文件里面都有測試用例，那怎么把這個目錄下的用例都執(zhí)行了呢，就要先找到這個目錄下的所有python文件，然后找到里面的測試用例，逐個執(zhí)行，代碼如下：

    import unittest,HTMLTestRunner
    suite = unittest.TestSuite()#創(chuàng)建測試套件
    all_cases = unittest.defaultTestLoader.discover('.','test_*.py')
    #找到某個目錄下所有的以test開頭的Python文件里面的測試用例
    for case in all_cases:
      suite.addTests(case)#把所有的測試用例添加進來
    fp = open('res.html','wb')
    runner = HTMLTestRunner.HTMLTestRunner(stream=fp,title='all_tests',description='所有測試情況')
    runner.run(suite)
    #運行測試

我們在后續(xù)進行持續(xù)集成的時候，要讓代碼自動運行，就會用到Jenkins了，但是上面產(chǎn)生的測試報告都是html格式的，Jenkins不認識，就在Jenkins里面顯示不出來。那咱們就要產(chǎn)生一些Jenkins認識的測試報告，Jenkins認識xml格式的報告，那咱們就產(chǎn)生xml格式的唄，就需要用一個新的模塊，xmlrunner，安裝直接 pip install xmlrunner即可，代碼如下：

import unittest
import xmlrunner
#導(dǎo)入這個模塊
class My(unittest.TestCase):
 
  def test1(self,a,b,c):
    self.assertEqual(a+b,c)
 
if __name__=='__main__':
  test_suite = unittest.TestSuite()
  test_suite.addTest(unittest.makeSuite(My))
  runner = xmlrunner.XMLTestRunner(output='report')#指定報告放的目錄
  runner.run(test_suite)

然后咱們運行，可以看到在report目錄下已經(jīng)產(chǎn)生了xml格式的報告了，而且還自動把日期加上了