pytest系列——allure（四）之在测试用例添加描述（@allure.description()）

前言

allure支持往测试报告中对测试用例添加非常详细的描述语用来描述测试用例详情；这对阅读测试报告的人来说非常的友好，可以清晰的知道每个测试用例的详情。

allure添加描述的三种方式：

• 使用装饰器@allure.description，传递一个字符串参数来描述测试用例。
• 使用装饰器@allure.description_html，传递一段HTML文本，这将在测试报告的“Description”部分渲染出来。
• 直接在测试用例方法中通过编写文档注释的方法来添加描述。

实例

# file_name: test_description.py


import pytest
import allure


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

@allure.description_html("""
Test with some complicated html description

  

    
Name
    
Age
    
Sex
  
  

    
lwjnicole
    
28
    
男
  
  

    
nicole
    
29
    
女
  

""")
def test_description_privide_html():
    assert True


def test_description_docstring():
    """
    这是通过文本注释的方式添加的描述语

    同样支持多行描述

    大家好，我是lwjnicole
    :return:
    """
    assert True


if __name__ == '__main__':
    pytest.main(['-s', 'test_description.py'])

执行命令：

> pytest test_description.py --alluredir=./report/result_data

> allure serve ./report/result_data

1、查看测试报告展示效果【下面的测试报告显示的是通过装饰器@allure.description传递字符串参数来添加描述语的方式】：

2、查看测试报告展示效果【 下面的测试报告显示的是通过装饰器@allure.description_html传递一段HTML文本来添加描述语的方式，这段HTML会渲染在报告的"Description"部分】：

3、查看测试报告展示效果【 下面的测试报告显示的是通过直接在测试用例方法中编写文档注释来添加描述语的方式】：

allure动态更新描述语(allure.dynamic.description)：

# file_name: test_description.py


import pytest
import allure


@allure.description("这是更新前的描述语，在使用allure.dynamic.description后将会被更新成新的描述语")
def test_dynamic_description():
    assert True
    allure.dynamic.description("这是通过使用allure.dynamic.description更新后的描述语")


if __name__ == '__main__':
    pytest.main(['-s', 'test_description.py'])

执行命令：

> pytest test_description.py --alluredir=./report/result_data

> allure serve ./report/result_data

查看测试报告展示效果【从下面的测试报告中可以看到，Description中展示的是使用allure.dynamic.description更新后的描述语；而不是allure.description传递的那一段字符串描述语】：

我这里给你们分享一下我所积累和真理的文档和学习资料有需要是领取就可以了

1、学习思路和方法

这个大纲涵盖了目前市面上企业百分之99的技术，这个大纲很详细的写了你该学习什么内容，企业会用到什么内容。总共十个专题足够你学习

2、想学习却无从下手，该如何学习？

这里我准备了对应上面的每个知识点的学习资料、可以自学神器，已经项目练手。

3、软件测试/自动化测试【全家桶装】学习中的工具、安装包、插件....

4、有了安装包和学习资料，没有项目实战怎么办，我这里都已经准备好了往下看

最后送上一句话：
世界的模样取决于你凝视它的目光，自己的价值取决于你的追求和心态，一切美好的愿望，不在等待中拥有，而是在奋斗中争取。
如果我的博客对你有帮助、如果你喜欢我的文章内容，请 “点赞” “评论” “收藏” 一键三连哦！