前言

在软件开发的过程中，单元测试是保证代码质量的重要环节。今天，我们将介绍Python中一个非常实用的单元测试框架——unittest。对于新手来说，掌握unittest库不仅能帮助你写出更加健壮的代码，还能提升你的测试效率。那么，让我们一起来学习unittest库的基本用法吧！

什么是单元测试？

单元测试是指对软件中的最小可测试单元进行检查和验证，通常是一个函数或一个方法。它的目的是确保这些单元能够按照预期工作。单元测试有助于我们在早期发现错误，提高代码的可靠性和可维护性。

为什么使用unittest库？

Python的unittest库是一个内置的单元测试框架，它提供了丰富的功能来支持测试自动化。使用unittest库的好处包括：

1. 易于编写：unittest提供了简单的API来编写测试用例。
2. 自动发现：可以自动发现并运行测试。
3. 丰富的断言方法：提供多种断言方法来验证测试结果。
4. 集成报告：能够生成详细的测试报告。
5. 夹具（Fixture）支持：方便地为测试提供初始化和清理资源。

一.基本用法

1.导入模块

import unittest

2.编程测试用例

这里我们写两个测试函数，一个加法，一个减法

def add(a, b):
    return a + b


def sub(a,b):
    return a - b

编写测试用例

import unittest


def add(a, b):
    return a + b


def sub(a, b):
    return a - b


class TestFun(unittest.TestCase):
    def test_add(self):
        self.assertEqual(add(1, 2), 3)
        self.assertEqual(add(-1, 1), 0)
        self.assertEqual(add(0, 0), 0)
    def test_sub(self):
        self.assertEqual(sub(3,4),1)


if __name__ == '__main__':
    unittest.main()

测试结果如下：

3.使用断言

unittest提供了多种断言方法来验证测试结果，常用的有：

1.assertEqual(a, b)：检查a和b是否相等。

2.assertTrue(x)：检查x是否为True。

3.assertFalse(x)：检查x是否为False。

4.assertIs(a, b)：检查a和b是否是同一个对象。

5.assertIsNot(a, b)：检查a和b是否不是同一个对象。

6.assertIn(a, b)：检查a是否在b中。

7.assertNotIn(a, b)：检查a是否不在b中。

4.使用夹具（Fixture）

夹具是用于设置和清理测试环境的工具。unittest提供了setUp和tearDown方法来分别在每个测试方法执行前后运行

代码如下

import unittest


def add(a, b):
    return a + b


def sub(a, b):
    return a - b


class TestFun(unittest.TestCase):
    def setUp(self):
        print("测试前做的事情")


        
    def test_add(self):
        self.assertEqual(add(1, 2), 3)
        self.assertEqual(add(-1, 1), 0)
        self.assertEqual(add(0, 0), 0)


        
    def test_sub(self):
        self.assertEqual(sub(3,4),1)


    def tearDown(self):
        print("测试后结束后的事情")
        


if __name__ == '__main__':
    unittest.main()

结果如下：

5.生产测试报告

unittest可以生成详细的测试报告。当你在命令行中运行测试时，它会显示每个测试方法的名称、是否通过以及运行时间。如果需要更详细的报告，可以使用第三方工具如HTMLTestRunner

pip install HTMLTestReport

测试代码如下

保存文件为Test.py

import unittest




def add(a, b):
    return a + b


def sub(a, b):
    return a - b


class TestFun(unittest.TestCase):
    def setUp(self):
        print("测试前做的事情")


        
    def test_add(self):
        self.assertEqual(add(1, 2), 3)
        self.assertEqual(add(-1, 1), 0)
        self.assertEqual(add(0, 0), 0)


        
    def test_sub(self):
        self.assertEqual(sub(3,4),1)


    def tearDown(self):
        print("测试后结束后的事情")
        


if __name__ == '__main__':
    unittest.main()

生成测试报告的文件，代码如下

import unittest
from Test import TestFun
from htmltestreport import HTMLTestReport
 
# 生成测试套件
suite = unittest.TestSuite()
suite.addTest(unittest.makeSuite(TestFun))
 
# 实例化HTMLTestReport对象
report_path = "report.html"
report = HTMLTestReport(report_path,title='单元测试报告',description='test函数测试报告V1.0')
 
# 执行测试套件
report.run(suite)

生产报告如下

六.注意事项

1. 测试文件导入：确保你的测试文件正确导入了要测试的模块。
2. 测试类继承：测试类应该继承自unittest.TestCase，这样它才能使用unittest提供的各种断言方法和测试工具。
3. 测试方法命名：测试方法的名称必须以test开头，这样unittest才能自动识别并执行它们。
4. 测试类执行：使用unittest.main()来执行测试类，这样可以运行所有的测试方法。
5. 类方法装饰器：如果你使用setUpClass和tearDownClass方法，记得使用@classmethod装饰器。
6. 测试环境设置：使用setUp方法来准备测试环境，使用tearDown方法来清理测试环境，确保每个测试方法在干净的环境中运行。
7. 断言使用：合理使用断言方法来验证测试结果，如assertEqual、assertTrue等。
8. 测试独立性：确保测试用例之间的独立性，避免测试顺序的影响。
9. 异常处理：在测试方法中合理使用异常处理，确保测试失败时能够给出清晰的错误信息。
10. 代码覆盖率：关注测试的代码覆盖率，确保所有的重要代码路径都被测试到。