6.1 认识unittest · Python / Linux / Mysql / 软件测试等等

[TOC] ## **6.1 认识 unittest** 在 Python 中有诸多单元测试框架，如 doctest、unittest、pytest、nose 等，Python 2.1 及其以后的版本已经将 unittest 作为一个标准模块放入 Python 开发包中。 ### **6.1.1 认识单元测试** 不用单元测试框架能写单元测试吗？答案是肯定的。单元测试本质上就是通过一段代码去验证另外一段代码，所以不用单元测试框架也可以写单元测试。下面就通过例子演示。创建一个被测试文件 calculator.py。 ``` # 计算器类 class Calculator: ''' 用于完成两个数的加、减、乘、除 ''' def __init__(self, a, b): self.a = int(a) self.b = int(b) # 加法 def add(self): return self.a + self.b # 减法 def sub(self): return self.a - self.b # 乘法 def mul(self): return self.a * self.b # 除法 def div(self): return self.a / self.b ``` 程序非常简单，创建一个 Calculator 类，通过__init__()方法接收两个参数，并做 int 类型转换。创建 add()、sub()、mul()、div()方法分别进行加、减、乘、除运算。根据上面实现的功能，创建 test_calculator.py 文件。 ``` from calculator import Calculator def test_add(): c = Calculator(3, 5) result = c.add() assert result == 8, '加法运算失败！' def test_sub(): c = Calculator(7, 2) result = c.sub() assert result == 5, "减法运算失败!" def test_mul(): c = Calculator(3, 3) result = c.mul() assert result == 10, "乘法运算失败！" def test_div(): c = Calculator(6, 2) result = c.div() assert result == 3, "除法运算失败！" if __name__ == '__main__': test_add() test_sub() test_mul() test_div() ``` 运行结果如下： ``` ============================= test session starts ============================= collecting ... collected 4 items test_calculator.py::test_add PASSED [ 25%] test_calculator.py::test_sub PASSED [ 50%] test_calculator.py::test_mul FAILED [ 75%] AssertionError: 乘法运算失败！ 9 != 10 预期:10 实际:9 def test_mul(): c = Calculator(3, 3) result = c.mul() > assert result == 10, "乘法运算失败！" E AssertionError: 乘法运算失败！ E assert 9 == 10 test_calculator.py:16: AssertionError test_calculator.py::test_div PASSED [100%] ========================= 1 failed, 3 passed in 0.03s ========================= ``` 在测试代码中，首先引入 calculator 文件中的 Calculator 类，并对测试数据进行初始化。接下来调用该类下面的方法，得到计算结果，并断言结果是否正确。下面通过 unittest 单元测试框架重新编写测试用例。 ``` import unittest from calculator import Calculator class TestCalculator(unittest.TestCase): def test_add(self): c = Calculator(3, 5) result = c.add() self.assertEqual(result, 8) def test_sub(self): c = Calculator(7, 2) result = c.sub() self.assertEqual(result, 5) def test_mul(self): c = Calculator(3, 3) result = c.mul() self.assertEqual(result, 10) def test_div(self): c = Calculator(6, 2) result = c.div() self.assertEqual(result, 3) if __name__ == '__main__': unittest.main() ``` 运行结果如下： ``` ============================= test session starts ============================= collecting ... collected 4 items calculator2.py::TestCalculator::test_add PASSED [ 25%] calculator2.py::TestCalculator::test_div PASSED [ 50%] calculator2.py::TestCalculator::test_mul FAILED [ 75%] calculator2.py:15 (TestCalculator.test_mul) 10 != 9 预期:9 实际:10 calculator2.py::TestCalculator::test_sub PASSED [100%] ========================= 1 failed, 3 passed in 0.06s ========================= ``` 引入 unittest 模块。如果想用 unittest 编写测试用例，那么一定要遵守它的“规则”。（1）创建一个测试类，这里为 TestCalculator 类，必须要继承 unittest 模块的 TestCase类。（2）创建一个测试方法，该方法必须以“test”开头。接下来的测试步骤与前面测试代码相同。首先，调用被测试类，传入初始化数据。其次，调用被测试方法，得到计算结果。通过 unittest 提供的 assertEqual()方法来断言结果是否与预期结果相同。该方法由 TestCase 父类提供，由于继承了该类，所以可以通过self 调用。最后，调用 unittest 的 main()来执行测试用例，它会按照前面的两条规则查找测试用例并执行。 ### **6.1.2 重要的概念** 在 unittest 文档中有四个重要的概念：Test Case、Test Suite、Test Runner 和 Test Fixture。只有理解了这几个概念，才能理解单元测试的基本特征。 **1．Test Case** Test Case 是最小的测试单元，用于检查特定输入集合的特定返回值。unittest 提供了TestCase 基类，我们创建的测试类需要继承该基类，它可以用来创建新的测试用例。 **2．Test Suite** 测试套件是测试用例、测试套件或两者的集合，用于组装一组要运行的测试。unittest提供了 TestSuite 类来创建测试套件。 **3．Test Runner** Test Runner 是一个组件，用于协调测试的执行并向用户提供结果。Test Runner 可以使用图形界面、文本界面或返回特殊值来展示执行测试的结果。unittest 提供了 TextTestRunner类运行测试用例，为了生成 HTML 格式的测试报告，后面会选择使用 HTMLTestRunner 运行类。 **4．Test Fixture** Test Fixture 代表执行一个或多个测试所需的环境准备，以及关联的清理动作。例如，创建临时或代理数据库、目录，或启动服务器进程。unittest 中提供了 setUp()/tearDown()、setUpClass()/tearDownClass()等方法来完成这些操作。 在理解了上面几个概念之后，我们对前面的测试用例做如下修改。 ``` import unittest from calculator import Calculator class TestCalculator(unittest.TestCase): # 测试用例前置动作 def setUp(self): print("test start:") # 测试用例后置动作 def tearDownClass(self): print("test end") def test_add(self): c = Calculator(3, 5) result = c.add() self.assertEqual(result, 8) def test_sub(self): c = Calculator(7, 2) result = c.sub() self.assertEqual(result, 5) def test_mul(self): c = Calculator(3, 3) result = c.mul() self.assertEqual(result, 10) def test_div(self): c = Calculator(6, 2) result = c.div() self.assertEqual(result, 3) if __name__ == '__main__': # 创建测试套件 suit = unittest.TestSuite() suit.addTest(TestCalculator("test_add")) suit.addTest(TestCalculator("test_sub")) suit.addTest(TestCalculator("test_mul")) suit.addTest(TestCalculator("test_div")) # 创建测试运行器 runner = unittest.TextTestRunner() runner.run(suit) ``` 首先，创建一个测试类并继承 TestCase 类，在该类下面创建一条以“test”开头的方法为测试用例。这个前面已有说明，这里再次说明是为了强调它的重要性。 其次，在测试类中增加了 setUp()/tearDown()方法，用于定义测试用例的前置和后置动作。因为在当前测试中暂时用不上，所以这里定义了一些简单的打印。 接下来，是测试用例的执行，这里做了很大的改动。首先，抛弃了 unittest 提供的 main()方法，而是调用 TestSuite 类下面的 addTest()来添加测试用例。因为一次只能添加一条用例，所以需要指定测试类及测试方法。然后，再调用 TextTestRunner 类下面的 run()运行测试套件。 这样做确实比直接使用 main()方法要麻烦得多，但也并非没有优点。 首先，测试用例的执行顺序可以由测试套件的添加顺序控制，而 main()方法只能按照测试类、方法的名称来执行测试用例。例如，TestA 类比 TestB 类先执行，test_add()用例比test_div()用例先执行。 其次，当一个测试文件中有很多测试用例时，并不是每次都要执行所有的测试用例，尤其是比较耗时的 UI 自动化测试。因而通过测试套件和测试运行器可以灵活地控制要执行的测试用例。执行结果如下。 ``` ============================= test session starts ============================= collecting ... collected 4 items calculator3.py::TestCalculator::test_add PASSED [ 25%]test start: calculator3.py::TestCalculator::test_div PASSED [ 50%]test start: calculator3.py::TestCalculator::test_mul FAILED [ 75%]test start: calculator3.py:23 (TestCalculator.test_mul) 10 != 9 预期:9 实际:10 calculator3.py::TestCalculator::test_sub PASSED [100%]test start: calculator3.py::TestCalculator::test_sub ERROR [100%] ==================== 1 failed, 3 passed, 1 error in 0.18s ===================== ``` 从执行结果可以看到，setUp/tearDown 作用于每条测试用例的开始之处与结束之处。 ### **6.1.3 断言方法** 在执行测试用例的过程中，最终测试用例执行成功与否，是通过测试得到的实际结果与预期结果进行比较得到的。unittest 框架的 TestCase 类提供的用于测试结果的断言方法如表 6-1 所示。 :-: 表 6-1 TestCase 类提供的用于测试结果的断言方法 | 方法 | 检查 | 版本 | | --- | --- |--- | | assertEqual(a, b) | a == b | | | assertNotEqual(a, b) | a != b | | | assertTrue(x) | bool(x) is True | | | assertFalse(x) | bool(x) is False | | | assertIs(a, b) | a is b | 3.1 | | assertIsNot(a, b) | a is not b | 3.1 | | assertIsNone(x) | x is None | 3.1 | | assertIsNotNone(x) | x is not None | 3.1 | | assertIn(a, b) | a in b | 3.1 | | assertNotIn(a, b) | a not in b | 3.1 | | assertIsInstance(a, b) | isinstance(a, b) | 3.2 | | assertNotIsInstance(a, b) | not isinstance(a, b) | 3.2 | 断言方法的使用如下所示。 ``` import unittest class TestAssert(unittest.TestCase): def test_equal(self): self.assertEqual(2+2, 4) self.assertEqual("python", "python") self.assertNotEqual("hello", "python") def test_in(self): self.assertIn("hello", "hello_world") self.assertNotIn("hi", "hello") def test_true(self): self.assertTrue(True) self.assertFalse(False) if __name__ == "__main__": unittest.main() ``` 运行上面的测试用例，即可通过测试结果推断出这些断言方法是如何使用的。