標籤：

什麼是行為驅動的 Python？

03-01

使用 Python behave 框架的行為驅動開發模式可以幫助你的團隊更好的協作和測試自動化。

您是否聽說過 行為驅動開發(behavior-driven development)（BDD），並好奇這是個什麼東西？也許你發現了團隊成員在談論「嫩瓜」（LCTT 譯註：「 嫩瓜(gherkin)」 是一種簡單的英語文本語言，工具 cucumber 通過解釋它來執行測試腳本，見下文），而你卻不知所云。或許你是一個 Python 人(Pythonista)，正在尋找更好的方法來測試你的代碼。 無論在什麼情況下，了解 BDD 都可以幫助您和您的團隊實現更好的協作和測試自動化，而 Python 的 behave 框架是一個很好的起點。

什麼是 BDD？

在軟體中，行為是指在明確定義的輸入、動作和結果場景中功能是如何運轉的。 產品可以表現出無數的行為，例如：

  • 在網站上提交表單
  • 搜索想要的結果
  • 保存文檔
  • 進行 REST API 調用
  • 運行命令行界面命令

根據產品的行為定義產品的功能可以更容易地描述產品，並對其進行開發和測試。 BDD 的核心是：使行為成為軟體開發的焦點。在開發早期使用示例語言的規範來定義行為。最常見的行為規範語言之一是 Gherkin，Cucumber項目中的Given-When-Then場景格式。 行為規範基本上是對行為如何工作的簡單語言描述，具有一致性和焦點的一些正式結構。 通過將步驟文本「粘合」到代碼實現，測試框架可以輕鬆地自動化這些行為規範。

下面是用Gherkin編寫的行為規範的示例：

根據產品的行為定義產品的功能可以更容易地描述產品，開發產品並對其進行測試。 這是BDD的核心：使行為成為軟體開發的焦點。 在開發早期使用示例規範的語言來定義行為。 最常見的行為規範語言之一是Gherkin，來自 Cucumber 項目中的 Given-When-Then 場景格式。 行為規範基本上是對行為如何工作的簡單語言描述，具有一致性和聚焦點的一些正式結構。 通過將步驟文本「粘合」到代碼實現，測試框架可以輕鬆地自動化這些行為規範。

下面是用 Gherkin 編寫的行為規範的示例：

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

快速瀏覽一下，行為是直觀易懂的。 除少數關鍵字外，該語言為自由格式。 場景簡潔而有意義。 一個真實的例子說明了這種行為。 步驟以聲明的方式表明應該發生什麼——而不會陷入如何如何的細節中。

BDD 的主要優點是良好的協作和自動化。 每個人都可以為行為開發做出貢獻，而不僅僅是程序員。從流程開始就定義並理解預期的行為。測試可以與它們涵蓋的功能一起自動化。每個測試都包含一個單一的、獨特的行為，以避免重複。最後，現有的步驟可以通過新的行為規範重用，從而產生雪球效果。

Python 的 behave 框架

behave 是 Python 中最流行的 BDD 框架之一。 它與其他基於 Gherkin 的 Cucumber 框架非常相似，儘管沒有得到官方的 Cucumber 定名。 behave 有兩個主要層：

  1. 用 Gherkin 的 .feature 文件編寫的行為規範
  2. 用 Python 模塊編寫的步驟定義和鉤子，用於實現 Gherkin 步驟

如上例所示，Gherkin 場景有三部分格式：

  1. 鑒於（Given）一些初始狀態
  2. 每當（When）行為發生時
  3. 然後（Then）驗證結果

當 behave 運行測試時，每個步驟由裝飾器「粘合」到 Python 函數。

安裝

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

behave 框架只需要一個包：

pip install behave

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

pip install requests # 用於調用 REST API
pip install selenium # 用於 web 瀏覽器交互

GitHub 上的 behavior-driven-Python 項目包含本文中使用的示例。

Gherkin 特點

behave 框架使用的 Gherkin 語法實際上是符合官方的 Cucumber Gherkin 標準的。.feature 文件包含了功能（Feature）部分，而場景部分又包含具有 Given-When-Then 步驟的場景（Scenario） 部分。 以下是一個例子：

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 部分都有簡短的描述性標題。
  • 緊跟在 Feature 標題後面的行是會被 behave 框架忽略掉的注釋。將功能描述放在那裡是一種很好的做法。
  • Scenario 和 Feature 可以有標籤（注意 @cucumber-basket 標記）用於鉤子和過濾（如下所述）。
  • 步驟都遵循嚴格的 Given-When-Then 順序。
  • 使用 And 和 But 可以為任何類型添加附加步驟。
  • 可以使用輸入對步驟進行參數化——注意雙引號里的值。

通過使用場景大綱（Scenario Outline），場景也可以寫為具有多個輸入組合的模板：

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 |

場景大綱總是有一個示例（Examples）表，其中第一行給出列標題，後續每一行給出一個輸入組合。 只要列標題出現在由尖括弧括起的步驟中，行值就會被替換。 在上面的示例中，場景將運行三次，因為有三行輸入組合。 場景大綱是避免重複場景的好方法。

Gherkin 語言還有其他元素，但這些是主要的機制。 想了解更多信息，請閱讀 Automation Panda 這個網站的文章 Gherkin by Example 和 Writing Good Gherkin。

Python 機制

每個 Gherkin 步驟必須「粘合」到步驟定義——即提供了實現的 Python 函數。 每個函數都有一個帶有匹配字元串的步驟類型裝飾器。它還接收共享的上下文和任何步驟參數。功能文件必須放在名為 features/ 的目錄中，而步驟定義模塊必須放在名為 features/steps/ 的目錄中。 任何功能文件都可以使用任何模塊中的步驟定義——它們不需要具有相同的名稱。 下面是一個示例 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

可以使用三個步驟匹配器：parse、cfparse 和 re。默認的，也是最簡單的匹配器是 parse，如上例所示。注意如何解析參數化值並將其作為輸入參數傳遞給函數。一個常見的最佳實踐是在步驟中給參數加雙引號。

每個步驟定義函數還接收一個上下文變數，該變數保存當前正在運行的場景的數據，例如 feature、scenario 和 tags 欄位。也可以添加自定義欄位，用於在步驟之間共享數據。始終使用上下文來共享數據——永遠不要使用全局變數！

behave 框架還支持鉤子來處理 Gherkin 步驟之外的自動化問題。鉤子是一個將在步驟、場景、功能或整個測試套件之前或之後運行的功能。鉤子讓人聯想到面向方面的編程。它們應放在 features/ 目錄下的特殊 environment.py 文件中。鉤子函數也可以檢查當前場景的標籤，因此可以有選擇地應用邏輯。下面的示例顯示了如何使用鉤子為標記為 @web 的任何場景生成和銷毀一個 Selenium WebDriver 實例。

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 進行構建和清理。

要了解一個 behave 項目應該是什麼樣子，這裡是示例項目的目錄結構：

任何 Python 包和自定義模塊都可以與 behave 框架一起使用。 使用良好的設計模式構建可擴展的測試自動化解決方案。步驟定義代碼應簡明扼要。

運行測試

要從命令行運行測試，請切換到項目的根目錄並運行 behave 命令。 使用 -help 選項查看所有可用選項。

以下是一些常見用例：

# 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

為方便起見，選項可以保存在 config 文件中。

其他選擇

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

  • pytest-bdd，是 pytest 的插件，和 behave 一樣，它使用 Gherkin 功能文件和步驟定義模塊，但它也利用了 pytest 的所有功能和插件。例如，它可以使用 pytest-xdist 並行運行 Gherkin 場景。 BDD 和非 BDD 測試也可以與相同的過濾器一起執行。pytest-bdd 還提供更靈活的目錄布局。
  • radish 是一個 「Gherkin 增強版」框架——它將場景循環和前提條件添加到標準的 Gherkin 語言中，這使得它對程序員更友好。它還像 behave 一樣提供了豐富的命令行選項。
  • lettuce 是一種較舊的 BDD 框架，與 behave 非常相似，在框架機制方面存在細微差別。然而，GitHub 最近顯示該項目的活動很少（截至2018 年 5 月）。

任何這些框架都是不錯的選擇。

另外，請記住，Python 測試框架可用於任何黑盒測試，即使對於非 Python 產品也是如此！ BDD 框架非常適合 Web 和服務測試，因為它們的測試是聲明性的，而 Python 是一種很好的測試自動化語言。

本文基於作者的 PyCon Cleveland 2018 演講「行為驅動的Python」。

via: opensource.com/article/

作者：Andrew Knight 選題：lujun9972 譯者：Flowsnow 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出


推薦閱讀：

TAG:驅動程序 | Python | 驅動程序開發 |