Pytest-Bdd-Playwright 系列教程（11）：场景快捷方式

前言

• 在 Pytest-Bdd 中，场景是构成测试用例的核心部分。通常情况下，我们需要通过 @scenario 装饰器将测试函数与特定的场景绑定。当项目规模扩大时，多个 feature 文件及场景的存在可能会导致手动绑定场景变得冗长、繁琐；
• 场景快捷方式（scenarios 函数）正是为了解决这一问题而设计的。它允许我们通过递归方式，自动绑定指定路径下的所有场景，从而极大地提升测试开发效率。

1. 手动绑定场景的传统方法

在介绍场景快捷方式之前，我们先来看一下传统的手动绑定方式是如何实现的。

假设有一个名为 features/some.feature 的文件，内容如下：

要手动绑定 Valid login 场景，我们可以使用以下代码：

虽然这种方法直观且容易理解，但当 feature 文件较多时，每个场景都需要手动绑定，代码量迅速增加，不利于维护。

2. 场景快捷方式的自动绑定方法

为了简化上述流程，Pytest-Bdd 提供了 scenarios 函数。通过它，您可以自动绑定指定路径下的所有场景，无需逐一手动声明。

2.1 绑定所有场景

假设项目的目录结构如下：

project/
├── features/
│   ├── login.feature
│   ├── signup.feature
├── tests/
│   ├── test_login.py

我们可以通过以下方式绑定 features 文件夹中的所有场景：

# pytest.ini
[pytest]
bdd_features_base_dir = features/

# test_login.py
from pytest_bdd import scenarios

# 自动绑定 'features' 文件夹中的所有场景
scenarios('')

这段代码将递归搜索 features 文件夹下的所有 .feature 文件，并将其中的场景绑定为测试用例。这不仅减少了代码量，还能确保测试覆盖率的一致性。

2.2 绑定多个路径

如果项目中有多个 feature 文件夹或文件需要绑定，也可以直接传递多个路径：

# pytest.ini
[pytest]
bdd_features_base_dir = features/

# test_login.py
from pytest_bdd import scenarios

# 同时绑定多个路径
scenarios('login.feature', 'signup.feature')

这种方式非常灵活，适合复杂项目的场景管理需求。

2.3 自动与手动绑定的结合

在某些情况下，我们可能希望对部分场景进行手动绑定，同时对其他场景使用自动绑定。这在需要自定义测试函数名、参数化测试用例或增加日志记录时尤为常见。

Pytest-Bdd 支持这种混合绑定方式，只需确保在调用 scenarios 之前完成手动绑定。例如：

# pytest.ini
[pytest]
bdd_features_base_dir = features/

# test_login.py
from pytest_bdd import scenario, scenarios

# 手动绑定某个场景
@scenario('some.feature', 'Valid login')
def test_valid_login():
    pass

# 自动绑定 'features' 文件夹中的其他场景
scenarios('features')

在这种模式下，test_valid_login 场景保持手动绑定，而 features 文件夹中的其他场景则会通过 scenarios 函数自动绑定。这种方法可以根据需求灵活调整场景绑定策略。

3. 示例：结合 Playwright 的实际应用

3.1 项目目录结构

project/
├── features/
│   ├── login.feature
│   ├── signup.feature
├── pages/
│   ├── login_page.py
│   ├── signup_page.py
├── tests/
│   ├── test_auth.py

3.2 代码实现

features/login.feature

Feature: User login
    Scenario: Valid login
        Given the user navigates to the login page
        When the user enters valid credentials
        Then the user is redirected to the dashboard

pages/login_page.py

from playwright.sync_api import Page

class LoginPage:
    def __init__(self, page: Page):
        self.page = page

    def navigate(self):
        self.page.goto("https://example.com/login")

    def login(self, username: str, password: str):
        self.page.fill("input#username", username)
        self.page.fill("input#password", password)
        self.page.click("button#login")

tests/test_auth.py

from pytest_bdd import scenarios, given, when, then
from pages.login_page import LoginPage

# 自动绑定所有场景
scenarios('')

@given("the user navigates to the login page")
def navigate_to_login_page(page):
    login_page = LoginPage(page)
    login_page.navigate()

@when("the user enters valid credentials")
def enter_credentials(page):
    login_page = LoginPage(page)
    login_page.login("test_user", "secure_password")

@then("the user is redirected to the dashboard")
def verify_dashboard(page):
    assert page.url == "https://example.com/dashboard"

pytest.ini

[pytest]
bdd_features_base_dir = features/

4. 使用场景快捷方式的优势

4.1 减少重复代码

通过自动绑定，可以大幅减少重复的装饰器声明，提升代码的可读性和简洁性。尤其是在场景数量较多时，优势尤为明显。

4.2 提高开发效率

手动绑定需要开发人员逐一检查每个 feature 文件及场景，而 scenarios 函数能够自动完成这一过程，节省了大量时间。

4.3 保证一致性

由于 scenarios 函数会递归处理所有场景，不容易遗漏特定场景，能够保证测试覆盖的一致性。

总结

场景快捷方式功能是 Pytest-Bdd 提供的一项极为实用的工具，适合需要处理大量场景的测试项目。通过自动绑定场景，可以有效减少重复代码、提高开发效率，并保证测试覆盖的一致性。