单元测试框架Uinttest一文详解

2019 年 10 月 3 日
笔记

一谈及unittest，大家都知道，unittest是Python中自带的单元测试框架，它里面封装好了一些校验返回的结果方法和一些用例执行前的初始化操作。unittest单元测试框架不仅可以适用于单元测试，还可以适用web自动化测试用例的开发与执行，该测试框架可组织执行测试用例，并且提供了丰富的断言方法，判断测试用例是否通过，最终生成测试结果。

在聊unittest时，需要先明白，最基础的四个概念：TestCase，TestSuite，TestRunner，TestFixture，看如下静态图：

unittest运行流程

先编写好TestCase，然后由TestLoader加载TestCase到TestSuite，其次由TextTestRunner来运行TestSuite，运行的结果保存在TextTestResult中，我们通过命令行或者unittest.main()执行时，main会调用TextTestRunner中的run来执行，或者我们可以直接通过TextTestRunner来执行用例。

unittest模块的各个属性说明

unittest.TestCase：TestCase类，所有测试用例类继承的基本类。

class BaiduTest(unittest.TestCase):

unittest.main()：使用它可以方便的将一个单元测试模块变为可直接运行的测试脚本，main()方法使用TestLoader类来搜索所有包含在该模块中以“test”命名开头的测试方法，并自动执行他们。执行方法的默认顺序是：根据ASCII码的顺序加载测试用例，数字与字母的顺序为：0-9，A-Z，a-z。所以以A开头的测试用例方法会优先执行，以a开头会后执行。

unittest.TestSuite()：unittest框架的TestSuite()类是用来创建测试套件的。

unittest.TextTextRunner()：unittest框架的TextTextRunner()类，通过该类下面的run()方法来运行suite所组装的测试用例，入参为suite测试套件。

unittest.defaultTestLoader()： defaultTestLoader()类，通过该类下面的discover()方法可自动更具测试目录start_dir匹配查找测试用例文件（test*.py），并将查找到的测试用例组装到测试套件，因此可以直接通过run()方法执行discover。用法如下：

discover=unittest.defaultTestLoader.discover(test_dir, pattern='test_*.py')

unittest.skip()：装饰器，当运行用例时，有些用例可能不想执行等，可用装饰器暂时屏蔽该条测试用例。一种常见的用法就是比如说想调试某一个测试用例，想先屏蔽其他用例就可以用装饰器屏蔽。

@unittest.skip(reason)： skip(reason)装饰器：无条件跳过装饰的测试，并说明跳过测试的原因。

@unittest.skipIf(reason)：skipIf(condition,reason)装饰器：条件为真时，跳过装饰的测试，并说明跳过测试的原因。

@unittest.skipUnless(reason)：skipUnless(condition,reason)装饰器：条件为假时，跳过装饰的测试，并说明跳过测试的原因。

@unittest.expectedFailure()：expectedFailure()测试标记为失败。

setUp()：setUp()方法用于每个测试用例执行前的初始化工作。如测试用例中需要访问数据库，可以在setUp中建立数据库连接并进行初始化。如测试用例需要登录web，可以先实例化浏览器。

tearDown()：tearDown()方法用于每个测试用例执行之后的善后工作。如关闭数据库连接、关闭浏览器。

setUpClass()：setUpClass()方法用于所有测试用例前的设置工作。

tearDownClass()：tearDownClass()方法用于所有测试用例执行后的清理工作。

addTest()：addTest()方法是将测试用例添加到测试套件中。

run()：run()方法是运行测试套件的测试用例，入参为suite测试套件。

assert*()：在执行测试用例的过程中，最终用例是否执行通过，是通过判断测试得到的实际结果和预期结果是否相等决定的。

断言方式如下：

assertEqual(a,b，[msg=’测试失败时打印的信息’]):断言a和b是否相等，相等则测试用例通过。

assertNotEqual(a,b，[msg=’测试失败时打印的信息’]):断言a和b是否相等，不相等则测试用例通过。

assertTrue(x，[msg=’测试失败时打印的信息’])：断言x是否True，是True则测试用例通过。

assertFalse(x，[msg=’测试失败时打印的信息’])：断言x是否False，是False则测试用例通过。

assertIs(a,b，[msg=’测试失败时打印的信息’]):断言a是否是b，是则测试用例通过。

assertNotIs(a,b，[msg=’测试失败时打印的信息’]):断言a是否是b，不是则测试用例通过。

assertIsNone(x，[msg=’测试失败时打印的信息’])：断言x是否None，是None则测试用例通过。

assertIsNotNone(x，[msg=’测试失败时打印的信息’])：断言x是否None，不是None则测试用例通过。

assertIn(a,b，[msg=’测试失败时打印的信息’])：断言a是否在b中，在b中则测试用例通过。

assertNotIn(a,b，[msg=’测试失败时打印的信息’])：断言a是否在b中，不在b中则测试用例通过。

assertIsInstance(a,b，[msg=’测试失败时打印的信息’])：断言a是是b的一个实例，是则测试用例通过。

assertNotIsInstance(a,b，[msg=’测试失败时打印的信息’])：断言a是是b的一个实例，不是则测试用例通过。

说了这么多的属性，接下来用一段代码举例：

unittest基本代码示例：

import unittest  from unittestbasic1.unittest_operation import *    '''  @author: wenyihuqingjiu  @project: unittestdemo  @file: unittest_demo_basic.py  @time: 2019-09-26 23:38  @desc:  '''    class TestMathFunc(unittest.TestCase):        # TestCase基类方法,所有case执行之前自动执行      @classmethod      def setUpClass(cls):          print("*************这里是所有测试用例前的准备工作*************")        # TestCase基类方法,所有case执行之后自动执行      @classmethod      def tearDownClass(cls):          print("*************这里是所有测试用例后的清理工作*************")        # TestCase基类方法,每次执行case前自动执行      def setUp(self):          print("-------------这里是一个测试用例前的准备工作-------------")        # TestCase基类方法,每次执行case后自动执行      def tearDown(self):          print("-------------这里是一个测试用例后的清理工作-------------")        @unittest.skip("我想临时跳过这个测试用例.")      def test_add(self):          self.assertEqual(3, add(1, 2))          self.assertNotEqual(3, add(2, 2))  # 测试业务方法add        def test_minus(self):          self.skipTest('跳过这个测试用例')          self.assertEqual(1, minus(3, 2))  # 测试业务方法minus        def test_multi(self):          self.assertEqual(6, multi(2, 3))  # 测试业务方法multi        def test_divide(self):          self.assertEqual(2, divide(6, 3))  # 测试业务方法divide          self.assertEqual(2.5, divide(5, 2))      if __name__ == '__main__':      unittest.main(verbosity=2)

基本函数如下：

def add(a, b):      return a+b      def minus(a, b):      return a-b      def multi(a, b):      return a*b      def divide(a, b):      return a/b

运行代码，结果如下所示：

理论加实践，结合起来看，应该更容易明白些，切莫做纸上谈兵。

添加用例运行方式

弄明白了unittest的基本属性，接下来分享下添加用例运行的不同方式

方式一：使用addTests单个添加

用addTests方法单个添加用例，代码示例如下：

import unittest  from unittestbasic2.unittest_operation2 import TestMathFunc    '''  @author: wenyihuqingjiu  @project: unittestdemo  @file: unittest_demo_suite1.py  @time: 2019-09-26 23:38  @desc:  '''    if __name__ == '__main__':      suite = unittest.TestSuite()      # 单个添加测试用例      suite.addTest(TestMathFunc("test_multi"))      suite.addTest(TestMathFunc("test_divide"))      runner = unittest.TextTestRunner(verbosity=2)      runner.run(suite)

方式二：测试用例添加到用例集中

从方法一种看，单个添加用例比较麻烦，该方法可以将用例添加到一个用例集中，再通过suite统一运行，代码示例如下：

import unittest  from unittestbasic2.unittest_operation2 import TestMathFunc    '''  @author: wenyihuqingjiu  @project: unittestdemo  @file: unittest_demo_suite2.py  @time: 2019-09-26 23:38  @desc:  '''    if __name__ == '__main__':      suite = unittest.TestSuite()      # 将测试用例添加到一个用例集中      tests = [TestMathFunc("test_add"), TestMathFunc("test_minus")]      suite.addTests(tests)  # 将测试用例列表添加到测试组中      runner = unittest.TextTestRunner(verbosity=2)      runner.run(suite)

方式三：TestLoader方法加载用例

使用TestLoader方法加载用例，就是无法对case进行排序，执行顺序是随机的。实现方法有如下三种，代码示例如下：

import unittest  from unittestbasic2.unittest_operation2 import TestMathFunc    '''  @author: wenyihuqingjiu  @project: unittestdemo  @file: unittest_demo_suite3.py  @time: 2019-09-26 23:44  @desc:  '''    if __name__ == '__main__':      suite = unittest.TestSuite()      # 第一种方法：传入'模块名.TestCase名'      # 用addTests + TestLoader。不过用TestLoader的方法是无法对case进行排序的      # loadTestsFromName()，传入'模块名.TestCase名'      # ①      # suite.addTests(unittest.TestLoader().loadTestsFromName('unittest_operation2.TestMathFunc'))      # suite.addTests(unittest.TestLoader().loadTestsFromName('unittest_operation1.TestMathFunc'))      # 这里还可以把'模块名.TestCase名'放到一个列表中      # ②      # suite.addTests(unittest.TestLoader().loadTestsFromNames(['unittest_operation2.TestMathFunc', 'unittest_operation1.TestMathFunc']))        # 第二种方法：传入TestCase 需要导入对应模块      suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestMathFunc))      runner = unittest.TextTestRunner(verbosity=2)      runner.run(suite)

方式四：通过discover()方法

看了前三种实现方式，都比较单一，实际运用中，case数量不仅仅只有一两个，一个一个去添加的话，那得多麻烦。故而引用discover()方法，匹配指定文件夹下以test开头的测试用例，代码示例如下：

import unittest    '''  @author: wenyihuqingjiu  @project: unittestdemo  @file: unittest_demo_suite4.py  @time: 2019-09-26 23:46  @desc:  '''    if __name__ == '__main__':      path = './testcase'      all_cases = unittest.defaultTestLoader.discover(path, 'test*.py')      # 找到某个目录下所有的以test开头的Python文件里面的测试用例      runner = unittest.TextTestRunner(verbosity=2)      runner.run(all_cases)

如上所述，就是常见的用例执行方式了，不过，运用最多的还是最后一种方式。

测试报告

在做测试时，自然是要生成测试报告的，一份好的测试报告，可以很直观的看出当前代码构建的系统状况，也可以帮助自己很快定位问题。

前段时间，在github上搜索到一份带截图的测试报告模板，所以引用使用了一番，整体很不错，自己也略小有调整，将报告模板引用到代码中即可使用。

说到测试报告，再使用之前的代码，就实现不了，需要引用HTMLTestRunner。我一般使用html格式的报告，还有一种是xml格式的，使用jenkins构建代码的话，那就需要生成xml格式的测试报告了。

html格式测试报告

先来看如何生成html格式的测试报告，代码示例如下：

import unittest  from utils.HTMLTestRunner_cn import HTMLTestRunner  import time    '''  @author: wenyihuqingjiu  @project: unittestdemo  @file: unittest_demo_suite5.py  @time: 2019-09-26 23:58  @desc:  '''    if __name__ == '__main__':      path = './testcase'      report_file = '../'      # 找到某个目录下所有的以test开头的Python文件里面的测试用例      all_cases = unittest.defaultTestLoader.discover(path, 'test*.py')        report_time = time.strftime("%Y-%m-%d-%H_%M_%S", time.localtime(time.time()))      report_file_path = report_file + '/report/' + report_time + '-result.html'      file_result = open(report_file_path, 'wb')      runner = HTMLTestRunner(stream=file_result, title="简单运算demo", description="温一壶清酒", verbosity=2, retry=2,                             save_last_try=True)      runner.run(all_cases)

运行后，查看测试报告，如下所示：

以自己的产品做了个登录测试，生成的测试报告更全面，代码示例如下：

from selenium import webdriver  import unittest  import time  from utils.HTMLTestRunner_cn import HTMLTestRunner    '''  @author: wenyihuqingjiu  @project: unittestdemo  @file: unittestlogin.py  @time: 2019-09-22 11:38  @desc:  '''      class case_01(unittest.TestCase):      @classmethod      def setUpClass(cls):          cls.driver = webdriver.Chrome()          cls.driver.maximize_window()        @classmethod      def tearDownClass(cls):          cls.driver.quit()        def add_img(self):          self.imgs.append(self.driver.get_screenshot_as_base64())          return True        def setUp(self):          # 在是python3.x 中，如果在这里初始化driver ，因为3.x版本 unittestbasic1 运行机制不同，会导致用力失败时截图失败          self.driver.get("")          self.driver.implicitly_wait(30)          self.imgs = []          self.addCleanup(self.cleanup)        def cleanup(self):          pass        def test_case1(self):          """ 正常登录"""          self.driver.find_element_by_xpath(              "//*[@id='app']/div/div[1]/div[1]/div[2]/div[1]/div/div[1]/div/div/div/div/div[3]").click()          self.add_img()          self.driver.find_element_by_css_selector("input[type='text']").send_keys("")          time.sleep(1)          self.add_img()          self.driver.find_element_by_css_selector("input[type='password']").send_keys("")          time.sleep(1)          self.add_img()          self.driver.find_element_by_css_selector("button[type='button']").click()          time.sleep(3)          self.add_img()          user_name = self.driver.find_element_by_css_selector(".user-name").text          self.assertEqual("一壶清酒stage1111", user_name, msg="登录失败！！")          self.driver.find_element_by_css_selector(".user-name").click()          time.sleep(3)          self.driver.find_element_by_xpath(              "//*[@id='app']/div/div[2]/div[1]/div[2]/div[5]/div[3]/ul/li[2]/span/i").click()          print("退出登录")          time.sleep(5)        def test_case2(self):          """ 账号不存在"""          self.driver.find_element_by_xpath(              "//*[@id='app']/div/div[1]/div[1]/div[2]/div[1]/div/div[1]/div/div/div/div/div[3]").click()          self.driver.find_element_by_css_selector("input[type='text']").send_keys("")          time.sleep(1)          self.driver.find_element_by_css_selector("input[type='password']").send_keys("")          time.sleep(1)          self.driver.find_element_by_css_selector("button[type='button']").click()          time.sleep(1)          self.add_img()          print("登录失败！")        def test_case3(self):          """ 密码错误"""          self.driver.find_element_by_xpath(              "//*[@id='app']/div/div[1]/div[1]/div[2]/div[1]/div/div[1]/div/div/div/div/div[3]").click()          self.driver.find_element_by_css_selector("input[type='text']").send_keys("")          time.sleep(1)          self.driver.find_element_by_css_selector("input[type='password']").send_keys("")          time.sleep(1)          self.driver.find_element_by_css_selector("button[type='button']").click()          time.sleep(1)          self.add_img()          print("登录失败！")        @unittest.skip("临时跳过这个测试用例")      def test_case4(self):          """ 跳过该用例"""          self.driver.find_element_by_xpath(              "//*[@id='app']/div/div[1]/div[1]/div[2]/div[1]/div/div[1]/div/div/div/div/div[3]").click()          self.driver.find_element_by_css_selector("input[type='text']").text()          time.sleep(1)          self.driver.find_element_by_css_selector("input[type='password']").text()          time.sleep(1)          self.driver.find_element_by_css_selector("button[type='button']").click()          time.sleep(3)        @unittest.skipIf(3 > 2, "判断为真，此用例不执行")      def test_case5(self):          """ skipIf判断，为真则不执行"""          self.driver.find_element_by_xpath(              "//*[@id='app']/div/div[1]/div[1]/div[2]/div[1]/div/div[1]/div/div/div/div/div[3]").click()          self.driver.find_element_by_css_selector("input[type='text']").text()          time.sleep(1)          self.driver.find_element_by_css_selector("input[type='password']").text()          time.sleep(1)          self.driver.find_element_by_css_selector("button[type='button']").click()          time.sleep(3)        @unittest.skipUnless(3 < 2, "判断为假，此用例不执行")      def test_case6(self):          """ skipIf判断，为假则不执行"""          self.driver.find_element_by_xpath(              "//*[@id='app']/div/div[1]/div[1]/div[2]/div[1]/div/div[1]/div/div/div/div/div[3]").click()          self.driver.find_element_by_css_selector("input[type='text']").text()          time.sleep(1)          self.driver.find_element_by_css_selector("input[type='password']").text()          time.sleep(1)          self.driver.find_element_by_css_selector("button[type='button']").click()          time.sleep(3)        def test_case7(self):          """ 断言失败"""          self.driver.find_element_by_xpath(              "//*[@id='app']/div/div[1]/div[1]/div[2]/div[1]/div/div[1]/div/div/div/div/div[3]").click()          self.driver.find_element_by_css_selector("input[type='text']").send_keys("")          time.sleep(1)          self.driver.find_element_by_css_selector("input[type='password']").send_keys("")          time.sleep(1)          self.driver.find_element_by_css_selector("button[type='button']").click()          time.sleep(3)          user_name = self.driver.find_element_by_css_selector(".user-name").text          self.assertEqual("一壶清酒stage", user_name, msg="登录失败！！")          self.driver.find_element_by_css_selector(".user-name").click()          time.sleep(3)          self.driver.find_element_by_xpath(              "//*[@id='app']/div/div[2]/div[1]/div[2]/div[5]/div[3]/ul/li[2]/span/i").click()          print("退出登录")      if __name__ == "__main__":      suites = unittest.TestSuite()      suites.addTest(case_01("test_case1"))      suites.addTest(case_01("test_case2"))      suites.addTest(case_01("test_case3"))      suites.addTest(case_01("test_case4"))      suites.addTest(case_01("test_case5"))      suites.addTest(case_01("test_case6"))      suites.addTest(case_01("test_case7"))      report_time = time.strftime("%Y-%m-%d-%H_%M_%S", time.localtime(time.time()))      report_file = '../'      report_file_path = report_file + '/report/' + report_time + '-result.html'      file_result = open(report_file_path, 'wb')      # retry重试次数      runer = HTMLTestRunner(stream=file_result, title="带截图的测试报告", description="温一壶清酒", verbosity=2, retry=0,                             save_last_try=True)      runer.run(suites)

查看测试报告如下所示：

xml格式测试报告

生成xml格式的测试报告，代码示例如下：

import unittest  import time  import xmlrunner    '''  @author: wenyihuqingjiu  @project: unittestdemo  @file: unittest_demo_suite6.py  @time: 2019-09-27 00:11  @desc:  '''    if __name__ == '__main__':      path = './testcase'      report_file = '../'      # 找到某个目录下所有的以test开头的Python文件里面的测试用例      all_cases = unittest.defaultTestLoader.discover(path, 'test*.py')        report_time = time.strftime("%Y-%m-%d-%H_%M_%S", time.localtime(time.time()))      report_file_path = report_file + '/report/'      runner = xmlrunner.XMLTestRunner(verbosity=2, output=report_file_path)    # output 报告存放路径      runner.run(all_cases)

生成的报告如下所示：

问题

生成的测试报告，发送到邮箱中，预览附件时，部分文字是乱码，样式按钮也不可点击，是因为样式文件被浏览器拦截了嘛？

预览文件如下：

本文仅代表作者观点，系作者@温一壶清酒发表。
欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。
文章出处：http://www.cnblogs.com/hong-fithing/