环境准备

本次选用的是Python+Pytest+requests来搭建自动化框架，需要有 Python 环境（3.x 版本），安装pytest和requests，不会安装的自行去网上搜教程。

关于 Pytest 的基本使用，这里不作讲解，不清楚的可以看我之前的文章。

简单 Demo

我们先创建一个项目，取名api-test，然后在下面创建一个test_api.py的文件

# test_api.py

import pytest
import requests


def test_01():
    response = requests.get('http://127.0.0.1:5000/login').json()
    print(response)
    assert response.get('success') == 'ok'

if __name__ == '__main__':
    pytest.main()

直接运行，结果如下

============================= test session starts =============================
platform win32 -- Python 3.7.1, pytest-6.2.1, py-1.10.0, pluggy-0.13.1
rootdir: D:\study\api-test
plugins: allure-pytest-2.8.31, dependency-0.5.1, forked-1.3.0, ordering-0.6, rerunfailures-9.1.1, xdist-2.2.1collected 1 item

test_api.py .{'success': 'ok', 'token': 'sdkhasgdhgasjhdgasgda'}
                                                            [100%]

============================== 1 passed in 0.16s ==============================
Process finished with exit code 0

一个简单的测试用例就完成了。

自动化测试工作中，往往会有很多测试文件，每次都需要导入 requests 库吗？

域名都是写在用例一起吗？

如果要记录日志，每次都在用例里面记录吗？

测试数据也写在用例里吗？

等等，答案显然是否定的，下面就让我们一起踏上框架封装之路。

首先我们创建一个包：base，用于存放最基础的封装方法，在包下创建一个模块http_client.py，此处用于封装 requests 发送请求的方法。

封装思路：

• 创建 HttpClient 类，方便后续 api 继承后直接调用类下面的 get 和 post 方法
• 创建__request 私有方法，作为发送请求公共方法，方便后面日志搜集请求信息和返回信息
• 使用 requests.session()，requests 库的 session 会话对象可以跨请求保持某些参数

# base/http_client.py

import requests


class HttpClient():

    def __init__(self):
        self.__session = requests.session()

    def get(self, path, **kwargs):
        return self.__request(path, 'GET', **kwargs)

    def post(self, path, data=None, json=None, **kwargs):
        return self.__request(path, 'POST', data, json, **kwargs)

    def __request(self, url, method, data=None, json=None, **kwargs):
        resp = None
        if method == "GET":
            resp = self.__session.get(url, **kwargs)
        elif method == "POST":
            resp = requests.post(url, data, json, **kwargs)
        return resp

然后我们使用封装好的 requests 替换用例中的 requests

# test_api.py

import pytest
from base.http_client import HttpClient

http_client = HttpClient()


def test_01():
    response = http_client.get('http://127.0.0.1:5000/login').json()
    print(response)
    assert response.get('success') == 'ok'

if __name__ == '__main__':
    pytest.main()

同样能够运行成功。

那么问题来了，如果多个 py 文件中都需要调用到同一个接口，比如登录，是不是所有文件中都需要写一遍呢？哪天接口路径改了，那修改起来是一件很麻烦的事情，还容易出错。

那我的想法是把这个接口提取到一个公共的地方封装起来，那么就可以给其他用例文件导入使用，即使有修改，那我修改公共的就可以解决问题了。

我们在项目下创建名为api的包，下面创建login.py

# login.py

from base.http_client import HttpClient

# 继承HttpClient
class Auth(HttpClient):

    def login(self, **kwargs):
        return self.get('http://127.0.0.1:5000/login', **kwargs)

# 实例化Auth类
auth = Auth()

那么，test_api.py就需要做下修改：

# test_api.py

import pytest
from api.login import auth


def test_01():
    response = auth.login().json()
    print(response)
    assert response.get('success') == 'ok'


if __name__ == '__main__':
    pytest.main()

运行测试成功。

由于某天登录出问题，报错了：

============================= test session starts =============================
...
...
    def test_01():
        response = auth.login().json()
>       assert response.get('success') == 'ok'
E       AssertionError: assert 'ko' == 'ok'
E         - ok
E         + ko

test_api.py:7: AssertionError
=========================== short test summary info ===========================
FAILED test_api.py::test_01 - AssertionError: assert 'ko' == 'ok'
============================== 1 failed in 0.22s ==============================

我们需要定位问题，那就要拿到当时的请求明细，故而我们需要加入一个日志功能，记录发送的请求和接收的响应。

要想记录请 i 去和返回的信息，只需要在之前创建的http_client.py模块做修改就行。那么先封装一个日志工具。

在项目下创建包名为utils和logs目录，紧接着utils包下创建logger.py。

# utils/logger.py

import os
import time
import logging
import json as _json

root_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
logger = logging.getLogger()
logger.setLevel(logging.DEBUG)
# 建立一个filehandler来把日志记录在文件里，级别为debug以上
fh = logging.FileHandler("{}/logs/{}.log".format(root_path, time.strftime('%Y%m%d', time.localtime())))
fh.setLevel(logging.DEBUG)
# 建立一个streamhandler来把日志打在CMD窗口上，级别为error以上
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# 设置日志格式
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
ch.setFormatter(formatter)
fh.setFormatter(formatter)
# 将相应的handler添加在logger对象中
logger.addHandler(ch)
logger.addHandler(fh)

接着修改http_client.py

import json as _json
import requests
from utils.logger import api_logger


class HttpClient():
    # 接口做post一般都是采用json格式进行提交
    __headers = {
        "content-type": "application/json;charset=UTF-8"
    }

    def __init__(self):
        self.__session = requests.session()

    def get(self, path, **kwargs):
        return self.__request(path, 'GET', **kwargs)

    def post(self, path, data=None, json=None, **kwargs):
        return self.__request(path, 'POST', data, json, **kwargs)

    def __request(self, url, method, data=None, json=None, **kwargs):
        headers = kwargs.get("headers")
        params = kwargs.get("params")
        # 如果传入header不为空，那么更新header
        if headers:
            self.__headers.update(headers)
        self.__request_log(url, method, data, json, params, self.__headers)
        resp = None
        if method == "GET":
            resp = self.__session.get(url, **kwargs)
        elif method == "POST":
            resp = requests.post(url, data, json, **kwargs)
        self.__response_log(resp)
        return resp

    def __request_log(self, url, method, data=None, json=None, params=None, headers=None):
        api_logger.info("接口请求地址: {}".format(url))
        api_logger.info("接口请求方式: {}".format(method))
        api_logger.info("接口请求头: {}".format(_json.dumps(headers, indent=4, ensure_ascii=False)))
        api_logger.info("接口请求 params 参数: {}".format(_json.dumps(params, indent=4, ensure_ascii=False)))
        api_logger.info("接口请求体 data 参数 : {}".format(_json.dumps(data, indent=4, ensure_ascii=False)))
        api_logger.info("接口请求体 json 参数: {}".format(_json.dumps(json, indent=4, ensure_ascii=False)))

    def __response_log(self, resp):
        try:
            api_logger.info("返回信息 : {}".format(resp.text, ensure_ascii=False))
        except Exception as e:
            api_logger.error('系统错误：{}'.format(e))

我们再次执行测试，查看 logs 文件下的日志，可以看到记录了接口测试过程。

实际工作中的自动化场景复杂程度远远不止如此。

• 公共方法可能在多个场景被使用，那么就需要在抽离出一个业务层
• 接口入参也需要单独抽离，方便统一维护
• 用例层抽离，方便统一管理

yml 文件读取功能

直接创建：data目录作为数据层，operations包作为业务层，testcases作为用例层。

数据我们采用yaml格式，封装 yaml 文件读取功能，在utils包下创建read_data.py

# utils/read_data.py

import os
import yaml

root_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

class ReadFileData:

    def load_yaml(self, file_path):
        try:
            data_file_path = os.path.join(root_path, "data", file_path)
            with open(data_file_path, encoding='utf-8') as f:
                data = yaml.safe_load(f)
        except Exception as ex:
            print(ex)
        else:
            return data

data = ReadFileData()

数据层

data下创建login.yml文件用于存储登录的用户名和密码

# data/login.yml

login_data:
  json:
    username: 'admin'
    password: '123456'

不要忘记在api包下新增我们登录接口如下：

# api/login.py

from base.http_client import HttpClient


# 继承HttpClient
class Auth(HttpClient):

    # ..此处省略..

    def token(self, **kwargs):
        return self.post('http://127.0.0.1:5000/user/token', **kwargs)


auth = Auth()

业务层

在operaitons包下创建auth.py文件

from api.auth import auth
from utils.read_data import data

# 读取测试数据
data = data.load_yaml('login.yml')


def get_token():
    test_case = data['login_data']
    # 由于yml文件读取出来是字典形式，可以直接用关键字传参方式调用api层的接口方法
    return auth.token(**test_case)

测试用例层

把test_api.py移动到testcases下，新增登录测试用例：

# testcases/test_api.py

import pytest
from api.login import auth
from operations.auth import get_token


def test_01():
    response = auth.login().json()
    assert response.get('success') == 'ok'

# 新增登录测试用例
def test_token():
    resp = get_token().json()
    assert resp.get('msg') == '登录成功'

if __name__ == '__main__':
    pytest.main()

执行用例成功

============================= test session starts =============================
platform win32 -- Python 3.7.1, pytest-6.2.1, py-1.10.0, pluggy-0.13.1
rootdir: D:\study\api-test
plugins: allure-pytest-2.8.31, dependency-0.5.1, forked-1.3.0, ordering-0.6, rerunfailures-9.1.1, xdist-2.2.1collected 2 items

testcases\test_api.py ..                                                 [100%]

============================== 2 passed in 0.81s ==============================

至此，我们自动化框架基本完成了，更多功能还需要读者自己去扩展和补充。