Python 自动化测试(五): Pytest 结合 Allure 生成测试报告

本文节选自霍格沃玆测试学院测试开发内部教材，进阶学习文末加群！

测试报告在项目中是至关重要的角色，一个好的测试报告：

1. 可以体现测试人员的工作量；
2. 开发人员可以从测试报告中了解缺陷的情况；
3. 测试经理可以从测试报告中看到测试人员的执行情况及测试用例的覆盖率；
4. 项目负责人可以通过测试报告查看整个项目还余留多少问题，此次版本是否测试通过；

所以打造一个美观、一目了然的测试报告，清晰的反应质量问题，并提供给相关人员了解项目的整体状态，是非常必要的。

Pytest 结合 Allure 生成测试报告

Allure 框架是一种灵活的、轻量级、支持多语言测试报告工具，它不仅能够以简洁的 Web
报告形式显示已测试的内容，而且允许参与开发过程的每个人从测试的日常执行中提取最大限度的有用信息。同时支持多种语言包括
Java、Python、JavaScript、Ruby、Groovy、PHP、.Net、 Scala。

安装

Mac 可以使用 brew 安装 allure，安装命令如下：

brew install allure   

其他操作系统请参考：

https://docs.qameta.io/allure/#_installing_a_commandline  

与 pytest 结合需要安装 allure-pytest 插件：

pip install allure-pytest  

查看 Allure 版本：

allure --version  

运行

第一步 ：在 pytest 执行测试的时候，指定参数 --alluredir 选项及结果数据保存的目录，代码如下：

pytest --alluredir=tmp/my_allure_results  

tmp/my_allure_results 中保存了本次测试的结果数据。

第二步 ：打开报告，需要启动 allure 服务，在 terminal 中输入 allure serve [path/to/allure_results]，代码如下：

allure serve path/to/allure_results  

也可以使用 allure generate 生成 HTML 格式的测试结果报告，并使用 allure open 来打开报告。

allure generate ./result/ -o ./report/ --clean  

上面的命令将 ./result/ 目录下的测试数据生成HTML测试报告到 ./report 路径下，-–clean
选项目的是先清空测试报告目录，再生成新的测试报告，然后使用下面的命令打开报告。

allure open -h 127.0.0.1 -p 8883 ./report/   

上面这个命令则会启动一个 Web 服务将已经生成的测试报告打开。打开生成的测试报告，在默认的浏览器打开测试报告，报告如下：

上面的测试报告首页中展示了此次测试的测试用例数量以及成功用例、失败用例、跳过用例的比例、测试环境、SUITES、FEATURES BY STORIES
等基本信息。当与 Jenkins 做了持续置成后，TREND 区域还将显示，历次测试的通过情况。

首页的左边栏，还从不同的维度展示测试报告的其他信息。重点页面介绍：

• Behaviors 页面，按照 FEATURES 和 STORIES 展示测试用例的执行结果；
• Suites 页面，Allure 测试报告将每一个测试脚本，作为一个 Suite。在首页里点击 Suites 区域内的任何一条 Suite，都会进入 Suites 页面；
• Graphs 页面，展示了此次测试结果的统计信息，比如测试用例执行结果状态、测试用例重要等级分布、测试用例执行时间分布等；
• 测试用例详情页面，在 Suites 页面上点击任何一条测试用例，Suites 页面的右侧将展示这条用例的详细执行情况。在这个页面可以看到测试用例的每个步骤，以及每个步骤的执行结果，包括步骤里面添加的链接、图片、网页片段或者视频作为重要信息的补充。在这里可以一目了在的看到用例失败的原因。

实战案例|百度搜索功能自动化测试

在实际项目中，一旦用例报错，我们希望能够将当时应用的状态记录下来，记录这些状态的方式可以是日志、截图、视频等手段，并将这些记录在测试报告中，方便相关人员定位问题。我们基于
Pytest 与 Allure 结合生成测试报告来实现这个目标。

以百度 Web 网页版本测试为例，百度首页呈现的功能：新闻、网页、贴吧、知道、音乐、图片、视频、地图等，我们以百度网页的搜索功能为例， 使用
Allure、pytest 结合 Selenium 自动化测试框架，完成一个搜索功能的测试 。

为了模拟百度搜索功能场景，这里需要创建两个文件，数据文件与用例文件。首先创建数据管理文件 data/data.yml，代码如下：

- allure  
- pytest  
- unittest  

然后，创建用例文件名为 test_baidudemo.py，代码如下：

#!/usr/bin/env python  
# -*- coding: utf-8 -*-  
  
import allure  
import pytest  
import yaml  
from selenium import webdriver  
import time  
  
@allure.testcase("http://www.github.com")  
@allure.feature("百度搜索")  
@pytest.mark.parametrize('test_data1', yaml.safe_load(\  
open("data/data.yml")))  
def test_steps_demo(test_data1):  
    with allure.step("打开百度网页"):  
        driver = webdriver.Chrome()  
        driver.get("http://www.baidu.com")  
        driver.maximize_window()  
  
    with allure.step(f"输入搜索词：{test_data1}"):  
        driver.find_element_by_id("kw").send_keys(test_data1)  
        time.sleep(2)  
        driver.find_element_by_id("su").click()  
        time.sleep(2)  
  
    with allure.step("保存图片"):  
        driver.save_screenshot("./result/b.png")  
        allure.attach.file("./result/b.png", \  
        attachment_type=allure.attachment_type.PNG)  
    with allure.step("关闭浏览器"):  
        driver.quit()  

代码解析：

• allure.testcase 用例标识，给定用例的链接，可以与用例的管理地址关联。
• allure.feature 功能模块划分，方便管理和运行测试用例。
• pytest.mark.parametrize 用来参数化测试用例。
• allure.step 用来添加测试步骤，在测试报告里面会展示出来这个步骤说明。

执行：

 pytest test_baidudemo.py -s -q --alluredir=./result/  
  
 allure serve ./result/  

测试结果图：

上面的测试报告展示运行时间，时长，用例数，通过率，以及测试套件 SUITES，环境等信息。

点击左侧栏最下方的 Package
可以看到所有的测试用例以及测试数据，点击一条用例右侧会展示出用例的优先级，数据，测试步骤以及每个步骤的的名称及附加的图片等信息。这里添加了一个测试用例的链接，可以与测试用例的管理链接关联起来，方便后期统计覆盖率。

另外，pytest 与 Allure 也可以与 Jenkins
集成，实现自动化测试的持续集成。更多测试开发实战进阶技巧，
来霍格沃兹测试开发学社，学习更多软件测试与测试开发的进阶技术，知识点涵盖web自动化测试 app自动化测试、接口自动化测试、测试框架、性能测试、安全测试、持续集成/持续交付/DevOps，测试左移、测试右移、精准测试、测试平台开发、测试管理等内容，课程技术涵盖bash、pytest、junit、selenium、appium、postman、requests、httprunner、jmeter、jenkins、docker、k8s、elk、sonarqube、jacoco、jvm-sandbox等相关技术，全面提升测试开发工程师的技术实力

点击获取更多信息