接口自动化测试，完整入门篇

灰太狼 2024-03-23 12:21 51阅读 0赞

**目录**

*  [1. 什么是接口测试][1.]
 *  [2. 基本流程][2.]
 *  [3. 需求分析][3.]
 *  [4. 用例设计][4.]
 *  [5. 脚本开发][5.]
 *  [6. 结果分析][6.]
 *  [7. 完整脚本][7.]
 *  [8. 参考资料][8.]

### 1. 什么是接口测试 ###

顾名思义，接口测试是对系统或组件之间的接口进行测试，主要是校验数据的交换，传递和控制管理过程，以及相互逻辑依赖关系。其中接口协议分为HTTP,WebService,Dubbo,Thrift,Socket等类型，测试类型又主要分为功能测试，性能测试，稳定性测试，安全性测试等。

在分层测试的“金字塔”模型中，接口测试属于第二层服务集成测试范畴。相比UI层（主要是WEB或APP）自动化测试而言，接口自动化测试收益更大，且容易实现，维护成本低，有着更高的投入产出比，是每个公司开展自动化测试的首选。

下面我们以一个HTTP接口为例，完整的介绍接口自动化测试流程：从需求分析到用例设计，从脚本编写、测试执行到结果分析，并提供完整的用例设计及测试脚本。

![503cda06e3384df0bf298257ed1ed2cc.png][]

### 2. 基本流程 ###

基本的接口功能自动化测试流程如下：

需求分析 -> 用例设计 -> 脚本开发 -> 测试执行 -> 结果分析

2.1 示例接口  
接口名称：豆瓣电影搜索

接口文档地址：https://developers.douban.com/wiki/?title=movie\_v2\#search

接口调用示例：

1) 按演职人员搜索：https://api.douban.com/v2/movie/search?q=张艺谋

2) 按片名搜索：https://api.douban.com/v2/movie/search?q=大话西游

3) 按类型搜索：https://api.douban.com/v2/movie/search?tag=喜剧

###    3. 需求分析 ###

需求分析是参考需求、设计等文档，在了解需求的基础上还需清楚内部的实现逻辑，并且可以在这一阶段提出需求、设计存在的不合理或遗漏之处。

如：豆瓣电影搜索接口，我理解的需求即是支持对片名，演职人员及标签的搜索，并分页返回搜索结果。

### 4. 用例设计 ###

用例设计是在理解接口测试需求的基础上，使用MindManager或XMind等思维导图软件编写测试用例设计，主要内容包括参数校验，功能校验、业务场景校验、安全性及性能校验等，常用的用例设计方法有等价类划分法，边界值分析法，场景分析法，因果图，正交表等。

针对豆瓣电影搜索接口功能测试部分，我们主要从参数校验，功能校验，业务场景校验三方面，设计测试用例如下：  
![17496bb2d3c341768586bc19edfa76f7.png][]

### 5. 脚本开发 ###

依据上面编写的测试用例设计，我们使用python+nosetests框架编写了相关自动化测试脚本。可以完整实现接口自动化测试、自动执行及邮件发送测试报告功能。

### 5.1 相关lib安装 ###

必要的lib库如下，使用pip命令安装即可：

pip install nose  
pip install nose-html-reporting  
pip install requests  
5.2 接口调用  
使用requests库，我们可以很方便的编写上述接口调用方法（如搜索q=刘德华，示例代码如下）：

\#coding=utf-8  
import requests  
import json  
  
url = 'https://api.douban.com/v2/movie/search'  
params=dict(q=u'刘德华')  
r = requests.get(url, params=params)  
print 'Search Params:\\n', json.dumps(params, ensure\_ascii=False)  
print 'Search Response:\\n', json.dumps(r.json(), ensure\_ascii=False, indent=4)  
在实际编写自动化测试脚本时，我们需要进行一些封装。如下代码中我们对豆瓣电影搜索接口进行了封装，test\_q方法只需使用nosetests提供的yield方法即可很方便的循环执行列表qs中每一个测试集：

class test\_doubanSearch(object):

@staticmethod  
def search(params, expectNum=None):  
url = 'https://api.douban.com/v2/movie/search'  
r = requests.get(url, params=params)  
print 'Search Params:\\n', json.dumps(params, ensure\_ascii=False)  
print 'Search Response:\\n', json.dumps(r.json(), ensure\_ascii=False, indent=4)

def test\_q(self):  
\# 校验搜索条件 q  
qs = \[u'白夜追凶', u'大话西游', u'周星驰', u'张艺谋', u'周星驰,吴孟达', u'张艺谋,巩俐', u'周星驰,大话西游', u'白夜追凶,潘粤明'\]  
for q in qs:  
params = dict(q=q)  
f = partial(test\_doubanSearch.search, params)  
f.description = json.dumps(params, ensure\_ascii=False).encode('utf-8')  
yield (f,)  
我们按照测试用例设计，依次编写每个功能的自动化测试脚本即可。

### 5.3 结果校验 ###

在手工测试接口的时候，我们需要通过接口返回的结果判断本次测试是否通过，自动化测试也是如此。

对于本次的接口，我们搜索“q=刘德华”，我们需要判断返回的结果中是否含有“演职人员刘德华或片名刘德华”，搜索“tag=喜剧”时，需要判断返回的结果中电影类型是否为“喜剧”，结果分页时需要校验返回的结果数是否正确等。完整结果校验代码如下：

class check\_response():  
@staticmethod  
def check\_result(response, params, expectNum=None):  
\# 由于搜索结果存在模糊匹配的情况，这里简单处理只校验第一个返回结果的正确性  
if expectNum is not None:  
\# 期望结果数目不为None时，只判断返回结果数目  
eq\_(expectNum, len(response\['subjects'\]), '\{0\}!=\{1\}'.format(expectNum, len(response\['subjects'\])))  
else:  
if not response\['subjects'\]:  
\# 结果为空，直接返回失败  
assert False  
else:  
\# 结果不为空，校验第一个结果  
subject = response\['subjects'\]\[0\]  
\# 先校验搜索条件tag  
if params.get('tag'):  
for word in params\['tag'\].split(','):  
genres = subject\['genres'\]  
ok\_(word in genres, 'Check \{0\} failed!'.format(word.encode('utf-8')))

\# 再校验搜索条件q  
elif params.get('q'):  
\# 依次判断片名，导演或演员中是否含有搜索词，任意一个含有则返回成功  
for word in params\['q'\].split(','):  
title = \[subject\['title'\]\]  
casts = \[i\['name'\] for i in subject\['casts'\]\]  
directors = \[i\['name'\] for i in subject\['directors'\]\]  
total = title + casts + directors  
ok\_(any(word.lower() in i.lower() for i in total),  
'Check \{0\} failed!'.format(word.encode('utf-8')))

@staticmethod  
def check\_pageSize(response):  
\# 判断分页结果数目是否正确  
count = response.get('count')  
start = response.get('start')  
total = response.get('total')  
diff = total - start

if diff >= count:  
expectPageSize = count  
elif count > diff > 0:  
expectPageSize = diff  
else:  
expectPageSize = 0

eq\_(expectPageSize, len(response\['subjects'\]), '\{0\}!=\{1\}'.format(expectPageSize, len(response\['subjects'\])))

### 5.4 执行测试 ###

对于上述测试脚本，我们使用nosetests命令可以方便的运行自动化测试，并可使用nose-html-reporting插件生成html格式测试报告。

运行命令如下：

nosetests -v test\_doubanSearch.py:test\_doubanSearch --with-html --html-report=TestReport.html

###  ###

### 5.5 发送邮件报告 ###

测试完成之后，我们可以使用smtplib模块提供的方法发送html格式测试报告。基本流程是读取测试报告 -> 添加邮件内容及附件 -> 连接邮件服务器 -> 发送邮件 -> 退出，示例代码如下：

import smtplib  
from email.mime.text import MIMEText  
from email.mime.multipart import MIMEMultipart

def send\_mail():  
\# 读取测试报告内容  
with open(report\_file, 'r') as f:  
content = f.read().decode('utf-8')

msg = MIMEMultipart('mixed')  
\# 添加邮件内容  
msg\_html = MIMEText(content, 'html', 'utf-8')  
msg.attach(msg\_html)

\# 添加附件  
msg\_attachment = MIMEText(content, 'html', 'utf-8')  
msg\_attachment\["Content-Disposition"\] = 'attachment; filename="\{0\}"'.format(report\_file)  
msg.attach(msg\_attachment)

msg\['Subject'\] = mail\_subjet  
msg\['From'\] = mail\_user  
msg\['To'\] = ';'.join(mail\_to)  
try:  
\# 连接邮件服务器  
s = smtplib.SMTP(mail\_host, 25)  
\# 登陆  
s.login(mail\_user, mail\_pwd)  
\# 发送邮件  
s.sendmail(mail\_user, mail\_to, msg.as\_string())  
\# 退出  
s.quit()  
except Exception as e:  
print "Exceptioin ", e

## 6. 结果分析 ##

打开nosetests运行完成后生成的测试报告，可以看出本次测试共执行了51条测试用例，50条成功，1条失败。

![81553ef2ce3d4827b597028b5529c770.png][]

### 7. 完整脚本 ###

豆瓣电影搜索接口的完整自动化测试脚本，我已上传到的GitHub。下载地址：test\_demo/test\_douban at master · lovesoo/test\_demo · GitHub

下载完成之后，使用如下命令即可进行完整的接口自动化测试并通过邮件发送最终的测试报告：

python test\_doubanSearch.py  
最终发送测试报告邮件，截图如下：

![1b5ed52ed69b4631a3244bd2ef718f75.png][]

### 8. 参考资料 ###

1) requests: Requests: 让 HTTP 服务人类 — Requests 2.18.1 文档

2) nosetests: Testing with nose — nose 1.3.7 documentation

3) nose-html-reporting: nose-html-reporting · PyPI

[1.]: https://www.cnblogs.com/lovesoo/p/7845731.html#_label0
[2.]: https://www.cnblogs.com/lovesoo/p/7845731.html#_label1
[3.]: https://www.cnblogs.com/lovesoo/p/7845731.html#_label2
[4.]: https://www.cnblogs.com/lovesoo/p/7845731.html#_label3
[5.]: https://www.cnblogs.com/lovesoo/p/7845731.html#_label4
[6.]: https://www.cnblogs.com/lovesoo/p/7845731.html#_label5
[7.]: https://www.cnblogs.com/lovesoo/p/7845731.html#_label6
[8.]: https://www.cnblogs.com/lovesoo/p/7845731.html#_label7
[503cda06e3384df0bf298257ed1ed2cc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/025b668c908545b88c5f1138a64c1e9b.png
[17496bb2d3c341768586bc19edfa76f7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/e0ade52e4b8c4bd2880b2f6453115776.png
[81553ef2ce3d4827b597028b5529c770.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/46d1c58039334849b0bdb3daa20897f9.png
[1b5ed52ed69b4631a3244bd2ef718f75.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/ae69dacb856345b6b97a569c4638505a.png