接口测试框架（三）-框架优化

草帽路飞UU

* 一、加入读取、写入Excel文件功能

第一步，在文件读取类中加入读取与写入excel文件的类。

1. from xlrd import open_workbook
   
2. from xlutils.copy import copy
   
3. from xlwt import Style
   
4. 
   
5. class ExcelReader():
   
6.     def __init__(self, excel_file, sheet, title_line=True):
   
7.         if os.path.exists(excel_file):
   
8.             self.excel_file = excel_file
   
9.         else:
   
10.             raise FileNotFoundError('File not found!%s')
    
11.         self.sheet = sheet
    
12.         self.title_line = title_line
    
13.         self.table = None
    
14.         self._data = list()
    
15. 
    
16.     def set_value(self,col, row, value):
    
17.         #   将传入值写进xlsw文件相应的行号，列号中
    
18.         rb = open_workbook(self.excel_file, formatting_info=True)
    
19.         wb = copy(rb)
    
20.         ws = wb.get_sheet(0)
    
21.         ws.write(col, row, value, Style.default_style)
    
22.         wb.save(self.excel_file)
    
23. 
    
24.     @property
    
25.     def data(self):
    
26.         #   读取xlsx文件
    
27.         if not self._data:
    
28.             work_book = open_workbook(self.excel_file)
    
29.             if type(self.sheet) not in [int, str]:
    
30.                 print '[Excel sheet error]Input <int> <str> please'
    
31.             elif type(self.sheet) is str:
    
32.                 self.table = work_book.sheet_by_name(self.sheet)
    
33.             else:
    
34.                 self.table = work_book.sheet_by_index(self.sheet)
    
35.             #   判断是否有标题，标题有无影响数据的格式(可运行最下方main函数进行比较)
    
36.             #   有标题：[{标题1:参数1，标题2：参数2，标题3：参数3}]
    
37.             #   无标题：[[参数1(行1)，参数2(行1)，参数3(行1)],[参数1(行2)，参数2(行2)，参数3(行2)]]
    
38.             if self.title_line:
    
39.                 title = self.table.row_values(0)
    
40.                 for row in range(1, self.table.nrows):
    
41.                     self._data.append(dict(zip(title, self.table.row_values(row))))
    
42.             else:
    
43.                 for col in range(self.table.nrows):
    
44.                     self._data.append(self.table.row_values(col))
    
45.         return self._data

复制代码

这里参照了灰蓝的写法，自己再加入了写入excel文件的方法。

* 二、创建测试类用于读取excel中的测试用例

这一步主要是讲落叶归根博客中的方法引入到我们的测试框架中。大致的思路是，将excel中的数据存入我们的用例类中，生成一个个的测试用例。好像就这一块算是我自己独立完成的，哎，要走的路好长呀。

这里有几个很重要的点，分别是：参数、关联、检查点、是否运行

参数：注意一定要是字典类型否则会出错。参数还要支持参数化，例如$token则会去配置文件中读取token的值，并赋值给该参数。

关联：这里还是拿token举例。比如说我先执行登录接口，登录成功后会返回给我们一个token，接下来的测试都需要用到token。那么我们在这里将登录接口中的token设为关联，运行登录测试用例后，就会将刚获取的token的值存入配置文件中。

检查点：这个比较简单，看响应内容中是否有包含该字符串。

是否运行：这里的值设为yes就会执行，没有的话就不会执行。

1. #!/usr/bin/env python
   
2. #coding=utf-8
   
3. 
   
4. from utils.file_reader import YamlReader
   
5. from utils.config import BASE_PATH
   
6. from utils.client import HTTPsClient
   
7. from utils.log import logger
   
8. import yaml
   
9. import json
   
10. import os
    
11. 
    
12. 
    
13. class InterfaceCase(object):
    
14.     #   接口测试对象，属性对应接口测试xlsx文件。方法有建立用例数据，运行用例数据
    
15.     def __init__(self, data):
    
16.         self.data = data
    
17.         self.no = int('%d' % data['No.'])
    
18.         self.apiName = data['API']
    
19.         self.testCase = data['TestCase']
    
20.         self.host = data['HOST']
    
21.         self.url = data['URL']
    
22.         self.requestMethod = data['RequestMethod']
    
23.         self.params = data['Params']
    
24.         self.relation = data['Relation']
    
25.         self.checkPoint = data['CheckPoint']
    
26.         self.active = data['Active']
    
27.         self.result = 'Na'
    
28.         self.response = None
    
29.         self.y = YamlReader(os.path.join(BASE_PATH, 'config', 'test.yaml'))
    
30.         self.get_config()
    
31. 
    
32.     def __str__(self):
    
33.         #   漂亮的输出测试用例的重要属性
    
34.         return 'No.' + str(self.no) + ' API:' + self.apiName + ' TestCase:' + self.testCase + \
    
35.           ' result:' + self.result
    
36. 
    
37.     def get_config(self):
    
38.         #   将参数中带有$的参数与配置文件中的参数匹配，并赋值
    
39.         #   例如：参数中有$token，则将配置文件中token的值付给token这个参数
    
40.         try:
    
41.             params = json.loads(self.params)
    
42.         except ValueError:
    
43.             logger.warn('No.%s Params input error!' % self.no)
    
44.             return
    
45.         data = self.y.data
    
46.         for i in params:
    
47.             if '
    
48. 
    
49. * 三、编写测试用例
    
50. 
    
51. 都写好啦，终于可以编写接口测试用例了！11，和10列我用来存储执行用例的情况，一个是检查点是否成功，另一个是响应内容。
    
52. <div class="blockcode"><blockquote>#!/usr/bin/env python
    
53. #coding=utf-8
    
54. 
    
55. import unittest
    
56. import os
    
57. from utils.file_reader import ExcelReader
    
58. from utils.log import logger
    
59. from utils.config import Config, DATA_PATH
    
60. from utils.interface_case import InterfaceCase
    
61. 
    
62. 
    
63. class InterfaceTest001(unittest.TestCase):
    
64.     excel_path = os.path.join(DATA_PATH, Config().get('data')['interface_case_list'])
    
65.     e = ExcelReader(excel_path, 0, True)
    
66.     case_list = e.data
    
67. 
    
68.     def test_func(self):
    
69.         for i in self.case_list:
    
70.             #   运行用例前，将xlsx文件中执行结果以及用例执行情况还原
    
71.             self.e.set_value(int('%d' % i['No.']), 11, 'Na')
    
72.             self.e.set_value(int('%d' % i['No.']), 10, '')
    
73.             t = InterfaceCase(i)
    
74.             #   是否执行该条用例
    
75.             if t.active == 'yes':
    
76.                 response = t.run()
    
77.                 logger.info(t)
    
78.                 #   将用例执行结果以及用例执行情况写入xlsx
    
79.                 self.e.set_value(t.no, 10, response['msg'])
    
80.                 self.e.set_value(t.no, 11, t.result)
    
81. 
    
82. 
    
83. if __name__ == '__main__':
    
84.     #   运行测试用例
    
85.     unittest.main()

复制代码

事后一些小小的想法

虽然刚开始的时候觉得落叶归根这种excel存储测试用例的方法实在是太赞了，但是写完之后发现了很多的局限性。比如这样写，我就很难用灰蓝博客中介绍的生成html报告的方法，只能看自己输出的日志文件。

项目开始的时候，我想用这个框架做接口测试，但是发现这个测试框架根本就不够灵活。比如我要做一个登录次数上限的用例，我就不能用这个测试框架，必须要自己重新写测试类。

还有一个特别困扰的问题，师父希望接口测试的脚本更加的灵活。灵活到，我给别人发一个脚本，他F5就可以直接运行。而不是这个框架这样，需要其他的测试员去读懂这个框架。读懂之后还要配置这个框架需要的环境。

总的来说，动手编写这个框架还是很开心的，提升了自己编写python脚本的能力。 in params:
                try:
                    params = data[0]
                except KeyError:
                    raise KeyError('No.%s Params "%s" not found!' % (self.no, i))
        self.params = params

    def run(self):
        #   运行用例，暂时只支持POST以及GET方法。client.py中可支持更多参数配置
        h = HTTPsClient(url=self.host+self.url, method=self.requestMethod)
        if self.requestMethod == 'POST':
            self.response = h.json_transform_dict(h.send(data=self.params))
        elif self.requestMethod == 'GET':
            self.response = h.json_transform_dict(h.send(params=self.params))
        else:
            raise KeyError('method "%s" not support!' % self.requestMethod)
        if self.checkPoint:
            try:
                params = self.checkPoint.split('=')
            except TypeError:
                logger.error('checkPoint input error!')
                raise TypeError('checkPoint input error : %s' % self.checkPoint)
            value = str(self.response[params[0]])
            if value != params[1]:
                self.result = 'Fail'
                logger.info('No.%s check point "%s" not found ' % (self.no, self.checkPoint))
                return self.response
            elif value == params[1]:
                self.result = 'Pass'
        else:
            self.result = 'Pass'
        #   判断是否存在关联，如果有且格式正确则将执行后的参数写入配置文件
        #   例如：$token=token,则将response中的token值存入到配置文件中
        if self.relation:
            try:
                l = self.relation.split(',')
            except TypeError:
                logger.error('relation input error!')
                raise TypeError('relation input error : %s' % self.relation)
            for i in l:
                try:
                    params = i[1:].split('=')
                except TypeError:
                    logger.error('relation input error!')
                    raise TypeError('relation input error : %s' % i)
                data = self.y.data[0]
                #   response['data']根据项目不同可能略有差异
                #   此处防止response中想要获取的值为空，产生异常
                if self.response['data'][params[0]] == None:return self.response
                try:
                    data[params[1]] = self.response['data'][params[0]].encode('utf-8')
                except AttributeError:
                    data[params[1]] = self.response['data'][params[0]]
                #   将变量写入yaml文件
                self.y.data = yaml.dump(data, default_flow_style=False)
        return self.response

* 三、编写测试用例

都写好啦，终于可以编写接口测试用例了！11，和10列我用来存储执行用例的情况，一个是检查点是否成功，另一个是响应内容。
[        DISCUZ_CODE_2        ]
事后一些小小的想法

虽然刚开始的时候觉得落叶归根这种excel存储测试用例的方法实在是太赞了，但是写完之后发现了很多的局限性。比如这样写，我就很难用灰蓝博客中介绍的生成html报告的方法，只能看自己输出的日志文件。

项目开始的时候，我想用这个框架做接口测试，但是发现这个测试框架根本就不够灵活。比如我要做一个登录次数上限的用例，我就不能用这个测试框架，必须要自己重新写测试类。

还有一个特别困扰的问题，师父希望接口测试的脚本更加的灵活。灵活到，我给别人发一个脚本，他F5就可以直接运行。而不是这个框架这样，需要其他的测试员去读懂这个框架。读懂之后还要配置这个框架需要的环境。

总的来说，动手编写这个框架还是很开心的，提升了自己编写python脚本的能力。

jkcxjsf

发的是山东省地方