简单实现接口自动化测试(基于python)

一、简介

本文从一个简单的登录接口测试入手，一步步调整优化接口调用姿势，然后简单讨论了一下接口测试框架的要点，最后介绍了一下我们目前正在使用的接口测试框架pithy。期望读者可以通过本文对接口自动化测试有一个大致的了解。

二、引言

为什么要做接口自动化测试？ 在当前互联网产品迭代频繁的背景下，回归测试的时间越来越少，很难在每个迭代都对所有功能做完整回归。但接口自动化测试因其实现简单、维护成本低，容易提高覆盖率等特点，越来越受重视。

为什么要自己写框架呢？ 使用requets + unittest很容易实现接口自动化测试，而且requests的api已经非常人性化，非常简单，但通过封装以后（特别是针对公司内特定接口），再加上对一些常用工具的封装，可以进一步提高业务脚本编写效率。

三、环境准备

确保本机已安装python2.7以上版本，然后安装如下库

pip install flask pip install requests

后面我们会使用flask写一个用来测试的接口，使用requests去测试

四、测试接口准备

下面使用flask实现两个http接口，一个登录，另外一个查询详情，但需要登录后才可以，新建一个demo.py文件（注意，不要使用windows记事本），把下面代码copy进去，然后保存、关闭

接口代码

最后执行如下命令

python demo.py

响应如下

大家可以看到服务已经起起来了

接口信息

登录接口

请求url /login

请求方法 post

请求参数

响应信息

详情接口

请求url

/info

请求方法

get

请求cookies

响应信息

五、编写接口测试

测试思路

使用requests [使用链接] 库模拟发送HTTP请求 使用python标准库里unittest写测试case 脚本实现

六、优化

封装接口调用 写完这个测试登录脚本，你或许会发现，在整个项目的测试过程，登录可能不止用到一次，如果每次都这么写，会不会太冗余了？ 对，确实太冗余了，下面做一下简单的封装，把登录接口的调用封装到一个方法里，把调用参数暴漏出来，示例脚本如下：

OK，在这一个版本中，我们不但在把登录接口的调用封装成了一个实例方法，实现了复用，而且还把host（self.base_url）提取了出来，但问题又来了，登录之后，登录接口的http响应会把session以 cookie的形式set到客户端，之后的接口都会使用此session去请求，还有，就是在接口调用过程中，希望可以把日志打印出来，以便调试或者出错时查看。 好吧，我们再来改一版。

保持cookies&增加log信息 使用requests库里的同一个Session对象(它也会在同一个Session 实例发出的所有请求之间保持 cookie)，即可解决上面的问题，示例代码如下：

大功告成，我们把多个相关接口调用封装到一个类中，使用同一个requests Session实例来保持cookies，并且在调用过程中打印出了日志，我们所有目标都实现了，但再看下脚本，又会感觉不太舒服，在每个方法里，都要写一遍print 1、2、3... 要拼url、还要很多细节等等，但其实我们真正需要做的只是拼出关键的参数（url参数、body参数或者传入headers信息），可不可以只需定义必须的信息，然后把其它共性的东西都封装起来呢，统一放到一个地方去管理？

封装重复操作 来，我们再整理一下我们的需求:

首先，不想去重复做拼接url的操作 然后，不想每次都去手工打印日志 不想和requests session打交道 只想定义好参数就直接调用 我们先看一下实现后，脚本可能是什么样:

调用登录接口的日志

在这里，我们使用python的装饰器功能，把公共特性封装到装饰器中去实现。现在感觉好多了，没什么多余的东西了，我们可以专注于关键参数的构造，剩下的就是如何去实现这个装饰器了，我们先理一下思路：

因篇幅限制，源码不再列出，有兴趣的同学可以查看已经实现的源代码

源代码查看地址： https://github.com/yuyu1987/pithy-test/blob/master/pithy/api.py

七、扩展

http接口请求的姿势我们定义好了，我们还可以做些什么呢？

非HTTP协议接口 测试用例编写 配置文件管理 测试数据管理 工具类编写 测试报告生成 持续集成 等等等等

需要做的还是挺多的，要做什么不要做什么，或者先做哪个，我觉得可以根据以下几点去判断：

是否有利于提高团队生产效率 是否有利于提高测试质量 有没有现成的轮子可以用 下面就几项主要的点进行一下说明，限于篇幅，不再展开了

测试报告 这个应该是大家最关心的了，毕竟这是测试工作的产出； 目前python的主流单元测试框均有report插件，因此不建议自己再编写，除非有特殊需求的。

pytest：推荐使用pytest-html和allure pytest

unittest：推荐使用HTMLTestRunner

持续集成 持续集成推荐使用Jenkins，运行环境、定时任务、触发运行、邮件发送等一系列功能均可以在Jenkins上实现。

测试用例编写 推荐遵守如下规则：

原子性：每个用例保持独立，彼此不耦合，以降低干扰； 专一性：一个用例应该专注于验证一件事情，而不是做很多事情，一个测试点不要重复验证； 稳定性：绝大多数用例应该是非常稳定的，也就是说不会经常因为除环境以外的因素挂掉，因为如果在一个测试项目中有很多不稳定的用例的话，测试结果就不能很好的反应项目质量； 分类清晰：有相关性的用例应写到一个模块或一个测试类里，这样做即方便维护，又提高了报告的可读性； 测试工具类这个可以根据项目情况去做，力求简化一些类库的使用，数据库访问、日期时间、序列化与反序列化等数据处理，或者封装一些常用操作，如随机生成订单号等等，以提高脚本编写效率。

测试数据管理 常见的方式有写在代码里、写在配置文件里(xml、yaml、json、.py、excel等)、写在数据库里等，该处没有什么好推荐的，建议根据个人喜好，怎么方便怎么来就可以。

八、pithy测试框架介绍

pithy意为简洁有力的，意在简化自动化接口测试，提高测试效率

项目地址：yuyu1987/pithy-test

帮助文档：Welcome to pithy-test’s documentation!

目前实现的功能如下：

一键生成测试项目 http client封装 thrift接口封装 简化配置文件使用 优化JSON、日期等工具使用 编写测试用例推荐使用pytest，pytest提供了很多测试工具以及插件，可以满足大部分测试需求。

安装 pip install pithy-test pip install pytest 使用 一键生成测试项目

调用HTTP登录接口示例

优化JSON、字典使用