Python3 + requests + unittest接口测试

一、缘 起

笔者最近完成了基于Python3 + requests + unittest的接口测试脚本，故在此做一下记录，于己为复盘，于彼为学习和参考

二、思 路

接口测试无非三步：

  • 首先，造数据 - Python3连接MySQL，插入测试数据
  • 然后，发请求 - requests模块依次发请求
  • 最后，校验返回值 - 基于unittest框架，assert主要的response值

三、说 明

脚本的工程名为zhtyInterfaceTest，整体结构如下图

脚本结构

  1. .idea为PyChram编辑器自动生成的，不用管
  2. common为通用的模块/方法集合，如接口加密方法、配置parameters方法、配置数据库方法、读Excel方法，等，一切你能想到的辅助测试的方法都可以放到这里
  3. testCase为测试测试用例集合，笔者用unittest框架、用discover方法添加测试用例，那么想按顺序执行测试用例，就必须对测试用例命名按照ASCII顺序，具体如下图
    测试用例命名
  4. testFile存放测试数据和测试用图，测试数据为Excel格式
  5. testResult为测试结果集合，基于unittest框架，运行完脚本直接生成HTML格式的测试报告
  6. config.ini为配置文件，配置需要测试的URL、数据库及SQL语句
  7. runAll.py为主程序

四、实 现

  1. 造测试数据，如果读者对Python3操作数据库不甚熟悉，可以参考笔者之前写的文章《Python3连接MySQL数据库及基本操作》
  • ./zhtyInterfaceTest/common/mysqlCfg.py
#!/usr/bin/python
# coding=utf-8

from pymysql import connect
from pymysql.err import OperationalError
import os
import configparser as cparser

# ------------------读取配置文件及数据库配置----------------------
base_path = str(os.path.dirname(os.path.dirname(__file__)))
base_path = base_path.replace('\\', '/')
cfg_path = base_path + '/config.ini'
cf = cparser.ConfigParser()
cf.read(cfg_path, encoding='utf-8')
host = cf.get('MYSQL', 'host')
port = cf.get('MYSQL', 'port')
user = cf.get('MYSQL', 'user')
password = cf.get('MYSQL', 'password')
db_name = cf.get('MYSQL', 'db_name')
charset = cf.get('MYSQL', 'charset')

# -----------封装MySQL数据库基本操作-----------------


class DB:

    def __init__(self):

        try:
            # 连接数据库
            self.conn = connect(
                host=host,
                port=int(port),
                user=user,
                password=password,
                db=db_name,
                charset=charset
            )
        except OperationalError as e:
            print('MySQL error %d: %s' % (e.args[0], e.args[1]))
        else:
            self.cursor = self.conn.cursor()

    def execute_sql(self, command, sql):
        """
        插入表数据
        :param command:
        :param sql:
        :return:
        """
        if command in ('SELECT', 'select'):
            # 如果为查询指令
            sql = sql.encode('utf-8')
            try:
                self.cursor.execute(sql)
                result = self.cursor.fetchall()
                return result
            except Exception as e:
                print(e)
            finally:
                self.conn.close()
        elif command in ('delete', 'DELETE', 'update', 'UPDATE', 'insert', 'INSERT'):
            # 如果为增删改
            sql = sql.encode('utf-8')
            try:
                self.cursor.execute(sql)
                self.conn.commit()
            except Exception as e:
                self.conn.rollback()
                print(e)
            finally:
                self.conn.close()
        else:
            print('Command Error!')


if __name__ == '__main__':

    # sel_sql = cf.get('SQL', 'SELECT')
    # s = DB().execute_sql('select', sel_sql)
    print(DB().execute_sql('select', cf.get('SQL', 'SELECT'))[0][0])
  • ./zhtyInterfaceTest/runAll.py
#!/usr/bin/python
# coding=utf-8

from HTMLTestRunner import HTMLTestRunner
import configparser as cparser
from common.mysqlCfg import DB
import unittest
import time
import os

discover = unittest.defaultTestLoader.discover('./testCase/teacher', pattern='test*.py')

if __name__ == '__main__':

    # ------------------读取配置文件----------------------
    base_path = str(os.path.dirname(__file__))
    base_path = base_path.replace('\\', '/')
    cfg_path = base_path + '/config.ini'
    cf = cparser.ConfigParser()
    cf.read(cfg_path, encoding='utf-8')

    # 初始化测试数据
    ins_tb_user = cf.get('SQL', 'ins_tb_user')
    ins_relation_class = cf.get('SQL', 'ins_relation_class')
    ins_sport_data_01 = cf.get('SQL', 'ins_sport_data_01')
    ins_sport_data_02 = cf.get('SQL', 'ins_sport_data_02')
    ins_class_course_data = cf.get('SQL', 'ins_class_course_data')
    # 执行SQL
    DB().execute_sql('insert', ins_tb_user)
    DB().execute_sql('insert', ins_relation_class)
    DB().execute_sql('insert', ins_sport_data_01)
    DB().execute_sql('insert', ins_sport_data_02)
    DB().execute_sql('insert', ins_class_course_data)

~
......
~
【脚 本 说 明】
  • 通过读取config.ini文件的数据库配置信息和需要执行的SQL语句，实现连接数据库以及执行SQL的方法
  • 在主程序runAll.py执行测试用例前提前造好测试数据
  1. 发request请求
  • ./zhtyInterfaceTest/reqMethod.py
#!/usr/bin/python
# coding=utf-8

import configparser as cparser
import requests
import os

# ------------------读取配置文件----------------------
base_path = str(os.path.dirname(os.path.dirname(__file__)))
base_path = base_path.replace('\\', '/')
cfg_path = base_path + '/config.ini'
cf = cparser.ConfigParser()
cf.read(cfg_path, encoding='utf-8')


class RequestMethod:
    """ 定义请求类型 """

    def __init__(self):

        """初始化参数"""
        self.base_url = cf.get('URL', 'base_url')
        self.data = {}
        self.files = {}

    def get(self, url, params):
        """
        定义get方法请求
        :return:
        """
        test_url = self.base_url + url
        try:
            return requests.get(url=test_url, params=params, timeout=60)
        except TimeoutError:
            return print('%s get request timeout!' % url)

    def post(self, url, params):
        """
        定义post方法请求
        :return:
        """
        test_url = self.base_url + url
        try:
            return requests.post(url=test_url, data=params, timeout=60)
        except TimeoutError:
            return print('%s post request timeout!' % url)

    def post_with_file(self, url, params, fp):
        """
        定义post方法请求
        :return:
        """
        test_url = self.base_url + url
        file = {
            'head_img': open(fp, 'rb')
        }
        try:
            return requests.post(url=test_url, data=params, files=file, timeout=60)
        except TimeoutError:
            return print('%s post request timeout!' % url)
  • ./zhtyInterfaceTest/testCase/teacher/test_1_login.py
#!/usr/bin/python
# coding=utf-8

from common.reqMethod import RequestMethod
from common.getParams import *
import unittest


class Login(unittest.TestCase):

    """登录接口测试"""

    def setUp(self):
        self.url = 'login'
        self.sheet = 'login'

    def tearDown(self):
        print(self.req_result)

    def test_login_success(self):
        """
        测试正常登录
        :return:
        """
        case = 'test_login_success'
        # 获取请求参数
        param = get_req_params(self.sheet, case)
        # 发起请求
        self.req_result = RequestMethod().post(self.url, param).json()
~
......
~
【脚 本 说 明】
  • 读配置文件获取基础URL，然后依次定义三种常用的HTTP请求方法：get、post、post_with_file
  • 根据请求方法的不同，传参的类型一般为：测试接口（与基础URL拼接为请求URL）、params和fp（上传文件的路径）
  • 在每一个测试用例中，通过调用getParams.py模块的get_req_params方法，从Excel获取请求参数，通过get_resp_params方法从Excel获取响应参数
  • 在测试用例中调用reqMethod.py中封装的请求方法，发接口请求
  1. 校验返回值
  • ./zhtyInterfaceTest/testCase/teacher/test_1_login.py
from common.reqMethod import RequestMethod
from common. ......


class Login(unittest.TestCase):

    ......

    def test_login_success(self):
        ......

        # 返回参数断言
        self.assertEqual(self.req_result['code'], get_resp_params(self.sheet, case, 'code'))
        self.assertEqual(self.req_result['msg'], get_resp_params(self.sheet, case, 'msg'))
        self.assertEqual(self.req_result['data']['user_name'], get_resp_params(self.sheet, case, 'user_name'))
        ......
【脚 本 说 明】
  • 通过调用getParams.py模块的get_resp_params方法从Excel获取响应参数，和接口返回的参数做比对，实现断言
  1. 生成测试报告
  • ./zhtyInterfaceTest/runAll.py
......

 now = time.strftime('%Y-%m-%d %H_%M_%S')  # 获取当前时间
    filename = now + ' testReport.html'
    fp = open('./testResult/{0}'.format(filename), 'wb')
    runner = HTMLTestRunner(stream=fp,
                            title='智慧体育教师版接口测试报告',
                            description='用例执行情况：')
    runner.run(discover)
    fp.close()
......

五、最 后

运行结果

测试报告截图

Git地址：https://gitee.com/freedomlidi/zhtyInterfaceTestPublic.git

OK！

~
~
~

不积跬步，无以至千里

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 204,189评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,577评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,857评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,703评论 1赞 276
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,705评论 5赞 366
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,620评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,995评论 3赞 396
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,656评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,898评论 1赞 298
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1赞 330
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,395评论 4赞 319
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,982评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2赞 342