• 接口自动化测试框架搭建【附教程加源码】

    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 用例设计，根据业务场景设计测试用例，方便后续实现

    20200616180851

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

    20200616181307

    5 整体实现架构

    20200615120654

    接口测试实现层：在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等请求
    1. getRequests
    2. # get请求的入参
    3.     [Arguments]    ${url_domain}    ${getbody}    ${geturl}    ${getToken}
    4.     Create session    postmain    ${url_domain}
    5. # 定义header的内容
    6.     ${head}    createdictionary    content-type=application/json    Authorization=${getToken}    MerchantId=${s_merchant_id}
    7. # get请求
    8.     ${addr}    getRequest    postmain    ${geturl}    params=${getbody}    headers=${head}
    9. # 请求状态码断言
    10.     Should Be Equal As Strings    ${addr.status_code}    200
    11.     ${response_get_data}    To Json    ${addr.content}
    12. # 返回http_get请求结果
    13.     Set Test Variable    ${response_get_data}	 
    14.     Delete All Sessions

    6.2 自定义关键字

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

      20200615081943

    1. # 获取configs.ini的内容
    2. import configparser
    3. def getEnv(path,env):
    4.     config = configparser.ConfigParser()
    5.     config.read(path)
    6.     passport = config[env]['passport']
    7.     stock=config[env]['stock']
    8.     finance=config[env]['finance']
    9.     SUP = config[env]['SUP']
    10.     publicApi = config[env]['publicApi']
    11.     publicOrder = config[env]['publicOrder']
    12.     data_dict={'passport':passport,'stock':stock,'finance':finance,'SUP':SUP,'publicApi':publicApi,'publicOrder':publicOrder}
    13.     return data_dict
    • excelTodict 用户将excel中的内容作为字典返回
    1. import xlrd
    2.  
    3. '''
    4. 通用获取excel数据
    5. @:param path excel文件路径
    6. @:param sheet_name excel文件里面sheet的名称 如：Sheet1
    7. @:env 环境，是IT还是PRE
    8. '''
    9. def getExcelDate(path, sheet_name,env):
    10.     bk = xlrd.open_workbook(path)
    11.     sh = bk.sheet_by_name(sheet_name)
    12.     row_num = sh.nrows
    13.     data_list = []
    14.     for i in range(1, row_num):
    15.         row_data = sh.row_values(i)
    16.         data = {}
    17.         for index, key in enumerate(sh.row_values(0)):
    18.             data[key] = row_data[index]
    19.         data_list.append(data)
    20.     data_list1 = []
    21.     for x in data_list:
    22.         #print('这是'+str(x))
    23.         if(x.get('env')==env):
    24.             data_list1.append(x)
    25.     return data_list1
    • getToken 提供接口下单的授权token
    1. *** Keywords ***
    2. # 根据传入的clientid、secret生成对应的token
    3. getToken
    4.     [Arguments]    ${client_id}    ${client_secret}    ${url_domain}
    5.     Create session    postmain    ${url_domain}
    6.     ${auth}    createdictionary    grant_type=client_credentials    client_id=${client_id}    client_secret=${client_secret}
    7.     ${header}    createdictionary    content-type=application/x-www-form-urlencoded
    8.     ${addr}    postRequest    postmain    /oauth/token    data=${auth}    headers=${header}
    9.     Should Be Equal As Strings    ${addr.status_code}    200
    10.     ${responsedata}    To Json    ${addr.content}
    11.     ${access}    Get From Dictionary    ${responsedata}    access_token
    12.     ${token}    set variable    bearer ${access}
    13.     Set Test Variable    ${token}
    14.     Delete All Sessions
    • getAllDate 获取该用例下的所有数据
    1. getAllData
    2.     [Arguments]    ${row_no}
    3.     getEnvDomain
    4.     getBalance    ${row_no}
    5.     getStockNum    ${row_no}
    6.     getSupProPrice    ${row_no}
    7.     getProPrice    ${row_no}
    8.     Set Test Variable    ${publicOrderUrl}
    9.     Set Test Variable    ${FPbalance}
    10.     Set Test Variable    ${Pbalance}
    11.     Set Test Variable    ${Sbalance}
    12.     Set Test Variable    ${Jbalance}
    13.     Set Test Variable    ${Cardnum}
    14.     Set Test Variable    ${sprice}
    15.     Set Test Variable    ${price}
    16.     Set Test Variable    ${j_merchant_id}
    17.     Set Test Variable    ${s_merchant_id}
    18.     Set Test Variable    ${stock_id}
    19.     Set Test Variable    ${p_product_id}
    20.     Set Test Variable    ${s_product_id}
    21.
    • 实现demo
    1. *** Settings ***
    2. Test Template
    3. Resource          引用所有资源.txt
    4.  
    5. *** Test Cases ***
    6. *** Settings ***
    7. Test Template
    8. Resource          引用所有资源.txt
    9.  
    10. *** Test Cases ***
    11. 01 下单卡密直储商品
    12.     [Tags]    order
    13.     LOG    ---------------------获取下单前的数量、余额------------------------------------------
    14.     getAllData    0
    15.     ${Cardnum1}    set variable    ${Cardnum}
    16.     ${FPbalance1}    set variable    ${FPbalance}
    17.     ${Pbalance1}    set variable    ${Pbalance}
    18.     ${Sbalance1}    set variable    ${Sbalance}
    19.     ${Jbalance1}    set variable    ${Jbalance}
    20.     ${CustomerOrderNo1}    Evaluate    random.randint(1000000, 9999999)    random
    21.     ${Time}    Get Time
    22.     log    ------------------------下单操作-------------------------------------------------------
    23.     getToken    100xxxx    295dab07a9xxxx9780be0eb95xxxx   ${casUrl}
    24.     ${input_cs}    create dictionary    memberId=${j_merchant_id}    clientId=1xxx079    userId=string    shopType=string    customerOrderNo=${CustomerOrderNo1}
    25.     ...    productId=${p_product_id}    buyNum=1    chargeAccount=otest888888    notifyUrl=string    chargeIp=string    chargePassword=string
    26.     ...    chargeGameName=string    chargeGameRole=string    chargeGameRegion=string    chargeGameSrv=string    chargeType=string    remainingNumber=0
    27.     ...    contactTel=string    contactQQ=string    customerPrice=0    poundage=0    batchNumber=    originalOrderId=string
    28.     ...    shopName=string    appointSupProductId=0    stemFromSubOrderId=123456    externalBizId=456789
    29.     postRequests    ${publicOrderUrl}    ${input_cs}    /api/Order    ${token}
    30.     ${data}    get from dictionary    ${responsedata}    data
    31.     ${orderid}    get from dictionary    ${data}    id
    32.     sleep    6
    33.     ${getdata}    create dictionary    Id=${orderid}    PageIndex=1    PageSize=1
    34.     getRequests    ${publicOrderUrl}    ${getdata}    /api/Order/GetList    ${token}
    35.     ${datalist}    get from dictionary    ${response_get_data}    data
    36.     ${data}    get from dictionary    ${datalist}    list
    37.     ${dict}    set variable    ${data}[0]
    38.     ${orderOuterStatus}    get from dictionary    ${dict}    orderOuterStatus
    39.     LOG    ---------------------获取下单后的数量、余额----------------------------------------------
    40.     getAllData    0
    41.     ${Cardnum2}    set variable    ${Cardnum}
    42.     ${FPbalance2}    set variable    ${FPbalance}
    43.     ${Pbalance2}    set variable    ${Pbalance}
    44.     ${Sbalance2}    set variable    ${Sbalance}
    45.     ${Jbalance2}    set variable    ${Jbalance}
    46.     ${sprice}    set variable    ${sprice}
    47.     ${price}    set variable    ${price}
    48.     log    ------------------断言-----------------------------------------------------------------
    49.     ${Cardnum3}    Evaluate    ${Cardnum1}
    50.     ${Jbalance3}    Evaluate    ${Jbalance1}
    51.     ${Sbalance3}    Evaluate    ${Sbalance1}
    52.     ${Pbalance3}    Evaluate    ${Pbalance1}
    53.     should be true    ${orderOuterStatus}==90
    54.     should be true    ${Cardnum3}==${Cardnum2}
    55.     should be true    ${Jbalance3}==${Jbalance2}
    56.     should be true    ${Sbalance3}==${Sbalance2}
    57.     should be true    ${Pbalance3}==${Pbalance2}
    58.
    7 集成到CICD流程

    7.1 jenkins配置job
    通过jenkins的参数化构建，定义it和pre两套环境

    20200615121059

    jenkins发送RF执行的命令

    20200615121250

    7.2 封装的jenkins_job的执行接口地址
    通过python的flask框架，根据测试和pre两套环境包一层jenkins的job执行接口

    1. __author__ = 'paul'
    2.  
    3. # !/usr/bin/env python
    4. # -*- coding: utf-8 -*-
    5. from flask import Flask, abort, request, jsonify
    6. import jenkins
    7.  
    8. server = jenkins.Jenkins('http://10.0.1.xxx:80', username='xxx', password='fuluxxxx')
    9.  
    10. app = Flask(__name__)
    11.  
    12. tasks = []
    13.  
    14. # it的测试集合http请求接口
    15. @app.route('/test/it', methods=['get'])
    16. def robot_Test_It():
    17.     server.build_job('CI_FuluOrder', {'environment': 'IT'})
    18.     return jsonify({'result': 'success'})
    19.  
    20. # pre的测试集合http请求接口
    21. @app.route('/test/pre', methods=['get'])
    22. def robot_Test_Pre():
    23.     server.build_job('CI_FuluOrder', {'environment': 'PRE'})
    24.     return jsonify({'result': 'success'})
    25.  
    26. if __name__ == "__main__":
    27.     # 将host设置为0.0.0.0，则外网用户也可以访问到这个服务
    28.     app.run(host="0.0.0.0", port=80, debug=True)
    29.

    7.3 将上述flask封装的接口打包成镜像
    根据dockerfile生成镜像

    1. FROM python:3.6
    2. WORKDIR /app
    3. EXPOSE 80
    4. COPY .	.
    5. RUN pip install -r requirements.txt 
    6. ENTRYPOINT ["python","robotTestApi.py"]
    7.

    7.4 将镜像部署到kubernetes，对外提供服务
    供触发测试执行的调用入口 ,这部分封装的接口部署在本地的k8s集群下ordermiddle

    IT: http://ordermiddle.xxx.cn/test/it
    pre：http://ordermiddle.xxx.cn/test/pre

    7.5 被测项目的CICD集成接口自动化测试
    gitlab目前采取直接对CICD脚本加入测试步骤，在部署到容器30秒后（考虑到容器在K8S启动时间）调用测试接口

    20200615121532

    7.6 发送测试报告

    20200616181105

    Python接口自动化测试零基础入门到精通（2023最新版）

  • 相关阅读:
    ubuntu+.net6+docker 应用部署教程
    Docker安装Gitlab-ruuner
    hexo博客发布换电脑换地方了怎么办？
    Ubuntu添加和删除用户
    #Z0045. S数
    删除共享文件凭据脚本
    OpenHarmony实战开发-组件复用实践。
    [onnxrumtime]onnxruntime和cuda对应关系表
    CF1539 D. PriceFixed
    生成二维码
  • 原文地址：https://blog.csdn.net/ada4656/article/details/133797550