软件测试学习笔记丨Allure2报告中添加用例描述

最新推荐文章于 2025-12-16 22:22:21 发布

原创最新推荐文章于 2025-12-16 22:22:21 发布 · 328 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#学习 #笔记 #自动化测试 #测试开发 #软件测试

本文介绍了Allure2如何通过装饰器、HTML代码、文档注释和动态方式在测试报告中添加详细的测试用例描述，以增强测试报告的可读性。

Allure2报告中添加用例描述

应用场景：Allure 支持往测试报告中对测试用例添加非常详细的描述语，用来描述测试用例详情。
Allure 添加描述的四种方式：
方式一：使用装饰器 @allure.description() 传递一个字符串参数来描述测试用例。

@allure.description("""多行描述语：<br/>这是通过传递字符串参数的方式添加的一段描述语，<br/>使用的是装饰器 @allure.description""")
def test_description_provide_string():
    assert True

方式二：使用装饰器 @allure.description_html 传递一段 HTML 文本来描述测试用例。

@allure.description_html("""html代码块""")
def test_description_privide_html():
    assert True

方式三：直接在测试用例方法中通过编写文档注释的方法来添加描述。

def test_description_docstring():
    """
    直接在测试用例方法中 </br>
    通过编写文档注释的方法 </br>
    来添加描述。 </br>
    :return:
    """
    assert True

方式四：用例代码内部动态添加描述信息。

import allure

@allure.description("""这个描述将被替换""")
def test_dynamic_description():
    assert 42 == int(6 * 7)
    allure.dynamic.description('这是最终的描述信息')
    # allure.dynamic.description_html(''' html 代码块 ''')