Unittest框架详解
- Test Fixture，就是Setup()和TearDown() Test Case()
- Test Case，一个Test Case就是一个测试用例，他们都是unittest.TestCase类的子类的方法
- Test Suite，Test Suite是一个测试用例集合，基本上你用不到它，用unittest.main()或者其它发现机制来运行所有的测试用例就对了。 :)
- Test runner，这是单元测试结果的呈现接口，你可以定制自己喜欢的呈现方式，比如GUI界面，基本上你也用不到它。
unittest单元测试框架不仅可以适用于单元测试，还可以适用WEB自动化测试用例的开发与执行，该测试框架可组织执行测试用例，并且提供了丰富的断言方法，判断测试用例是否通过，最终生成测试结果。今天就总结下如何使用unittest单元测试框架来进行接口自动化测试。
目录：
一、unittest模块的各个属性说明
先来聊一聊unittest模块的各个属性，所谓知己知彼方能百战百胜，了解unittest的各个属性，对于后续编写用例有很大的帮助。
1.unittest的属性如下
['BaseTestSuite', 'FunctionTestCase', 'SkipTest', 'TestCase', 'TestLoader', 'TestProgram', 'TestResult', 'TestSuite', 'TextTestResult', 'TextTestRunner', '_TextTestResult', '__all__', '__builtins__', '__doc__', '__file__', '__name__', '__package__', '__path__', '__unittest', 'case', 'defaultTestLoader', 'expectedFailure', 'findTestCases', 'getTestCaseNames', 'installHandler', 'loader', 'main', 'makeSuite', 'registerResult', 'removeHandler', 'removeResult', 'result', 'runner', 'signals', 'skip', 'skipIf', 'skipUnless', 'suite', 'util']
说明：
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()测试标记为失败。
2.TestCase类的属性如下：
['__call__', '__class__', '__delattr__', '__dict__', '__doc__', '__eq__', '__format__', '__getattribute__', '__hash__', '__init__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_addSkip', '_baseAssertEqual', '_classSetupFailed', '_deprecate', '_diffThreshold', '_formatMessage', '_getAssertEqualityFunc', '_truncateMessage', 'addCleanup', 'addTypeEqualityFunc', 'assertAlmostEqual', 'assertAlmostEquals', 'assertDictContainsSubset', 'assertDictEqual', 'assertEqual', 'assertEquals', 'assertFalse', 'assertGreater', 'assertGreaterEqual', 'assertIn', 'assertIs', 'assertIsInstance', 'assertIsNone', 'assertIsNot', 'assertIsNotNone', 'assertItemsEqual', 'assertLess', 'assertLessEqual', 'assertListEqual', 'assertMultiLineEqual', 'assertNotAlmostEqual', 'assertNotAlmostEquals', 'assertNotEqual', 'assertNotEquals', 'assertNotIn', 'assertNotIsInstance', 'assertNotRegexpMatches', 'assertRaises', 'assertRaisesRegexp', 'assertRegexpMatches', 'assertSequenceEqual', 'assertSetEqual', 'assertTrue', 'assertTupleEqual', 'assert_', 'countTestCases', 'debug', 'defaultTestResult', 'doCleanups', 'fail', 'failIf', 'failIfAlmostEqual', 'failIfEqual', 'failUnless', 'failUnlessAlmostEqual', 'failUnlessEqual', 'failUnlessRaises', 'failureException', 'id', 'longMessage', 'maxDiff', 'run', 'setUp', 'setUpClass', 'shortDescription', 'skipTest', 'tearDown', 'tearDownClass']
说明：
setUp():setUp()方法用于测试用例执行前的初始化工作。如测试用例中需要访问数据库，可以在setUp中建立数据库连接并进行初始化。如测试用例需要登录web，可以先实例化浏览器。
tearDown():tearDown()方法用于测试用例执行之后的善后工作。如关闭数据库连接。关闭浏览器。
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的一个实例，不是则测试用例通过。
3.TestSuite类的属性如下：（组织用例时需要用到）
['__call__', '__class__', '__delattr__', '__dict__', '__doc__', '__eq__', '__format__', '__getattribute__', '__hash__', '__init__', '__iter__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_addClassOrModuleLevelException', '_get_previous_module', '_handleClassSetUp', '_handleModuleFixture', '_handleModuleTearDown', '_tearDownPreviousClass', '_tests', 'addTest', 'addTests', 'countTestCases', 'debug', 'run']
说明：
addTest(): addTest()方法是将测试用例添加到测试套件中，如下方，是将test_baidu模块下的BaiduTest类下的test_baidu测试用例添加到测试套件。
suite = unittest.TestSuite() suite.addTest(test_baidu.BaiduTest('test_baidu'))
4.TextTextRunner的属性如下：（组织用例时需要用到）
['__class__', '__delattr__', '__dict__', '__doc__', '__format__', '__getattribute__', '__hash__', '__init__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_makeResult', 'buffer', 'descriptions', 'failfast', 'resultclass', 'run', 'stream', 'verbosity']
说明：
run(): run()方法是运行测试套件的测试用例，入参为suite测试套件。
runner = unittest.TextTestRunner()
runner.run(suite)
二、使用unittest框架编写测试用例思路
设计基本思路如下：
1 import unittest 2 3 class Test(unittest.TestCase): 4 def setUp(self): 5 print('set up !!') 6 7 def test_case1(self): 8 print('case_1.....') 9 10 def test_case2(self): 11 print('case_2.....') 12 13 def tearDown(self): 14 print('teardonw!!!') 15 16 if __name__ == '__main__': 17 unittest.main() #main 运行 18 19 # suite = unittest.TestSuite() 20 # suite.addTest(Test('test_case2')) 21 # suite.addTest(Test('test_case1')) 22 # runner = unittest.TextTestRunner() 23 # runner.run(suite) #使用TestSuite添加测试套件，使用TextTestRunner.run 执行测试套件 24 25 # test_dir = './' 26 # discover = unittest.defaultTestLoader.discover(test_dir,pattern='unittest_*.py') 27 # runner = unittest.TextTestRunner() 28 # runner.run(discover)
来个小练习：
1 # -*- coding:utf-8 -*- 2 # 1.先设置编码，utf-8可支持中英文，如上，一般放在第一行 3 4 # 2.注释：包括记录创建时间，创建人，项目名称。 5 ''' 6 Created on 2018-7-30 7 @author: Baylor 8 Project:使用unittest框架编写测试用例思路 9 ''' 10 # 3.导入unittest模块 11 12 import unittest 13 # 4.定义测试类，父类为unittest.TestCase。 14 # 可继承unittest.TestCase的方法，如setUp和tearDown方法，不过此方法可以在子类重写，覆盖父类方法。 15 # 可继承unittest.TestCase的各种断言方法。 16 class Test(unittest.TestCase): 17 # 5.定义setUp()方法用于测试用例执行前的初始化工作。 18 # 注意，所有类中方法的入参为self，定义方法的变量也要“self.变量” 19 # 注意，输入的值为字符型的需要转为int型 20 def setUp(self): 21 self.number = input('Enter a number:') 22 self.number = int(self.number) 23 24 # 6.定义测试用例，以“test_”开头命名的方法 25 # 注意，方法的入参为self 26 # 可使用unittest.TestCase类下面的各种断言方法用于对测试结果的判断 27 # 可定义多个测试用例 28 # 最重要的就是该部分 29 def test_case1(self): 30 print(self.number) 31 self.assertEqual(self.number, 10, msg='Your input is not 10') 32 33 def test_case2(self): 34 print(self.number) 35 self.assertEqual(self.number, 20, msg='Your input is not 20') 36 37 @unittest.skip('暂时跳过用例3的测试') 38 def test_case3(self): 39 print(self.number) 40 self.assertEqual(self.number, 30, msg='Your input is not 30') 41 42 # 7.定义tearDown()方法用于测试用例执行之后的善后工作。 43 # 注意，方法的入参为self 44 def tearDown(self): 45 print('Test over') 46 47 48 # 8如果直接运行该文件(__name__值为__main__),则执行以下语句，常用于测试脚本是否能够正常运行 49 if __name__ == '__main__': # 快捷输入 main tab补齐 50 # 8.1执行测试用例方案一如下： 51 # unittest.main()方法会搜索该模块下所有以test开头的测试用例方法，并自动执行它们。 52 # 执行顺序是命名顺序：先执行test_case1，再执行test_case2 53 unittest.main() 54 55 56 ''' 57 #8.2执行测试用例方案二如下： 58 #8.2.1先构造测试集 59 #8.2.1.1实例化测试套件 60 suite=unittest.TestSuite() 61 #8.2.1.2将测试用例加载到测试套件中。 62 #执行顺序是安装加载顺序：先执行test_case2，再执行test_case1 63 suite.addTest(Test('test_case2')) 64 suite.addTest(Test('test_case1')) 65 #8.2.2执行测试用例 66 #8.2.2.1实例化TextTestRunner类 67 runner=unittest.TextTestRunner() 68 #8.2.2.2使用run()方法运行测试套件（即运行测试套件中的所有用例） 69 runner.run(suite) 70 ''' 71 72 ''' 73 #8.3执行测试用例方案三如下： 74 #8.3.1构造测试集（简化了方案二中先要创建测试套件然后再依次加载测试用例） 75 #执行顺序同方案一：执行顺序是命名顺序：先执行test_case1，再执行test_case2 76 test_dir = './' 77 discover = unittest.defaultTestLoader.discover(test_dir, pattern='test_*.py') 78 #8.3.2执行测试用例 79 #8.3.2.1实例化TextTestRunner类 80 runner=unittest.TextTestRunner() 81 #8.3.2.2使用run()方法运行测试套件（即运行测试套件中的所有用例） 82 runner.run(discover) 83 ''' 84 85 print(1111)
使用方案一执行测试用例结果如下：
Enter a number:10
10
Test over
Enter a number:.10
Fs
Ran 3 tests in 6.092s
FAILED (failures=1, skipped=1)
10
Test over
因为先执行test_case1,再执行test_case2,所以第一次输入10时，执行通过，返回. 第二次输入10时，执行不通过，返回F，最终一个用例通过，一个用例失败，还有一个用例是直接跳过的（装饰器）。
使用方案二执行测试用例结果如下：
Enter a number:10
10
Test over
Enter a number:F10
.
Ran 2 tests in 4.973s
FAILED (failures=1)
10
Test over
因为先执行test_case2,再执行test_case1,所以第一次输入10时，执行不通过，返回F , 第二次输入10时，执行通过，返回. ，最终一个用例通过，一个用例失败。
使用方案三执行测试用例结果如下（执行测试用例顺序同方案一）：
Enter a number:10
10
Test over
Enter a number:.10
Fs
Ran 3 tests in 6.092s
FAILED (failures=1, skipped=1)
10
Test over
因为先执行test_case1,再执行test_case2,所以第一次输入10时，执行通过，返回. 第二次输入10时，执行不通过，返回F，最终一个用例通过，一个用例失败，还有一个用例是直接跳过的（装饰器）。
三、使用unittest框架编写测试用例实例
目录结构：
百度电影接口用例 Test Case:
1 # -*- coding:utf-8 -*- 2 __author__ = 'chenjianguo' 3 ''' 4 Created on 2016-7-22 5 @author: Baylor 6 Project:百度电影接口测试 7 ''' 8 9 import unittest, requests 10 11 class BaiduTest(unittest.TestCase): 12 def setUp(self): 13 self.base_url = "http://v.baidu.com/person_intro/?dtype=saleworks&pn=1&ps=12&wt=movie&id=76" 14 15 def test_baidu(self): 16 self.title = requests.get(self.base_url) # 变量self. 是为了让tearDown使用 17 # print(title.status_code) 18 self.assertEqual(self.title.status_code, 200, msg="接口未通过") 19 20 def tearDown(self): 21 a = self.title.content.decode('utf8') 22 # print(eval(a)) 23 print(eval(a)['movie']['typename']) 24 print('执行完毕。。。。') 25 26 if __name__ == "__main__": 27 unittest.main()
豆瓣接口测试用例 Test Case:
1 # -*- coding:utf-8 -*- 2 __author__ = 'chenjianguo' 3 ''' 4 Created on 2016-7-22 5 @author: Baylor 6 Project:豆瓣接口测试 7 ''' 8 9 import unittest,requests 10 11 class DoubanTest(unittest.TestCase): 12 @classmethod # 必须加这个 类方法 13 def setUpClass(cls): 14 print('我在何时运行--setupclass') #所有用例执行之前运行它 15 16 @classmethod 17 def tearDownClass(cls): 18 print('我在何时运行--teardownclass')#所有用例执行完之后运行它 19 20 def setUp(self): 21 self.base_url = "https://movie.douban.com/j/search_tags?type=movie&source=index" 22 23 def test_douban(self): 24 self.title = requests.get(self.base_url) #变量self. 是为了让tearDown使用 25 # print(title.status_code) 26 # self.assertEqual(self.title.status_code,200, msg="接口未通过") 27 self.assertIs(self.title.status_code,200, msg="接口未通过") 28 29 def tearDown(self): 30 print(self.title.content.decode('utf8')) 31 print('执行完毕。。。。') 32 33 if __name__ == "__main__": 34 unittest.main()
web测试用例：通过测试套件TestSuite来组装多个测试用例。
1 # -*- coding:utf-8 -*- 2 3 ''' 4 explain： 编写接口测试用例 5 ''' 6 7 import unittest 8 from test_project.test_case import test_baidu 9 from test_project.test_case import test_douban 10 11 suite = unittest.TestSuite() 12 suite.addTest(test_baidu.BaiduTest('test_baidu')) 13 suite.addTest(test_douban.DoubanTest('test_douban')) 14 15 if __name__ == '__main__': 16 # runner = unittest.TextTestRunner() 17 # runner.run(suite) 18 19 # https://pan.baidu.com/s/1dcwD42ym6Hd5Di7Gy9_hxw #课件下载 20 import HTMLTestRunner 21 # f = open('report.html','wb') 22 # runner = HTMLTestRunner.HTMLTestRunner(stream=f,title='xxx报告',description='测试情况') 23 # runner.run(xxx) 24 25 # import xmlrunner 26 # report = xmlrunner.XMLTestRunner(output='TestLog') 27 # report.run(suite) 28 29 import BeautifulReport 30 report = BeautifulReport.BeautifulReport(suite) 31 report.report(description='xxx测试', filename='report2.html',log_path='TestLog') 32 print(report.failure_count) # 失败的次数 33 print(report.success_count) # 成功的次数
测试结果：
说明：.代表用例执行通过，两个点表示两个用例执行通过。F表示用例执行不通过。
资料补充
1 class demoSkipTest(unittest.TestCase): 2 a = 50 3 b = 20 4 5 def test_add(self): 6 """加法""" 7 result = self.a + self.b 8 self.assertEqual(result, 40) 9 10 @unittest.skipIf(a > b, u"a>b就跳过") 11 def test_sub(self): 12 """减法""" 13 result = self.a - self.b 14 self.assertTrue(result == -30) 15 16 @unittest.skipUnless(b == 0, u"除数为0，则跳转") 17 def test_div(self): 18 """除法""" 19 result = self.a / self.b 20 self.assertTrue(result == 1) 21 22 @unittest.expectedFailure 23 def test_mul(self): 24 """乘法""" 25 result = self.a * self.b 26 self.assertTrue(result == 0) 27 28 29 if __name__ == "__main__": 30 unittest.main()