企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
在Python 语言中进行BDD的规格和测试文件的编写的时候,常常会遇到下面的概念: * Fixture : 测试设施。设定测试环境的预设状态或值的机制。 * Background: 背景。所有场景的公共部分。 * Scenario: 场景。 * Given : 前置条件 * When: 用户操作 * Then:预期结果 ## 规格文件 pytest-bdd 和Behave 是Python中比较流行的BDD 框架,两种使用的规格文件基本类型,规格文件都是以 .feature结尾,一个需求文件中只能有一个Feature字段,可以包含多个Scenario(用户场景)。 Given->When->Then类似于准备->执行->验证/清理的流程。 * Given:一般可以用来做预置条件/数据准备,下面第一个And也属于Given。 * When下面的And都属于When, 一般是操作步骤。 * Then: 一般用于验证结果(断言),也可以进行清理数据。 ## Fixture 测试设施 在软件测试中,"Fixture" 是一种设定测试环境的预设状态或值的机制。通常为了某个测试或一组测试,需要一些预设的对象、文件或数据库等等。如何设置和管理这些预设状态就是 "Fixture" 的作用,它通常用来初始化测试环境,或者在每次测试完成后进行清理。 考虑到这个功能,有些中文翻译可能会把 "Fixture" 翻译为 **"固件"** 或 **"前置条件" **或 **"测试设施"**。然而,这通常还需要结合上下文具体理解。在很多开发文档或技术讨论中,也常常直接使用英文 "Fixture"。 在 BDD 和测试中,Fixture 是设置给定环境或编写 "Given" 步骤所需的一项工作。可以把它看作是一个重复使用的预设条件,使你能够用一致的环境运行测试。这些预设条件可能涉及各种各样的事情,比如创建数据库、初始化变量、创建类的实例,或者运行特定的命令等。 在 pytest,这些 fixtures 是用 @pytest.fixture 装饰器声明的 Python 函数。例如: ``` @pytest.fixture def client(): from myapp import MyClient return MyClient() ``` 这个 client fixture 可以在测试函数、类或模块中通过参数 re-use。 ``` def test_get_data(client): data = client.get_data() assert data is not None ``` 在 pytest-bdd 中,fixture 的使用方式非常相似,但支持为步骤 (given, when, then) 设置 fixture,使在 BDD 测试中更容易设置和共享上下文。 举个例子: ``` from pytest_bdd import given, scenario, then, when import pytest @scenario('calculations.feature', 'Adding numbers') def test_add(): pass @pytest.fixture def calc(): return Calculator() @given('I have a calculator', target_fixture='calculator') def i_have_a_calculator(calc): return calc @when('I add <number1> and <number2>') def add_numbers(calculator, number1, number2): calculator.add(int(number1), int(number2)) @then('I should get <result>') def get_result(calculator, result): assert calculator.result == int(result) ``` 在这个例子中, * @pytest.fixture 注解的 calc()方法创建了一个 Calculator 类的实例 * `@given('I have a calculator', target_fixture='calculator')` 的作用是 返回一个名为“calculator”的fixture(即测试用例执行前需要准备的对象或数据)。这个fixture可以在之后的测试步骤中被引用和使用。 使用这种方式的好处是在 BDD 的步骤中更容易地重用和共享设置和数据。同时,它也可以帮助你分离你的测试代码,使得它们更加模块化和易维护。 ## Background 是什么? 在 BDD 中,`Background`关键字用于定义在执行每个场景时都需要执行的步骤。通常,这些步骤用于设置初始条件或预设环境。换句话说,它是需要在每个场景开始之前运行的给定(`Given`)步骤。 以下是一个例子,演示如何在 Background 中设置初始的环境状态: ~~~ Feature: 乘坐地铁 Background: Given 我有一张有效的地铁卡 Scenario: 乘坐地铁 When 我刷地铁卡 Then 旋转门应该打开 Scenario: 余额不足 Given 我的卡余额是0 When 我刷地铁卡 Then 旋转门不会打开 ~~~ 在这个示例中,`Background`包含了一个 "Given 我有一张有效的地铁卡" 的步骤。这意味着在执行每个场景 "乘坐地铁" 和 "余额不足" 之前,测试始终会先执行这个步骤。 `Background`的目的是帮助减少测试场景之间的重复,并传达对所有场景都有效的前提条件。但需要注意的是,过度使用`Background`可能会使测试复杂化和难以理解,特别是在`Background`中有很多步骤或它们的效果不明显时。 ## Fixture 和 Background 的区别 `Fixture`和`Background`都是在开启测试前设置预期环境或状态的工具,但它们在用途和功能上有所区别,用在不同的场景。 * **Fixture**:在 pytest 和许多其他测试框架中,fixture 是设置测试环境的一种工具,它为测试提供了需要的初识状态或值。可以把 pytest fixture 理解为设置给定环境或预设需要的工作,它可以创建对象、连接数据库、开启服务器或其他任何为了测试需要预先设定的操作。Fixture 可以被多个测试用例重复使用,从而避免代码的重复。 * **Background**:在 Gherkin 语言(被许多 BDD 框架,如 Cucumber 和 behave 使用)中,Background 是一个特殊的场景,它在包含它的`Feature`中的每个`Scenario`或`Scenario Outline`开始前运行。我们可以把 Background 理解成作为每个场景前提的共享步骤。**背景的目标是为了消除场景之间的冗余**。 它们的区别主要在于: * Background 是 BDD 中 Gherkin 语法的一部分,用于描述在每个测试场景开始时的共享行为, * 而 Fixture 是 pytest 测试中的一个概念,它更倾向于代码层面,负责进行一些设置和清理工作。 Background 和Fixture 也可以一起使用。例如,在 Given 步骤中使用`fixture`去实现在`Background`中描述的行为。 ``` Feature: 乘坐地铁 Background: Given 我有一张有效的地铁卡 ``` 对应的`Given`实现可能如下: ``` @given("我有一张有效的地铁卡", target_fixture="card") def have_subway_card(): return SubwayCard(is_valid=True) ``` 在这个例子中,`have_subway_card`就是一个 fixture,它在`Background`描述的`Given`步骤中被使用。 ## Scenario 用户场景 在行为驱动开发(Behavior-Driven Development,BDD)中,`Scenario`是描述一个特定功能如何在特定情境下工作的方法,或者说是描述功能如何被使用的故事。每个`Scenario`是一个完整的可测试的用户故事。 `Scenario`通常使用 "Given-When-Then" 的格式描述,这种格式可以清晰地阐述环境条件、行为和期望结果。每个`Scenario`应该是自足并可以单独运行。 以下是一个例子: ``` Scenario: User login with correct username and password Given a user has been registered with username "user1" and password "pass1" When the user login with username "user1" and password "pass1" Then the login should be successful ``` 在这个例子中: * `Given`步骤设定了开始条件,即已经有一个注册用户 "user1",其密码是 "pass1"。 * `When`步骤描述了用户尝试使用正确的用户名和密码登录的行为。 * `Then`步骤描述了期望的结果,即登录应该成功。 * 每个`Scenario`开始都是独立的,不依赖于其他`Scenario`,每个`Scenario`均应清理其测试环境,以确保不会影响其他测试。这就是所谓的测试原子性。 * `Scenario`是 BDD 的核心部分,它帮助我们将抽象的需求转化为具体、可执行和可验证的测试。 ***** *****