[[246386]]

使用 Python behave 框架的行為驅(qū)動(dòng)開(kāi)發(fā)模式可以幫助你的團(tuán)隊(duì)更好的協(xié)作和測(cè)試自動(dòng)化。

您是否聽(tīng)說(shuō)過(guò)行為驅(qū)動(dòng)開(kāi)發(fā)behavior-driven development（BDD），并好奇這是個(gè)什么東西？也許你發(fā)現(xiàn)了團(tuán)隊(duì)成員在談?wù)?ldquo;嫩瓜”（LCTT 譯注：“嫩瓜gherkin” 是一種簡(jiǎn)單的英語(yǔ)文本語(yǔ)言，工具 cucumber 通過(guò)解釋它來(lái)執(zhí)行測(cè)試腳本，見(jiàn)下文），而你卻不知所云?；蛟S你是一個(gè) Python 人Pythonista，正在尋找更好的方法來(lái)測(cè)試你的代碼。 無(wú)論在什么情況下，了解 BDD 都可以幫助您和您的團(tuán)隊(duì)實(shí)現(xiàn)更好的協(xié)作和測(cè)試自動(dòng)化，而 Python 的 behave 框架是一個(gè)很好的起點(diǎn)。

什么是 BDD？

在軟件中，行為是指在明確定義的輸入、動(dòng)作和結(jié)果場(chǎng)景中功能是如何運(yùn)轉(zhuǎn)的。 產(chǎn)品可以表現(xiàn)出無(wú)數(shù)的行為，例如：

• 在網(wǎng)站上提交表單
• 搜索想要的結(jié)果
• 保存文檔
• 進(jìn)行 REST API 調(diào)用
• 運(yùn)行命令行界面命令

根據(jù)產(chǎn)品的行為定義產(chǎn)品的功能可以更容易地描述產(chǎn)品，并對(duì)其進(jìn)行開(kāi)發(fā)和測(cè)試。 BDD 的核心是：使行為成為軟件開(kāi)發(fā)的焦點(diǎn)。在開(kāi)發(fā)早期使用示例語(yǔ)言的規(guī)范來(lái)定義行為。最常見(jiàn)的行為規(guī)范語(yǔ)言之一是 Gherkin，Cucumber項(xiàng)目中的Given-When-Then場(chǎng)景格式。 行為規(guī)范基本上是對(duì)行為如何工作的簡(jiǎn)單語(yǔ)言描述，具有一致性和焦點(diǎn)的一些正式結(jié)構(gòu)。 通過(guò)將步驟文本“粘合”到代碼實(shí)現(xiàn)，測(cè)試框架可以輕松地自動(dòng)化這些行為規(guī)范。

下面是用Gherkin編寫的行為規(guī)范的示例：

根據(jù)產(chǎn)品的行為定義產(chǎn)品的功能可以更容易地描述產(chǎn)品，開(kāi)發(fā)產(chǎn)品并對(duì)其進(jìn)行測(cè)試。 這是BDD的核心：使行為成為軟件開(kāi)發(fā)的焦點(diǎn)。 在開(kāi)發(fā)早期使用示例規(guī)范的語(yǔ)言來(lái)定義行為。 最常見(jiàn)的行為規(guī)范語(yǔ)言之一是Gherkin，來(lái)自 Cucumber 項(xiàng)目中的 Given-When-Then 場(chǎng)景格式。 行為規(guī)范基本上是對(duì)行為如何工作的簡(jiǎn)單語(yǔ)言描述，具有一致性和聚焦點(diǎn)的一些正式結(jié)構(gòu)。 通過(guò)將步驟文本“粘合”到代碼實(shí)現(xiàn)，測(cè)試框架可以輕松地自動(dòng)化這些行為規(guī)范。

下面是用 Gherkin 編寫的行為規(guī)范的示例：

Scenario: Basic DuckDuckGo Search
  Given the DuckDuckGo home page is displayed
  When the user searches for "panda"
  Then results are shown for "panda"

快速瀏覽一下，行為是直觀易懂的。 除少數(shù)關(guān)鍵字外，該語(yǔ)言為自由格式。 場(chǎng)景簡(jiǎn)潔而有意義。 一個(gè)真實(shí)的例子說(shuō)明了這種行為。 步驟以聲明的方式表明應(yīng)該發(fā)生什么——而不會(huì)陷入如何如何的細(xì)節(jié)中。

BDD 的主要優(yōu)點(diǎn)是良好的協(xié)作和自動(dòng)化。 每個(gè)人都可以為行為開(kāi)發(fā)做出貢獻(xiàn)，而不僅僅是程序員。從流程開(kāi)始就定義并理解預(yù)期的行為。測(cè)試可以與它們涵蓋的功能一起自動(dòng)化。每個(gè)測(cè)試都包含一個(gè)單一的、獨(dú)特的行為，以避免重復(fù)。***，現(xiàn)有的步驟可以通過(guò)新的行為規(guī)范重用，從而產(chǎn)生雪球效果。

Python 的 behave 框架

behave 是 Python 中***的 BDD 框架之一。 它與其他基于 Gherkin 的 Cucumber 框架非常相似，盡管沒(méi)有得到官方的 Cucumber 定名。 behave 有兩個(gè)主要層：

1. 用 Gherkin 的 .feature 文件編寫的行為規(guī)范
2. 用 Python 模塊編寫的步驟定義和鉤子，用于實(shí)現(xiàn) Gherkin 步驟

如上例所示，Gherkin 場(chǎng)景有三部分格式：

1. 鑒于（Given）一些初始狀態(tài)
2. 每當(dāng)（When）行為發(fā)生時(shí)
3. 然后（Then）驗(yàn)證結(jié)果

當(dāng) behave 運(yùn)行測(cè)試時(shí)，每個(gè)步驟由裝飾器“粘合”到 Python 函數(shù)。

安裝

作為先決條件，請(qǐng)確保在你的計(jì)算機(jī)上安裝了 Python 和 pip。 我強(qiáng)烈建議使用 Python 3.（我還建議使用 pipenv，但以下示例命令使用更基本的 pip。）

behave 框架只需要一個(gè)包：

pip install behave

其他包也可能有用，例如：

pip install requests    # 用于調(diào)用 REST API
pip install selenium    # 用于 web 瀏覽器交互

GitHub 上的 behavior-driven-Python 項(xiàng)目包含本文中使用的示例。

Gherkin 特點(diǎn)

behave 框架使用的 Gherkin 語(yǔ)法實(shí)際上是符合官方的 Cucumber Gherkin 標(biāo)準(zhǔn)的。.feature 文件包含了功能（Feature）部分，而場(chǎng)景部分又包含具有 Given-When-Then 步驟的場(chǎng)景（Scenario） 部分。 以下是一個(gè)例子：

Feature: Cucumber Basket
  As a gardener,
  I want to carry many cucumbers in a basket,
  So that I don’t drop them all.
 
  @cucumber-basket
  Scenario: Add and remove cucumbers
    Given the basket is empty
    When "4" cucumbers are added to the basket
    And "6" more cucumbers are added to the basket
    But "3" cucumbers are removed from the basket
    Then the basket contains "7" cucumbers

這里有一些重要的事情需要注意：

• Feature 和 Scenario 部分都有簡(jiǎn)短的描述性標(biāo)題。
• 緊跟在 Feature 標(biāo)題后面的行是會(huì)被 behave 框架忽略掉的注釋。將功能描述放在那里是一種很好的做法。
• Scenario 和 Feature 可以有標(biāo)簽（注意 @cucumber-basket 標(biāo)記）用于鉤子和過(guò)濾（如下所述）。
• 步驟都遵循嚴(yán)格的 Given-When-Then 順序。
• 使用 And 和 But 可以為任何類型添加附加步驟。
• 可以使用輸入對(duì)步驟進(jìn)行參數(shù)化——注意雙引號(hào)里的值。

通過(guò)使用場(chǎng)景大綱（Scenario Outline），場(chǎng)景也可以寫為具有多個(gè)輸入組合的模板：

Feature: Cucumber Basket
 
  @cucumber-basket
  Scenario Outline: Add cucumbers
    Given the basket has “<initial>” cucumbers
    When "<more>" cucumbers are added to the basket
    Then the basket contains "<total>" cucumbers
 
    Examples: Cucumber Counts
      | initial | more | total |
      |    0    |   1  |   1   |
      |    1    |   2  |   3   |
      |    5    |   4  |   9   |

場(chǎng)景大綱總是有一個(gè)示例（Examples）表，其中***行給出列標(biāo)題，后續(xù)每一行給出一個(gè)輸入組合。 只要列標(biāo)題出現(xiàn)在由尖括號(hào)括起的步驟中，行值就會(huì)被替換。 在上面的示例中，場(chǎng)景將運(yùn)行三次，因?yàn)橛腥休斎虢M合。 場(chǎng)景大綱是避免重復(fù)場(chǎng)景的好方法。

Gherkin 語(yǔ)言還有其他元素，但這些是主要的機(jī)制。 想了解更多信息，請(qǐng)閱讀 Automation Panda 這個(gè)網(wǎng)站的文章 Gherkin by Example 和 Writing Good Gherkin。

Python 機(jī)制

每個(gè) Gherkin 步驟必須“粘合”到步驟定義——即提供了實(shí)現(xiàn)的 Python 函數(shù)。 每個(gè)函數(shù)都有一個(gè)帶有匹配字符串的步驟類型裝飾器。它還接收共享的上下文和任何步驟參數(shù)。功能文件必須放在名為 features/ 的目錄中，而步驟定義模塊必須放在名為 features/steps/ 的目錄中。 任何功能文件都可以使用任何模塊中的步驟定義——它們不需要具有相同的名稱。 下面是一個(gè)示例 Python 模塊，其中包含 cucumber basket 功能的步驟定義。

from behave import *
from cucumbers.basket import CucumberBasket
 
@given('the basket has "{initial:d}" cucumbers')
def step_impl(context, initial):
    context.basket = CucumberBasket(initial_count=initial)
 
@when('"{some:d}" cucumbers are added to the basket')
def step_impl(context, some):
    context.basket.add(some)
 
@then('the basket contains "{total:d}" cucumbers')
def step_impl(context, total):
    assert context.basket.count == total

可以使用三個(gè)步驟匹配器：parse、cfparse 和 re。默認(rèn)的，也是最簡(jiǎn)單的匹配器是 parse，如上例所示。注意如何解析參數(shù)化值并將其作為輸入?yún)?shù)傳遞給函數(shù)。一個(gè)常見(jiàn)的***實(shí)踐是在步驟中給參數(shù)加雙引號(hào)。

每個(gè)步驟定義函數(shù)還接收一個(gè)上下文變量，該變量保存當(dāng)前正在運(yùn)行的場(chǎng)景的數(shù)據(jù)，例如 feature、scenario 和 tags 字段。也可以添加自定義字段，用于在步驟之間共享數(shù)據(jù)。始終使用上下文來(lái)共享數(shù)據(jù)——永遠(yuǎn)不要使用全局變量！

behave 框架還支持鉤子來(lái)處理 Gherkin 步驟之外的自動(dòng)化問(wèn)題。鉤子是一個(gè)將在步驟、場(chǎng)景、功能或整個(gè)測(cè)試套件之前或之后運(yùn)行的功能。鉤子讓人聯(lián)想到面向方面的編程。它們應(yīng)放在 features/ 目錄下的特殊 environment.py 文件中。鉤子函數(shù)也可以檢查當(dāng)前場(chǎng)景的標(biāo)簽，因此可以有選擇地應(yīng)用邏輯。下面的示例顯示了如何使用鉤子為標(biāo)記為 @web 的任何場(chǎng)景生成和銷毀一個(gè) Selenium WebDriver 實(shí)例。

from selenium import webdriver
 
def before_scenario(context, scenario):
    if 'web' in context.tags:
        context.browser = webdriver.Firefox()
        context.browser.implicitly_wait(10)
 
def after_scenario(context, scenario):
    if 'web' in context.tags:
        context.browser.quit()

注意：也可以使用 fixtures 進(jìn)行構(gòu)建和清理。

要了解一個(gè) behave 項(xiàng)目應(yīng)該是什么樣子，這里是示例項(xiàng)目的目錄結(jié)構(gòu)：

任何 Python 包和自定義模塊都可以與 behave 框架一起使用。 使用良好的設(shè)計(jì)模式構(gòu)建可擴(kuò)展的測(cè)試自動(dòng)化解決方案。步驟定義代碼應(yīng)簡(jiǎn)明扼要。

運(yùn)行測(cè)試

要從命令行運(yùn)行測(cè)試，請(qǐng)切換到項(xiàng)目的根目錄并運(yùn)行 behave 命令。 使用 -help 選項(xiàng)查看所有可用選項(xiàng)。

以下是一些常見(jiàn)用例：

# run all tests
behave
 
# run the scenarios in a feature file
behave features/web.feature
 
# run all tests that have the @duckduckgo tag
behave --tags @duckduckgo
 
# run all tests that do not have the @unit tag
behave --tags ~@unit
 
# run all tests that have @basket and either @add or @remove
behave --tags @basket --tags @add,@remove

為方便起見(jiàn)，選項(xiàng)可以保存在 config 文件中。

其他選擇

behave 不是 Python 中唯一的 BDD 測(cè)試框架。其他好的框架包括：

• pytest-bdd，是 pytest 的插件，和 behave 一樣，它使用 Gherkin 功能文件和步驟定義模塊，但它也利用了 pytest 的所有功能和插件。例如，它可以使用 pytest-xdist 并行運(yùn)行 Gherkin 場(chǎng)景。 BDD 和非 BDD 測(cè)試也可以與相同的過(guò)濾器一起執(zhí)行。pytest-bdd 還提供更靈活的目錄布局。
• radish 是一個(gè) “Gherkin 增強(qiáng)版”框架——它將場(chǎng)景循環(huán)和前提條件添加到標(biāo)準(zhǔn)的 Gherkin 語(yǔ)言中，這使得它對(duì)程序員更友好。它還像 behave 一樣提供了豐富的命令行選項(xiàng)。
• lettuce 是一種較舊的 BDD 框架，與 behave 非常相似，在框架機(jī)制方面存在細(xì)微差別。然而，GitHub 最近顯示該項(xiàng)目的活動(dòng)很少（截至2018 年 5 月）。

任何這些框架都是不錯(cuò)的選擇。

另外，請(qǐng)記住，Python 測(cè)試框架可用于任何黑盒測(cè)試，即使對(duì)于非 Python 產(chǎn)品也是如此！ BDD 框架非常適合 Web 和服務(wù)測(cè)試，因?yàn)樗鼈兊臏y(cè)試是聲明性的，而 Python 是一種很好的測(cè)試自動(dòng)化語(yǔ)言。