• 基于Python简单实现接口自动化测试（详解）

    一、简介

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

    二、引言

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

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

    为什么要自己写框架呢？

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

    同时，我也准备了一份软件测试视频教程（含接口、自动化、性能等），需要的可以直接在下方观看，或者直接关注VX公众号：互联网杂货铺，免费领取

    软件测试视频教程观看处：

    字节大佬教你逼自己如何在15天内掌握自动化测试（接口自动化/APP自动化/Web自动化/性能测试），内含项目实战

    三、环境准备

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

    1. pip install flask
    2. pip install requests

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

    四、测试接口准备

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

    接口代码

    1. #!/usr/bin/python
    2. # coding=utf-8
    3. from flask import Flask, request, session, jsonify
    4.  
    5. USERNAME = 'admin'
    6. PASSWORD = '123456'
    7.  
    8. app = Flask(__name__)
    9. app.secret_key = 'pithy'
    10.  
    11.  
    12. @app.route('/login', methods=['GET', 'POST'])
    13. def login():
    14.     error = None
    15.     if request.method == 'POST':
    16.         if request.form['username'] != USERNAME:
    17.             error = 'Invalid username'
    18.         elif request.form['password'] != PASSWORD:
    19.             error = 'Invalid password'
    20.         else:
    21.             session['logged_in'] = True
    22.             return jsonify({'code': 200, 'msg': 'success'})
    23.     return jsonify({'code': 401, 'msg': error}), 401
    24.  
    25.  
    26. @app.route('/info', methods=['get'])
    27. def info():
    28.     if not session.get('logged_in'):
    29.         return jsonify({'code': 401, 'msg': 'please login !!'})
    30.     return jsonify({'code': 200, 'msg': 'success', 'data': 'info'})
    31.  
    32. if __name__ == '__main__':
    33.     app.run(debug=True)

    最后执行如下命令

    python demo.py

    响应如下

    1.  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
    2.  * Restarting with stat

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

    接口信息

    登录接口

    请求url

     /login

    请求方法

     post

    请求参数

    响应信息

    详情接口

    请求url

    /info

    请求方法

    get

    请求cookies

    响应信息

    五、编写接口测试

    测试思路

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

    脚本实现

    1. #!/usr/bin/python
    2. # coding=utf-8
    3. import requests
    4. import unittest
    5.  
    6.  
    7. class TestLogin(unittest.TestCase):
    8.  
    9.     @classmethod
    10.     def setUpClass(cls):
    11.         cls.login_url = 'http://127.0.0.1:5000/login'
    12.         cls.info_url = 'http://127.0.0.1:5000/info'
    13.         cls.username = 'admin'
    14.         cls.password = '123456'
    15.  
    16.     def test_login(self):
    17.         """
    18.         测试登录
    19.         """
    20.         data = {
    21.             'username': self.username,
    22.             'password': self.password
    23.         }
    24.  
    25.         response = requests.post(self.login_url, data=data).json()
    26.  
    27.         assert response['code'] == 200
    28.         assert response['msg'] == 'success'
    29.  
    30.     def test_info(self):
    31.         """
    32.         测试info接口
    33.         """
    34.  
    35.         data = {
    36.             'username': self.username,
    37.             'password': self.password
    38.         }
    39.  
    40.         response_cookies = requests.post(self.login_url, data=data).cookies
    41.         session = response_cookies.get('session')
    42.         assert session
    43.  
    44.         info_cookies = {
    45.             'session': session
    46.         }
    47.  
    48.         response = requests.get(self.info_url, cookies=info_cookies).json()
    49.         assert response['code'] == 200
    50.         assert response['msg'] == 'success'
    51.         assert response['data'] == 'info'
    52.

    六、优化

    封装接口调用

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

    1. #!/usr/bin/python
    2. # coding=utf-8
    3. import requests
    4. import unittest
    5. try:
    6.     from urlparse import urljoin
    7. except ImportError:
    8.     from urllib.parse import urljoin
    9.  
    10.  
    11. class DemoApi(object):
    12.  
    13.     def __init__(self, base_url):
    14.         self.base_url = base_url
    15.  
    16.     def login(self, username, password):
    17.         """
    18.         登录接口
    19.         :param username: 用户名
    20.         :param password: 密码
    21.         """
    22.         url = urljoin(self.base_url, 'login')
    23.         data = {
    24.             'username': username,
    25.             'password': password
    26.         }
    27.  
    28.         return requests.post(url, data=data).json()
    29.  
    30.     def get_cookies(self, username, password):
    31.         """
    32.         获取登录cookies
    33.         """
    34.         url = urljoin(self.base_url, 'login')
    35.         data = {
    36.             'username': username,
    37.             'password': password
    38.         }
    39.  
    40.         return requests.post(url, data=data).cookies
    41.  
    42.     def info(self, cookies):
    43.         """
    44.         详情接口
    45.         """
    46.         url = urljoin(self.base_url, 'info')
    47.         return requests.get(url, cookies=cookies).json()
    48.  
    49.  
    50. class TestLogin(unittest.TestCase):
    51.  
    52.     @classmethod
    53.     def setUpClass(cls):
    54.         cls.base_url = 'http://127.0.0.1:5000'
    55.         cls.username = 'admin'
    56.         cls.password = '123456'
    57.         cls.app = DemoApi(cls.base_url)
    58.  
    59.     def test_login(self):
    60.         """
    61.         测试登录
    62.         """
    63.         response = self.app.login(self.username, self.password)
    64.         assert response['code'] == 200
    65.         assert response['msg'] == 'success'
    66.  
    67.     def test_info(self):
    68.         """
    69.         测试获取详情信息
    70.         """
    71.         cookies = self.app.get_cookies(self.username, self.password)
    72.         response = self.app.info(cookies)
    73.         assert response['code'] == 200
    74.         assert response['msg'] == 'success'
    75.         assert response['data'] == 'info'

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

    保持cookies&增加log信息

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

    1. #!/usr/bin/python
    2. # coding=utf-8
    3. import unittest
    4. from pprint import pprint
    5. from requests.sessions import Session
    6. try:
    7.     from urlparse import urljoin
    8. except ImportError:
    9.     from urllib.parse import urljoin
    10.  
    11.  
    12. class DemoApi(object):
    13.  
    14.     def __init__(self, base_url):
    15.         self.base_url = base_url
    16.         # 创建session实例
    17.         self.session = Session()
    18.  
    19.     def login(self, username, password):
    20.         """
    21.         登录接口
    22.         :param username: 用户名
    23.         :param password: 密码
    24.         """
    25.         url = urljoin(self.base_url, 'login')
    26.         data = {
    27.             'username': username,
    28.             'password': password
    29.         }
    30.  
    31.         response = self.session.post(url, data=data).json()
    32.         print('\n*****************************************')
    33.         print(u'\n1、请求url: \n%s' % url)
    34.         print(u'\n2、请求头信息:')
    35.         pprint(self.session.headers)
    36.         print(u'\n3、请求参数:')
    37.         pprint(data)
    38.         print(u'\n4、响应:')
    39.         pprint(response)
    40.         return response
    41.  
    42.     def info(self):
    43.         """
    44.         详情接口
    45.         """
    46.         url = urljoin(self.base_url, 'info')
    47.         response = self.session.get(url).json()
    48.  
    49.         print('\n*****************************************')
    50.         print(u'\n1、请求url: \n%s' % url)
    51.         print(u'\n2、请求头信息:')
    52.         pprint(self.session.headers)
    53.         print(u'\n3、请求cookies:')
    54.         pprint(dict(self.session.cookies))
    55.         print(u'\n4、响应:')
    56.         pprint(response)
    57.         return response
    58.  
    59.  
    60. class TestLogin(unittest.TestCase):
    61.  
    62.     @classmethod
    63.     def setUpClass(cls):
    64.         cls.base_url = 'http://127.0.0.1:5000'
    65.         cls.username = 'admin'
    66.         cls.password = '123456'
    67.         cls.app = DemoApi(cls.base_url)
    68.  
    69.     def test_login(self):
    70.         """
    71.         测试登录
    72.         """
    73.         response = self.app.login(self.username, self.password)
    74.         assert response['code'] == 200
    75.         assert response['msg'] == 'success'
    76.  
    77.     def test_info(self):
    78.         """
    79.         测试获取详情信息
    80.         """
    81.         self.app.login(self.username, self.password)
    82.         response = self.app.info()
    83.         assert response['code'] == 200
    84.         assert response['msg'] == 'success'
    85.         assert response['data'] == 'info'
    86.

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

    封装重复操作

    来，我们再整理一下我们的需求：

    • 首先，不想去重复做拼接url的操作
    • 然后，不想每次都去手工打印日志
    • 不想和requests session打交道
    • 只想定义好参数就直接调用

    我们先看一下实现后，脚本可能是什么样：

    1. class DemoApi(object):
    2.  
    3.     def __init__(self, base_url):
    4.         self.base_url = base_url
    5.  
    6.     @request(url='login', method='post')
    7.     def login(self, username, password):
    8.         """
    9.         登录接口
    10.         """
    11.         data = {
    12.             'username': username,
    13.             'password': password
    14.         }
    15.  
    16.         return {'data': data}
    17.  
    18.     @request(url='info', method='get')
    19.     def info(self):
    20.         """
    21.         详情接口
    22.         """
    23.         pass

    调用登录接口的日志

    1. ******************************************************
    2. 1、接口描述
    3. 登录接口
    4.  
    5. 2、请求url
    6. http://127.0.0.1:5000/login
    7.  
    8. 3、请求方法
    9. post
    10.  
    11. 4、请求headers
    12. {
    13.     "Accept": "*/*",
    14.     "Accept-Encoding": "gzip, deflate",
    15.     "Connection": "keep-alive",
    16.     "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/16.4.0"
    17. }
    18.  
    19. 5、body参数
    20. {
    21.     "password": "123456",
    22.     "username": "admin"
    23. }
    24.  
    25. 6、响应结果
    26. {
    27.     "code": 200,
    28.     "msg": "success"
    29. }

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

    • 获取装饰器参数
    • 获取函数/方法参数
    • 把装饰器和函数定义的参数合并
    • 拼接url
    • 处理requests session，有则使用，无则新生成一个
    • 组装所有参数，发送http请求并打印日志

    七、扩展

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

    1. 非HTTP协议接口
    2. 测试用例编写
    3. 配置文件管理
    4. 测试数据管理
    5. 工具类编写
    6. 测试报告生成
    7. 持续集成等等

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

    • 是否有利于提高团队生产效率
    • 是否有利于提高测试质量
    • 有没有现成的轮子可以用

    下面就几项主要的点进行一下说明，限于篇幅，不再展开了

    测试报告

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

    • pytest：推荐使用pytest-html和allure pytest
    • unittest：推荐使用HTMLTestRunner

    持续集成

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

    测试用例编写

    推荐遵守如下规则：

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

    测试工具类

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

    测试数据管理

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

    八、pithy测试框架介绍

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

    目前实现的功能如下：

    • 一键生成测试项目
    • http client封装
    • thrift接口封装
    • 简化配置文件使用
    • 优化JSON、日期等工具使用

    编写测试用例推荐使用pytest，pytest提供了很多测试工具以及插件，可以满足大部分测试需求。

    安装

    1. pip install pithy-test
    2. pip install pytest

    使用

    一键生成测试项目

    1. >>>  pithy-cli init
    2. 请选择项目类型,输入api或者app: api
    3. 请输入项目名称,如pithy-api-test: pithy-api-test
    4. 开始创建pithy-api-test项目
    5. 开始渲染...
    6. 生成 api/.gitignore                   [√]
    7. 生成 api/apis/__init__.py             [√]
    8. 生成 api/apis/pithy_api.py            [√]
    9. 生成 api/cfg.yaml                     [√]
    10. 生成 api/db/__init__.py               [√]
    11. 生成 api/db/pithy_db.py               [√]
    12. 生成 api/README.MD                    [√]
    13. 生成 api/requirements.txt             [√]
    14. 生成 api/test_suites/__init__.py      [√]
    15. 生成 api/test_suites/test_login.py    [√]
    16. 生成 api/utils/__init__.py            [√]
    17. 生成成功,请使用编辑器打开该项目

    生成项目树

    1. >>> tree pithy-api-test
    2. pithy-api-test
    3. ├── README.MD
    4. ├── apis
    5. │   ├── __init__.py
    6. │   └── pithy_api.py
    7. ├── cfg.yaml
    8. ├── db
    9. │   ├── __init__.py
    10. │   └── pithy_db.py
    11. ├── requirements.txt
    12. ├── test_suites
    13. │   ├── __init__.py
    14. │   └── test_login.py
    15. └── utils
    16.     └── __init__.py
    17.  
    18. 4 directories, 10 files

    调用HTTP登录接口示例

    1. from pithy import request
    2.  
    3. @request(url='http://httpbin.org/post', method='post')
    4. def post(self, key1='value1'):
    5.     """
    6.     post method
    7.     """
    8.     data = {
    9.         'key1': key1
    10.     }
    11.     return dict(data=data)
    12.  
    13. # 使用
    14. response = post('test').to_json()     # 解析json字符,输出为字典
    15. response = post('test').json          # 解析json字符,输出为字典
    16. response = post('test').to_content()  # 输出为字符串
    17. response = post('test').content       # 输出为字符串
    18. response = post('test').get_cookie()  # 输出cookie对象
    19. response = post('test').cookie        # 输出cookie对象
    20.  
    21. # 结果取值, 假设此处response = {'a': 1, 'b': { 'c': [1, 2, 3, 4]}}
    22. response = post('13111111111', '123abc').json
    23.  
    24. print response.b.c   # 通过点号取值,结果为[1, 2, 3, 4]
    25.  
    26. print response('$.a') # 通过object path取值,结果为1
    27.  
    28. for i in response('$..c[@>3]'): # 通过object path取值,结果为选中c字典里大于3的元素
    29.     print i

    优化JSON、字典使用

    1. # 1、操作JSON的KEY
    2. from pithy import JSONProcessor
    3. dict_data = {'a': 1, 'b': {'a': [1, 2, 3, 4]}}
    4. json_data = json.dumps(dict_data)
    5. result = JSONProcessor(json_data)
    6. print result.a     # 结果：1
    7. print result.b.a   # 结果：[1, 2, 3, 4]
    8.  
    9. # 2、操作字典的KEY
    10. dict_data = {'a': 1, 'b': {'a': [1, 2, 3, 4]}}
    11. result = JSONProcessor(dict_data)
    12. print result.a     # 1
    13. print result.b.a   # [1, 2, 3, 4]
    14.  
    15. # 3、object path取值
    16. raw_dict = {
    17.     'key1':{
    18.         'key2':{
    19.             'key3': [1, 2, 3, 4, 5, 6, 7, 8]
    20.         }
    21.     }
    22. }
    23.  
    24. jp = JSONProcessor(raw_dict)
    25. for i in jp('$..key3[@>3]'):
    26.     print i
    27.     
    28. # 4、其它用法
    29. dict_1 = {'a': 'a'}
    30. json_1 = '{"b": "b"}'
    31. jp = JSONProcessor(dict_1, json_1, c='c')
    32. print(jp)

    九、总结

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

    PS：这里分享一套软件测试的自学教程合集。对于在测试行业发展的小伙伴们来说应该会很有帮助。除了基础入门的资源，博主也收集不少进阶自动化的资源，从理论到实战，知行合一才能真正的掌握。全套内容已经打包到网盘，内容总量接近500个G。如需要软件测试学习资料，关注公众号（互联网杂货铺），后台回复1，整理不易，给个关注点个赞吧，谢谢各位大佬！

    ☑ 240集-零基础到精通全套视频课程
    ☑ [课件+源码]-完整配套的教程
    ☑ 18套-测试实战项目源码
    ☑ 37套-测试工具软件包
    ☑ 268道-真实面试题
    ☑ 200个模板-面试简历模板、测试方案模板、软件测试报告模板、测试分析模版、测试计划模板、性能测试报告、性能测试报告、性能测试脚本用例模板（信息完整）

    这些资料，对于做【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！凡事要趁早，特别是技术行业，一定要提升技术功底。

  • 相关阅读:
    Unreal Engine（虚幻引擎）渲染 – 正确使用方法
    微信公众号开发相关流程及功能介绍
    CCAA 认证通用基础卷之（一）合格评定基础 第二章合格评定与国家质量基础设施 NQI （National Quality Infrastructure）
    每天一个知识点 - 如何快速熟悉后端项目
    软件项目管理习题——软件生命周期
    PMP每日一练 | 考试不迷路-8.4（包含敏捷+多选）
    对象引用、可变性和垃圾回收
    java 低耦合观察者模式
    texelFetch
    CentOS安装openjdk和elasticsearch
  • 原文地址：https://blog.csdn.net/HUA6911/article/details/133825429