• excel+requests管理测试用例接口自动化框架

    背景：

    某项目有多个接口，之前使用的unittest框架来管理测试用例，将每个接口的用例封装成一个py文件，接口有数据或者字段变动后，需要去每个py文件中找出变动的接口测试用例，维护起来不方便，为了便于接口变动后维护，使用excel来管理测试用例，接口有变动不需要修改代码，只需要维护excel即可。

    思路：

    为了方便维护测试用例，一个接口的测试用例使用一个excel文件来管理，每个excel文件中有两个sheet页，第一个sheet页是接口的基本信息，包括接口名称，地址和请求方式，第二个sheet页为接口的测试用例，如下图所示

    第一个sheet页

    第二个sheet页

     接口请求的数据类型为X-WWW-FORM-URLENCODED，在测试用例中每个字段为一列，每条用例为一行，倒数第二列为预期结果，倒数第三列为该条用例的描述。

    接口自动化框架结构：

    common目录存放公共的方法，例如写日志，连数据库

    config目录存放配置文件和读取配置文件内容的方法，cfg.ini包括发送邮件的配置信息和接口的ip和端口

    data目录存放接口的测试用例

    logs目录存放用例执行的日志

    report目录存放测试报告

    run_main.py为用例执行的入口

    源码：api_test.py封装读取测试用例的数据，执行测试用例和校验测试结果

    1.  
    2. #coding:utf-8
    3.  
    4. import xlrd,os
    5. import requests
    6. from datetime import datetime
    7. from xlrd import xldate_as_tuple
    8. from config import readConfig
    9. from common.logger import Log
    10.  
    11. '''
    12. 获取测试用例data所在的目录
    13. '''
    14. d = os.path.dirname(__file__) #返回当前文件所在目录（common文件夹路径）
    15. parent_path = os.path.dirname(d) #返回common的父级目录
    16. data_path = os.path.join(parent_path,'data') #返回data所在目录
    17. data_path1 = os.listdir(data_path) #返回data目录下所有的文件
    18.  
    19. log = Log()
    20.  
    21. def api_data():
    22.     for filename in data_path1:
    23.         book = xlrd.open_workbook(os.path.join(data_path,filename))
    24.  
    25.         '''
    26.         获取excel文件中接口信息
    27.         '''
    28.         table = book.sheet_by_index(0) #通过索引，获取相应的列表，这里表示获取excel的第一个列表
    29.         inf_name = table.row_values(1)[0] #返回接口名称
    30.         inf_address = table.row_values(1)[1] #返回接口地址
    31.         inf_mode = table.row_values(1)[2] #返回请求方式
    32.  
    33.         '''
    34.         获取excel文件中测试用例信息
    35.         '''
    36.         sheet = book.sheet_by_index(1) #通过索引，获取相应的列表，这里表示获取excel的第二个列表
    37.         nrows = sheet.nrows #获取所有行数
    38.         filed = sheet.row_values(0)
    39.         # print(filed)
    40.  
    41.         for i in range(1,nrows):
    42.             d1 = {}
    43.             for j in range(0,len(filed)-2):
    44.                 ctype = sheet.cell(i, j).ctype  # 表格的数据类型
    45.                 cell = sheet.cell_value(i, j)
    46.                 d = {}
    47.                 if ctype == 2 and cell % 1 == 0:  # 如果是整形
    48.                     cell = int(cell)
    49.                 elif ctype == 3:
    50.                     # 转成datetime对象
    51.                     date = datetime(*xldate_as_tuple(cell, 0))
    52.                     cell = date.strftime('%Y/%m/%d')
    53.                 elif ctype == 4:
    54.                     cell = True if cell == 1 else False
    55.                 # print(cell)
    56.                 d.update({filed[j]:cell})
    57.                 # print(d)
    58.                 d1.update(d)
    59.             # print(d1)
    60.  
    61.             '''
    62.             获取excel文件中测试用例预期结果和描述
    63.             '''
    64.             a = []
    65.             for k in range(len(filed)-2,len(filed)):
    66.                 ctype = sheet.cell(i, k).ctype  # 表格的数据类型
    67.                 cell = sheet.cell_value(i, k)
    68.                 if ctype == 2 and cell % 1 == 0:  # 如果是整形
    69.                     cell = int(cell)
    70.                 elif ctype == 3:
    71.                     # 转成datetime对象
    72.                     date = datetime(*xldate_as_tuple(cell, 0))
    73.                     cell = date.strftime('%Y/%m/%d')
    74.                 elif ctype == 4:
    75.                     cell = True if cell == 1 else False
    76.                 a.append(cell)
    77.             # print(a[0])
    78.             # print(type(a[0]))
    79.  
    80.             '''
    81.             获取cfg.ini配置文件中接口公共信息（ip和port）
    82.             '''
    83.             ip = readConfig.ip  # 获取配置文件中接口ip
    84.             i_port = readConfig.i_port  # 获取配置文件中接口port
    85.             url = "http://" + ip + ":" + i_port + inf_address
    86.             headers = {
    87.                 "User-Agent": "Mozilla/5.0 (Windows NT 10.0; WOW64; rv:44.0) Gecko/20100101 Firefox/44.0",
    88.                 "X-Requested-With": "XMLHttpRequest",
    89.                 "Connection": "keep-alive"
    90.             }
    91.             par = d1
    92.  
    93.             '''
    94.             判断请求方式是GET还是POST，并且判断测试用例预期结果与实际响应一致
    95.             '''
    96.             if inf_mode == 'GET':
    97.                 r = requests.get(url, params=par)
    98.                 result = r.json()
    99.                 # log.info("---编号%s，接口名称%s---")%(i,inf_name)
    100.                 print(inf_name, str(result).replace('None','null'), a[1])
    101.                 if str(result).replace('None','null') == a[0]:
    102.                     log.info("pass")
    103.                     log.info("--------")
    104.                 else:
    105.                     log.info("false")
    106.                     log.info("--------")
    107.             elif inf_mode == 'POST':
    108.                 r = requests.post(url, data=par, headers=headers)
    109.                 result = r.json()
    110.                 print(inf_name, str(result).replace('None', 'null'), a[1])
    111.                 if str(result).replace('None', 'null') == a[0]:
    112.                     print('pass')
    113.                     print('--------')
    114.                 else:
    115.                     print('false')
    116.                     print('--------')
    117.  
    118.  
    119. api_data()

    配置文件cfg.ini（主要配置邮箱和接口ip+port等常用数据信息）

    1.  
    2. [email]
    3.  
    4. smtp_server = smtp.163.com
    5. port = 465
    6. sender = xxx;psw是QQ邮箱的授权码
    7. psw = xxx
    8.  
    9. ;收件人多个时，中间用逗号隔开,如'a@xx.com,b@xx.com'
    10. receiver = xxx[interface]
    11.  
    12. ip = xxx
    13. ;接口ip
    14. port = xxx
    15. ;接口端口

    readConfig.py读取配置文件中数据

    1.  
    2. # coding:utf-8
    3. import os
    4. import configparser
    5.  
    6. cur_path = os.path.dirname(os.path.realpath(__file__))
    7. configPath = os.path.join(cur_path, "cfg.ini")
    8. conf = configparser.ConfigParser()
    9. conf.read(configPath,encoding='utf-8')
    10.  
    11.  
    12. smtp_server = conf.get("email", "smtp_server")
    13.  
    14. sender = conf.get("email", "sender")
    15.  
    16. psw = conf.get("email", "psw")
    17.  
    18. receiver = conf.get("email", "receiver")
    19.  
    20. port = conf.get("email", "port")
    21.  
    22. ip = conf.get("interface","ip")
    23.  
    24. i_port = conf.get("interface","port")

    优化：

    部分接口访问时，响应未知用户，需要用session关联接口，先调用登录接口，把登录接口的调用封装成了一个实例方法，实现了复用，登录之后，登录接口的http响应会把session以 cookie的形式set到客户端，之后的接口都会使用此session去请求封装登录接口user_login.py

    1.  
    2. #coding:utf-8
    3. import requests
    4. from common.logger import Log
    5.  
    6. class Login():
    7.     log = Log()
    8.  
    9.     def __init__(self,s):
    10.         self.s = s
    11.  
    12.     def login(self,code,passwd):
    13.         url = "http://192.168.20.100:8081/backend/system/user/login"
    14.         headers = {"Content-Type":"application/x-www-form-urlencoded; charset=UTF-8",
    15.                    "User-Agent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.104 Safari/537.36",
    16.                    "X-Requested-With":"XMLHttpRequest",
    17.                    "Cookie":"JSESSIONID=92D7FB4C7FB917B7D2E8DC429A63443F",
    18.                    "Connection":"keep-alive"
    19.                   }
    20.         d = {"code":code,"passwd":passwd}
    21.  
    22.         res = self.s.post(url,headers=headers,data=d)
    23.         result1 = res.text #字节输出
    24.         self.log.info(u"调用登录方法，获取结果：%s"%result1)
    25.         return res.json()

    优化api_test.py中部分代码（红色部分为优化的代码）

    1.在请求接口前首先调用登录接口2.加入执行用例的编号（p），每循环一次自增1

    1.  
    2. #coding:utf-8
    3.  
    4. import xlrd,os
    5. import requests
    6. from datetime import datetime
    7. from xlrd import xldate_as_tuple
    8. from config import readConfig
    9. from common.logger import Log
    10. from case.user_login import Login
    11.  
    12. '''
    13. 获取测试用例data所在的目录
    14. '''
    15. d = os.path.dirname(__file__) #返回当前文件所在目录（common文件夹路径）
    16. parent_path = os.path.dirname(d) #返回common的父级目录
    17. data_path = os.path.join(parent_path,'data') #返回data所在目录
    18. data_path1 = os.listdir(data_path) #返回data目录下所有的文件
    19.  
    20. s = requests.session()
    21. lon = Login(s)
    22. log = Log()
    23.  
    24.  
    25. def api_data():
    26.     p = 1
    27.     for filename in data_path1:
    28.         book = xlrd.open_workbook(os.path.join(data_path,filename))
    29.  
    30.         '''
    31.         获取excel文件中接口信息
    32.         '''
    33.         table = book.sheet_by_index(0) #通过索引，获取相应的列表，这里表示获取excel的第一个列表
    34.         inf_name = table.row_values(1)[0] #返回接口名称
    35.         inf_address = table.row_values(1)[1] #返回接口地址
    36.         inf_mode = table.row_values(1)[2] #返回请求方式
    37.  
    38.         '''
    39.         获取excel文件中测试用例信息
    40.         '''
    41.         sheet = book.sheet_by_index(1) #通过索引，获取相应的列表，这里表示获取excel的第二个列表
    42.         nrows = sheet.nrows #获取所有行数
    43.         filed = sheet.row_values(0)
    44.         # print(filed)
    45.  
    46.         for i in range(1,nrows):
    47.             d1 = {}
    48.             for j in range(0,len(filed)-2):
    49.                 ctype = sheet.cell(i, j).ctype  # 表格的数据类型
    50.                 cell = sheet.cell_value(i, j)
    51.                 d = {}
    52.                 if ctype == 2 and cell % 1 == 0:  # 如果是整形
    53.                     cell = int(cell)
    54.                 elif ctype == 3:
    55.                     # 转成datetime对象
    56.                     date = datetime(*xldate_as_tuple(cell, 0))
    57.                     cell = date.strftime('%Y/%m/%d')
    58.                 elif ctype == 4:
    59.                     cell = True if cell == 1 else False
    60.                 # print(cell)
    61.                 d.update({filed[j]:cell})
    62.                 # print(d)
    63.                 d1.update(d)
    64.             # print(d1)
    65.  
    66.             '''
    67.             获取excel文件中测试用例预期结果和描述
    68.             '''
    69.             a = []
    70.             for k in range(len(filed)-2,len(filed)):
    71.                 ctype = sheet.cell(i, k).ctype  # 表格的数据类型
    72.                 cell = sheet.cell_value(i, k)
    73.                 if ctype == 2 and cell % 1 == 0:  # 如果是整形
    74.                     cell = int(cell)
    75.                 elif ctype == 3:
    76.                     # 转成datetime对象
    77.                     date = datetime(*xldate_as_tuple(cell, 0))
    78.                     cell = date.strftime('%Y/%m/%d')
    79.                 elif ctype == 4:
    80.                     cell = True if cell == 1 else False
    81.                 a.append(cell)
    82.             # print(a[0])
    83.             # print(type(a[0]))
    84.  
    85.             '''
    86.             获取cfg.ini配置文件中接口公共信息（ip和port）
    87.             '''
    88.             ip = readConfig.ip  # 获取配置文件中接口ip
    89.             i_port = readConfig.i_port  # 获取配置文件中接口port
    90.             url = "http://" + ip + ":" + i_port + inf_address
    91.             headers = {
    92.                 "User-Agent": "Mozilla/5.0 (Windows NT 10.0; WOW64; rv:44.0) Gecko/20100101 Firefox/44.0",
    93.                 "X-Requested-With": "XMLHttpRequest",
    94.                 "Connection": "keep-alive"
    95.             }
    96.             par = d1
    97.  
    98.             '''
    99.             判断请求方式是GET还是POST，并且判断测试用例预期结果与实际响应一致，所有接口请求前先调用登录接口
    100.             '''
    101.             code = "xxx"  #登录接口用户code
    102.             passwd = "xxx" #登录接口用户passwd
    103.             lon.login(code, passwd)
    104.  
    105.             if inf_mode == 'GET':
    106.                 r = s.get(url, params=par)
    107.                 result = r.json()
    108.                 log.info("编号：%s，接口名称：%s，测试点：%s，响应：%s"%(p,inf_name,a[1],str(result).replace('None','null')))
    109.                 # print(inf_name, str(result).replace('None','null'), a[1])
    110.                 if str(result).replace('None','null') == a[0]:
    111.                     log.info("pass")
    112.                     log.info("--------")
    113.                 else:
    114.                     log.info("false")
    115.                     log.info("--------")
    116.             elif inf_mode == 'POST':
    117.                 r = s.post(url, data=par, headers=headers)
    118.                 result = r.json()
    119.                 log.info("编号：%s，接口名称：%s，测试点：%s，响应：%s" % (p, inf_name,a[1],str(result).replace('None', 'null')))
    120.                 # print(inf_name, str(result).replace('None', 'null'), a[1])
    121.                 if str(result).replace('None', 'null') == a[0]:
    122.                     log.info("pass")
    123.                     log.info("--------")
    124.                 else:
    125.                     log.info("false")
    126.                     log.info("--------")
    127.  
    128.             p=p+1
    129.  
    130. api_data()

    执行结果：

    优化二：

    excel中添加结果列，将每条用例的执行结果写入excel中，因为excel版本是2007以上，采用openpyxl模块去修改excel单元格的值，执行通过用绿色字体标注pass，执行不通过的用例红色字体标注false优化api_test.py中部分代码

    1.  
    2. #coding:utf-8
    3.  
    4. import xlrd,os
    5. import requests
    6. import openpyxl
    7. from openpyxl.styles import Font
    8. # from xlutils.copy import copy
    9. from datetime import datetime
    10. from xlrd import xldate_as_tuple
    11. from config import readConfig
    12. from common.logger import Log
    13. from case.user_login import Login
    14.  
    15.  
    16. '''
    17. 获取测试用例data所在的目录
    18. '''
    19. d = os.path.dirname(__file__) #返回当前文件所在目录（common文件夹路径）
    20. parent_path = os.path.dirname(d) #返回common的父级目录
    21. data_path = os.path.join(parent_path,'data') #返回data所在目录
    22. data_path1 = os.listdir(data_path) #返回data目录下所有的文件
    23.  
    24. s = requests.session()
    25. lon = Login(s)
    26. log = Log()
    27.  
    28.  
    29. def api_data():
    30.     p = 1
    31.  
    32.  
    33.     for filename in data_path1:
    34.         book = xlrd.open_workbook(os.path.join(data_path,filename))
    35.  
    36.         '''
    37.         使用xlwt操作excel，xlwt只支持excel2007以下版本
    38.         '''
    39.  
    40.         # wb = copy(book)
    41.         # ws = wb.get_sheet(1)
    42.  
    43.         '''
    44.         使用openpyxl操作excel，openpyxl支持excel2007以上版本
    45.         '''
    46.         wb = openpyxl.load_workbook(os.path.join(data_path,filename))
    47.         ws = wb.worksheets[1]
    48.         font_green = Font(color="37b400")
    49.         font_red = Font(color="ff0000")
    50.  
    51.  
    52.         '''
    53.         获取excel文件中接口信息
    54.         '''
    55.         table = book.sheet_by_index(0) #通过索引，获取相应的列表，这里表示获取excel的第一个列表
    56.         inf_name = table.row_values(1)[0] #返回接口名称
    57.         inf_address = table.row_values(1)[1] #返回接口地址
    58.         inf_mode = table.row_values(1)[2] #返回请求方式
    59.  
    60.         '''
    61.         获取excel文件中测试用例信息
    62.         '''
    63.         sheet = book.sheet_by_index(1) #通过索引，获取相应的列表，这里表示获取excel的第二个列表
    64.         nrows = sheet.nrows #获取所有行数
    65.         ncols = sheet.ncols #获取所有列数
    66.         filed = sheet.row_values(0)
    67.         # print(filed)
    68.  
    69.         for i in range(1,nrows):
    70.             d1 = {}
    71.             for j in range(0,len(filed)-3):
    72.                 ctype = sheet.cell(i, j).ctype  # 表格的数据类型
    73.                 cell = sheet.cell_value(i, j)
    74.                 d = {}
    75.                 if ctype == 2 and cell % 1 == 0:  # 如果是整形
    76.                     cell = int(cell)
    77.                 elif ctype == 3:
    78.                     # 转成datetime对象
    79.                     date = datetime(*xldate_as_tuple(cell, 0))
    80.                     cell = date.strftime('%Y/%m/%d')
    81.                 elif ctype == 4:
    82.                     cell = True if cell == 1 else False
    83.                 # print(cell)
    84.                 d.update({filed[j]:cell})
    85.                 # print(d)
    86.                 d1.update(d)
    87.             # print(d1)
    88.  
    89.             '''
    90.             获取excel文件中测试用例预期结果和描述
    91.             '''
    92.             a = []
    93.             for k in range(len(filed)-3,len(filed)-1):
    94.                 ctype = sheet.cell(i, k).ctype  # 表格的数据类型
    95.                 cell = sheet.cell_value(i, k)
    96.                 if ctype == 2 and cell % 1 == 0:  # 如果是整形
    97.                     cell = int(cell)
    98.                 elif ctype == 3:
    99.                     # 转成datetime对象
    100.                     date = datetime(*xldate_as_tuple(cell, 0))
    101.                     cell = date.strftime('%Y/%m/%d')
    102.                 elif ctype == 4:
    103.                     cell = True if cell == 1 else False
    104.                 a.append(cell)
    105.             # print(a[0])
    106.             # print(type(a[0]))
    107.  
    108.             '''
    109.             获取cfg.ini配置文件中接口公共信息（ip和port）
    110.             '''
    111.             ip = readConfig.ip  # 获取配置文件中接口ip
    112.             i_port = readConfig.i_port  # 获取配置文件中接口port
    113.             url = "http://" + ip + ":" + i_port + inf_address
    114.             headers = {
    115.                 "User-Agent": "Mozilla/5.0 (Windows NT 10.0; WOW64; rv:44.0) Gecko/20100101 Firefox/44.0",
    116.                 "X-Requested-With": "XMLHttpRequest",
    117.                 "Connection": "keep-alive"
    118.             }
    119.             par = d1
    120.  
    121.             '''
    122.             判断请求方式是GET还是POST，并且判断测试用例预期结果与实际响应一致，所有接口请求前先调用登录接口
    123.             '''
    124.             code = "xuxingan"
    125.             passwd = "admin"
    126.             lon.login(code, passwd)
    127.  
    128.  
    129.  
    130.             if inf_mode == 'GET':
    131.                 r = s.get(url, params=par)
    132.                 result = r.json()
    133.                 log.info("编号：%s，接口名称：%s，测试点：%s，响应：%s"%(p,inf_name,a[1],str(result).replace('None','null')))
    134.                 # print(inf_name, str(result).replace('None','null'), a[1])
    135.                 if str(result).replace('None','null') == a[0]:
    136.                     # ws.write(i,ncols-1,'pass'.encode('utf-8'))
    137.                     ws.cell(row=i+1,column=ncols,value='pass').font = font_green
    138.                     log.info("pass")
    139.                     log.info("--------")
    140.                 else:
    141.                     # ws.write(i,ncols-1,'false'.encode('utf-8'))
    142.                     ws.cell(row=i+1, column=ncols, value='false').font = font_red
    143.                     log.info("false")
    144.                     log.info("--------")
    145.             elif inf_mode == 'POST':
    146.                 r = s.post(url, data=par, headers=headers)
    147.                 result = r.json()
    148.                 log.info("编号：%s，接口名称：%s，测试点：%s，响应：%s" % (p, inf_name,a[1],str(result).replace('None', 'null')))
    149.                 # print(inf_name, str(result).replace('None', 'null'), a[1])
    150.                 if str(result).replace('None', 'null') == a[0]:
    151.                     # ws.write(i,ncols-1,'pass'.encode('utf-8'))
    152.                     ws.cell(row=i+1, column=ncols, value='pass').font = font_green
    153.                     log.info("pass")
    154.                     log.info("--------")
    155.                 else:
    156.                     # ws.write(i,ncols-1,'false'.encode('utf-8'))
    157.                     ws.cell(row=i+1, column=ncols, value='false').font = font_red
    158.                     log.info("false")
    159.                     log.info("--------")
    160.             wb.save(os.path.join(data_path, filename))
    161.             p=p+1
    162.  
    163.  
    164.     log.info("总计%s条用例"%p)
    165.  
    166. api_data()

    执行结果

    总结：

    第一个版本有点粗糙，1.后续加入将每条用例的执行结果写入测试用例excel文件 2.生成自动化测试报告

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

  • 相关阅读:
    Leetcode刷题详解——四数之和
    SpringBoot SpringBoot 开发实用篇 1 热部署 1.3 热部署范围配置
    分布式事务最经典的八种解决方案
    Java面试题16-线程池的底层工作原理
    Tomcat经验1
    SpringBoot整合SQLite
    基于ResNet34的花朵分类
    Python调用pyttsx3实现离线文字转语音
    SpringBoot - SpringBoot配置说明
    外贸开发信主题怎么写？营销邮件标题推荐？
  • 原文地址：https://blog.csdn.net/wqda125/article/details/133869077