[博学谷学习记录]超强总结，用心分享|软件测试之接口测试框架开发

        

目录

一、框架结构

（一）重点说明

二、框架目录结构

三、框架代码实现案例

 （一）封装被测试系统接口——API

（二）定义接口测试用例——scripts

（三）集成测试报告

1、报错：

2、解决：使用绝对路径

（四）测试数据参数化

1、基于json文件实现参数化

2、基于数据库实现参数化

---

        本周继续学习接口自动化，此阶段主要掌握接口框架代码的开发，本文将对此框架的原理进行介绍，并对

一、框架结构

（一）重点说明

（1）核心在于将测试用例与被测试系统API进行分离，便于后期维护

（2）测试用例是通过unittest进行管理，并提供了丰富的断言（等于、包含等）

（3）可以通过参数化思想测试数据与测试脚本的分离

（4）可以调用数据库进行结果验证或将数据库作为参数化的数据源

（5）借助第三方工具快速的生成HTML报告

二、框架目录结构

• tpshop -- 项目代号
  • data -- 管理测试数据的文件夹
  • report -- 管理测试结果报告的文件夹
  • api -- 封装被测试系统的接口
  • scripts -- 测试用例脚本
  • tools -- 第三方工具包管理app.py -- 配置信息文件
  • run_suite.py -- 测试用例执行入口
  • utils.py -- 自定义工具类

三、框架代码实现案例

需求：

 （一）封装被测试系统接口——API

只实现接口，用例直接调用接口

# 封装被测试系统接口
# 定义接口类
class LoginAPI:
    # 初始化
    def __init__(self):
        self.url_verify = "http://localhost/index.php?m=Home&c=User&a=verify"
        self.url_login = "http://localhost/index.php?m=Home&c=User&a=do_login"
    # 获取验证码接口
    def get_verify_code(self, session):
        return session.get(self.url_verify)
    # 登录接口
    def login(self, session, username, password, verify_code):
        login_data = {
        "username": username,
        "password": password,
        "verify_code": verify_code
        }
    return session.post(url=self.url_login, data=login_data)

（二）定义接口测试用例——scripts

# 导包
import requests
import unittest
from api.login import LoginAPI
# 定义测试类
class TestLoginAPI(unittest.TestCase):
    # 前置处理
    def setUp(self):
        self.login_api = LoginAPI()
        self.session = requests.Session()
    # 后置处理
    def tearDown(self):
        if self.session:
            self.session.close()
    # 定义测试方法
    # 登录成功
    def test01_login_success(self):
        # 调用验证码接口
        response = self.login_api.get_verify_code(self.session)
        # 断言
        self.assertEqual(200, response.status_code)
        self.assertIn("image", response.headers.get("Content-Type"))
        # 调用登录接口
        response = self.login_api.login(self.session, "13488888888", "123456",
        "8888")
        print(response.json())
        self.assertEqual(200, response.status_code)
        self.assertEqual(1, response.json().get("status"))
        self.assertIn("登陆成功", response.json().get("msg"))
    # 账号不正确
    def test02_user_isnot_exist(self):
        # 调用验证码接口
        response = self.login_api.get_verify_code(self.session)
        # 断言
        self.assertEqual(200, response.status_code)
        self.assertIn("image", response.headers.get("Content-Type"))
        # 调用登录接口
        response = self.login_api.login(self.session, "13488888899", "123456",
        "8888")
        print(response.json())
        self.assertEqual(200, response.status_code)
        self.assertEqual(-1, response.json().get("status"))
        self.assertIn("账号不存在", response.json().get("msg"))
    # 密码错误
    def test03_password_exist(self):
        # 调用验证码接口
        response = self.login_api.get_verify_code(self.session)
        # 断言
        self.assertEqual(200, response.status_code)
        self.assertIn("image", response.headers.get("Content-Type"))
        # 调用登录接口
        response = self.login_api.login(self.session, "13488888888", "error",
        "8888")
        print(response.json())
        self.assertEqual(200, response.status_code)
        self.assertEqual(-2, response.json().get("status"))
        self.assertIn("密码错误", response.json().get("msg"))

（三）集成测试报告

# 导包
import time
import unittest
from scripts.test01_login import TestLoginAPI
from tools.HTMLTestRunner import HTMLTestRunner
# 封装测试套件
suite = unittest.TestSuite()
suite.addTest(unittest.makeSuite(TestLoginAPI))
# 指定报告路径
report = "./report/report-{}.html".format(time.strftime("%Y%m%d-%H%M%S"))
# 打开文件流
with open(report, "wb") as f:
    # 创建HTMLTestRunner执行器
    runner = HTMLTestRunner(f, title="接口测试报告")
    # 执行测试套件
    runner.run(suite)

1、报错：

生成测试报告时，report使用相对路径会报错：FileNotFoundError: [Errno 2] No such file or directory: '../data/five_mouthpiece.json'

2、解决：使用绝对路径

app文件代码：

import os BASE_DIR = os.path.dirname(os.path.abspath(__file__)) print(BASE_DIR)

其他文件里的文件路径进行拼接：

import app app.BASE_DIR + '/report/report.html'

（四）测试数据参数化

1、基于json文件实现参数化

# 导包
import json
import requests
import unittest
from api.login import LoginAPI
from parameterized import parameterized
# 构造测试数据
def build_data():
    json_file = "../data/login.json"
    test_data = []
    with open(json_file, encoding="utf-8") as f:
        json_data = json.load(f)
        for case_data in json_data:
            username = case_data.get("username")
            password = case_data.get("password")
            verify_code = case_data.get("verify_code")
            status_code = case_data.get("status_code")
            content_type = case_data.get("content_type")
            status = case_data.get("status")
            msg = case_data.get("msg")
            test_data.append((username, password, verify_code, status_code,
            content_type, status, msg))
            print("test_data = {}".format((username, password, verify_code,
            status_code, content_type, status, msg)))
        return test_data
# 定义测试类
class TestLoginAPI(unittest.TestCase):
    # 前置处理
    def setUp(self):
        self.login_api = LoginAPI()
        self.session = requests.Session()
    # 后置处理
    def tearDown(self):
        if self.session:
            self.session.close()
    # 定义测试方法
    @parameterized.expand(build_data)
    def test01_login(self, username, password, verify_code, status_code,
    content_type, status, msg):
        # 调用验证码接口
        response = self.login_api.get_verify_code(self.session)
        # 断言
        self.assertEqual(status_code, response.status_code)
        self.assertIn(content_type, response.headers.get("Content-Type"))
        # 调用登录接口
        response = self.login_api.login(self.session, username, password,
        verify_code)
        print(response.json())
        self.assertEqual(status_code, response.status_code)
        self.assertEqual(status, response.json().get("status"))
        self.assertIn(msg, response.json().get("msg"))

2、基于数据库实现参数化

# 导包
import requests
import unittest
from api.login import LoginAPI
from tools.dbutil import DBUtil
from parameterized import parameterized
# 构造测试数据
def build_data():
    sql = "select * from t_login"
    db_data = DBUtil.exe_sql(sql)
    print(db_data)
    test_data = []
    for case_data in db_data:
        username = case_data[2]
        password = case_data[3]
        verify_code = case_data[4]
        status_code = case_data[5]
        content_type = case_data[6]
        status = case_data[7]
        msg = case_data[8]
        test_data.append((username, password, verify_code, status_code,
        content_type, status, msg))
        print("test_data = {}".format((username, password, verify_code,
        status_code, content_type, status, msg)))
    return test_data
# 定义测试类
class TestLoginAPI(unittest.TestCase):
    # 前置处理
    def setUp(self):
        self.login_api = LoginAPI()
        self.session = requests.Session()
    # 后置处理
    def tearDown(self):
        if self.session:
            self.session.close()
    # 定义测试方法
    @parameterized.expand(build_data)
    def test01_login(self, username, password, verify_code, status_code,
    content_type, status, msg):
        # 调用验证码接口
        response = self.login_api.get_verify_code(self.session)
        # 断言
        self.assertEqual(status_code, response.status_code)
        self.assertIn(content_type, response.headers.get("Content-Type"))
        # 调用登录接口
        response = self.login_api.login(self.session, username, password,
        verify_code)
        print(response.json())
        self.assertEqual(status_code, response.status_code)
        self.assertEqual(status, response.json().get("status"))
        self.assertIn(msg, response.json().get("msg"))

注释：