深度解析：Allure报告如何提升你的测试效率？

Allure 简介与安装

• Allure 是由 Java 语⾔开发的⼀个轻量级，灵活的测试报告⼯具。
• Allure 多平台的 Report 框架。
• Allure ⽀持多语⾔，包括 python、JaveScript、PHP、Ruby 等。
• 可以为开发/测试/管理等人员提供详尽的的测试报告，包括测试类别、测试步骤、日志、图片、视频等。
• 可以为管理层提供高水准的统计报告。
• 可以集成到 Jenkins 生成在线的趋势汇总报告。

安装步骤：

1. 安装 Java，环境变量配置教程。
2. 安装 Allure 环境变量配置教程
3. 安装插件：pip install allure-pytest。
4. 环境验证：allure -- version

Allure 用法

方法名	方法参数	参数说明
@allure.epic()	epic 描述	敏捷里面的概念，定义史诗，往下是 feature
@allure.feature()	模块名称	功能点的描述，往下是 story
@allure.story()	用户故事	用户故事，往下是 title
@allure.title(用例的标题)	用例的标题	重命名 html 报告名称
@allure.step()	操作步骤	测试用例的步骤
@allure.testcase()	测试用例的链接地址	对应功能测试用例系统里面的 case
@allure.issue()	缺陷	对应缺陷管理系统里面的链接
@allure.description()	用例描述	测试用例的描述
@allure.severity()	用例等级	blocker，critical，normal，minor，trivial
@allure.link()	链接	定义一个链接，在测试报告展现
@allure.attachment()	附件	报告添加附件

Allure 报告生成

Allure 命令行语法格式如下：

allure[option] [command] [commandoptions]

生成报告的两种方式

方式一：在线报告，会直接打开默认浏览器展示当前报告。

# 方式一：测试完成后查看实际报告，在线查看报告，会直接打开默认浏览器展示当前报告。
allureserve./result/(注意这里的serve书写)
# Java
allureservetarget/allure-results(注意这里的serve书写)

方式二：应用场景：如果希望随时打开报告，可以生成一个静态资源文件报告，将这个报告布署到 web 服务器上，启动 web 服务，即可随时随地打开报告。

解决方案：使用allure generate 生成带有 index.html 的结果报告。这种方式需要两个步骤：

• 第一步：生成报告。
• 第二步：打开报告。

  # 生成报告
  allure generate ./result (allure结果)
  # 打开报告
  allure open ./report/ (报告位置)

Allure 添加用例标题、步骤

用例标题

• 通过使用装饰器 @allure.title 可以为测试用例自定义一个可阅读性的标题。
• allure.title 的三种使用方式：

1. 直接使用 @allure.title 为测试用例自定义标题。
2. @allure.title 支持通过占位符的方式传递参数，可以实现测试用例标题参数化，动态生成测试用例标题。
3. allure.dynamic.title 动态更新测试用例标题。

# 方式一:
@allure.title("自定义标题")
def test_title():
    assert True
# 方式二：通过占位符的方式传递参数，可以实现测试用例标题参数化，动态生成测试用例标题。
@allure.title("参数化用例标题：参数一：{param1} ，参数二：{param2}")
@pytest.mark.parametrize("param1, param2, expected", [
    (1, 1, 2),
    (0.1, 0.3, 0.4)
])
def test_with_parametrize_title(param1, param2, expected):
    assert param1 + param2 == expected

# 方式三：动态更新测试用例标题。
@allure.title("原始标题")
def test_with_dynamic_title():
    assert True
    allure.dynamic.title("更改后的新标题")

用例步骤

Allure 支持两种方法：

• 方法一：使用装饰器定义一个测试步骤，在测试用例中使用。
• 方法二：使用 with allure.step() 添加测试步骤。

Allure 添加图片

• 应用场景：在做 UI 自动化测试时，可以将页面截图，或者出错的页面进行截图，将截图添加到测试报告中展示，辅助定位问题。
• 解决方案：使用以下两种方式添加图片。

allure.attach.file 方法

• 语法：allure.attach.file(source, name, attachment_type, extension)，参数解释：
  • source：文件路径，相当于传一个文件。
  • name：附件名字。
  • attachment_type：附件类型，是 allure.attachment_type 其中的一种(支持 PNG、JPG、BMP、GIF 等)。
  • extension：附件的扩展名。

class TestWithAttach:
    def test_pic(self):
        allure.attach.file("pic.png",
                           name="图片",
                           attachment_type=allure.attachment_type.PNG,
                           extension="png")

allure.attach 方法

• 语法：allure.attach(body, name=None, attachment_type=None, extension=None):，参数解释：
  • body：要写入附件的内容
  • name：附件名字。
  • attachment_type：附件类型，是 allure.attachment_type 其中的一种(支持 PNG、JPG、BMP、GIF 等)。
  • extension：附件的扩展名。

class TestWithAttach:
    def test_pic2(self):
        with open("./img/logo.png",mode="rb") as f :
            file = f.read()
            allure.attach(file,"页面截图",allure.attachment_type.PNG)

Allure 添加日志

• 日志展示在 Test body 标签下，标签下可展示多个子标签代表不同的日志输出渠道：
• • log 子标签：展示日志信息。
  • stdout 子标签：展示 print 信息。
  • stderr 子标签：展示终端输出的信息。
• 禁用日志，可以使用命令行参数控制 --allure-no-capture

总结

• 添加商品测试用例设计、用例编写和断言
• Allure 测试报告定制

获取更多软件测试知识