Pytest-Bdd-Playwright 系列教程(16):标准化JSON报告&Gherkin格式命令行报告

Pytest-Bdd-Playwright 系列教程(16):标准化JSON报告&Gherkin格式命令行报告

前言

  • 在自动化测试中,生成详细、易于理解的报告是非常重要的,尤其是当我们使用行为驱动开发(BDD)方法时;
  • pytest-bdd与Cucumber标准兼容,可以生成多种格式的测试报告,帮助团队更高效地沟通和协作;
  • 本文将介绍如何使用pytest-bdd生成标准化的JSON报告,并展示如何在命令行终端使用Gherkin格式进行报告输出。

一、创建Feature文件

在项目中,创建一个features/login_demo.feature文件,内容如下:

gherkin 复制代码
Feature: 用户登录功能

  Scenario: 用户使用正确的凭证登录
    Given 用户已打开登录页面
    When 用户输入有效的用户名和密码
    Then 用户应该成功登录并看到主页

二、创建步骤定义文件

为每个步骤编写步骤定义,创建一个tests/test_login_demo.py文件,内容如下:

python 复制代码
from pytest_bdd import given, when, then, scenario

@given('用户已打开登录页面')
def open_login_page():
    print("打开登录页面")

@when('用户输入有效的用户名和密码')
def input_credentials():
    print("输入有效的用户名和密码")

@then('用户应该成功登录并看到主页')
def verify_login():
    print("验证用户成功登录并看到主页")


@scenario('login_demo.feature', '用户使用正确的凭证登录')
def test_login():
    pass

三、生成Cucumber格式的JSON报告

为了便于后续的报告分析和展示,Pytest-BDD支持将测试结果以Cucumber JSON格式输出。通过以下命令,可以将报告输出到指定路径:

bash 复制代码
pytest ./tests/test_login_demo.py --cucumberjson=report.json

该命令会将所有场景展平(即将场景大纲展开为多个具体场景)并生成一个标准的Cucumber格式的JSON报告。

解析JSON报告

生成的JSON报告文件包含了每个场景的执行结果,可以进一步用于集成到CI/CD工具中,如Jenkins。报告内容通常包括每个测试步骤的状态、执行时间等信息。

下面是生成的JSON报告内容:

四、使用Gherkin格式的命令行报告

除了生成JSON格式的报告,Pytest-BDD还支持在命令行中使用Gherkin格式输出结果。为了让报告更加简洁且易于理解,可以使用--gherkin-terminal-reporter选项。

配置

要启用 --gherkin-terminal-reporter,可以将其添加到你的 pytest 配置文件(pytest.ini)中的 [pytest] 部分:

text 复制代码
[pytest]
addopts = 
	 -vs 
	 --gherkin-terminal-reporter

或者,我们可以在命令行中运行 pytest 时使用该选项,使用-vs选项可以进一步增加输出的详细信息:

bash 复制代码
pytest ./tests/test_login_demo.py -vs --gherkin-terminal-reporter

此命令将以Gherkin格式在终端中显示每个场景的执行结果。

注:pytest-sugar 的输出会干扰 --gherkin-terminal-reporter 的格式化效果,单独使用 --gherkin-terminal-reporter以避免干扰。

五、将BDD报告集成到Jenkins中

Jenkins作为常见的持续集成工具,支持通过插件将BDD报告集成到构建过程。

我们可以使用JUnit插件来显示测试结果;

或者使用Cucumber Reports插件来处理Cucumber格式的JSON报告。

总结

通过使用pytest-bdd,我们可以生成清晰、标准化的测试报告。无论是Cucumber格式的JSON报告,还是命令行中的Gherkin格式输出,pytest-bdd都能满足不同场景下的需求。将这些报告与持续集成工具(如Jenkins)结合使用,可以进一步提高团队的协作效率和测试反馈的及时性。

相关推荐
微笑伴你而行2 小时前
目标检测如何将同时有方形框和旋转框的json/xml标注转为txt格式
xml·目标检测·json
cdcdhj4 小时前
数据库存储大量的json文件怎么样高效的读取和分页,利用文件缓存办法不占用内存
缓存·node.js·json
Z_z在努力10 小时前
【杂类】JSON:现代Web开发的数据交换基石
json
上官浩仁1 天前
springboot jackson json入门与实战
java·spring boot·json
GISBox1 天前
GISBox矢量服务使用指南:从数据导入到服务发布
react.js·json·gis
Dxy12393102162 天前
Python如何处理非标准JSON
开发语言·python·json
IAM四十二2 天前
Android Json 解析你还在用 fastjson 吗?
android·json·fastjson
程序员小远2 天前
基于jmeter+perfmon的稳定性测试记录
自动化测试·软件测试·python·测试工具·jmeter·职场和发展·测试用例
{⌐■_■}2 天前
【JavaScript】读取商品页面中的结构化数据(JSON-LD),在不改动服务端情况下,实现一对一跳转
开发语言·javascript·json
绿豆_13142 天前
playwright+python UI自动化测试中实现图片颜色和像素对比
自动化测试·python·opencv·计算机视觉·playwirght