快速打造接口自动化测试框架

1 接口测试介绍

接口测试是对系统或组件之间的接口进行测试,主要是校验数据的交换,传递和控制管理过程,以及相互逻辑依赖关系。
接口自动化相对于UI自动化来说,属于更底层的测试,这样带来的好处就是测试收益更大,且维护成本相对来说较低,是我们进行自动化测试的首选;

2 框架选型

目前接口自动化的框架比较多,比如jmeter,就可以集接口自动化和性能测试于一体,该工具编写用例效率不高;还有我们常用的postman,结合newman也可以实现接口自动化;Python+unittest+requests+HTMLTestRunner是目前比较主流的测试框架,对python有一定的编码要求;

本期我们选择robotframework(文中后续统一简称为RF)这一个比较老牌的测试框架进行介绍,RF是一个完全基于关键字测试驱动的框架,它即能够基于它的一定规则,导入你需要的测试库(例如:其集成了selenium的测试库,即可以理解为操作控件的测试底层库),然后基于这些测试库,你能应用TXT形式编写自己的关键字(支持python和java语言,这些关键字即你的库组成),之后,再编写(测试用例由测试关键字组成)进行测试;他支持移动端、UI自动化和接口自动化的测试;

3 环境搭建

python的安装:目前选取的python3以上的版本,RF的运行依赖python
robotframework:参考https://www.jianshu.com/p/9dcb4242b8f2
jenkins:用于调度RF的用例执行环境
gitlab:代码仓库

4 需求

4.1 需求内容

接口内容:实现一个下单,并检查订单状态是否正常的场景;该需求涉及到如下三个接口
下单接口
订单结果查询接口
下单必须带上认证标识,生成token的接口
环境覆盖:需要支持能在多套环境运行,比如测试和预发布环境
系统集成:需要能够集成在CICD中,实现版本更新后的自动检测

4.2 用例设计

4.2.1 用例设计,根据业务场景设计测试用例,方便后续实现

image

4.2.2 测试数据构造,预置不同环境的测试数据,供实现调用

image

5 整体实现架构

image

接口测试实现层:在RF,通过引用默认关键字RequestsLibrary(实现http请求)和通过python自定义关键字来完成用例实现的需求;

jenkins调度:在jenkins上配置一个job,设置好RF用例执行的服务器和发送给服务器相关的RF执行的指令,并且在jenkins中配置好测试报告模板,这样用例便可以通过jenkins完成执行并发送测试结果给项目干系人;

生成用例执行的API:上图中蓝色部分,就是为了将jenkins的job生成一个可访问api接口,方便被测项目的CICD集成;

集成到被测系统CICD流程:将上面步骤中封装的API配置在被测应用的gitlab-ci.yml中,完成整个接口自动化的闭环

6 RF用例实现

6.1 引用的内置关键字

RequestsLibrary 构造http的请求,get|post等请求


getRequests
# get请求的入参
[Arguments]${url_domain}${getbody}${geturl}${getToken}
Create session    postmain${url_domain}

# 定义header的内容

${head}createdictionary    content-type=application/json    Authorization=${getToken}MerchantId=${s_merchant_id}

# get请求

${addr}getRequest    postmain${geturl}params=${getbody}headers=${head}

# 请求状态码断言
Should BeEqualAs Strings${addr.status_code}200
${response_get_data}To Json${addr.content}

# 返回http_get请求结果

SetTest Variable${response_get_data}
Delete All Sessions

6.2 自定义关键字

getEnvDomain 用于从自定义的configs.ini文件获取对应环境的微服务的请求域名
configs.ini的内容

image

获取configs.ini的内容


import configparser

def getEnv(path,env):

config = configparser.ConfigParser()

config.read(path)

passport = config[env]['passport']

stock=config[env]['stock']

finance=config[env]['finance']

SUP= config[env]['SUP']

publicApi = config[env]['publicApi']

publicOrder = config[env]['publicOrder']

data_dict={'passport':passport,'stock':stock,'finance':finance,'SUP':SUP,'publicApi':publicApi,'publicOrder':publicOrder}

return data_dict

excelTodict 用户将excel中的内容作为字典返回

import xlrd

'''

通用获取excel数据

@:param path excel文件路径
@:param sheet_name excel文件里面sheet的名称 如:Sheet1
@:env 环境,是IT还是PRE

'''

def getExcelDate(path, sheet_name,env):
bk = xlrd.open_workbook(path)
sh = bk.sheet_by_name(sheet_name)
row_num = sh.nrows
data_list = []
for i in range(1, row_num):
row_data = sh.row_values(i)
data = {}
for index, key in enumerate(sh.row_values(0)):
data[key] = row_data[index]
data_list.append(data)
data_list1 = []
for x in data_list:
#print('这是'+str(x))
if(x.get('env')==env):
data_list1.append(x)
return data_list1

getToken 提供接口下单的授权token

*** Keywords ***

# 根据传入的clientid、secret生成对应的token

getToken
[Arguments]    ${client_id}    ${client_secret}    ${url_domain}
Create session    postmain    ${url_domain}
${auth}    createdictionary    grant_type=client_credentials    client_id=${client_id}    client_secret=${client_secret}
${header}    createdictionary    content-type=application/x-www-form-urlencoded
${addr}    postRequest    postmain    /oauth/token    data=${auth}    headers=${header}
Should Be Equal As Strings    ${addr.status_code}    200
${responsedata}    To Json    ${addr.content}
${access}    Get From Dictionary    ${responsedata}    access_token
${token}    set variable    bearer ${access}
Set Test Variable    ${token}
Delete All Sessions

getAllDate 获取该用例下的所有数据


getAllData

[Arguments]    ${row_no}

getEnvDomain
getBalance    ${row_no}
getStockNum    ${row_no}
getSupProPrice    ${row_no}
getProPrice    ${row_no}

Set Test Variable    ${publicOrderUrl}
Set Test Variable    ${FPbalance}
Set Test Variable    ${Pbalance}
Set Test Variable    ${Sbalance}
Set Test Variable    ${Jbalance}
Set Test Variable    ${Cardnum}
Set Test Variable    ${sprice}
Set Test Variable    ${price}
Set Test Variable    ${j_merchant_id}
Set Test Variable    ${s_merchant_id}
Set Test Variable    ${stock_id}
Set Test Variable    ${p_product_id}
Set Test Variable    ${s_product_id}

实现demo

*** Settings ***
Test Template
Resource          引用所有资源.txt

*** Test Cases ***
*** Settings ***
Test Template
Resource          引用所有资源.txt

*** Test Cases ***
01 下单卡密直储商品
[Tags]    order
LOG    ---------------------获取下单前的数量、余额------------------------------------------
getAllData    0

${Cardnum1}    set variable    ${Cardnum}
${FPbalance1}    set variable    ${FPbalance}
${Pbalance1}    set variable    ${Pbalance}
${Sbalance1}    set variable    ${Sbalance}
${Jbalance1}    set variable    ${Jbalance}
${CustomerOrderNo1}    Evaluate    random.randint(1000000, 9999999)    random

${Time}    Get Time


log    ------------------------下单操作-------------------------------------------------------
getToken    100xxxx    295dab07a9xxxx9780be0eb95xxxx   ${casUrl}
${input_cs}    create dictionary    memberId=${j_merchant_id}    clientId=1xxx079    userId=string    shopType=string    customerOrderNo=${CustomerOrderNo1}

...    productId=${p_product_id}    buyNum=1    chargeAccount=otest888888    notifyUrl=string    chargeIp=string    chargePassword=string

...    chargeGameName=string    chargeGameRole=string    chargeGameRegion=string    chargeGameSrv=string    chargeType=string    remainingNumber=0

...    contactTel=string    contactQQ=string    customerPrice=0    poundage=0    batchNumber=    originalOrderId=string

...    shopName=string    appointSupProductId=0    stemFromSubOrderId=123456    externalBizId=456789

postRequests    ${publicOrderUrl}    ${input_cs}    /api/Order    ${token}

${data}    get from dictionary    ${responsedata}    data

${orderid}    get from dictionary    ${data}    id

sleep    6
${getdata}    create dictionary    Id=${orderid}    PageIndex=1    PageSize=1
getRequests    ${publicOrderUrl}    ${getdata}    /api/Order/GetList    ${token}
${datalist}    get from dictionary    ${response_get_data}    data
${data}    get from dictionary    ${datalist}    list
${dict}    set variable    ${data}[0]
${orderOuterStatus}    get from dictionary    ${dict}    orderOuterStatus

LOG    ---------------------获取下单后的数量、余额----------------------------------------------

getAllData    0
${Cardnum2}    set variable    ${Cardnum}
${FPbalance2}    set variable    ${FPbalance}
${Pbalance2}    set variable    ${Pbalance}
${Sbalance2}    set variable    ${Sbalance}
${Jbalance2}    set variable    ${Jbalance}
${sprice}    set variable    ${sprice}
${price}    set variable    ${price}

log    ------------------断言-----------------------------------------------------------------

${Cardnum3}    Evaluate    ${Cardnum1}
${Jbalance3}    Evaluate    ${Jbalance1}
${Sbalance3}    Evaluate    ${Sbalance1}
${Pbalance3}    Evaluate    ${Pbalance1}
should be true    ${orderOuterStatus}==90
should be true    ${Cardnum3}==${Cardnum2}
should be true    ${Jbalance3}==${Jbalance2}
should be true    ${Sbalance3}==${Sbalance2}
should be true    ${Pbalance3}==${Pbalance2}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342