软件测试|使用Pytest、Allure Step和Allure Attach创建详细测试报告

引言

在软件开发过程中，测试是不可或缺的一部分。为了更好地展示测试结果并定位问题，结合Pytest测试框架和Allure测试报告工具可以创建清晰、详细的测试报告。本文将介绍如何使用Pytest、Allure的allure.step()和allure.attach()功能来创建具有丰富信息的测试报告。

环境准备

在运行代码之前，我们需要先确定我们已经安装好了pytest以及allure-pytest第三方库，安装的命令如下：

pip install pytest allure-pytest

同时，我们要保证我们已经配置好了allure环境，否则将无法运行allure。

使用示例

考虑以下场景：我们要测试一个简单的函数，计算两个数字的和，并在测试过程中使用Allure的allure.step()和allure.attach()来增强测试报告。

1. 创建测试文件

首先，创建一个名为test_calculation.py的测试文件，内容如下：

import allure
import pytest

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

@pytest.mark.parametrize("a, b, expected", [(2, 3, 5), (5, 7, 12)])
def test_add_numbers(a, b, expected):
    with allure.step("输入两个数字并计算和"):
        result = add_numbers(a, b)
        
        allure.attach(f"输入: {a}, {b}\n预期结果: {expected}\n实际结果: {result}", name="测试数据")
        
        with allure.step("验证计算结果"):
            assert result == expected

1. 运行测试

在终端中，使用以下命令来运行测试并生成Allure报告数据：

pytest --alluredir=allure-results

1. 生成报告

生成的Allure报告数据将存储在allure-results文件夹中。使用以下命令来生成报告：

allure serve allure-results

浏览器将会自动打开并显示测试报告，如下图：

解释和说明

在上述示例中，我们首先定义了一个用于计算两个数字和的add_numbers函数。然后，我们使用@pytest.mark.parametrize装饰器来定义多组测试数据。

在测试函数内部，我们使用了Allure的allure.step()来创建测试步骤，这将在测试报告中显示具有层次结构的步骤信息。在步骤内部，我们使用了allure.attach()来附加额外的信息，例如测试数据和预期结果。这些附加信息将帮助我们更好地理解测试过程和结果。

最后，在验证阶段，我们使用assert语句来断言实际计算结果与预期结果是否相符。如果断言失败，Allure报告将显示详细的错误信息，帮助我们快速定位问题。

总结

通过结合Pytest、Allure的allure.step()和allure.attach()功能，我们可以创建更加详细和易于理解的测试报告，从而更好地跟踪和定位问题。这对于团队合作和软件质量的提升都是非常有益的。

最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！?