pytest-snapshot 0.9.0

assert_match

一个经典的等式测试看起来像这样

def test_function_output():
    assert foo('function input') == 'expected result'

可以使用快照测试重写为

def test_function_output_with_snapshot(snapshot):
    snapshot.snapshot_dir = 'snapshots'  # This line is optional.
    snapshot.assert_match(foo('function input'), 'foo_output.txt')

测试的作者应该

1. 运行pytest --snapshot-update来生成包含foo()输出的快照文件snapshots/foo_output.txt。

2. 验证快照文件的内容是否有效。

3. 将其提交到版本控制。

现在，每次运行测试时，它都会断言foo()的输出等于快照。

如果foo()的行为发生变化，测试开始失败怎么办？

在第一个例子中，开发人员需要手动更新test_function_output中的预期结果。如果预期结果很大或有多个测试，这可能会很繁琐。

在第二个例子中，开发人员只需

1. 运行pytest --snapshot-update

2. 验证快照文件是否包含新的预期结果

3. 将其提交到版本控制。

快照测试可用于值是字符串或字节的表达式。对于其他类型，您应首先创建值的人类可读表示。例如，为了测试可序列化为JSON的值，您可以将其转换为JSON，或者更优地使用PyYAML将其转换为更易读的yaml格式。

snapshot.assert_match(yaml.dump(foo()), 'foo_output.yml')

assert_match_dir

当测试值的集合时，assert_match_dir非常有用。它将值的集合保存为一个包含快照文件的目录。assert_match_dir接受从文件名到值的字典。字典也可以嵌套，以创建包含快照文件的嵌套目录。

例如，以下代码创建了包含文件john.json和jane.json的目录snapshots/people。

def test_something(snapshot):
    snapshot.snapshot_dir = 'snapshots'
    snapshot.assert_match_dir({
        'john.json': '{"first name": "John", "last name": "Doe"}',
        'jane.json': '{"first name": "Jane", "last name": "Doe"}',
    }, 'people')

当运行pytest --snapshot-update时，快照文件将根据需要添加、更新或删除。作为安全措施，只有在使用--allow-snapshot-deletion标志时，才会删除快照。

常见用法

创建快照测试的一个快速方法是创建一个包含许多测试用例目录的目录。在每个测试用例中，添加包含您要测试的函数输入的文件。例如

test_cases
    case1
        input.json
    case2
        input.json
    ...

接下来，添加一个对所有测试用例目录进行参数化的测试。测试应该

• 从测试用例目录读取输入

• 调用要测试的函数

• 将结果快照到测试用例目录

import json
import os

import pytest
import yaml
from pathlib import Path


def json_to_yaml(json_string):
    obj = json.loads(json_string)
    return yaml.dump(obj, indent=2)


@pytest.mark.parametrize('case_dir', list(Path('test_cases').iterdir()))
def test_json(case_dir, snapshot):
    # Read input files from the case directory.
    input_json = case_dir.joinpath('input.json').read_text()

    # Call the tested function.
    output_yaml = json_to_yaml(input_json)

    # Snapshot the return value.
    snapshot.snapshot_dir = case_dir
    snapshot.assert_match(output_yaml, 'output.yml')

现在，我们可以运行pytest --snapshot-update为每个测试用例创建一个output.yml快照。如果后来我们决定修改测试的函数行为，我们可以使用另一个pytest --snapshot-update来修复测试用例。