Python3的unittest用例按编写顺序执行
unittest是Python標準庫自帶的單元測試框架,是Python版本的JUnit,關于unittest框架的使用,官方文檔非常詳細,網上也有不少好的教程,這里就不多說了。
本文主要分享在使用unittest的過程中,做的一些擴展嘗試。先上一個例子。
import unittestclass TestLegion(unittest.TestCase): def test_create_legion(self): """創建軍團 :return: """ def test_bless(self): """ 公會祈福 :return: """ def test_receive_bless_box(self): """ 領取祈福寶箱 :return: """ def test_quit_legion(self): """退出軍團 :return: """這是一個標準的使用unittest進行測試的例子,寫完后心里美滋滋,嗯,就按照這個順序測就可以了。結果一運行。
什么鬼。執行的順序亂了。第一個執行的測試用例并不是創建軍團,而是公會祈福,此時玩家還沒創建軍團,進行公會祈福的話會直接報錯,導致用例失敗。
到這里有些同學會想說,為什么要讓測試用例之間有所依賴呢?
的確,如果完全沒依賴,測試用例的執行順序是不需要關注的。但是這樣對于用例的設計和實現,要求就高了許多。而對游戲來說,一個系統內的操作,是有很大的關聯性的。以軍團為例,軍團內的每個操作都有一個前提,你需要加入一個軍團。所以要實現用例之間的完全解耦,需要每個用例開始之前,檢測玩家的軍團狀態。
如果可以控制測試用例的執行順序,按照功能玩法流程一遍走下來,節省的代碼量是非常可觀的,閱讀測試用例也會清晰許多。
如何控制unittest用例執行的順序呢?
我們先看看,unittest是怎么樣對用例進行排序的。在loader.py的loadTestsFromTestCase方法里邊,調用了getTestCaseNames方法來獲取測試用例的名稱
def getTestCaseNames(self, testCaseClass): """Return a sorted sequence of method names found within testCaseClass """ def isTestMethod(attrname, testCaseClass=testCaseClass, prefix=self.testMethodPrefix): return attrname.startswith(prefix) and \ callable(getattr(testCaseClass, attrname)) testFnNames = list(filter(isTestMethod, dir(testCaseClass))) if self.sortTestMethodsUsing: testFnNames.sort(key=functools.cmp_to_key(self.sortTestMethodsUsing)) return testFnNames可以看到,getTestCaseNames方法對測試用例的名稱進行了排序
testFnNames.sort(key=functools.cmp_to_key(self.sortTestMethodsUsing))看看排序方法
def three_way_cmp(x, y): """Return -1 if x < y, 0 if x == y and 1 if x > y""" return (x > y) - (x < y)根據排序規則,unittest執行測試用例,默認是根據ASCII碼的順序加載測試用例,數字與字母的順序為:0-9,A-Z,a-z。
做個實驗:
import functoolscase_names = ["test_buy_goods", "test_Battle", "test_apply", "test_1_apply"] def three_way_cmp(x, y): """Return -1 if x < y, 0 if x == y and 1 if x > y""" return (x > y) - (x < y) case_names.sort(key=functools.cmp_to_key(three_way_cmp)) print(case_names) output:['test_1_apply', 'test_Battle', 'test_apply', 'test_buy_goods']基于unittest的機制,如何控制用例執行順序呢?查了一些網上的資料,主要介紹了兩種方式:
方式1,通過TestSuite類的addTest方法,按順序加載測試用例:
suite = unittest.TestSuite() suite.addTest(TestLegion("test_create_legion")) suite.addTest(TestLegion("test_bless")) suite.addTest(TestLegion("test_receive_bless_box")) suite.addTest(TestLegion("test_quit_legion")) unittest.TextTestRunner(verbosity=3).run(suite) ?方式2,通過修改函數名的方式:
class TestLegion(unittest.TestCase): def test_1_create_legion(self): """創建軍團 :return: """ def test_2_bless(self): """ 公會祈福 :return: """ def test_3_receive_bless_box(self): """ 領取祈福寶箱 :return: """ def test_4_quit_legion(self): """退出軍團 :return: """ ?看起來都能滿足需求,但是都不夠好用,繁瑣,代碼不好維護。
那就造個輪子吧
于是開始了utx這個小項目,那么如何在不改動代碼的情況下,讓測試用例按照編寫的順序依次執行呢?
方案就是,在測試類初始化的時候,將測試方法按照編寫的順序,自動依次重命名為“test_1_create_legion”,“test_2_bless”,“test_3_receive_bless_box”等等,從而實現控制測試用例的執行。
這就需要控制類的創建行為,Python提供了一個非常強力的工具:元類,在元類的__new__方法中,我們可以獲取類的全部成員函數,另外基于Python3.6的字典底層重構后,字典是有序的了,默認順序和添加的順序一致。所以我們拿到的測試用例,就和編寫的順序一致了。
??
接下來,就是按照順序,依次改名了,定義一個全局的total_case_num變量,每次進行改名的時候,total_case_num遞增+1,作為用例的id,加入到用例的名字當中。
接下來是定義自己的TestCase類,繼承unittest.TestCase,使用上邊定義的元類
class _TestCase(unittest.TestCase, metaclass=Meta): def shortDescription(self): """覆蓋父類的方法,獲取函數的注釋 :return: """ doc = self._testMethodDoc doc = doc and doc.split()[0].strip() or None return doc最后一步,對unittest打一個猴子補丁,將unittest.TestCase替換為自定義的_TestCase
unittest.TestCase = _TestCase看下運行效果,代碼和本文開始的例子一樣,只是多了一句utx庫的導入。
import unittest from utx import *class TestLegion(unittest.TestCase): def test_create_legion(self): """創建軍團 :return: """ def test_bless(self): """ 公會祈福 :return: """ def test_receive_bless_box(self): """ 領取祈福寶箱 :return: """ def test_quit_legion(self): """退出軍團 :return: """運行效果:
?執行順序就和我們的預期一致了~
基于這一套,開始加上其他的一些擴展功能,比如
- 用例自定義標簽,可以運行指定標簽的測試用例
- 數據驅動
- 檢測測試用例是否編寫了說明描述
- 執行測試用例的時候,顯示執行進度
- setting類提供多個設置選項進行配置
- 集成 ztest 和 BSTestRunner 生成測試報告,感謝兩位作者的測試報告模版
utx庫核心源碼不到200行,就不做過多講解了,直接去Github看吧
作者:煎煎煎餅 鏈接:https://www.jianshu.com/p/d65f97723af7 來源:簡書 簡書著作權歸作者所有,任何形式的轉載都請聯系作者獲得授權并注明出處。轉載于:https://www.cnblogs.com/songzhenhua/p/9690198.html
總結
以上是生活随笔為你收集整理的Python3的unittest用例按编写顺序执行的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 监控:系统构架重要的一环
- 下一篇: Python学习笔录