BDD - Python Behave 入门

BDD - Python Behave 入门

  • Behave 是什么
  • Behave 的主要特点和组成部分
  • Behave 实践
    • 安装 Behave
    • Behave 项目目录结构
    • 创建项目
      • 创建 Feature 文件
      • 创建步骤定义文件
    • 执行用例
      • 执行全部用例
      • 执行部分用例
    • 生成报告
      • 生成 Json report
      • 生成 HTML 报告
      • 生成 Junit report
      • 生成 Cucumber report
      • 生成 Allure 报告

Behave 是什么

Behave 是一个用于 Python 的行为驱动开发(BDD)框架。BDD 是一种敏捷软件开发方法,它促使开发人员、QA(质量保障)团队和非技术利益相关者之间更好地合作,以确保软件开发的最终产物符合预期的行为。

Behave 的 BDD 侧重于从用户的角度出发,关注软件的行为和功能,以一种易于理解的自然语言来描述。Behave 使用 Gherkin 语言来描述软件的功能,该语言是一种用于描述软件行为的业务可读的语言。Gherkin 语言的特点是简洁易懂,非技术人员也能够理解。

Behave 的主要特点和组成部分

Gherkin 语言: Behave 使用 Gherkin 语言描述软件的功能和行为。Gherkin 是一种简单的自然语言,它使用关键字(如 Given、When、Then)来描述场景和行为,这使得非技术人员能够轻松理解和参与。

Feature 文件: Behave 的测试用例以 .feature 文件的形式存在,其中包含了用 Gherkin 语言编写的场景描述。这些文件包含了对软件功能的期望行为和测试用例。

步骤定义: Behave 允许用户使用 Python 编写步骤定义,将 Gherkin 语言中描述的场景映射到实际的测试代码。步骤定义包括 Given、When、Then 等关键字,并通过正则表达式与实际的测试逻辑关联起来。

运行测试: Behave 提供了一个命令行界面,通过该界面可以运行定义的测试用例。测试执行过程中,Behave 将解释 Gherkin 语言的描述,并调用相应的步骤定义执行实际的测试代码。

报告生成: Behave 生成详细的测试报告,其中包含测试用例的执行结果、失败的步骤、日志信息等。这有助于团队追踪测试进度和了解软件的行为是否符合预期。

Behave 实践

官网 Github 和 文档

安装 Behave

pip install behave

或升级 Behave

pip install -U behave

Behave 项目目录结构

最简单的目录结构:
在这里插入图片描述
复杂的目录结构:
注意 Feature 文件 可以按子目录分类,但是步骤定义文件不能按子目录分类,必须统统都在 steps 文件夹中,steps 文件夹的位置跟 Features 目录推荐是兄弟关系比较清晰,也可以是父子关系。

在这里插入图片描述

创建项目

按下面结构来创建 feature 文件和步骤实现,测试计算器的加法。

在这里插入图片描述

创建 Feature 文件

创建一个名为 calculator.feature 的.feature 文件,其中描述了加法功能的场景
这里 calculator2.feature 只是 calculator.feature 的 copy,mock 两个功能吧。

# calculator.featureFeature: Calculator AdditionIn order to verify that the calculator can perform additionAs a userI want to ensure that the addition operation is correctScenario: Add two numbersGiven the calculator is turned onWhen I add 5 and 7Then the result should be 12

创建步骤定义文件

创建一个 Python 文件,用于定义 Gherkin 语言中描述的步骤的实际执行代码。保存为 calculator_steps.py

# calculator_steps.pyfrom behave import given, when, then@given('the calculator is turned on')
def step_calculator_turned_on(context):context.calculator_on = True@when('I add {num1:d} and {num2:d}')
def step_add_numbers(context, num1, num2):context.result = num1 + num2@then('the result should be {expected_result:d}')
def step_check_result(context, expected_result):assert context.result == expected_result, f"Actual result: {context.result}, Expected result: {expected_result}"

执行用例

执行全部用例

打开终端,进入包含 Features 和 Steps 目录的父目录 BDD,并运行以下命令:behave
Behave 将解释 BDD 目录下所有 .feature 文件中的场景,并调用 calculator_steps.py 中定义的步骤执行相应的测试逻辑

PS C:\Automation\Test\BDD> behave
Feature: Calculator Addition # Features/Calculator/calculator.feature:3In order to verify that the calculator can perform additionAs a userI want to ensure that the addition operation is correctScenario: Add two numbers           # Features/Calculator/calculator.feature:8Given the calculator is turned on # steps/calculator_steps.py:5When I add 5 and 7                # steps/calculator_steps.py:9Then the result should be 12      # steps/calculator_steps.py:13Feature: Calculator Addition test # Features/Calculator2/calculator2.feature:3In order to verify that the calculator can perform additionAs a userI want to ensure that the addition operation is correctScenario: Add two numbers test      # Features/Calculator2/calculator2.feature:8Given the calculator is turned on # steps/calculator_steps.py:5When I add 5 and 7                # steps/calculator_steps.py:9Then the result should be 12      # steps/calculator_steps.py:132 features passed, 0 failed, 0 skipped
2 scenarios passed, 0 failed, 0 skipped
6 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.000s

执行部分用例

也可以只运行部分 feature 场景,执行 behave Features/Calculator2
只运行 Features/Calculator2 目录下的用例,Features/Calculator 的用例不会执行。

PS C:\Automation\Test\BDD> behave Features/Calculator2
Feature: Calculator Addition test # Features/Calculator2/calculator2.feature:3In order to verify that the calculator can perform additionAs a userI want to ensure that the addition operation is correctScenario: Add two numbers test      # Features/Calculator2/calculator2.feature:8Given the calculator is turned on # steps/calculator_steps.py:5When I add 5 and 7                # steps/calculator_steps.py:9Then the result should be 12      # steps/calculator_steps.py:131 feature passed, 0 failed, 0 skipped
1 scenario passed, 0 failed, 0 skipped
3 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.000s

生成报告

生成 Json report

执行:behave -f json -o report.json

PS C:\Automation\Test\BDD> behave -f json -o report.json
2 features passed, 0 failed, 0 skipped
2 scenarios passed, 0 failed, 0 skipped
6 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.000s

上述命令将运行 Behave 测试,并将结果输出到当前目录下 report.json 文件中。你可以根据需要更改输出文件的名称。

生成 HTML 报告

如果你希望使用 HTML 报告,你可以考虑使用 behave-html-formatter 插件。
首先,你需要安装该插件:

pip install behave-html-formatter

然后,使用以下命令运行 Behave:behave -f behave_html_formatter:HTMLFormatter -o report.html

PS C:\Automation\Test\BDD> behave -f behave_html_formatter:HTMLFormatter -o report.html
2 features passed, 0 failed, 0 skipped
2 scenarios passed, 0 failed, 0 skipped
6 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.016s

这样就会在当前目录下生成一个名为 report.html 的 HTML 报告文件

在这里插入图片描述

生成 Junit report

执行命令:behave --junit

PS C:\Automation\Test\bdd> behave --junit 
Feature: Calculator Addition # Features/Calculator/calculator.feature:3In order to verify that the calculator can perform additionAs a userI want to ensure that the addition operation is correctScenario: Add two numbers           # Features/Calculator/calculator.feature:8Given the calculator is turned on # steps/calculator_steps.py:5When I add 5 and 7                # steps/calculator_steps.py:9Then the result should be 12      # steps/calculator_steps.py:13
Feature: Calculator Addition 2 # Features/Calculator2/calculator2.feature:3In order to verify that the calculator can perform additionAs a userI want to ensure that the addition operation is correctScenario: Add two numbers 2         # Features/Calculator2/calculator2.feature:8Given the calculator is turned on # steps/calculator_steps.py:5When I add 5 and 7                # steps/calculator_steps.py:9Then the result should be 12      # steps/calculator_steps.py:132 features passed, 0 failed, 0 skipped
2 scenarios passed, 0 failed, 0 skipped
6 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.007s

默认会创建 reports 子目录,生成测试报告。

在这里插入图片描述
当然也可以指定目录,执行命令:behave --junit --junit-directory my_reports

生成 Cucumber report

Behave 本身直接生成 Cucumber 报告的功能是有限的,因为 Cucumber 报告通常与 Gherkin 语法密切相关,而 Behave 使用的是 Gherkin 语法的 Python 版本。

如果你想生成类似 Cucumber 风格的报告,你可以考虑使用 behave2cucumber 工具。该工具能够将 Behave 的 JSON 报告转换为 Cucumber JSON 格式。

以下是使用该工具的步骤:

  1. 安装 behave2cucumber:
pip install behave2cucumber
  1. 运行 Behave 以生成 JSON 报告:
behave -f json -o report.json
  1. 使用 behave2cucumber 工具将 Behave JSON 报告转换为 Cucumber JSON 格式:
python -m behave2cucumber -i report.json -o cucumber_json.json

-i 表示由 behave 生成的测试 json 文件中的输入文件
-o 表示兼容 cucumber json文件的输出文件 cucumber_json

在这里插入图片描述

  1. 利用 jenkins 上的 cucumber reports 插件配置 cucumber json 文件生成 cucumber 报告
    在这里插入图片描述

生成 Allure 报告

对于更漂亮和交互式的报告,你可能需要考虑使用专门的报告生成工具,例如 Allure 或其他定制的报告工具。 Allure 支持 Behave 并提供了漂亮的图形化报告和交互式功能。

以下是使用 Allure 生成漂亮的报告的示例:

  1. 安装 Allure 及 Behave 插件:
pip install allure-behave
  1. 运行 Behave 测试并生成 Allure 报告:
PS C:\Automation\Test\bdd> behave -f allure_behave.formatter:AllureFormatter -o allure-results
2 features passed, 0 failed, 0 skipped
2 scenarios passed, 0 failed, 0 skipped
6 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.000s

当前目录下生成
在这里插入图片描述
3. 生成和查看 Allure 报告:

根据官方 Allure Report installation ,本地安装 Allure

  • 确保安装了Java版本8或更高版本,并且在JAVA_HOME环境变量中指定了它的目录。.
  • 从 latest Allure Report release on GitHub 下载 allure-.zip 或 allure-.tgz.
  • 将下载的压缩文件解压缩到任意目录,Allure 报告现在可以使用 bin/allure 或 bin/allure.bat 脚本运行,具体取决于操作系统。

生成和查看 report 执行命令:allure serve C:\Automation\Test\BDD\allure-results

在这里插入图片描述
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/291720.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

大数据技术基础-读书笔记

大数据技术基础-读书笔记 一、大数据概述 大数据是指在一定时间内无法用常规软件工具对其内容进行抓取、处理、分析和管理的数据集合。 大数据一般会涉及两种以上的数据形式,数据量通常是100TB以上的高速、实时数据流,或者从每年增长速度快的小数据开…

【Docker-5】镜像编排

Dockerfile语法 制作apache镜像 httpd.service 文件路径:/lib/systemd/system/httpd.service [rootdocker-0002 ~]# mkdir apache [rootdocker-0002 ~]# cd apache拷贝动态页面到docker-0002的/root/apache/ [rootecs-proxy ~]# scp /root/5/public/info.php 192.…

js中的Array.from()和Array.of()方法的用法详情

😁 作者简介:一名大四的学生,致力学习前端开发技术 ⭐️个人主页:夜宵饽饽的主页 ❔ 系列专栏:JavaScript小贴士 👐学习格言:成功不是终点,失败也并非末日,最重要的是继续…

Spring Boot学习随笔- 拦截器实现和配置(HandlerInterceptor、addInterceptors)、jar包部署和war包部署

学习视频:【编程不良人】2021年SpringBoot最新最全教程 第十三章、拦截器 拦截器 :Interceptor 拦截 中断 类似于javaweb中的Filter,不过没有Filter那么强大 作用 Spring MVC的拦截器是一种用于在请求处理过程中进行预处理和后处理的机制。拦…

C# SQLite基础工具类

目录 1、安装System.Data.SQLite工具包 2、创建数据库 3、数据库的连接与断开 4、执行一条SQL语句 5、批量执行sql语句 6、返回首行首列值 7、执行sql语句返回datatable 1、安装System.Data.SQLite工具包 2、创建数据库 /// <summary> /// 数据库路径 …

量化交易学习笔记:XGBoost 在量化选股中的应用

一、引言 本篇文章通过借鉴传统机器学习算法——XGBoost——对相同的量价因子进行实验&#xff0c;方便与深度学习模型进行对比实践。 二、算法介绍 XGBoost 是在 Gradient Boosting&#xff08;梯度提升&#xff09;框架下实现的机器学习算法&#xff0c;全称为“极限梯度提…

文献速递:生成对抗网络医学影像中的应用—— CG-3DSRGAN:用于从低剂量PET图像恢复图像质量的分类指导的3D生成对抗网络

文献速递&#xff1a;生成对抗网络医学影像中的应用—— CG-3DSRGAN&#xff1a;用于从低剂量PET图像恢复图像质量的分类指导的3D生成对抗网络 本周给大家分享文献的主题是生成对抗网络&#xff08;Generative adversarial networks, GANs&#xff09;在医学影像中的应用。文献…

Sentinel 流量治理组件教程

前言 官网首页&#xff1a;home | Sentinel (sentinelguard.io) 随着微服务的流行&#xff0c;服务和服务之间的稳定性变得越来越重要。Sentinel 是面向分布式、多语言异构化服务架构的流量治理组件&#xff0c;主要以流量为切入点&#xff0c;从流量路由、流量控制、流量整形…

node实现简单的数据爬虫

前言 我使用的是墨迹天气的页面&#xff0c;因为这个使用的链接简单 页面结构简单并且大都是文字形式 第一步 打开墨迹天气网址 随便点开一个页面 点击F12或者鼠标右键点击检查 查看页面的信息 分析页面内容 使用文字所在的class和标签来定位 编写代码 配置express环境 …

SpringIOC之MethodBasedEvaluationContext

博主介绍&#xff1a;✌全网粉丝5W&#xff0c;全栈开发工程师&#xff0c;从事多年软件开发&#xff0c;在大厂呆过。持有软件中级、六级等证书。可提供微服务项目搭建与毕业项目实战&#xff0c;博主也曾写过优秀论文&#xff0c;查重率极低&#xff0c;在这方面有丰富的经验…

飞天使-k8s知识点7-kubernetes升级

文章目录 验证新版本有没有问题需要安装的版本微微 1.20.6.0kubeadm upgrade plan 验证新版本有没有问题 查看可用版本的包 现有的状态 查看版本 yum list kubeadm --showduplicates |grep 1.20 yum list kubelet --showduplicates |grep 1.20 yum list kubectl --showduplic…

随机森林 2(决策树)

通过 随机森林 1 的介绍&#xff0c;相信大家对随机森林都有了一个初步的认知&#xff0c;知道了随机和森林分别指的是什么&#xff0c;以及决策树根据什么选择内部节点。本文将会从森林深入到树&#xff0c;去看一下决策树是如何构建的。网上很多文章都讲了决策树如何构建&…