自動化測試：behave

時間 2019-11-05

原文原文鏈接

在系統開發過程當中，咱們通常我的參與的開發都是局部的，本身負責的一部分與其它團隊成員的成果組合在一塊兒才能實現用戶的完整行爲。好比常見的電商系統就有幾個主要的流程javascript

商品搜索
購物車
訂單
支付
物流

這些模塊複雜的足以造成各自的團隊，不一樣團隊相互之間依據必定的接口來配合協做。在開發階段能夠基於接口各自獨立開發，對於依賴其它模塊的接口能夠經過接口mock來完成。但mock方式自己是有使用場景的，一旦依賴方接口穩定後，就會調用實際服務來代替mock接口。css

場景A：在上面提到的購物流程都完善的前提下，一個作物流系統的同事須要真實模似真實的用戶場景產生物流單，他須要去相應的環境進行商品搜索，加入購物車，登陸，下單，付款等衆多操做以後纔會輪到他的模塊登場。想一想都是件至關繁瑣的事情，因此但願有一種很快捷的方式代替人工去完成這些複雜且花時間的體力勞動。固然你也能夠找測試妹子說：那個誰，幫我在某某環境下一個單我測試物流單邏輯。html

指望只須要執行一條命令，就能快速獲得指定條件的訂單。java

場景B：在上面提到的購物流程中，任意修改某個流程都有可能對總體流程構成不一樣程度的影響，有沒有快速簡捷的方式給咱們確認新的修改是否會影響主流程的變動呢？通常的做法就是須要測試人員去迴歸主流程，但這個成本比較高並且並必定那麼的可靠，咱們須要一種成本低又不知疲倦的工具爲咱們完成上面的工做，即便達不到100%人工測試的效果。python

指望在代碼提交後，每日構建工具可以在修改以後的版本上執行主流程的測試用例，確保第一時間反饋出問題來，而不須要等到測試人員報BUG或者是線上用戶反饋出問題來才被動知道。web

場景C：shell

在作一個稍微大型的功能後，爲了確保各個子功能可以相互協做正常，咱們通常首先會對子功能作單元測試，而後對大功能作集成測試。在集成測試時，須要快速的定義測試用例並獲得預期結果。json

集成測試的方式可能有不少種，好比我以前對http api接口的集成測試就依靠谷歌的postman（固然你也能夠用junit來搞集成測試，在裏面作各類斷言）。但這種方式須要人工判斷接口是否正確，由於此工具只具有執行能力並不具有判斷能力。因此須要一款脫離特定語言的測試用例工具來幫助咱們完成，並且很是容易的可以對環境進行擴展，好比定義開發環境，測試環境，預上線環境，生產環境等。api

behave簡要說明

依賴項

與python配合完成，因此須要在執行測試用例的機器上至少須要安裝：數據結構

python
behave

另外能夠爲behave建立單獨的python環境，能夠引入virtualenv。每次運行時經過source xxxenv/bin/activate來進入特定的python環境，source的目的就是替換環境變量。

其它組件

好比我主要測試http api，因此會用到下面一些庫：

requests, 用於作http請求的
json,用於處理字符串與json之間的各類轉換
operator，操做符，好比a>b之類的函數表達

參考文檔

https://pythonhosted.org/behave/index.html

項目背景

針對HTTP API的集成測試的自動化。上面所說的場景A/B/C是我暫時理解的，不一樣的人在不現的階段對自動化測試的需求不同。好比我作爲業務系統的開發者，場景C能夠幫助在我提交大型功能前作聯調測試，系統穩定後，咱們去修改一個功能但依賴其它模塊數據時，但願快速產生預期數據那麼場景A適合咱們。當咱們比較惶恐的修改某種功能時，場景B的主流程測試可以給咱們信心。

項目結構

這裏以文章前面說的購物場景爲例。

envbehave

是建立的一個python獨立環境，可選。

features

behave相關的全部測試用例文件

dev 存放測試用例的目錄，能夠按業務定義名稱好做區分，好比訂單相關的能夠叫 order。
steps，存放配置測試用例文件的執行文件，behave+python
environment.py，是爲了支持多環境而建立的，好比開發，測試，預上線，生產環境可任意切換
service.py，封裝了基礎功能，目的就是簡化step以及測試用例的代碼

代碼實現

多環境支持

behave提供了對於環境的控制，咱們能夠在以下函數中添加本身的邏輯：

before_step
before_scenario
before_feature
before_tag
before_all

根據以前所述，集成測試可能涉及到不一樣小組提供的api，因此能夠定義以下數據：

CONFIG = {
    'dev': {
        'hosts': {
            'product': 'http://localhost:1234/api/product',
            'order':'http://localhost:1234/api/order',
            'cart': 'http://localhost:1234/api/cart',
            'pay': 'http://localhost:1234/api/pay',
            'user': 'http://localhost:1234/api/user',
            'logistics': 'http://localhost:1234/api/logistics',
        }
    },
    'test': {
        'hosts': {
            'product': 'http://test.jim.com/api/product',
            'order':'http://test.jim.com/api/order',
            'cart': 'http://test.jim.com/api/cart',
            'pay': 'http://test.jim.com/api/pay',
            'user': 'http://test.jim.com/api/user',
            'logistics': 'http://test.jim.com/api/logistics',
        }
    },


}

而後在before_all中進行數據初始化,環境參數能夠經過命令行的-D參數來控制，好比: -D env=dev

env = 'dev'
def before_all(context):
    global env
    if (context.config.userdata.get('env')):
        env = context.config.userdata['env']

    for k, v in CONFIG[env]['hosts'].items():
        hosts[k] = v

基礎功能封裝

封裝通用的功能，便於使用測試用例簡單方便，容易管理。建立一個service.py,主體結構以下：

#coding=utf-8
import requests, json

hosts = {}
class BddService(object):
    def __init__(self, api, data={}, headers={}):
       # 數據初始化

    def __before__(self, context, data, url):

       # 處理數據，好比從測試用例中取參數，存放到context的requestData中，供後續的http請求使用

    def __after__(self, context, r, url):
       # 從http request中獲取數據，存放到context的responseData中，供後續的斷言使用

    def get(self, context, url, data={}):
       # 完成 http 調用

測試用例參數指定

咱們須要在用例下面直觀靈活的指定參數，能夠經過behave提供的文本功能實現，它能夠讀一段多行文本到context.text變量中，而後咱們對去作處理。

When 搜索商品
    """
    {"name":"product1"}
    """

在before函數中完成值的填充,將最終的請求參數存放在context的requestData變量中。

def __before__(self, context, data, url):

    if context.text:
        print (context.text)
        o = json.loads(context.text)
        print (o)
        for k in o:
            data[k] = o[k]
    context.requestData = data

HTTP請求結構處理

在after函數中完成取值，將HTTP請求的結構存放在context的responseData變量中。對於HTTP請求的結構支持兩類數據，一類是json數據，一類是簡單值（好比直接返回一個數字或者一個bool值或者是一個字符串）。

def __after__(self, context, r, url):
    try:
        context.response = r.json()
        if context.response.get('value', None):
            context.responseData = context.response.pop('value')
            try:
                if type(context.responseData) == str or type(context.responseData) == unicode:
                    context.responseData = json.loads(context.responseData)
           except:
        if not hasattr(context, 'responseData') or context.responseData == None:
   except:
        context.response = r.text

上面邏輯中的get('value')，是特殊的數據結構（約定HTTP接口都會按必定的固定格式返回），好比我這裏的結構,其中的value纔是真正的業務數據。

{
    "result": true,
    "error": null,
    "value": [
        {
            "id": 1,
            "name": "product1",
            "productImage": null
        }
    ]
}

斷言

behave默認狀況下進行斷言，須要在@then中完成斷言，就須要爲每一個測試用例編寫獨立的斷言函數，能夠作統一的封裝，主體支持兩類操做。

判斷請求響應是否正常
判斷請求的值是否符合預期

建立一個assert.py

編寫兩個斷言函數

從@then腳本後面讀取多行文本，若是爲空直接跳過斷言。

@then(u'獲得響應數據')
def step_impl(context):
    if not context.text:
        return
    try:
        expect = json.loads(context.text)
    except:
        expect = context.text
    assertObj(expect, context.responseData)

@then(u'獲得響應')
def step_impl(context):
    if not context.text:
        return
    expect = json.loads(context.text)
    assertObj(expect, context.response)

編寫斷言函數

須要判斷比較值的類型，由於只支持對基本類型的數據作斷言，若是是列表就須要迭代到成員對象，至於迭代到基本數據類型（好比字符串，數字），而後利用operator庫作處理。

def assertObj(expect, actual):
    if(type(expect) == list):
        for i in range(len(expect)):
            assertObj(expect[i], actual[i])
    elif type(expect)==bool or type(expect)==str or type(expect)==int:
        assertObjKey(None, expect, actual)
    else:
        for k in expect:
            if(type(expect[k]) == dict or type(expect[k]) == list):
                if(type(actual[k]) != type(expect[k])):
                    actual[k] = json.loads(actual[k])
                assertObj(expect[k], actual[k])
            else:
                assertObjKey(k, expect[k], actual[k])


def assertObjKey(k,originExpect,actualValue):
    #測試用例的值支持<,<=,<,<=,!=,==
    #樣例數據:{"premium":"ge$0"}
    expectArray = str(originExpect).split("$");

    if (len(expectArray) == 2):
        action = expectArray[0];
        realExpect = expectArray[1]
       if action == "ge":
            assert operator.ge(actualValue, long(realExpect))
        elif action == "gt":
            assert operator.gt(actualValue, long(realExpect))
        elif action == "le":
            assert operator.le(actualValue, long(realExpect))
        elif action == "lt":
            assert operator.lt(actualValue, long(realExpect))
        elif action == "ne":
            assert operator.ne(actualValue, realExpect)
        elif action == "eq":
            assert operator.eq(actualValue, realExpect)
        else:
            assert originExpect == actualValue
    else:
        assert originExpect == actualValue

優化

上面代碼中判斷操做符有衆多if，基本上就是一種比較一條if，比較冗餘，現更新以下：利用getattr來獲取方法，與java中的反射有點像。

method= getattr(operator, action,None)
if(method!=None):
    method(actualValue, float(realExpect))
else:
    assert operator.eq(actualValue, realExpect)

編寫step

能夠根據調用的不一樣業務接口建立不一樣的step文件，好比以下圖所示：

這裏貼一個登陸的step腳本示例,其他的大同小異。

R = BddService('user')

@given(u'初始化數據')
def given_init(context):
    context.userName="jim"
    context.password="123456"

@when(u'登陸')
def step_impl(context):
    R.get(context,"/login",{"userName":context.userName,"password":context.password})

建立實例

python中建立實例時沒有關鍵字new，這與其它語言有比較大的區別，剛開始老是以爲彆扭，如今看仍是彆扭。

完成測試用例

建立一個order.feature

Feature:訂單流程測試


Scenario:常規下單流程

    Given 初始化數據

    When 登陸
    Then 獲得響應
    """
    {"result":true}
    """

    When 搜索商品
    """
    {"name":"product1"}
    """
    Then 獲得響應
    """
    {"result":true}
    """

    When 加入購物車
    Then 獲得響應
    """
    {"result":true}
    """

    When 提交訂單
    Then 獲得響應數據
    """
    1
    """

    When 支付訂單
    Then 獲得響應數據
    """
    1
    """

    When 生成物流單
    Then 獲得響應數據
    """
    1
    """

執行測試用例

只須要在對應的目錄執行以下腳本便可愉快的執行測試用例。

behave -D env=test features/dev/order.feature

若是運行正常，會看出以下的輸出，黃色的表明執行經過，若是執行失敗會打印出錯誤信息，以及用例執行到哪一步報錯。另外說明下，behave在執行正常的狀況下會屏蔽經過print輸出的日誌，貌似能夠經過參數調，有興趣的能夠研究研究。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。