https://opensource.com/article/18/5/behavior-driven-python
作者 | Andrew Knight
譯者 | Liang Chen (Flowsnow) ???共計翻譯:24.0 篇 貢獻時間:1049 天
使用 Python behave 框架的行為驅動開發樣式可以幫助你的團隊更好的協作和測試自動化。
您是否聽說過行為驅動開發[1](BDD),並好奇這是個什麼東西?也許你發現了團隊成員在談論“嫩瓜”(LCTT 譯註:“嫩瓜” 是一種簡單的英語文字語言,工具 cucumber 透過解釋它來執行測試指令碼,見下文),而你卻不知所云。或許你是一個 Python 人,正在尋找更好的方法來測試你的程式碼。 無論在什麼情況下,瞭解 BDD 都可以幫助您和您的團隊實現更好的協作和測試自動化,而 Python 的 behave[2] 框架是一個很好的起點。
什麼是 BDD?
在軟體中,行為是指在明確定義的輸入、動作和結果場景中功能是如何運轉的。 產品可以表現出無數的行為,例如:
根據產品的行為定義產品的功能可以更容易地描述產品,並對其進行開發和測試。 BDD 的核心是:使行為成為軟體開發的焦點。在開發早期使用示例語言的規範來定義行為。最常見的行為規範語言之一是 Gherkin,Cucumber專案中的Given-When-Then場景格式。 行為規範基本上是對行為如何工作的簡單語言描述,具有一致性和焦點的一些正式結構。 透過將步驟文字“粘合”到程式碼實現,測試框架可以輕鬆地自動化這些行為規範。
下麵是用Gherkin編寫的行為規範的示例:
根據產品的行為定義產品的功能可以更容易地描述產品,開發產品並對其進行測試。 這是BDD的核心:使行為成為軟體開發的焦點。 在開發早期使用示例規範[3]的語言來定義行為。 最常見的行為規範語言之一是Gherkin[4],來自 Cucumber[5] 專案中的 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 的主要優點[6]是良好的協作和自動化。 每個人都可以為行為開發做出貢獻,而不僅僅是程式員。從流程開始就定義並理解預期的行為。測試可以與它們涵蓋的功能一起自動化。每個測試都包含一個單一的、獨特的行為,以避免重覆。最後,現有的步驟可以透過新的行為規範重用,從而產生雪球效果。
Python 的 behave 框架
behave 是 Python 中最流行的 BDD 框架之一。 它與其他基於 Gherkin 的 Cucumber 框架非常相似,儘管沒有得到官方的 Cucumber 定名。 behave 有兩個主要層:
.feature
檔案編寫的行為規範如上例所示,Gherkin 場景有三部分格式:
當 behave 執行測試時,每個步驟由裝飾器“粘合”到 Python 函式。
安裝
作為先決條件,請確保在你的計算機上安裝了 Python 和 pip
。 我強烈建議使用 Python 3.(我還建議使用 pipenv[7],但以下示例命令使用更基本的 pip
。)
behave 框架只需要一個包:
pip install behave
其他包也可能有用,例如:
pip install requests # 用於呼叫 REST API
pip install selenium # 用於 web 瀏覽器互動
GitHub 上的 behavior-driven-Python[8] 專案包含本文中使用的示例。
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
部分都有簡短的描述性標題[9]。Feature
標題後面的行是會被 behave 框架忽略掉的註釋。將功能描述放在那裡是一種很好的做法。Scenario
和 Feature
可以有標簽(註意 @cucumber-basket
標記)用於鉤子和過濾(如下所述)。And
和 But
可以為任何型別新增附加步驟。透過使用場景大綱(Scenario Outline
),場景也可以寫為具有多個輸入組合的模板:
Feature: Cucumber Basket
@cucumber-basket
Scenario Outline: Add cucumbers
Given the basket has “<initial>” cucumbers
When "
" cucumbers are added to the basket
Then the basket contains "
" cucumbers
Examples: Cucumber Counts
| initial | more | total |
| 0 | 1 | 1 |
| 1 | 2 | 3 |
| 5 | 4 | 9 |
場景大綱總是有一個示例(Examples
)表,其中第一行給出列標題,後續每一行給出一個輸入組合。 只要列標題出現在由尖括號括起的步驟中,行值就會被替換。 在上面的示例中,場景將執行三次,因為有三行輸入組合。 場景大綱是避免重覆場景的好方法。
Gherkin 語言還有其他元素,但這些是主要的機制。 想瞭解更多資訊,請閱讀 Automation Panda 這個網站的文章 Gherkin by Example[11] 和 Writing Good Gherkin[12]。
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
可以使用三個步驟匹配器[13]:parse
、cfparse
和 re
。預設的,也是最簡單的匹配器是 parse
,如上例所示。註意如何解析引數化值並將其作為輸入引數傳遞給函式。一個常見的最佳實踐是在步驟中給引數加雙引號。
每個步驟定義函式還接收一個背景關係[14]變數,該變數儲存當前正在執行的場景的資料,例如 feature
、scenario
和 tags
欄位。也可以新增自定義欄位,用於在步驟之間共享資料。始終使用背景關係來共享資料——永遠不要使用全域性變數!
behave 框架還支援鉤子[15]來處理 Gherkin 步驟之外的自動化問題。鉤子是一個將在步驟、場景、功能或整個測試套件之前或之後執行的功能。鉤子讓人聯想到面向方面的程式設計[16]。它們應放在 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[17] 進行構建和清理。
要瞭解一個 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[18] 檔案中。
其他選擇
behave 不是 Python 中唯一的 BDD 測試框架。其他好的框架包括:
任何這些框架都是不錯的選擇。
另外,請記住,Python 測試框架可用於任何黑盒測試,即使對於非 Python 產品也是如此! BDD 框架非常適合 Web 和服務測試,因為它們的測試是宣告性的,而 Python 是一種很好的測試自動化語言[19]。
本文基於作者的 PyCon Cleveland 2018[20] 演講“行為驅動的Python[21]”。
via: https://opensource.com/article/18/5/behavior-driven-python
作者:Andrew Knight[23] 選題:lujun9972 譯者:Flowsnow 校對:wxy
本文由 LCTT 原創編譯,Linux中國 榮譽推出