如何简单实现接口自动化测试(基于 python) -买球官网平台

引用
来源:

一、简介

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

二、引言

为什么要做接口自动化测试?

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

为什么要自己写框架呢?

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

三、环境准备

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

pip install flask
pip install requests

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

四、测试接口准备

下面使用flask实现两个http接口,一个登录,另外一个查询详情,但需要登录后才可以,新建一个demo.py文件(注意,不要使用windows记事本),把下面代码copy进去,然后保存、关闭。
接口代码
#!/usr/bin/python
# coding=utf-8
from flask import flask, request, session, jsonify
username = 'admin'
password = '123456'
app = flask(__name__)
app.secret_key = 'pithy'
@app.route('/login', methods=['get', 'post'])
def login():
    error = none
    if request.method == 'post':
        if request.form['username'] != username:
            error = 'invalid username'
        elif request.form['password'] != password:
            error = 'invalid password'
        else:
            session['logged_in'] = true
            return jsonify({'code': 200, 'msg': 'success'})
    return jsonify({'code': 401, 'msg': error}), 401
@app.route('/info', methods=['get'])
def info():
    if not session.get('logged_in'):
        return jsonify({'code': 401, 'msg': 'please login !!'})
    return jsonify({'code': 200, 'msg': 'success', 'data': 'info'})
if __name__ == '__main__':
    app.run(debug=true)

最后执行如下命令:
python demo.py

响应如下:
 * running on http://127.0.0.1:5000/ (press ctrl c to quit)
 * restarting with stat

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

接口信息

登录接口
  • 请求url
  • /login
  • 请求方法
  • post
  • 请求参数
  •    
    参数名称 参数类型 参数说明
    username string         登录名称
    password string         登录密码
  • 响应信息
  • 参数名称 参数类型 参数说明
    code integer 结果code
    msg string 结果信息

详情接口
  • 请求url
  • /info
  • 请求方法
  • get
  • 请求cookies
  •     参数名称  参数类型 参数说明
       session string session
  • 响应信息
  •    参数名称 参数类型 参数说明
        code integer 结果code
        msg string 结果信息
       data string 数据信息

五、编写接口测试

测试思路
  • 使用requests [使用链接] 库模拟发送http请求。
  • 使用python标准库里unittest写测试case。
脚本实现
#!/usr/bin/python
# coding=utf-8
import requests
import unittest
class testlogin(unittest.testcase):
    @classmethod
    def setupclass(cls):
        cls.login_url = 'http://127.0.0.1:5000/login'
        cls.info_url = 'http://127.0.0.1:5000/info'
        cls.username = 'admin'
        cls.password = '123456'
    def test_login(self):
        """
        测试登录
        """
        data = {
            'username': self.username,
            'password': self.password
        }
        response = requests.post(self.login_url, data=data).json()
        assert response['code'] == 200
        assert response['msg'] == 'success'
    def test_info(self):
        """
        测试info接口
        """
        data = {
            'username': self.username,
            'password': self.password
        }
        response_cookies = requests.post(self.login_url, data=data).cookies
        session = response_cookies.get('session')
        assert session
        info_cookies = {
            'session': session
        }
        response = requests.get(self.info_url, cookies=info_cookies).json()
        assert response['code'] == 200
        assert response['msg'] == 'success'
        assert response['data'] == 'info'

六、优化
封装接口调用

写完这个测试登录脚本,你或许会发现,在整个项目的测试过程,登录可能不止用到一次,如果每次都这么写,会不会太冗余了? 对,确实太冗余了,下面做一下简单的封装,把登录接口的调用封装到一个方法里,把调用参数暴漏出来,示例脚本如下:
#!/usr/bin/python
# coding=utf-8
import requests
import unittest
try:
    from urlparse import urljoin
except importerror:
    from urllib.parse import urljoin
class demoapi(object):
    def __init__(self, base_url):
        self.base_url = base_url
    def login(self, username, password):
        """
        登录接口
        :param username: 用户名
        :param password: 密码
        """
        url = urljoin(self.base_url, 'login')
        data = {
            'username': username,
            'password': password
        }
        return requests.post(url, data=data).json()
    def get_cookies(self, username, password):
        """
        获取登录cookies
        """
        url = urljoin(self.base_url, 'login')
        data = {
            'username': username,
            'password': password
        }
        return requests.post(url, data=data).cookies
    def info(self, cookies):
        """
        详情接口
        """
        url = urljoin(self.base_url, 'info')
        return requests.get(url, cookies=cookies).json()
class testlogin(unittest.testcase):
    @classmethod
    def setupclass(cls):
        cls.base_url = 'http://127.0.0.1:5000'
        cls.username = 'admin'
        cls.password = '123456'
        cls.app = demoapi(cls.base_url)
    def test_login(self):
        """
        测试登录
        """
        response = self.app.login(self.username, self.password)
        assert response['code'] == 200
        assert response['msg'] == 'success'
    def test_info(self):
        """
        测试获取详情信息
        """
        cookies = self.app.get_cookies(self.username, self.password)
        response = self.app.info(cookies)
        assert response['code'] == 200
        assert response['msg'] == 'success'
        assert response['data'] == 'info'

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

好吧,我们再来改一版。

保持cookies&增加log信息

使用requests库里的同一个session对象(它也会在同一个session 实例发出的所有请求之间保持 cookie),即可解决上面的问题,示例代码如下:
#!/usr/bin/python
# coding=utf-8
import unittest
from pprint import pprint
from requests.sessions import session
try:
    from urlparse import urljoin
except importerror:
    from urllib.parse import urljoin
class demoapi(object):
    def __init__(self, base_url):
        self.base_url = base_url
        # 创建session实例
        self.session = session()
    def login(self, username, password):
        """
        登录接口
        :param username: 用户名
        :param password: 密码
        """
        url = urljoin(self.base_url, 'login')
        data = {
            'username': username,
            'password': password
        }
        response = self.session.post(url, data=data).json()
        print('\n*****************************************')
        print(u'\n1、请求url: \n%s' % url)
        print(u'\n2、请求头信息:')
        pprint(self.session.headers)
        print(u'\n3、请求参数:')
        pprint(data)
        print(u'\n4、响应:')
        pprint(response)
        return response
    def info(self):
        """
        详情接口
        """
        url = urljoin(self.base_url, 'info')
        response = self.session.get(url).json()
        print('\n*****************************************')
        print(u'\n1、请求url: \n%s' % url)
        print(u'\n2、请求头信息:')
        pprint(self.session.headers)
        print(u'\n3、请求cookies:')
        pprint(dict(self.session.cookies))
        print(u'\n4、响应:')
        pprint(response)
        return response
class testlogin(unittest.testcase):
    @classmethod
    def setupclass(cls):
        cls.base_url = 'http://127.0.0.1:5000'
        cls.username = 'admin'
        cls.password = '123456'
        cls.app = demoapi(cls.base_url)
    def test_login(self):
        """
        测试登录
        """
        response = self.app.login(self.username, self.password)
        assert response['code'] == 200
        assert response['msg'] == 'success'
    def test_info(self):
        """
        测试获取详情信息
        """
        self.app.login(self.username, self.password)
        response = self.app.info()
        assert response['code'] == 200
        assert response['msg'] == 'success'
        assert response['data'] == 'info'

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

封装重复操作

来,我们再整理一下我们的需求:
  • 首先,不想去重复做拼接url的操作。
  • 然后,不想每次都去手工打印日志。
  • 不想和requests session打交道。
  • 只想定义好参数就直接调用。
我们先看一下实现后,脚本可能是什么样:
class demoapi(object):
    def __init__(self, base_url):
        self.base_url = base_url
    @request(url='login', method='post')
    def login(self, username, password):
        """
        登录接口
        """
        data = {
            'username': username,
            'password': password
        }
        return {'data': data}
    @request(url='info', method='get')
    def info(self):
        """
        详情接口
        """
        pass

调用登录接口的日志:
******************************************************
1、接口描述
登录接口
2、请求url
http://127.0.0.1:5000/login
3、请求方法
post
4、请求headers
{
    "accept": "*/*",
    "accept-encoding": "gzip, deflate",
    "connection": "keep-alive",
    "user-agent": "python-requests/2.7.0 cpython/2.7.10 darwin/16.4.0"
}
5、body参数
{
    "password": "123456",
    "username": "admin"
}
6、响应结果
{
    "code": 200,
    "msg": "success"
}

在这里,我们使用python的装饰器功能,把公共特性封装到装饰器中去实现。现在感觉好多了,没什么多余的东西了,我们可以专注于关键参数的构造,剩下的就是如何去实现这个装饰器了,我们先理一下思路:
  • 获取装饰器参数
  • 获取函数/方法参数
  • 把装饰器和函数定义的参数合并
  • 拼接url
  • 处理requests session,有则使用,无则新生成一个
  • 组装所有参数,发送http请求并打印日志
因篇幅限制,源码不再列出,有兴趣的同学可以查看已经实现的源代码。

源代码查看地址:

七、扩展

http接口请求的姿势我们定义好了,我们还可以做些什么呢?
  • [x] 非http协议接口
  • [x] 测试用例编写
  • [x] 配置文件管理
  • [x] 测试数据管理
  • [x] 工具类编写
  • [x] 测试报告生成
  • [x] 持续集成
  • [x] 等等等等
需要做的还是挺多的,要做什么不要做什么,或者先做哪个,我觉得可以根据以下几点去判断:
  • 是否有利于提高团队生产效率?
  • 是否有利于提高测试质量?
  • 有没有现成的轮子可以用?
下面就几项主要的点进行一下说明,限于篇幅,不再展开了。

测试报告

这个应该是大家最关心的了,毕竟这是测试工作的产出;

目前python的主流单元测试框均有report插件,因此不建议自己再编写,除非有特殊需求的。
  • pytest:推荐使用pytest-html和allure pytest。
  • unittest:推荐使用htmltestrunner。
持续集成

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

推荐遵守如下规则:
  • 原子性:每个用例保持独立,彼此不耦合,以降低干扰。
  • 专一性:一个用例应该专注于验证一件事情,而不是做很多事情,一个测试点不要重复验证。
  • 稳定性:绝大多数用例应该是非常稳定的,也就是说不会经常因为除环境以外的因素挂掉,因为如果在一个测试项目中有很多不稳定的用例的话,测试结果就不能很好的反应项目质量。
  • 分类清晰:有相关性的用例应写到一个模块或一个测试类里,这样做即方便维护,又提高了报告的可读性。
测试工具类

这个可以根据项目情况去做,力求简化一些类库的使用,数据库访问、日期时间、序列化与反序列化等数据处理,或者封装一些常用操作,如随机生成订单号等等,以提高脚本编写效率。

测试数据管理

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

八、pithy测试框架介绍

pithy意为简洁有力的,意在简化自动化接口测试,提高测试效率。
  • 项目地址:
  • 帮助文档:
目前实现的功能如下:
  • 一键生成测试项目
  • http client封装
  • thrift接口封装
  • 简化配置文件使用
  • 优化json、日期等工具使用
编写测试用例推荐使用pytest,提供了很多测试工具以及插件,可以满足大部分测试需求。

安装

pip install pithy-test
pip install pytest

使用

一键生成测试项目
>>>  pithy-cli init
请选择项目类型,输入api或者app: api
请输入项目名称,如pithy-api-test: pithy-api-test
开始创建pithy-api-test项目
开始渲染...
生成 api/.gitignore                   [√]
生成 api/apis/__init__.py             [√]
生成 api/apis/pithy_api.py            [√]
生成 api/cfg.yaml                     [√]
生成 api/db/__init__.py               [√]
生成 api/db/pithy_db.py               [√]
生成 api/readme.md                    [√]
生成 api/requirements.txt             [√]
生成 api/test_suites/__init__.py      [√]
生成 api/test_suites/test_login.py    [√]
生成 api/utils/__init__.py            [√]
生成成功,请使用编辑器打开该项目

生成项目树:
>>> tree pithy-api-test
pithy-api-test
├── readme.md
├── apis
│   ├── __init__.py
│   └── pithy_api.py
├── cfg.yaml
├── db
│   ├── __init__.py
│   └── pithy_db.py
├── requirements.txt
├── test_suites
│   ├── __init__.py
│   └── test_login.py
└── utils
    └── __init__.py
4 directories, 10 files

调用http登录接口示例
from pithy import request
@request(url='http://httpbin.org/post', method='post')
def post(self, key1='value1'):
    """
    post method
    """
    data = {
        'key1': key1
    }
    return dict(data=data)
# 使用
response = post('test').to_json()     # 解析json字符,输出为字典
response = post('test').json          # 解析json字符,输出为字典
response = post('test').to_content()  # 输出为字符串
response = post('test').content       # 输出为字符串
response = post('test').get_cookie()  # 输出cookie对象
response = post('test').cookie        # 输出cookie对象
# 结果取值, 假设此处response = {'a': 1, 'b': { 'c': [1, 2, 3, 4]}}
response = post('13111111111', '123abc').json
print response.b.c   # 通过点号取值,结果为[1, 2, 3, 4]
print response('$.a') # 通过object path取值,结果为1
for i in response('$..c[@>3]'): # 通过object path取值,结果为选中c字典里大于3的元素
    print i

优化json、字典使用
# 1、操作json的key
from pithy import jsonprocessor
dict_data = {'a': 1, 'b': {'a': [1, 2, 3, 4]}}
json_data = json.dumps(dict_data)
result = jsonprocessor(json_data)
print result.a     # 结果:1
print result.b.a   # 结果:[1, 2, 3, 4]
# 2、操作字典的key
dict_data = {'a': 1, 'b': {'a': [1, 2, 3, 4]}}
result = jsonprocessor(dict_data)
print result.a     # 1
print result.b.a   # [1, 2, 3, 4]
# 3、object path取值
raw_dict = {
    'key1':{
        'key2':{
            'key3': [1, 2, 3, 4, 5, 6, 7, 8]
        }
    }
}
jp = jsonprocessor(raw_dict)
for i in jp('$..key3[@>3]'):
    print i
# 4、其它用法
dict_1 = {'a': 'a'}
json_1 = '{"b": "b"}'
jp = jsonprocessor(dict_1, json_1, c='c')
print(jp)

更多使用方法



九、总结

在本文中,我们以提高脚本开发效率为前提,一步一步打造了一个简易的测试框架,但因水平所限,并未涉及测试数据初始化清理、测试中如何mock等话题,前路依然任重而道远,希望给大家一个启发,不足之处还望多多指点,非常感谢。

作者简介

孙彦辉,饿了么软件测试工程师,主要负责大物流蜂鸟商家版的测试工作。

参考:
  • requests:
  • thriftpy:
  • objectpath:
  • pytest:

来自:
0
0
评论 共 0 条 请登录后发表评论

发表评论

您还没有登录,请您登录后再发表评论

相关推荐

  • 资源名称:web接口自动化测试 基于python语言资源截图: 资源太大,传百度网盘了,链接在附件中,有需要的同学自取。

  • 一、简介 本文从一个简单的登录接口测试入手,一步步调整优化接口调用姿势,...但接口自动化测试因其实现简单、维护成本低,容易提高覆盖率等特点,越来越受重视。 为什么要自己写框架呢? 使用requets unitt

  • 基于python的接口自动化测试实例.pdf

  • web接口自动化测试 基于python语言 web接口自动化测试 基于python语言 最新版

  • python web接口开发与自动化测试,pdf高清,非常值得学习的资料

  • 本文来自于csdn,本文基于python testlink jenkins实现的接口自动化测试框架,进行开发环境配置,模块创建等,希望对您的学习有所帮助。1、开发环境2、主要功能逻辑介绍3、框架功能简介4、数据库的创建5、框架模块...

  • 1、测试数据 3、自动写入 token 到测试数据中 4、编写测试用例 5、构建测试集合 6、执行测试用例集 7、测试报告 2、安装脚本中需要的库 3、选择自己

  • 本书以接口测试为主线,以web开发为切入点,全面...测试工具和接口自动化测试框架的开发;第11介绍了安全接口的开发与 测试;第12、13章介绍了web services技术;第14、15章介绍了django web项目的部署和接口性能测试。

  • 本文通过从postman获取基本的接口测试code简单的接口测试入手,一步步调整优化接口调用,以及增加基本的结果判断,讲解python自带的unittest框架调用,期望各位可以通过本文对接口自动化测试有一个大致的了解。...

  • 接口自动化测试python源码,都是基于python3 都是基于webdriver,大部分代码都可以通用,只是配置文件不一样 app监控了常用的men,cpu,fps 数据维护用的ymal 邮件发送excel的测试报告

  • 一、简介 本文从一个简单的登录接口测试入手,一步步调整优化接口调用姿势; 然后简单讨论了一下接口测试...但接口自动化测试因其实现简单、维护成本低,容易提高覆盖率等特点,越来越受重视。 为什么要自己写框架...

  • 公司内部的软件采用b/s架构,大部分是数据的增删改查,由于还在开发阶段,所以ui界面的变化非常快,难以针对ui进行自动化测试,那样会消耗大量的精力与时间维护自动化脚本。针对此种情况,针对接口测试较为有效。 ...

  • web接口开发与自动化测试基于python语言,百度网盘下载,高清

  • python实现头条项目接口自动化测试实战资料.rar,02_资料,课堂笔记.md,接口清单.txt,.ds_store,自动化测试目录结构.xmind,单条用例.xlsx,多条用例.xlsx,hmtt.sql,04_代码,api,__pycache__,api_channels.cpython-36....

  • 基于python语言的接口自动化,三分之一的篇幅有关 python的django,内容详细很实用,还在学习中,很适合入门。虫师的书 pdf版本建议使用pad看

  • 基于python的接口自动化测试框架讲解用ppt,为了能让学员更好的理解接口自动化测试框架的ppt。

  • 说明:该篇博客是博主一字一码编写的,实属不易,请尊重原创,谢谢大家!...整个项目分为四个部分:接口基础丶接口开发丶unittest与接口测试结合以及接口自动化框架从设计到开发 接口基础包括:h...

  • [接口测试] 是相对来说和我们的功能测试 [最为接近的一种自动化测试手段] ,所以我们首先来学习接口测试的内容。 实现接口的开发与接口的测试,在我们的思维上、想法上、面向的态度上都是不一样的。所以大家要有一个...

  • 基于python的接口自动化测试框架设计.pdf

global site tag (gtag.js) - google analytics