Python 单元测试：使用 unittest 框架编写测试用例

Travis Tang

2024-07-21

前言

大家好！最近我在整理代码的时候，发现单元测试真的是开发过程中不可或缺的一部分。以前总觉得写测试有点浪费时间，但实际上，测试用例可以帮助我们发现潜在的问题，确保代码的可靠性和稳定性。这让我想起了几年前一个朋友的经历。他在一次关键项目上线前因为没有写单元测试，结果上线当天服务器崩溃，造成了不小的损失。从那之后，我就下定决心要认真学习和使用单元测试。

今天，我就和大家分享一下如何使用 Python 的 unittest 框架编写测试用例。希望通过这篇文章，大家能学会用 unittest 来提升代码质量，避免上线后出现各种问题。如果你觉得这篇文章对你有帮助，别忘了关注我的博客并收藏这篇文章哦！

什么是单元测试？

单元测试是一种软件测试方法，通过对软件中的最小可测试单元进行验证，以确保其正确性。Python 中的 unittest 模块提供了一个强大的框架，用于创建和执行测试用例。单元测试的目标是验证每个单独的部分是否按预期工作，确保代码在不断变化中依旧保持稳定。

为什么使用 unittest？

使用 unittest 框架有很多好处：

捕捉错误：在开发阶段发现错误，而不是等到上线后。
文档化代码：测试用例可以作为代码的使用说明。
重构的信心：有了测试用例，重构代码时可以确保新旧代码具有相同的行为。

unittest 的基本使用

我们首先来看一个简单的例子，展示如何使用 unittest 框架编写和运行测试用例。

编写测试用例

在开始编写测试用例之前，需要先安装 Python。如果你的电脑上还没有安装 Python，可以去 Python 官网下载并安装最新版本。

import unittest

# 被测试的函数
def add(a, b):
    return a + b

# 创建一个测试类，继承unittest.TestCase
class TestAddFunction(unittest.TestCase):
    
    # 定义测试方法
    def test_add_integers(self):
        self.assertEqual(add(1, 2), 3)
        self.assertEqual(add(-1, 1), 0)
        self.assertEqual(add(-1, -1), -2)

    def test_add_floats(self):
        self.assertAlmostEqual(add(1.1, 2.2), 3.3, places=1)
        self.assertAlmostEqual(add(-1.1, 1.1), 0.0, places=1)
        self.assertAlmostEqual(add(-1.1, -1.1), -2.2, places=1)

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

在这个例子中，我们定义了一个简单的加法函数 add，并编写了两个测试方法 test_add_integers 和 test_add_floats。每个测试方法都使用了不同的 assert 方法来验证 add 函数的行为是否正确。

运行测试用例

要运行测试用例，只需在命令行中执行脚本即可：

1	python test_add_function.py

如果一切正常，你会看到类似下面的输出：

..
----------------------------------------------------------------------
Ran 2 tests in 0.001s

OK

这表示我们的两个测试用例都通过了。

更复杂的测试用例

除了基本的断言，unittest 还提供了许多其他功能，如设置和清理方法、跳过测试、预期失败等。让我们来看一个稍微复杂一点的例子。

import unittest

# 被测试的类
class Calculator:
    def add(self, a, b):
        return a + b
    
    def subtract(self, a, b):
        return a - b

class TestCalculator(unittest.TestCase):
    
    def setUp(self):
        self.calc = Calculator()

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

    def test_subtract(self):
        self.assertEqual(self.calc.subtract(2, 1), 1)
        self.assertEqual(self.calc.subtract(-1, 1), -2)
        self.assertEqual(self.calc.subtract(-1, -1), 0)

    def tearDown(self):
        del self.calc

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

在这个例子中，我们定义了一个 Calculator 类，并为其编写了测试用例。setUp 和 tearDown 方法分别在每个测试方法执行前后运行，用于设置和清理测试环境。

总结

通过使用 unittest 框架，我们可以方便地为我们的代码编写测试用例，确保代码的正确性和稳定性。希望大家能通过这篇文章掌握 unittest 的基本使用方法，并将其应用到实际开发中。

最后，感谢大家的阅读！如果你觉得这篇文章对你有帮助，别忘了关注我的博客并收藏这篇文章哦！让我们一起写出更高质量的代码！