BDD - Python Behave 入门

2023-12-22 18:28
文章标签 python 入门 bdd behave

本文主要是介绍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

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

这篇关于BDD - Python Behave 入门的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/524998。

相关文章

Python函数作用域示例详解

Python函数作用域示例详解

《Python函数作用域示例详解》本文介绍了Python中的LEGB作用域规则,详细解析了变量查找的四个层级,通过具体代码示例,展示了各层级的变量访问规则和特性,对python函数作用域相关知识感兴趣... 目录一、LEGB 规则二、作用域实例2.1 局部作用域（Local）2.2 闭包作用域（Enclos
阅读更多...
Python实现对阿里云OSS对象存储的操作详解

Python实现对阿里云OSS对象存储的操作详解

《Python实现对阿里云OSS对象存储的操作详解》这篇文章主要为大家详细介绍了Python实现对阿里云OSS对象存储的操作相关知识,包括连接,上传,下载,列举等功能,感兴趣的小伙伴可以了解下... 目录一、直接使用代码二、详细使用1. 环境准备2. 初始化配置3. bucket配置创建4. 文件上传到os
阅读更多...
使用Python实现可恢复式多线程下载器

使用Python实现可恢复式多线程下载器

《使用Python实现可恢复式多线程下载器》在数字时代,大文件下载已成为日常操作,本文将手把手教你用Python打造专业级下载器,实现断点续传,多线程加速,速度限制等功能,感兴趣的小伙伴可以了解下... 目录一、智能续传：从崩溃边缘抢救进度二、多线程加速：榨干网络带宽三、速度控制：做网络的好邻居四、终端交互
阅读更多...
Python中注释使用方法举例详解

Python中注释使用方法举例详解

《Python中注释使用方法举例详解》在Python编程语言中注释是必不可少的一部分,它有助于提高代码的可读性和维护性,：本文主要介绍Python中注释使用方法的相关资料,需要的朋友可以参考下... 目录一、前言二、什么是注释？示例：三、单行注释语法：以 China编程# 开头，后面的内容为注释内容示例：示例：四
阅读更多...
Python中win32包的安装及常见用途介绍

Python中win32包的安装及常见用途介绍

《Python中win32包的安装及常见用途介绍》在Windows环境下,PythonWin32模块通常随Python安装包一起安装,：本文主要介绍Python中win32包的安装及常见用途的相关... 目录前言主要组件安装方法常见用途1. 操作Windows注册表2. 操作Windows服务3. 窗口操作
阅读更多...
Python中re模块结合正则表达式的实际应用案例

Python中re模块结合正则表达式的实际应用案例

《Python中re模块结合正则表达式的实际应用案例》Python中的re模块是用于处理正则表达式的强大工具,正则表达式是一种用来匹配字符串的模式,它可以在文本中搜索和匹配特定的字符串模式,这篇文章主... 目录前言re模块常用函数一、查看文本中是否包含 A 或 B 字符串二、替换多个关键词为统一格式三、提
阅读更多...
从入门到精通C++11 ＜chrono＞ 库特性

从入门到精通C++11 ＜chrono＞ 库特性

《从入门到精通C++11＜chrono＞库特性》chrono库是C++11中一个非常强大和实用的库,它为时间处理提供了丰富的功能和类型安全的接口,通过本文的介绍,我们了解了chrono库的基本概念... 目录一、引言1.1 为什么需要<chrono>库1.2<chrono>库的基本概念二、时间段（Durat
阅读更多...
python常用的正则表达式及作用

python常用的正则表达式及作用

《python常用的正则表达式及作用》正则表达式是处理字符串的强大工具,Python通过re模块提供正则表达式支持,本文给大家介绍python常用的正则表达式及作用详解,感兴趣的朋友跟随小编一起看看吧... 目录python常用正则表达式及作用基本匹配模式常用正则表达式示例常用量词边界匹配分组和捕获常用re
阅读更多...
python实现对数据公钥加密与私钥解密

python实现对数据公钥加密与私钥解密

《python实现对数据公钥加密与私钥解密》这篇文章主要为大家详细介绍了如何使用python实现对数据公钥加密与私钥解密,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录公钥私钥的生成使用公钥加密使用私钥解密公钥私钥的生成这一部分，使用python生成公钥与私钥，然后保存在两个文
阅读更多...
python删除xml中的w:ascii属性的步骤

python删除xml中的w:ascii属性的步骤

《python删除xml中的w:ascii属性的步骤》使用xml.etree.ElementTree删除WordXML中w:ascii属性,需注册命名空间并定位rFonts元素,通过del操作删除属... 可以使用python的XML.etree.ElementTree模块通过以下步骤删除XML中的w:as
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2