在TypeScript项目中配置BDD测试：Cucumber.js实战指南

什么是BDD?

BDD（行为驱动开发）是一种软件团队协作模式，旨在弥合业务人员与技术团队之间的沟通鸿沟，具体通过以下机制实现：

• 促进跨职能角色的深度协作，确保各方对需解决的问题形成统一认知。
• 采用快速、小步迭代的开发节奏，以加速反馈循环并最大化价值交付。
• 自动生成系统文档，并通过自动化手段持续校验系统行为是否符合预期。

实现这一目标的关键在于将协作焦点集中在具体、真实的案例上，这些案例清晰描绘了系统预期的运行状态。利用这些案例作为指导，团队可以在持续的协作中，从概念设计平滑过渡到代码实施。

Gherkin语法

BDD特性（Feature）的描述遵循Gherkin语法规范。Gherkin提供了一套特殊的关键字，为可执行的规范文档赋予结构化的语义。这些关键字支持多语言翻译；在本指南中，我们将统一使用英文关键字。

Cucumber是目前主流的BDD测试框架，支持多种运行平台。在其文档中，绝大多数行都以特定的关键字起始。注释仅允许出现在新行的开头，即Feature文件的任意位置。注释行以零个或多个空格开始，随后是井号（#）及具体的注释文本。（注意：Cucumber目前尚不支持多行区块注释。）

可以使用空格或制表符进行代码缩进，官方建议的缩进标准为两个空格。参考示例如下：

Feature: Guess the word
  # The first example has two steps
  Scenario: Maker starts a game
    When the Maker starts a game
    Then the Maker waits for a Breaker to join
  # The second example has three steps
  Scenario: Breaker joins a game
    Given the Maker has started a game with the word "silky"
    When the Breaker joins the Maker's game
    Then the Breaker must guess a word with 5 characters

关于Gherkin语法的详细规范，可参考官方文档：Gherkin Reference - Cucumber Documentation。

给TypeScript项目配置BDD测试框架Cucumber.js

执行命令yarn add -D @cucumber/cucumber chai以安装BDD测试框架Cucumber.js以及断言框架Chai。

在项目根目录下创建features文件夹，并在其中新建文件bank-account.feature，文件内容如下：

# features/bank-account.feature
Feature: Bank Account
  Scenario: Stores money
    Given A bank account with starting balance of $100
    When $100 is deposited
    Then The bank account balance should be $200

该文档描述了一个存款场景：假设银行存款账户初始余额为100美元，当存入100美元后，账户余额应更新为200美元。

接着创建step-definitions\bank-account.steps.ts文件。

const { Given, Then, When} = require( '@cucumber/cucumber');
const { assert } = require( 'chai');
let accountBalance = 0;
Given('A bank account with starting balance of ${int}', function(amount) {
    accountBalance = amount;
});
When('${int} is deposited', function (amount) {
    accountBalance = Number(accountBalance) + Number(amount);
});
Then('The bank account balance should be ${int}', function(expectedAmount) {
    assert.equal(accountBalance, expectedAmount);
});

我们需要编写对应的测试代码，该代码通过类型系统与Feature文件中的输入输出进行映射。具体而言，Given关键字对应的方法将接收100美元作为初始账户金额，并赋值给变量accountBalance。在When关键字对应的方法中，amount参数将捕获存入的100美元金额。最后，在Then关键字对应的方法中，expectedAmount参数将映射为200美元，用于验证最终余额是否与accountBalance相等。若两者相等，则断言通过；否则，BDD框架将判定该测试用例失败。

我们可以通过以下命令

yarn cucumber-js features\**\*.feature -r step-definitions\**\*.js

来执行测试流程。

为实现自动化配置的简化，可以在工程根目录下创建文件cucumber.js，配置内容如下：

// cucumber.js
let common = [
    'features/**/*.feature', // Specify our feature files
    '--require step-definitions/**/*.js', // Load step definitions
    '--format progress-bar', // Load custom formatter
].join(' ');
module.exports = {
    default: common
};

再次执行命令yarn cucumber-js，此时Cucumber将读取cucumber.js文件中的配置项，自动定位Feature文件和步骤定义脚本，从而完成整个BDD测试流程。

参考：

BDD Testing & Collaboration Tools for Teams | Cucumber

以上就是在TypeScript项目中进行BDD测试的详细内容，更多关于TypeScript项目BDD测试的资料请关注本站其它相关文章！