接口自动化测试方案详解

前言

去年，我们进行了项目的拆分，拆分后的各个子系统也都逐步的改成了通过接口进行数据的交换，接口测试也被提上日程。经过一段时间的探索，接口自动化测试方案越来越完善，今天给大家做个详细的讲解。

方案

目前我们的接口都是使用的http协议，其测试的基本原理是模拟前端（客户端）向服务器发送数据，得到相应的响应数据，从而判断接口是否可以正常的进行数据交换。在测试的过程中尝试过两种方式，一种是利用性能测试工具Jmeter模拟客户端发起http请求，另外一种是使用python脚本直接编写脚本模拟客户端发起http请求。

利用Jmeter工具配置，需要对如何利用Jmeter进行性能测试熟悉，通过相应的配置可完成，但不够灵活，比如某些字段需要经过特定的加密处理，不能通过Jmeter直接完成。

所以选择直接用python脚本进行，模拟http请求也就几行代码就可完成。但只是模拟请求不是最终的目标，也需要易用，不会编码的人也会维护我们的测试用例，所以形成了现在的形态，遵循了测试框架的一些基本原则，业务逻辑与测试脚本分离，测试脚本与测试数据分离。大致框架如下图所示：

目录结构如下：

所有的测试用例使用Excel统一管理，测试数据根据需要可以选择配置在Excel中或者保存在测试数据文件中。测试用例格式如下：

  

日志格式如下：

测试完成后可将异常的接口通过邮件发送给相关人。以上是接口测试方案的大致介绍，下面给大家说说具体怎么配置用例。

如何进行测试

测试的核心脚本已经搭建好，后续不会有太大的改动，维护测试用例的Excel表格即可完成后续接口的测试，不管是新接口的测试还是老接口的回归，那如何编写一个接口的测试用例呢？

1、      打开测试用例的Excel表格，填写用例编号、接口描述信息，被测接口的域名和请求地址。

2、      选择接口请求的方式，目前有两种，一种是POST，一种是GET，根据实际情况选择。

3、      选择接口接收数据的方式，目前有三种，Form类型，请求的数据会进行urlencode编码，一般都是这种类型，官网的接口主要是这种；Data类型，以文本的形式直接请求接口，不经过urlencode编码，引擎的接口大部分是这种，选择Data类型时，请求的数据有两种，一种是直接在Excel中配置json字符串，一种是填写文本文件路径，文件中也是json字符串，主要在于post的数据很大时，比如保存案例，在Excel中不好管理。File类型表示上传文件，在测试上传时选择File类型。

4、      配置需要向接口发送的数据，如下图所示，需要根据上一步中选择的类型配置正确的测试数据，除了填写的是文件路径外，数据必须是标准的json格式字符串。

测试数据中，可以带参数，格式为${parameter}，此处的参数必须在后面的关联（Correlation）字段中有赋值，在后面的关联字段配置给大家详细介绍。其中内置了四个参数，分别是：${randomEmail}（随机邮箱地址）、${randomTel}（随机手机号码）、${timestamp}（当前时间戳）、${session}（session id，默认为None）以及${hashPassword}（hash加密密码，明文123456）。

5、      配置数据是否需要编码加密，目前有三种，不加密，MD5加密和DES加密。这是根据我们自身项目的特点加的选项，引擎有几个接口需要进行MD5加密，场景秀的接口都经过了DES加密。

6、      配置检查点，检查点的目的是校验接口返回的数据是否是我们期望的。

7、      配置关联，在接口的测试过程中，两个接口常常会有相关性，比如引擎新建案例需要先登录官网，那么，就需要做前后接口数据的关联。前面步骤已经提到过，在配置测试数据的时候可以配置参数，那么，关联的配置就是为了给这些参数赋值的，格式如下：${parameter}=[level1][level2][level3]，多个参数中间用半角的分号（;）隔开，如下图所示。关联参数有两部分组成，等号前面是参数名称，需要跟测试数据中配置的参数名称保持一致，等号后面的部分是获取当前接口返回值的，因为接口返回值都是json格式的字符串，所以[level1]表示第一层级的指定key的值，[level1][level2]表示获取第一层级指定key的值中的指定key的值，有点绕，我们举例说明，大家就明白了。

登录接口的返回值是：

1. {"data":"http:\/\/my.test.liveapp.com.cn\/admin\/myapp\/applist","success":true,"message":"6tdehonrs6mg9metjqprfind16"}

后续的操作都需要是登录状态，所以需要得到session id，那么参数就可以这么写：${session}=[message]，得到的值就是6tdehonrs6mg9metjqprfind16。

保存案例接口的返回值是：

1. {"ecode":0,"msg":"SUCCESS","data":[{"$id":"55d43d077f8b9ad56b8b4576","page_id":115323,"page_order":0},……

后续的操作需要mongo id和page id，那么参数可以这样写：${mongo_id}=[data][0][$id];${page_id}=[data][0][page_id]，就可以分别得到55d43d077f8b9ad56b8b4576和115323。这里大家发现会出现数字，是因为”data”的值是一个列表，而不是字典，没有相应的key，所以可以用数字代替，从0开始计算。

8、      最后一步，配置用例是否执行，只有Yes和No两种选项，这个很好理解，就不多解释了。

以上就是配置一条用例的过程，配置完成后，保存Excel文件，提交到SVN即可，Jenkins接口测试的项目已经配置好，在每次引擎项目构建之后都会自动构建接口测试项目。

如果大家还有什么疑问，可以找我一起探讨。

附代码如下（Github：https://github.com/TronGeek/InterfaceTest）：

1. #!/usr/bin/env python
2. #coding=utf8
4. # Todo：接口自动化测试
5. # Author：归根落叶
6. # Blog：http://this.ispenn.com
8. import json
9. import http.client,mimetypes
10. from urllib.parse import urlencode
11. import random
12. import time
13. import re
14. import logging
15. import os,sys
16. try:
17. import xlrd
18. except:
19. os.system('pip install -U xlrd')
20. import xlrd
21. try:
22. from pyDes import *
23. except ImportError as e:
24. os.system('pip install -U pyDes --allow-external pyDes --allow-unverified pyDes')
25. from pyDes import *
26. import hashlib
27. import base64
28. import smtplib
29. from email.mime.text import MIMEText
31. log_file = os.path.join(os.getcwd(),'log/liveappapi.log')
32. log_format = '[%(asctime)s] [%(levelname)s] %(message)s'
33. logging.basicConfig(format=log_format,filename=log_file,filemode='w',level=logging.DEBUG)
34. console = logging.StreamHandler()
35. console.setLevel(logging.DEBUG)
36. formatter = logging.Formatter(log_format)
37. console.setFormatter(formatter)
38. logging.getLogger('').addHandler(console)
40. #获取并执行测试用例
41. def runTest(testCaseFile):
42. testCaseFile = os.path.join(os.getcwd(),testCaseFile)
43. if not os.path.exists(testCaseFile):
44. logging.error('测试用例文件不存在！！！')
45. sys.exit()
46. testCase = xlrd.open_workbook(testCaseFile)
47. table = testCase.sheet_by_index(0)
48. errorCase = []
49. correlationDict = {}
50. correlationDict['${hashPassword}'] = hash1Encode('123456')
51. correlationDict['${session}'] = None
52. for i in range(1,table.nrows):
53. correlationDict['${randomEmail}'] = ''.join(random.sample('abcdefghijklmnopqrstuvwxyz',6)) + '@automation.test'
54. correlationDict['${randomTel}'] = '186' + str(random.randint(10000000,99999999))
55. correlationDict['${timestamp}'] = int(time.time())
56. if table.cell(i,10).value.replace('\n','').replace('\r','') != 'Yes':
57. continue
58. num = str(int(table.cell(i,0).value)).replace('\n','').replace('\r','')
59. api_purpose = table.cell(i,1).value.replace('\n','').replace('\r','')
60. api_host = table.cell(i,2).value.replace('\n','').replace('\r','')
61. request_url = table.cell(i,3).value.replace('\n','').replace('\r','')
62. request_method = table.cell(i,4).value.replace('\n','').replace('\r','')
63. request_data_type = table.cell(i,5).value.replace('\n','').replace('\r','')
64. request_data = table.cell(i,6).value.replace('\n','').replace('\r','')
65. encryption = table.cell(i,7).value.replace('\n','').replace('\r','')
66. check_point = table.cell(i,8).value
67. correlation = table.cell(i,9).value.replace('\n','').replace('\r','').split(';')
68. for key in correlationDict:
69. if request_url.find(key) > 0:
70. request_url = request_url.replace(key,str(correlationDict[key]))
71. if request_data_type == 'Form':
72. dataFile = request_data
73. if os.path.exists(dataFile):
74. fopen = open(dataFile,encoding='utf-8')
75. request_data = fopen.readline()
76. fopen.close()
77. for keyword in correlationDict:
78. if request_data.find(keyword) > 0:
79. request_data = request_data.replace(keyword,str(correlationDict[keyword]))
80. try:
81. if encryption == 'MD5':
82. request_data = json.loads(request_data)
83. status,md5 = getMD5(api_host,urlencode(request_data).replace("%27","%22"))
84. if status != 200:
85. logging.error(num + ' ' + api_purpose + "[ " + str(status) + " ], 获取md5验证码失败！！！")
86. continue
87. request_data = dict(request_data,**{"sign":md5.decode("utf-8")})
88. request_data = urlencode(request_data).replace("%27","%22")
89. elif encryption == 'DES':
90. request_data = json.loads(request_data)
91. request_data = urlencode({'param':encodePostStr(request_data)})
92. else:
93. request_data = urlencode(json.loads(request_data))
94. except Exception as e:
95. logging.error(num + ' ' + api_purpose + ' 请求的数据有误，请检查[Request Data]字段是否是标准的json格式字符串！')
96. continue
97. elif request_data_type == 'Data':
98. dataFile = request_data
99. if os.path.exists(dataFile):
100. fopen = open(dataFile,encoding='utf-8')
101. request_data = fopen.readline()
102. fopen.close()
103. for keyword in correlationDict:
104. if request_data.find(keyword) > 0:
105. request_data = request_data.replace(keyword,str(correlationDict[keyword]))
106. request_data = request_data.encode('utf-8')
107. elif request_data_type == 'File':
108. dataFile = request_data
109. if not os.path.exists(dataFile):
110. logging.error(num + ' ' + api_purpose + ' 文件路径配置无效，请检查[Request Data]字段配置的文件路径是否存在！！！')
111. continue
112. fopen = open(dataFile,'rb')
113. data = fopen.read()
114. fopen.close()
115. request_data = '''
116. ------WebKitFormBoundaryDf9uRfwb8uzv1eNe
117. Content-Disposition:form-data;name="file";filename="%s"
118. Content-Type:
119. Content-Transfer-Encoding:binary
121. %s
122. ------WebKitFormBoundaryDf9uRfwb8uzv1eNe--
123. ''' % (os.path.basename(dataFile),data)
124. status,resp = interfaceTest(num,api_purpose,api_host,request_url,request_data,check_point,request_method,request_data_type,correlationDict['${session}'])
125. if status != 200:
126. errorCase.append((num + ' ' + api_purpose,str(status),'http://'+api_host+request_url,resp))
127. continue
128. for j in range(len(correlation)):
129. param = correlation[j].split('=')
130. if len(param) == 2:
131. if param[1] == '' or not re.search(r'^\[',param[1]) or not re.search(r'\]$',param[1]):
132. logging.error(num + ' ' + api_purpose + ' 关联参数设置有误，请检查[Correlation]字段参数格式是否正确！！！')
133. continue
134. value = resp
135. for key in param[1][1:-1].split(']['):
136. try:
137. temp = value[int(key)]
138. except:
139. try:
140. temp = value[key]
141. except:
142. break
143. value = temp
144. correlationDict[param[0]] = value
145. return errorCase
147. # 接口测试
148. def interfaceTest(num,api_purpose,api_host,request_url,request_data,check_point,request_method,request_data_type,session):
149. headers = {'Content-Type':'application/x-www-form-urlencoded; charset=UTF-8',
150. 'X-Requested-With':'XMLHttpRequest',
151. 'Connection':'keep-alive',
152. 'Referer':'http://' + api_host,
153. 'User-Agent':'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.134 Safari/537.36'}
154. if session is not None:
155. headers['Cookie'] = 'session=' + session
156. if request_data_type == 'File':
157. headers['Content-Type'] = 'multipart/form-data;boundary=----WebKitFormBoundaryDf9uRfwb8uzv1eNe;charset=UTF-8'
158. elif request_data_type == 'Data':
159. headers['Content-Type'] = 'text/plain; charset=UTF-8'
161. conn = http.client.HTTPConnection(api_host)
162. if request_method == 'POST':
163. conn.request('POST',request_url,request_data,headers=headers)
164. elif request_method == 'GET':
165. conn.request('GET',request_url+'?'+request_data,headers=headers)
166. else:
167. logging.error(num + ' ' + api_purpose + ' HTTP请求方法错误，请确认[Request Method]字段是否正确！！！')
168. return 400,request_method
169. response = conn.getresponse()
170. status = response.status
171. resp = response.read()
172. if status == 200:
173. resp = resp.decode('utf-8')
174. if re.search(check_point,str(resp)):
175. logging.info(num + ' ' + api_purpose + ' 成功, ' + str(status) + ', ' + str(resp))
176. return status,json.loads(resp)
177. else:
178. logging.error(num + ' ' + api_purpose + ' 失败！！！, [ ' + str(status) + ' ], ' + str(resp))
179. return 2001,resp
180. else:
181. logging.error(num + ' ' + api_purpose + ' 失败！！！, [ ' + str(status) + ' ], ' + str(resp))
182. return status,resp.decode('utf-8')
184. #获取md5验证码
185. def getMD5(url,postData):
186. headers = {'Content-Type':'application/x-www-form-urlencoded; charset=UTF-8',
187. 'X-Requested-With':'XMLHttpRequest'}
188. conn = http.client.HTTPConnection('this.ismyhost.com')
189. conn.request('POST','/get_isignature',postData,headers=headers)
190. response = conn.getresponse()
191. return response.status,response.read()
193. # hash1加密
194. def hash1Encode(codeStr):
195. hashobj = hashlib.sha1()
196. hashobj.update(codeStr.encode('utf-8'))
197. return hashobj.hexdigest()
199. # DES加密
200. def desEncode(desStr):
201. k = des('secretKEY', padmode=PAD_PKCS5)
202. encodeStr = base64.b64encode(k.encrypt(json.dumps(desStr)))
203. return encodeStr
205. # 字典排序
206. def encodePostStr(postData):
207. keyDict = {'key':'secretKEY'}
208. mergeDict = dict(postData, **keyDict)
209. mergeDict = sorted(mergeDict.items())
210. postStr = ''
211. for i in mergeDict:
212. postStr = postStr + i[0] + '=' + i[1] + '&'
213. postStr = postStr[:-1]
214. hashobj = hashlib.sha1()
215. hashobj.update(postStr.encode('utf-8'))
216. token = hashobj.hexdigest()
217. postData['token'] = token
218. return desEncode(postData)
220. #发送通知邮件
221. def sendMail(text):
222. sender = 'no-reply@myhost.cn'
223. receiver = ['penn@myhost.cn']
224. mailToCc = ['penn@myhost.cn']
225. subject = '[AutomantionTest]接口自动化测试报告通知'
226. smtpserver = 'smtp.exmail.qq.com'
227. username = 'no-reply@myhost.cn'
228. password = 'password'
230. msg = MIMEText(text,'html','utf-8')
231. msg['Subject'] = subject
232. msg['From'] = sender
233. msg['To'] = ';'.join(receiver)
234. msg['Cc'] = ';'.join(mailToCc)
235. smtp = smtplib.SMTP()
236. smtp.connect(smtpserver)
237. smtp.login(username, password)
238. smtp.sendmail(sender, receiver + mailToCc, msg.as_string())
239. smtp.quit()
241. def main():
242. errorTest = runTest('TestCase/TestCasePre.xlsx')
243. if len(errorTest) > 0:
244. html = '接口自动化定期扫描，共有 ' + str(len(errorTest)) + ' 个异常接口，列表如下：' + ''
245. for test in errorTest:
246. html = html + ''
247. html = html + '<table><tbody><tr><th style="width:100px;">接口</th><th style="width:50px;">状态</th><th style="width:200px;">接口地址</th><th>接口返回值</th></tr><tr><td>' + test[0] + '</td><td>' + test[1] + '</td><td>' + test[2] + '</td><td>' + test[3] + '</td></tr></tbody></table>'
248. #sendMail(html)
250. if __name__ == '__main__':
251. main()