在TypeScript項目中進行BDD測試

2022 年 4 月 2 日
筆記
Typescript & Node.js

在TypeScript項目中進行BDD測試

什麼是BDD?

BDD(Behavior-Driven Design)是軟體團隊的一種工作方式，通過以下方式縮小業務人員和技術人員之間的差距：

鼓勵跨角色協作，建立對待解決問題的共同理解
以快速、小迭代的方式工作，以增加回饋和價值流
生成系統文檔，自動對照系統行為進行檢查

我們通過將協作工作的重點放在具體的、真實的例子上來實現這一點，這些例子說明了我們希望系統如何運行。我們用這些例子來指導我們在持續合作的過程中從概念到實施。

Gherkin語法

BDD特性(Feature)描述採用Gherkin語法。Gherkin使用一組特殊的關鍵字為可執行規範提供結構和意義。每個關鍵詞都被翻譯成多種語言；在本參考資料中，我們將使用英語。

Cucumber是流行的BDD測試框架，支援各種平台，其文檔中的大多數行都以一個關鍵字開頭。
注釋僅允許出現在新行的開頭，即要素文件中的任何位置。它們以零個或多個空格開頭，後跟散列符號（#）和一些文本。(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和斷言(Assert)框架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);
});
```
我們需要創建與之對應的測試程式碼，程式碼將通過類型與特性文件中輸入和輸出驗證進行映射，其中Given對應的方法將獲得100美金初始賬戶金額的映射，傳給accountBalance。在When對應的方法中，amount測試會獲得存入100美金的金額映射。最後，在Then對應的方法中expectedAmount會映射到200美金，用來驗證最後是否與accountBalance相等，如果相等斷言正常返回，否則BDD判斷測試Case失敗。
我們可以通過命令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.js文件中的配置項，會自動找到feature文件和步驟定義腳本文件，完成BDD測試工作。

參考：

BDD Testing & Collaboration Tools for Teams | Cucumber

Tags: Typescript & Node.js