【Python】Python单元测试

01-单元测试基础

1. 什么是单元测试
2. 常用的文件结构
3. 编写第一个单元测试
4. 运行单元测试

什么是单元测试

单元测试是指一个自动化的测试：

1. 用来验证一小段代码（单元）的正确性，例如只测试某个函数写的是否正确
2. 可以快速执行
3. 在独立的环境中执行

常用的文件结构

1. myprj是项目代码目录 tests是单元测试代码目录，一般来说测试代码与项目代码文件目录结构一样
2. 在tests/basic中test_calculator.py必须以test_开头，因为测试的工具会寻找所有以test开头的文件，把他们当作单元测试文件运行,这算是一个规范

运行单元测试

myprj.basic中calculator.py代码：

class Calculator:
    def add(self, *args):
        res = 0

        for n in args:
            res += n

        return res

tests.basic中test_calculator.py代码：

import unittest
from myprj.basic.calculator import Calculator
"""
    文件要用"test_"开头
    测试类名要用"Test"开头
"""
class TestCalculator(unittest.TestCase):
    def test_add(self):
        """测试类方法必须用"test_"开头
            通常分为三部分:
                setup
                action
                assert
        """
        # setup
        cal = Calculator()
        excepted_result = 10  # 期望输出为10

        # action
        actual_result = cal.add(2,3,5)

        # assert 判断执行结果与期望结果是否相等，如果不相等，则测试失败
        # 说明代码有问题
        self.assertEqual(excepted_result, actual_result)

为了方便的运行测试：

pip install nose
pip install coverage

# 运行一个测试文件
python -m unittest -v tests.basic.test_calculator
# 运行所有测试文件
nosetests --with-doctest -v tests/basic/
# 统计测试覆盖率
nosetests --with-coverage --cover-erase -v tests/

也可以使用pytest:

pytest --doctest-modules tests/

02. 断言函数

常用断言函数：

03. Test Fixtures

1. 什么是Test Fixtures
2. 模块级别的Fixtures
3. 类级别的Fixtures
4. 方法级别的Fixtures

什么是Test Fixtures

在测试之前或者之后执行的函数或者方法被称之为Test Fixtures
比如：在测试前需要先连接数据库，在测试后需要断开与数据建库的连接

模块级别的Fixtures

setUpModule() 在整个模块执行之前需要执行的函数
tearDownModule() 在整个模块执行结束之后需要执行的函数

import unittest
from myprj.fixtures.bank_account import BankAccount

def setUpModule():
    print("calling setUpModule")

def tearDownModule():
    print("calling tearDownModule")

class TestBankAccount(unittest.TestCase):
    def test_deposit_success(self):
        bank_account = BankAccount(0)
        bank_account.deposit(10)

        self.assertEqual(10, bank_account.balance)
        
    def test_withdraw_success(self):
        bank_account = BankAccount(10)
        bank_account.withdraw(10)
        self.assertEqual(0, bank_account.balance)

上述代码中，当单独执行test_deposit_success 与test_withdraw_success时候，代码会自动执行setUpModule 与 tearDownModule.
当执行TestBankAccount进行测试时，虽然有两个测试用例，但是setUpModule 与 tearDownModule只会执行一次

类级别的Fixtures

setUpClass() 在整类执行之前需要执行的函数
tearDownClass() 在整个类执行结束之后需要执行的函数

import unittest
from myprj.fixtures.bank_account import BankAccount

def setUpModule():
    print("calling setUpModule")

def tearDownModule():
    print("calling tearDownModule")


class TestBankAccount(unittest.TestCase):
    @classmethod
    def setUpClass(cls) -> None:
        print("calling setUpClass")

    @classmethod
    def tearDownClass(cls) -> None:
        print("calling tearDownClass")
        

    def test_deposit_success(self):
        bank_account = BankAccount(0)
        bank_account.deposit(10)

        self.assertEqual(10, bank_account.balance)

    def test_withdraw_success(self):
        bank_account = BankAccount(10)
        bank_account.withdraw(10)
        self.assertEqual(0, bank_account.balance)

方法级别的Fixtures

setUp() 在任何一个方法执行之前都会被执行
tearDown()

import unittest
from myprj.fixtures.bank_account import BankAccount

class TestBankAccount(unittest.TestCase):

    def setUp(self) -> None:
        '''每一个类方法都要新建一个对象
            在任何一个方法执行之前都会执行
        '''
        print("calling setUp")
        self.bank_account = BankAccount(10)

    def tearDown(self) -> None:
        print("calling tearDown")
        self.bank_account = None

    def test_deposit_success(self):
        self.bank_account.deposit(10)
        self.assertEqual(20, self.bank_account.balance)

    def test_withdraw_success(self):
        
        self.bank_account.withdraw(10)
        self.assertEqual(0, self.bank_account.balance)

04.Mock

1. 什么是Mock
2. Mock和MagicMock
3. Mock实例

本文参考：
https://www.bilibili.com/video/BV1SP4y1D7Wd/?spm_id_from=333.999.0.0