BDD實(shí)現(xiàn)方式

相信大部分的人都聽說(shuō)過(guò) BDD，即：行為驅(qū)動(dòng)開發(fā)，但并未涉及到它的使用方和項(xiàng)目實(shí)戰(zhàn)。

所以，本篇文章將大家全面了解 BDD 及實(shí)現(xiàn)方式，最后使用 Python BDD 框架落地到實(shí)際項(xiàng)目中去。

1. BDD 及優(yōu)勢(shì)

BDD，行為驅(qū)動(dòng)開發(fā)是 敏捷軟件開發(fā) 的一種技術(shù)，鼓勵(lì)軟件項(xiàng)目的所有成員之間的相互協(xié)助

傳統(tǒng)的軟件開發(fā)方式主要缺點(diǎn)包含：測(cè)試用例比較單一，導(dǎo)致覆蓋率不高；業(yè)務(wù)和產(chǎn)品不能夠全面了解產(chǎn)品的行為表現(xiàn)

BDD 的出現(xiàn)主要優(yōu)勢(shì)有下面 2 點(diǎn)，主要體現(xiàn)在：

• 可以很好的減少項(xiàng)目成員之間的溝通成本，增加協(xié)作
• BDD 能夠?qū)⑸暇€之后的手工測(cè)試轉(zhuǎn)換為自動(dòng)化測(cè)試，提升測(cè)試效率

2. 軟件開發(fā)流程

BDD 一般在產(chǎn)品需求文檔審核時(shí)就開始介入，產(chǎn)品或業(yè)務(wù)負(fù)責(zé)人提供產(chǎn)品需求文檔的同時(shí)，會(huì)提供具體的業(yè)務(wù)場(chǎng)景行為

開發(fā)人員根據(jù)定義的行為場(chǎng)景，開發(fā)軟件，并編寫場(chǎng)景下面的測(cè)試代碼

完成 BDD 先在本地進(jìn)行自測(cè)，沒(méi)問(wèn)題之后會(huì)提交到代碼倉(cāng)庫(kù)，最后通過(guò) CI 去持續(xù)集成，測(cè)試通過(guò)之后才能上線

BDD 的軟件開發(fā)流程圖如下：

3. Gherkin 語(yǔ)言及 Features

Gherkin 是 BDD 框架 Cucumber 的功能性語(yǔ)言，能夠通過(guò)自然語(yǔ)言，支持多國(guó)語(yǔ)言，描述一個(gè)具體的需求

Gherkin 語(yǔ)言使用的是主要英文關(guān)鍵詞包含：Scenario、Given、when 、And、Then 等；這些關(guān)鍵詞可以轉(zhuǎn)換成中文關(guān)鍵詞，比如：場(chǎng)景、加入、當(dāng)、那么等。

Features 功能文件一般命名為：*.feature，此文件可以編寫具體的需求行為，最后可以支持自動(dòng)化測(cè)試

功能文件的編寫規(guī)范如下：

• 空格或者制表符用于縮進(jìn)
• 每一行以 BDD 框架中預(yù)設(shè)的關(guān)鍵字開頭
• 使用 # 符號(hào)在文件內(nèi)進(jìn)行注釋
• 無(wú)論是中文或英文編寫，「 : 」符號(hào)只能用英文格式的冒號(hào)，否則運(yùn)行的時(shí)候會(huì)報(bào)錯(cuò)

下面是一個(gè)簡(jiǎn)單的功能文件，描述的是兩個(gè)數(shù)相加的邏輯：

# 功能文件（英文）
Feature: Adding
    Scenario: Adding two numbers
    Given the input "1+1"
    When the calculator is run
    Then output should be "2"

4. Behave

Behave 是 Python 的 BDD 框架，并且可以使用命令行工具進(jìn)行測(cè)試，使用 pip 可以很方便地進(jìn)行安裝

# 安裝 behave 框架
pip3 install behave

編寫完功能文件之后，就可以使用 behave 命令直接運(yùn)行了

# 直接運(yùn)行，控制臺(tái)查看結(jié)果
behave

# 以中文來(lái)運(yùn)行測(cè)試
behave --lang=zh-CN

5. 實(shí)戰(zhàn)一下

下面以自動(dòng)化測(cè)試 Google 搜索為例，來(lái)說(shuō)說(shuō)具體的使用方式

第 1 步，編寫 Features 文件，以中文為例

使用 behave --lang-help zh-CN 命令查看所有的中文關(guān)鍵字：

接著，利用這些關(guān)鍵字結(jié)合具體行為，編寫的 Feature 文件如下：

功能: Google搜索模塊測(cè)試
  場(chǎng)景大綱: Google搜索一個(gè)關(guān)鍵字功能
      假如 搜索框輸入一個(gè)關(guān)鍵字  keyword >
        當(dāng) 點(diǎn)擊搜索按鈕
        那么 頁(yè)面標(biāo)題應(yīng)該為 < title >
      例子:
          |   keyword  |   title    |
          |   Python   |   Python - Google 搜索       |
          |   AirPython |   AirPython - Google 搜索   |

需要注意的是，文件中定義了兩個(gè)參數(shù)，即：keyword 和 title

實(shí)際項(xiàng)目中大部分的自動(dòng)化測(cè)試都是基于數(shù)據(jù)驅(qū)動(dòng)參數(shù)化，因此需要搭配「 場(chǎng)景大綱+例子」一起使用。

第 2 步，編寫 step 文件

在 Features 同級(jí)目錄下新建一個(gè) steps 文件夾，接著，在此文件夾下再新建一個(gè) step.py 文件

然后，就可以對(duì)照第 1 步編寫的 Features 文件編寫測(cè)試用例了

借助 @given、@when、@then 裝飾器，將文本內(nèi)容和參數(shù)對(duì)應(yīng)上

最后，使用 Selenium 定義的 API 方法操作元素即可

from time import sleep
from selenium.webdriver.common.keys import Keys
from behave import *


@given(u'搜索框輸入一個(gè)關(guān)鍵字 {keyword}')
def step_impl(context, keyword):
    element_input = context.driver.find_element_by_name('q')
    element_input.clear()
    print("準(zhǔn)備輸入")
    element_input.send_keys(keyword)


@when(u'點(diǎn)擊搜索按鈕')
def step_impl(context):
    # 模擬Enter鍵
    context.driver.find_element_by_name("q").send_keys(Keys.ENTER)

    sleep(1)


@then(u'頁(yè)面標(biāo)題應(yīng)該為 {title}')
def step_impl(context, title):
    assert context.driver.title == title

需要指出的是，方法名中的第一個(gè)參數(shù) context 是一個(gè)全局的字典，可以在步驟方法之間傳遞數(shù)據(jù)

第 3 步，編寫配置環(huán)境文件 environment.py

環(huán)境配置文件定義了測(cè)試腳本運(yùn)行過(guò)程中，具體步驟、場(chǎng)景之前和之后要執(zhí)行的內(nèi)容

比如，我們?cè)?before_feature 方法（ 每一個(gè) feature 場(chǎng)景執(zhí)行之前執(zhí)行 ）前初始化 ChromeDriver，打開目標(biāo)網(wǎng)站首頁(yè)；然后在 after_feature 方法（ feature 場(chǎng)景測(cè)試完成之后執(zhí)行 ）后關(guān)閉瀏覽器

def before_feature(context, feature):
    context.driver = webdriver.Chrome()
    context.driver.get("https://www.google.com/")


def after_feature(context, feature):
    context.driver.quit()

第 4 步，轉(zhuǎn)換 cucumber 測(cè)試報(bào)告

為了保證下一步在 Jenkins 中能正常顯示測(cè)試報(bào)告，需要將 behave 生成的測(cè)試報(bào)告轉(zhuǎn)換為 cucumber 兼容的 json 測(cè)試報(bào)告

首先，安裝依賴 behave2cucumber

# json測(cè)試報(bào)告文件轉(zhuǎn)換
pip3 install behave2cucumber

然后，在上一步的環(huán)境配置文件中重寫 after_all 方法，將 behave 格式的測(cè)試報(bào)告轉(zhuǎn)換為 cucumber 兼容的測(cè)試報(bào)告

def after_all(context):
    """
    所有測(cè)試完成之后執(zhí)行
    注意：behave1.2.6生成的json沒(méi)法正常轉(zhuǎn)換為cucumber兼容的json報(bào)告，建議降級(jí)為：1.2.5
    :param context:
    :return:
    """

    # 轉(zhuǎn)換
    with open('./test_report.json',encoding='utf-8') as behave_json:
        # 格式轉(zhuǎn)換
        cucumberJson = behave2cucumber.convert(json.load(behave_json))

    jsonStr = json.dumps(cucumberJson)

    # 寫入
    jsonReport = open(r'./report/jsonReport.json', 'w',encoding='utf-8')
    jsonReport.write(jsonStr)
    jsonReport.close()

需要注意的是，behave 最新版本轉(zhuǎn)成的 cucumber 測(cè)試報(bào)告，在 Jenkins 中沒(méi)法展示出來(lái)，建議降低為 1.2.5 版本

第 5 步，本地運(yùn)行

在 Features 文件同級(jí)目錄下，執(zhí)行下面的命令，將在本地生成格式化后 json 格式的測(cè)試報(bào)告

# 以中文語(yǔ)言的形式在本地運(yùn)行
# 在本地產(chǎn)生測(cè)試報(bào)告
behave --lang=zh-CN -f json.pretty -o './test_report.json'

第 6 步，持續(xù)集成

首先搭建 Jenkins 環(huán)境，然后安裝 Cucumber reports 插件

https://plugins.jenkins.io/cucumber-reports

接著，新建一個(gè) Freestyle project 的任務(wù)，添加構(gòu)建步驟 - Execute Shell，寫入要執(zhí)行的 Python 腳本

# 打開目標(biāo)項(xiàng)目位置
cd /Users/xingag/Desktop/xag/git/marks/Python/測(cè)試/Demo/feature_chrome

# 執(zhí)行測(cè)試，并生成測(cè)試報(bào)告
behave --lang=zh-CN -f json.pretty -o './test_report.json'

最后，添加構(gòu)建后的操作 - Cucumber reports，指向第 4 步轉(zhuǎn)換后的 json 格式的測(cè)試報(bào)告

第 7 步，構(gòu)建

構(gòu)建后，測(cè)試腳本會(huì)自動(dòng)進(jìn)行執(zhí)行，然后會(huì)在結(jié)果欄生成可視化測(cè)試報(bào)告

6. 最后

文章只是通過(guò) Python 中的 Behave 框架來(lái)談 BDD 在實(shí)際項(xiàng)目中的用法

如果你想在 Java 或者 Golang 項(xiàng)目中使用，可以直接 JBehave 或者 GoDog 框架來(lái)實(shí)現(xiàn)，除了語(yǔ)法外，基本操作方法類似。