接口自动化框架设计必备利器之参数传递

在我们设计自动化测试框架的时候，我们会经常将测试数据保存在外部的文件（如Excel、YAML）中，实现测试脚本与测试数据解耦，方便后期维护。

当涉及到业务场景接口用例时，由于接口与接口存在关联关系，需要从上游接口取出来相关字段传递给下游接口作为入参使用，比如在Excel中我们会这样做：

在excel中新增一列【提取响应】，将上游接口的响应字段提取出来，在下游接口当中通过标记符进行使${XXX}

在YAML中我们也会有类似的用法：

 如果你想学习自动化测试，我这边给你推荐一套视频，这个视频可以说是B站播放全网第一的自动化测试教程，同时在线人数到达1000人，并且还有笔记可以领取及各路大神技术交流：798478386    

【已更新】B站讲的最详细的Python接口自动化测试实战教程全集（实战最新版）_哔哩哔哩_bilibili【已更新】B站讲的最详细的Python接口自动化测试实战教程全集（实战最新版）共计200条视频，包括：1、接口自动化之为什么要做接口自动化、2、接口自动化之request全局观、3、接口自动化之接口实战等，UP主更多精彩视频，请关注UP账号。https://www.bilibili.com/video/BV17p4y1B77x/?spm_id_from=333.337.search-card.all.click

- casename: 修改用户信息
  teststeps:
    - name: 登录成功
      request:
        method: POST
        url: /login
        json:
          principal: lemon_auto
          credentials: lemon123456
          appType: 3
          loginType: 0
        headers:
          Content-Type: application/json
      extract:
        token: $.access_token
        tokentype: $.token_type
      validate:
        - eq: [status_code, 200]
        - eq: [$.nickName, "lemon_auto"]

    - name: 进入到个人中心
      request:
        method: GET
        url: /p/user/userInfo
        queryparam: null
        headers:
          Authorization: ${tokentype}${token}
      validate:
        - eq: [status_code, 200]
        - eq: [$.nickName, "lemon_auto"]

【extract】代表要提取的响应字段信息，在下游接口中同样通过${XXX}用法进行引用

参数传递替换实现

在框架中关键实现是需要识别到标记符并且进行参数的替换，一般的思路我们采用正则表达式识别标记符，并且配合环境变量取出对应的字段值再使用replace进行替换，整个的操作封装相比复杂性会比较高。

在python中提供了Template类，它能够非常简单的通过模块替换你想要的字符串。Template类中默认的替换模板就是${XXX}标记符，具体用法如下：

1. 将要替换的原始字符串作为参数初始化Template对象

2. 使用substitute方法，传递需要替换的内容from string import Template

# 原始数据
data = '''
{
  "address": "青海省西宁市城东区格兰小镇",
  "communityName": "八家湾小区",
  "nearbyLandmarks": "${mark}",
  "userId": ${userId}
}
'''
# 这里是需要替换的内容，字典类型
dict = {'userId':123456,'mark':"王府井"}

print(Template(data).substitute(dict))

替换之后的结果为：

{
  "address": "青海省西宁市城东区格兰小镇",
  "communityName": "八家湾小区",
  "nearbyLandmarks": "王府井",
  "userId": 123456
}

可以看到使用非常简单，通过substitute即可将字典中的数据替换到原始数据中。

那如果原始数据中的标记符和替换的内容不对应会有什么情况？

比如这里我的替换内容只有userId：

from string import Template
data = '''
{
  "address": "青海省西宁市城东区格兰小镇",
  "communityName": "八家湾小区",
  "nearbyLandmarks": "${mark}",
  "userId": ${userId}
}
'''

dict = {'userId':123456}

print(Template(data).substitute(dict))

此时会报KeyError的错误，找不到mark这个key，如果不想要报错你可以使用safe_substitutefrom string import Template

data = '''
{
  "address": "青海省西宁市城东区格兰小镇",
  "communityName": "八家湾小区",
  "nearbyLandmarks": "${mark}",
  "userId": ${userId}
}
'''

dict = {'userId':123456}

print(Template(data).safe_substitute(dict)

此时的输出结果为：

{
  "address": "青海省西宁市城东区格兰小镇",
  "communityName": "八家湾小区",
  "nearbyLandmarks": "${mark}",
  "userId": 123456
}

我们可以看到safe_substitute不会报错，并且只会替换和标记符匹配的数据，不匹配的则保持原样。