全面介紹python中很常用的單元測試框架unitest

1、unitest主要功能模塊介紹

unitest主要包含TestCase、TestSuite、TestLoader、TextTestRunner、TextTestResult這幾個功能模塊。

TestCase：一個TestCase實例就是一個測試用例，一個測試用例就是一個完整的測試流程，包括測試前環境的搭建，測試代碼的執行，以及測試后環境的還原或者銷毀。元測試的本質也就在這里，一個測試用例是一個完整的測試單元，可以對某一具體問題進行檢查驗證。 TestSuite：多個測試用例集合在一起就是TestSuite，TestSuite也可以嵌套TestSuite。 TestLoader：TestLoader的作用是將Testcase加載到TestSuite中。 TextTestRunner：TextTestRunner是用來執行測試用例的，其中的run(test)會執行TestSuite/TestCase中的run(result)方法。 TextTestResult：TextTestResult用來保存測試結果，其中包括運行了多少測試用例，成功了多少，失敗了多少等信息。

整個流程為：寫好TestCase，然后由TestLoader加載TestCase到TestSuite，然后由TextTestRunner來運行TestSuite，運行的結果保存在TextTestResult中。

2、實例介紹

首先準備幾個待測的方法，寫在test_func.py中。

def add(a, b): return a + bdef multi(a, b): return a * bdef lower_str(string): return string.lower()def square(x): return x ** 2

準備好幾個待測的方法之后，為這些方法寫一個測試用例,寫入our_testcase.py中。

import unittestfrom test_func import *class TestFunc(unittest.TestCase): '''Test test_func.py''' def test_add(self): '''Test func add''' self.assertEqual(3, add(1, 2)) self.assertNotEqual(3, add(1, 3)) def test_multi(self): '''Test func multi''' self.assertEqual(6, multi(2, 3)) self.assertNotEqual(8, multi(3, 3)) def test_lower_str(self): '''Test func lower_str''' self.assertEqual('abc', lower_str('ABC')) self.assertNotEqual('Dce', lower_str('DCE')) def test_square(self): '''Test func square''' self.assertEqual(17, square(4)) # 這里故意設計一個會出錯的用例，測試4的平方等于17，實際上并不等于。 self.assertNotEqual(35, square(6))if __name__ == ’__main__’: unittest.main()

這里寫好之后，進入命令行終端，執行python our_testcase.py，執行結果如下。

...F======================================================================FAIL: test_square (__main__.TestFunc)Test func square----------------------------------------------------------------------Traceback (most recent call last): File 'our_testcase.py', line 27, in test_square self.assertEqual(17, square(4))AssertionError: 17 != 16----------------------------------------------------------------------Ran 4 tests in 0.000sFAILED (failures=1)

這里分析一下這個執行結果。首先能夠看到一共運行了4個測試用例，失敗了1個，并且給出了失敗原因，AssertionError: 17 != 16，這是我們故意留下的錯誤漏洞，被測試用例測試出來了。

第一行...F中，一個點.代表測試成功，F代表失敗，我們的測試結果中，前三個成功了，第四個失敗了，總共是四個測試，其余的符號中E代表出錯，S代表跳過。

特別說明的一點是，測試的執行順序跟方法的順序沒有關系，四個測試是隨機先后執行的。

每個測試方法編寫的時候，都要以test開頭，比如test_square，否則是不被unitest識別的。

在unitest.main()中加上verbosity參數可以控制輸出的錯誤報告的詳細程序，默認是1，如果設為0，則不輸出每一用例的執行結果，即上面的第一行的執行結果內容。如果設為2，則輸出詳細的執行結果。

修改our_testcase.py中主函數。

if __name__ == ’__main__’: unittest.main(verbosity=2)

執行結果如下。

test_add (__main__.TestFunc)Test func add ... oktest_lower_str (__main__.TestFunc)Test func lower_str ... oktest_multi (__main__.TestFunc)Test func multi ... oktest_square (__main__.TestFunc)Test func square ... FAIL======================================================================FAIL: test_square (__main__.TestFunc)Test func square----------------------------------------------------------------------Traceback (most recent call last): File 'our_testcase.py', line 27, in test_square self.assertEqual(17, square(4))AssertionError: 17 != 16----------------------------------------------------------------------Ran 4 tests in 0.000sFAILED (failures=1)

可以看到，每一個用例的詳細執行情況以及用例名，用例描述均被輸出了出來，在測試方法下加代碼示例中的'''Doc String'''，在用例執行時，會將該字符串作為此用例的描述，加合適的注釋能夠使輸出的測試報告更加便于閱讀。

3、組織TestSuite

按照上面的測試方法，我們無法控制用例執行的順序，這樣顯然是不合理的，因為在一些測試過程中，我們肯定需要控制先測試某些用例，再測試某些用例，這些用例有先后的因果關系。在這里，我們就需要用到TestSuite。我們添加到TestSuite中的case是會按照添加的順序執行的。

還有一個問題是，我們現在只有一個測試文件，我們直接執行該文件即可，但如果有多個測試文件，怎么進行組織，總不能一個個文件執行吧，答案也在TestSuite中。

新建一個文件，test_suite.py。

import unittestfrom our_testcase import TestFuncif __name__ == ’__main__’: suite = unittest.TestSuite() tests = [TestFunc('test_square'), TestFunc('test_lower_str'), TestFunc('test_multi')] suite.addTests(tests) runner = unittest.TextTestRunner(verbosity=2) runner.run(suite)

執行結果如下。

test_square (our_testcase.TestFunc)Test func square ... FAILtest_lower_str (our_testcase.TestFunc)Test func lower_str ... oktest_multi (our_testcase.TestFunc)Test func multi ... ok======================================================================FAIL: test_square (our_testcase.TestFunc)Test func square----------------------------------------------------------------------Traceback (most recent call last): File '/Users/luyuze/projects/test/our_testcase.py', line 27, in test_square self.assertEqual(17, square(4))AssertionError: 17 != 16----------------------------------------------------------------------Ran 3 tests in 0.000sFAILED (failures=1)

這樣，用例執行的順序就是按照我們添加進去的順序來執行的了。

上面使用的是TestSuite的addTests()方法，并直接傳入TestCase列表，也有一些其他的方法可以向TestSuite中添加用例。

# 直接用addTest方法添加單個TestCasesuite.addTest(TestMathFunc('test_multi'))# 使用loadTestFromName,傳入模塊名.TestCase名，下面倆方法效果相同suite.addTests(unittest.TestLoader().loadTestsFromName(’our_testcase.TestFunc’))suite.addTests(unittest.TestLoader().loadTestsFromNames([’our_testcase.TestFunc’]))# loadTestsFromTestCase()，傳入TestCasesuite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestFunc))

用TestLoader的方法是無法對case進行排序的，同時，suite中也可以套suite。

4、輸出文件

用例組織好了，但是結果只能輸出到控制臺，這樣沒辦法查看之前的執行記錄，我們想將結果輸出到文件。

修改test_suite.py。

import unittestfrom our_testcase import TestFuncif __name__ == ’__main__’: suite = unittest.TestSuite() tests = [TestFunc('test_square'), TestFunc('test_lower_str'), TestFunc('test_multi')] suite.addTests(tests) with open(’UnitestTextReport.txt’, ’a’) as f: runner = unittest.TextTestRunner(stream=f, verbosity=2) runner.run(suite)5、測試前后的處理

在之前的測試中，可能會存在這樣的問題：如果要在測試之前準備環境，測試完成之后做一些清理怎么辦？這里需要用到的是setUp()和tearDown()。

修改our_testcase.py。

import unittestfrom test_func import *class TestFunc(unittest.TestCase): '''Test test_func.py''' def setUp(self): print('do something before testcase') def test_add(self): '''Test func add''' self.assertEqual(3, add(1, 2)) self.assertNotEqual(3, add(1, 3)) def test_multi(self): '''Test func multi''' self.assertEqual(6, multi(2, 3)) self.assertNotEqual(8, multi(3, 3)) def test_lower_str(self): '''Test func lower_str''' self.assertEqual('abc', lower_str('ABC')) self.assertNotEqual('Dce', lower_str('DCE')) def test_square(self): '''Test func square''' self.assertEqual(17, square(4)) self.assertNotEqual(35, square(6)) def tearDownClass(self): print('do something after testcase')if __name__ == ’__main__’: unittest.main(verbosity=2)

執行結果：

test_add (__main__.TestFunc)Test func add ... do something before testcasedo something after testcaseoktest_lower_str (__main__.TestFunc)Test func lower_str ... do something before testcasedo something after testcaseoktest_multi (__main__.TestFunc)Test func multi ... do something before testcasedo something after testcaseoktest_square (__main__.TestFunc)Test func square ... do something before testcasedo something after testcaseFAIL======================================================================FAIL: test_square (__main__.TestFunc)Test func square----------------------------------------------------------------------Traceback (most recent call last): File 'our_testcase.py', line 30, in test_square self.assertEqual(17, square(4))AssertionError: 17 != 16----------------------------------------------------------------------Ran 4 tests in 0.001sFAILED (failures=1)

可以發現setUp()和tearDown()在每個case前后都執行了一次。如果要在所有case執行之前和所有case執行之后準備和清理環境，我們可以使用setUpClass() 與 tearDownClass()。

class TestFunc(unittest.TestCase): '''Test test_func.py''' @classmethod def setUpClass(cls): print 'This setUpClass() method only called once.' @classmethod def tearDownClass(cls): print 'This tearDownClass() method only called once too.'6、跳過case

如果我們臨時想要跳過某個case不執行，unitest也有相應的方法。

1、skip裝飾器

# -*- coding: utf-8 -*-import unittestfrom test_func import *class TestFunc(unittest.TestCase): '''Test test_func.py''' @unittest.skip(’do not run this case’) def test_add(self): '''Test func add''' self.assertEqual(3, add(1, 2)) self.assertNotEqual(3, add(1, 3)) def test_multi(self): '''Test func multi''' self.assertEqual(6, multi(2, 3)) self.assertNotEqual(8, multi(3, 3)) def test_lower_str(self): '''Test func lower_str''' self.assertEqual('abc', lower_str('ABC')) self.assertNotEqual('Dce', lower_str('DCE')) def test_square(self): '''Test func square''' self.assertEqual(17, square(4)) self.assertNotEqual(35, square(6))if __name__ == ’__main__’: unittest.main(verbosity=2)

執行結果：

test_add (__main__.TestFunc)Test func add ... skipped ’do not run this case’test_lower_str (__main__.TestFunc)Test func lower_str ... oktest_multi (__main__.TestFunc)Test func multi ... oktest_square (__main__.TestFunc)Test func square ... FAIL======================================================================FAIL: test_square (__main__.TestFunc)Test func square----------------------------------------------------------------------Traceback (most recent call last): File 'our_testcase.py', line 28, in test_square self.assertEqual(17, square(4))AssertionError: 17 != 16----------------------------------------------------------------------Ran 4 tests in 0.000sFAILED (failures=1, skipped=1)

結果顯示為，總共執行4個測試，1個失敗，1個被跳過。

skip裝飾器一共有三個 unittest.skip(reason)、unittest.skipIf(condition, reason)、unittest.skipUnless(condition, reason)，skip無條件跳過，skipIf當condition為True時跳過，skipUnless當condition為False時跳過。

2、TestCase.skipTest()方法

class TestFunc(unittest.TestCase): '''Test test_func.py''' def test_add(self): '''Test func add''' self.skipTest('do not run this case') self.assertEqual(3, add(1, 2)) self.assertNotEqual(3, add(1, 3))

效果與第一種是一樣的。

以上就是全面介紹python中很常用的單元測試框架unitest的詳細內容，更多關于python 單元測試框架unitest的資料請關注好吧啦網其它相關文章！