Python接口自动化测试：从零封装到可维护框架

启动服务：

python demo.py

服务跑在 http://127.0.0.1:5000。

接口很简单，详情如下：

登录接口

| 参数名称 | 参数类型 | 参数说明 | | :————: | :——-: | :——: | | username | String | 登录名称 | | password | String | 登录密码 |

响应：

| 参数名称 | 参数类型 | 参数说明 | | :——-: | :——-: | :——: | | code | Integer | 结果 code | | msg | String | 结果信息 |

详情接口

请求 url: /info
请求方法: get
需要 cookies: session

响应：

| 参数名称 | 参数类型 | 参数说明 | | :——-: | :——-: | :——: | | code | Integer | 结果 code | | msg | String | 结果信息 | | data | String | 数据信息 |

从最原始的测试脚本开始

思路直接：用 requests 模拟请求，用 unittest 组织用例。先写一个测试类：

#!/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'

这个版本能跑通，但问题很明显：登录操作在每个需要登录的用例里都要重复写一遍。项目里接口一旦多起来，这种重复会急剧膨胀。

第一次封装：抽出 API 类

把接口调用集中到一个类里，用例只关心业务参数。

#!/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'

现在登录逻辑只写一次，base_url 也抽出来了。但还有两个痛点：cookie 需要手动在用例间传递，以及没有请求日志，调试困难。

利用 Session 自动保持 cookie，并加入日志

requests 的 Session 对象能在多次请求间自动保持 cookie，正好解决手动传 cookie 的问题。另外在每个关键请求前后打印一下 url、headers、body 和响应，排错会方便很多。

#!/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'

现在 test_info 里只需要先调用一次 login，之后所有请求自动带上 session cookie，不用再手动取了。日志打印虽然有点啰嗦，但能快速定位问题。如果要优雅一点，可以把打印逻辑进一步抽成一个装饰器或者 mixin，不过目前这种程度已经能满足日常调试。

实际项目中还会做什么？

这个小框架只有骨架，但思路完全可以用到真实项目里。一般会继续扩展：

• 配置分离：把 base_url、超时时间、重试次数放到 YAML 或 JSON 配置文件里，再根据环境变量切换（开发/测试/预发布/生产）。
• 持续集成：把测试挂到 Jenkins 或 GitLab CI，每次提交自动跑一遍，失败就发通知。
• 断言与报告：用 pytest 的断言语法比 unittest 更简洁，再搭配 Allure 生成测试报告，会清爽很多。
• 数据驱动：把测试数据从用例代码中抽出来，用 Excel 或 CSV 管理，同一个脚本可以覆盖更多场景。

这些都不是必须一步到位的事，根据项目需要慢慢加就好。重要的是先让测试跑起来，然后不断重构，让代码保持干净。

以上，算是把一次从零搭建接口自动化测试的过程捋了一遍。核心就一句话：别嫌封装麻烦，前面的投入会在后面成倍地省回来。