python allure添加备注

原创

mob64ca12e5c0c2 2023-11-29 10:19:42 ©著作权

文章标签 Python 测试报告 python 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12e5c0c2的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python Allure 添加备注

简介

在软件开发过程中，测试是一个非常重要的环节。为了更好地管理和展示测试结果，我们可以使用 Allure 这一工具来生成漂亮的测试报告。除了基本的测试结果展示外，Allure 还支持添加备注来更详细地描述测试步骤和结果。本文将介绍如何使用 Python Allure 添加备注，并给出相应的代码示例。

准备工作

在开始之前，我们需要先安装 Allure 和相应的 Python Allure 模块。

安装 Allure

Allure 提供了一系列的命令行工具来生成和展示测试报告。我们可以通过以下命令来安装 Allure：

$ brew install allure

安装 Python Allure 模块

Python Allure 是一个用于生成 Allure 报告的 Python 模块。我们可以使用以下命令来安装：

$ pip install allure-pytest

安装完成后，我们就可以开始使用 Python Allure 来生成漂亮的测试报告。

添加备注

基本用法

在使用 Python Allure 生成测试报告时，我们可以通过在测试用例或测试步骤中添加备注来更详细地描述测试过程和结果。我们可以使用 allure.step 装饰器来添加备注。

下面是一个简单的示例：

import allure

@allure.step("步骤一：执行操作A")
def step_one():
    # 执行操作A

@allure.step("步骤二：执行操作B")
def step_two():
    # 执行操作B

@allure.feature("功能A")
@allure.story("用户故事一")
def test_case():
    step_one()
    step_two()

在上面的代码中，我们使用 @allure.step 装饰器来添加了两个备注，分别描述了步骤一和步骤二的操作。这样，在生成的测试报告中，我们可以看到这些备注，更好地理解测试过程。

备注参数化

有时，我们可能需要在备注中包含一些参数化的信息，比如测试数据。在 Python Allure 中，我们可以使用 {} 来引用参数化的内容。

以下是一个示例：

import allure

@allure.step("步骤一：执行操作A，参数：{param}")
def step_one(param):
    # 执行操作A

@allure.feature("功能A")
@allure.story("用户故事一")
def test_case():
    step_one("参数A")

在上面的代码中，我们在备注中使用了 {param} 来引用 step_one 函数的参数。这样，在生成的测试报告中，我们可以看到具体的参数值。

添加备注描述

有时，我们可能需要在注释中添加一些额外的描述信息，比如输入数据、预期结果等。在 Python Allure 中，我们可以使用 allure.attach 函数来添加备注描述。

以下是一个示例：

import allure

@allure.step("步骤一：执行操作A，参数：{param}")
def step_one(param):
    # 执行操作A
    allure.attach("输入参数", param)

@allure.feature("功能A")
@allure.story("用户故事一")
def test_case():
    step_one("参数A")

在上面的代码中，我们在 step_one 函数中使用了 allure.attach 函数来添加了一条备注描述，描述了输入参数的值。这样，在生成的测试报告中，我们可以看到这条描述信息。