python unittest之关键API说明及示例

前言

本次就python unittest单元测试框架的一些基本的、常用的API 进行分享,以便大家后续更深入的熟悉和应用unittest。

TestCase类API

TeseCase类实例化的对象是最小的可测单元颗粒。它维护着一组测试方法以及为测试方法所提供的初始化方法和清理方法。

下面我们一起看一下定义在TestCase类中常用的方法

  1. setUp()

初始化函数,在所有的测试方法调用之前调用(自动调用)

  1. tearDown()

清理函数,在所有的测试方法调用之后调用(自动调用)

  1. setUpClass()

类初始化方法,在单个类中的所有测试方法调用之前调用

  1. tearDownClass()

类清理方法,在单个类中的所有测试方法调用之后调用

  1. run(result=None)

运行测试,并返回测试结果(返回值为对象)

  1. skipTest(reason)

在测试方法或setUp调用该方法可跳过当前测试

  1. debug()

以不采集测试结果方式运行测试

  1. shortDescription()

返回一行描述的测试结果信息

TestSuite类API

在python unittest中,提供了一套非常不错的用例组织机制(TestSuite):用来组织系列TestCase构建测试套件。

下面一起看看如何一步步的创建套件并运行它

  1. 创建TestSuite实例对象
suite = unittest.TestSuite()
  1. 添加TestCase对象至套件中
suite.addTest(testcase class)
  1. 添加TestCase对象至套件中方法2
suite = unittest.makeSuite(testcase class)
  1. 添加测试方法至套件中
suite.addTest(testcaseclass("testmethod"))
  1. 使用TextTestRunner创建一个运行器
runner = unittest.TextTestRunner()
  1. 运行
runner.run(suite)

下面看看TestSuite类的API说明,以便进一步理解上述过程的细节。

  1. addTest()

新增一个测试方法到套件中

  1. addTests()

新增多个测试方法到套件中

  1. run()

运行套件中关联的测试方法,并返回测试结果(返回值为测试结果对象)

  1. debug()

运行套件中关联的测试方法,但不搜集测试结果

  1. countTestCases()

返回当前测试对象的测试方法数

TestSuite应用示例

下面我用看一个TestSuite应用基本示例

# _*_ coding:utf-8 _*_

__author__ = '苦叶子'

import unittest
import sys
reload(sys)
sys.setdefaultencoding("utf-8")


class suiteTest(unittest.TestCase):
    def setUp(self):
        self.a = 10
        self.b = 20
        
    def testadd(self):
        # 验证加法
        result = self.a + self.b
        self.assertTrue(result == 100)
        
    def testsub(self):
        # 验证减法
        result = self.a - self.b
        self.assertTrue(result == -10)

        
# 定义suite
def suite():
    suite = unittest.TestSuite()
    
    # 添加测试方法
    suite.addTest(suiteTest("testadd"))
    suite.addTest(suiteTest("testsub"))
    
    ## 或用以下方式添加测试方法
    # suite.addTest(unittest.makeSuite(suiteTest))
    
    return suite
    

if __name__ == '__main__':
    runner = unittest.TextTestRunner()
    test_suite = suite()
    runner.run(test_suite)

将上述代码保存至test_suite.py中,在命令行中执行下属命令,运行

python test_suite.py

结果如下图:

testsuite.png

TestLoader类API

TestLoader类提供了从类或模块级别来创建test suites的能力。

下面我们看一下简单的代码示例:

# _*_ coding:utf-8 _*_

__author__ = '苦叶子'

import unittest
import sys
reload(sys)
sys.setdefaultencoding("utf-8")

# 测试用例1 
class demo1Test(unittest.TestCase):
    def setUp(self):
        self.a = 10
        self.b = 20
        
    def testadd(self):
        # 验证加法
        result = self.a + self.b
        self.assertTrue(result == 100)
        
    def testsub(self):
        # 验证减法
        result = self.a - self.b
        self.assertTrue(result == -10)

# 测试用例2        
class demo2Test(unittest.TestCase):
    def setUp(self):
        self.a = 1
        self.b = 2
        
    def testadd(self):
        # 验证加法
        result = self.a + self.b
        self.assertTrue(result == 10)
        
    def testsub(self):
        # 验证减法
        result = self.a - self.b
        self.assertTrue(result == -1)        

if __name__ == '__main__':
    # 用例列表
    testlist = [demo1Test, demo2Test]
    testload = unittest.TestLoader()
    
    # 构建test suite
    test_Suite = []
    for testcase in testlist:
        testSuite = testload.loadTestsFromTestCase(testcase)
        test_Suite.append(testSuite)
    newSuite = unittest.TestSuite(test_Suite)
    
    # 运行测试
    runner = unittest.TextTestRunner()
    runner.run(newSuite)

其他方式说明,这里就不一一示例说明了。

  1. loadTestsFromTestCase()

从指定的TestCase构建一个TestSuite对象,该对象包含了TestCase中所有的测试方法

  1. loadTestsFromModule()

从指定的模块中构建一个TestSuite对象,该对象包含了模块中所有的测试方法

注: 模块,一个个的.py文件,这些.py文件里有一个个继承至unittest.TestCase的类

  1. loadTestsFromName()

从特定的字符串构建一个TestSuite对象

  1. discover()

从指定目录,并递归其子目录,查找所有的测试模块,构建TestSuite。

TestResult类

在unittest中通过该类提供了测试结果信息。下面对TestResult的一些常用方法进行说明。

  1. Errors

返回所有的因异常抛出导致的错误信息

  1. Failures

返回所有的因断言失败的信息

  1. Skipped

返回所有因某些原因导致跳过的测试信息

  1. wasSuccessful()

如果所有测试都passed则返回True,否则返回False

  1. stop()

取消所有正在执行的测试

  1. startTestRun()/stopTestRun()

自己去尝试下_

  1. testsRun

返回截止至当前的执行数

  1. Buffer

如果设置为True, 控制stdout/stderr信息是否缓存

这里就不写示例,请直接参考标准文档

总结

本次就unittest中的TestCase、TestSuite、TestResult、TestLoader关键类进行了分享,并展示了关键使用实例。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容

  • Unittest核心工作原理 最核心的四个概念:test case ,test suite,test runner...
    简单生活101阅读 1,803评论 0 1
  • Startup 单元测试的核心价值在于两点: 更加精确地定义某段代码的作用,从而使代码的耦合性更低 避免程序员写出...
    wuwenxiang阅读 10,081评论 1 27
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,560评论 18 399
  • 尖角边框的实现方式有很多种 1.最简单粗暴的方法:背景图片。 可维护性不好。但是可以是任意形状。 2.利用icon...
    Hunter_Gu阅读 289评论 0 0
  • 你曾经做过哪些工作?是否对现有的工作满腹牢骚?你是否觉得老板都是周扒皮,同事都是心机婊?你有没有过冲动想冲...
    CUT无名指阅读 291评论 0 1