博客

初学者指南：如何使用 Python 开发 BDD 项目

初学者指南：如何使用 Python 开发 BDD 项目

在软件测试领域，行为驱动开发（Behavior-Driven Development，BDD）是一种日益流行的方法。BDD 主张使用面向业务的自然语言（Gherkin）来描述测试场景，使测试用例更加可读，并有助于开发、测试人员及业务方的协作。在 Python 中，我们可以借助 pytest-bdd ，将 BDD 的理念融入到流行的测试框架 Pytest 中，从而更加轻松地编写、组织和维护自动化测试。

本文将带领你快速上手 pytest-bdd 的基本概念与用法，包括项目目录结构、编写测试用例步骤，以及使用标签与 Hooks 等高级特性。

什么是 pytest-bdd？

pytest-bdd 是基于 Pytest 的 BDD 插件，它允许你用 Gherkin 格式的文件（.feature 文件）编写测试场景。Gherkin 使用自然语言的关键词（Given、When、Then 等）描述软件的行为，使测试用例更易懂、可维护。通过与 Pytest 无缝整合，你可以充分利用 Pytest 的丰富生态（如强大的断言、插件和标记功能），并让测试编写人员和非技术人员都能轻松阅读和理解测试内容。

pytest-bdd 的优势包括：

  • Gherkin 语法集成：支持在 .feature 文件中使用功能（Feature）、场景（Scenario）、假如（Given）、当（When）、那么（Then）等关键字描述需求和行为。
  • 与 Pytest 无缝融合： 可以直接利用 Pytest 的生态系统，包括插件、标记和参数化功能。
  • 灵活的实现方式：既可以通过常规步骤定义直接编写测试步骤，也可以根据业务逻辑灵活添加标签（tags），针对不同场景定制化执行策略。

项目基本结构

一个典型的 pytest-bdd 项目目录结构通常如下：

project_name/
├── features/
│   ├── feature1.feature   # 功能描述文件
├── steps/
│   ├── test_feature1.py   # 对应步骤实现文件
├── conftest.py            # 配置与 Hooks

项目结构

1. features 文件夹

features 文件夹内存放 Gherkin 格式的 .feature 文件，每个文件定义一个或多个功能（Feature）及其中的场景（Scenario）。

例如 feature1.feature：

# language: zh-CN
功能: 登录功能
  为了确保应用程序正常运行
  作为一个软件测试人员
  我希望通过自动化测试验证关键功能

  场景: 用户可以成功登录
    假如用户位于登录页面
    当用户输入用户名 "test_user" 和密码 "secure_password"
    那么用户应该看到欢迎信息 "欢迎回来，test_user！"

在这个示例中，When 和 Then 的步骤中使用了参数（如用户名、密码和欢迎信息），这些参数会动态传递给测试步骤的实现函数。

2. steps 文件夹

steps 文件夹内存放步骤定义文件，这些文件中通过 pytest-bdd 的装饰器（@given、@when、@then）实现与 .feature 文件中步骤的关联。

例如 test_feature1.py：

from pytest_bdd import scenarios, given, when, then, parsers

# 加载对应的 feature 文件
scenarios("../features/feature1.feature")

@given("用户位于登录页面")
def go_to_login_page():
    print("打开登录页面")

@when(parsers.parse('用户输入用户名 "{username}" 和密码 "{password}"'))
def enter_credentials(username, password):
    print(f"输入用户名: {username}")
    print(f"输入密码: {password}")

@then(parsers.parse('用户应该看到欢迎信息 "{welcome_message}"'))
def verify_login(welcome_message):
    print(f"验证欢迎信息: {welcome_message}")
  • 参数（如 {username}、{password} 和 {welcome_message}）是从 .feature 文件中提取的动态数据。
  • 在步骤定义函数中，参数会作为函数的参数传入，可用于验证逻辑或模拟实际操作。

3. conftest.py

conftest.py 是 Pytest 的配置文件，用于定义共享的 fixture、环境变量或 Hooks 函数（如在场景运行前后自动执行某些操作）。通过 conftest.py，你可以在项目级别上统一管理测试运行时的行为。例如：

import pytest

@pytest.fixture
def setup_environment():
    print("设置测试环境")

场景运行与标签使用

在缺省实现下，直接运行 pytest 命令即可发现并执行 features 文件夹下的所有场景。你也可以使用标签（Tags）来灵活选择执行特定的场景或功能，以便对特定测试集进行分组和过滤。

下面是一个带有标签的例子（假设文件名为 math.feature）：

# language: zh-CN
@math
功能: 加法
  为了避免一些愚蠢的错误
  作为一个数学白痴
  我希望有人告诉我数字相加的结果

  场景: 两个数相加
    假如我已经在计算器里输入6
    而且我已经在计算器里输入7
    当我按 "相加"按钮
    那么我应该在屏幕上看到的结果是13

  场景大纲: 三个数相加
    假如我已经在计算器里输入<数据1>
    而且我已经在计算器里输入<数据2>
    而且我已经在计算器里输入<数据3>
    当我按"<操作按钮>"按钮
    那么我应该在屏幕上看到的结果是<结果>

    例子:
      | 数据1 | 数据2 | 数据3 | 操作按钮 | 结果 |
      | 12   | 2    | 3    | 相加     | 17  |

运行时可以使用 pytest -m math 来仅执行带有 @math 标签的场景。此外，如果你使用了 CukeTest 工具，也可以通过 CukeTest 的运行配置（cuke --tags @math）来执行带有特定标签的用例。

Hooks 设置

pytest-bdd 提供了若干 Hooks，让你在运行场景前后自动执行特定逻辑。例如：

# conftest.py
import pytest
from pytest_bdd import scenarios

def pytest_bdd_before_scenario(request, feature, scenario):
    if "foo" in scenario.tags:
        print("执行带有 @foo 标签的场景之前的操作")

# 根据需求，你可以定义不同的Hooks执行逻辑

通过对标签与 Hooks 的组合使用，可以在测试场景执行前后实现环境准备、登录预置条件、清理操作等个性化需求。

运行报告

默认情况下，Pytest-bdd 测试运行完成后，会在命令行中以文本模式显示测试结果。你可以通过指定参数（如 --json）将结果以 JSON 格式导出，然后再对 JSON 数据进行自定义解析与图形化展示。以下是一个 Pytest-bdd 自动化工具（如 CukeTest）生成的可视化报告示意图：

报告示例

总结

通过 pytest-bdd，你可以在 Python 环境中轻松实践行为驱动开发（BDD），将自然语言的场景描述无缝集成到自动化测试中。这种方法不仅能让测试用例更贴近业务需求，还能有效促进团队之间的沟通与协作。随着社区支持的不断增强，例如 VS Code 插件等工具的加持，pytest-bdd 的开发体验也在持续优化。

CukeTest：更便捷的 Pytest-bdd 开发工具

在众多 BDD 工具中，CukeTest 是一款不可错过的选择。它内置对 pytest-bdd 的支持，同时提供了中文剧本的兼容性、丰富的模板和示例，让开发变得更加高效且便捷。

CukeTest 的特点：

  • Gherkin 和 Pytest-bdd 支持：包括对中文剧本的支持，提升了本地化测试的便利性。
  • 多样化的测试报告：支持生成 HTML、JSON、PDF 和 Word 格式的报告，方便分享和分析。
  • 丰富的模板：丰富的模板和示例让初学者能够快速上手。
  • 直观的用户界面：可视化管理剧本文件、测试步骤和运行报告。
  • 多种自动化能力：支持 Web、桌面、移动应用和 API 的自动化测试。
  • 跨平台支持：适用于各种操作系统（Windows、Linux、Mac，以及国产操作系统），并兼容多种 CPU 架构（x86/AMD64、ARM、MIPS、LoongArch 等）。

借助 CukeTest，初学者能够迅速上手 BDD 开发，而经验丰富的测试工程师也可以利用其强大的自动化能力和管理工具，显著提升开发和测试效率。

如果你对使用 Pytest-bdd 或 CukeTest 有任何疑问或心得，欢迎在评论区留言讨论！我们期待与你交流更多经验。 😊

文件导航