01. 接口对象封装
2024年10月28日大约 8 分钟
01. 接口对象封装
目标
- 理解接口对象封装的目的
- 能够实现接口对象的封装
1. 引入Unittest后代码存在的问题?
- 代码冗余
- 代码耦合度高
- 代码维护成本高
2. 接口对象封装
核心思想:代码分层思想
分层思想
普通⽅法实现的 ,分为 接⼝对象层 和 测试脚本层。
接口对象层
- 根据接口API文档封装
- 重点关注如何调用接口
- 请求参数从测试用例层传递
- 接口响应结果返回给用例层
测试用例层
- 直接调用接口对象层发送请求,拿到响应结果,断言进行接口测试
- 重点关注测试数据准备和断言
- 直接调用接口对象层发送请求,拿到响应结果,断言进行接口测试
3. 封装Tpshop商城
1. 普通⽅式实现
import unittest
import requests
class TestTpshopLogin(unittest.TestCase):
# 测试 登录成功
def test01_login_ok(self):
# 创建 session 实例
session = requests.Session()
# 使用实例,调用get 发送获取验证码请求
session.get(url="http://192.168.10.31:9003/index.php?m=Home&c=User&a=verify&r=0.21519623710645064")
# 使用实例,调用post 发送登录请求
resp = session.post(
url="http://192.168.10.31:9003/index.php?m=Home&c=User&a=do_login&t=0.7094195931397276",
data={"username": "13800138006", "password": "123456", "verify_code": "8888"})
print("响应结果 =", resp.json())
# 断言:
self.assertEqual(200, resp.status_code)
self.assertEqual(1, resp.json().get("status"))
self.assertEqual("登陆成功", resp.json().get("msg"))
# 测试-手机号不存在
def test02_tel_not_exists(self):
# 创建 session 实例
session = requests.Session()
# 使用实例,调用get 发送获取验证码请求
session.get(url="http://192.168.10.31:9003/index.php?m=Home&c=User&a=verify&r=0.21519623710645064")
# 使用实例,调用post 发送登录请求
resp = session.post(
url="http://192.168.10.31:9003/index.php?m=Home&c=User&a=do_login&t=0.7094195931397276",
data={"username": "13847834701", "password": "123456", "verify_code": "8888"})
print("响应结果 =", resp.json())
# 断言:
self.assertEqual(200, resp.status_code)
self.assertEqual(-1, resp.json().get("status"))
self.assertEqual("账号不存在!", resp.json().get("msg"))
# 测试 密码错误
def test03_pwd_err(self):
# 创建 session 实例
session = requests.Session()
# 使用实例,调用get 发送获取验证码请求
session.get(url="http://192.168.10.31:9003/index.php?m=Home&c=User&a=verify&r=0.21519623710645064")
# 使用实例,调用post 发送登录请求
resp = session.post(
url="http://192.168.10.31:9003/index.php?m=Home&c=User&a=do_login&t=0.7094195931397276",
data={"username": "13800138006", "password": "123456890", "verify_code": "8888"})
print("响应结果 =", resp.json())
# 断言:
self.assertEqual(200, resp.status_code)
self.assertEqual(-2, resp.json().get("status"))
self.assertEqual("密码错误!", resp.json().get("msg"))
2. 登录接⼝对象层
封装思想
将动态变化的数据,设计到⽅法的参数。
将固定不变的,直接写成⽅法实现。
将响应结果,通过返回值传出。
分析
3. 封装实现
from typing import Any
import requests
# tpshop登陆api
class TpshopLoginApi(object):
# 发送验证码请求
@classmethod
def get_verify(cls, session: requests.Session) -> requests.Response:
resp = session.get(
url="http://192.168.10.31:9003/index.php?m=Home&c=User&a=verify&r=0.21519623710645064"
)
return resp
# 发送登录请求
@classmethod
def login(cls, session: requests.Session, login_data: Any) -> requests.Response:
resp = session.post(
url="http://192.168.10.31:9003/index.php?m=Home&c=User&a=do_login&t=0.7094195931397276",
data=login_data
)
return resp
4. 登录接⼝测试⽤例层
- 优化前
import unittest
import requests
from tpshop_login_api import TpshopLoginApi
class TestTpshopLogin(unittest.TestCase):
# 测试 登录成功
def test01_login_ok(self):
# 创建 session实例
s = requests.Session()
# 用实例,调用自己封装的 获取验证码 接口
TpshopLoginApi.get_verify(s)
# 调用 自己封装的接口,登录
abc = {"username": "13800138006", "password": "123456", "verify_code": "8888"}
resp = TpshopLoginApi.login(s, abc)
print(resp.json())
# 断言
self.assertEqual(200, resp.status_code)
self.assertEqual(1, resp.json().get("status"))
self.assertEqual("登陆成功", resp.json().get("msg"))
# 测试 手机号不存在
def test02_tel_not_exists(self):
# 创建 session实例
s = requests.Session()
# 用实例,调用自己封装的 获取验证码 接口
TpshopLoginApi.get_verify(s)
# 调用 自己封装的接口,登录
abc = {"username": "13048932745", "password": "123456", "verify_code": "8888"}
resp = TpshopLoginApi.login(s, abc)
print(resp.json())
# 断言
self.assertEqual(200, resp.status_code)
self.assertEqual(-1, resp.json().get("status"))
self.assertIn("账号不存在", resp.json().get("msg"))
# 测试 密码错误
def test03_pwd_err(self):
# 创建 session实例
s = requests.Session()
# 用实例,调用自己封装的 获取验证码 接口
TpshopLoginApi.get_verify(s)
# 调用 自己封装的接口,登录
abc = {"username": "13800138006", "password": "123456789", "verify_code": "8888"}
resp = TpshopLoginApi.login(s, abc)
print(resp.json())
# 断言
self.assertEqual(200, resp.status_code)
self.assertEqual(-2, resp.json().get("status"))
self.assertIn("密码错误", resp.json().get("msg"))
- 优化后(使用Fixture):
import unittest
import requests
from tpshop_login_api import TpshopLoginApi
# 封装 通用的断言函数
def common_assert(self, resp: requests.Response, status_code: int, status: int, msg: str):
"""
通用断言
:param self:
:param resp: 响应对象
:param status_code: 状态码
:param status: 状态码
:param msg: 响应信息
:return:
"""
self.assertEqual(status_code, resp.status_code)
self.assertEqual(status, resp.json().get("status"))
self.assertIn(msg, resp.json().get("msg"))
class TestTpshopLogin(unittest.TestCase):
# 添加类属性
session = None
@classmethod
def setUpClass(cls) -> None: # 在类中所有测试⽅法执⾏之前,⾃动执⾏1次
"""
类实例化前获取session
:return:
"""
cls.session = requests.Session()
def setUp(self) -> None: # 在每个测试⽅法执⾏之前,⾃动执⾏1次
# 调用 自己封装的接口,获取验证码
resp = TpshopLoginApi.get_verify(self.session)
print("获取验证码->", resp.status_code)
# 测试 登录成功
def test01_login_ok(self):
data = {"username": "13800138006 ", "password": "123456", "verify_code": "8888"}
resp = TpshopLoginApi.login(self.session, data)
print("登陆成功->", resp.json())
# self.assertEqual(200, resp.status_code)
# self.assertEqual(1, resp.json().get("status"))
# self.assertIn("登陆成功", resp.json().get("msg"))
common_assert(self, resp, 200, 1, "登陆成功")
# 测试 手机号不存在
def test02_tel_not_exists(self):
data = {"username": "13048392845", "password": "123456", "verify_code": "8888"}
resp = TpshopLoginApi.login(self.session, data)
print("手机号不存在->", resp.json())
common_assert(self, resp, 200, -1, "账号不存在")
# 测试 密码错误
def test03_pwd_err(self):
data = {"username": "13800138006", "password": "123456890", "verify_code": "8888"}
resp = TpshopLoginApi.login(self.session, data)
print("密码错误->", resp.json())
common_assert(self, resp, 200, -2, "密码错误")
5. 封装断⾔⽅法
# 封装 通用的断言函数
def common_assert(self, resp: requests.Response, status_code: int, status: int, msg: str):
"""
通用断言
:param self:
:param resp: 响应对象
:param status_code: 状态码
:param status: 状态码
:param msg: 响应信息
:return:
"""
self.assertEqual(status_code, resp.status_code)
self.assertEqual(status, resp.json().get("status"))
self.assertIn(msg, resp.json().get("msg"))
# 调用
common_assert(self, resp, 200, 1, "登陆成功")
common_assert(self, resp, 200, -1, "账号不存在")
common_assert(self, resp, 200, -2, "密码错误")
6. 参数化
- 提取每个测试⽤例 使⽤的 测试数据 和 断⾔数据
json_data = [
{
"req_body": {"username": "13800138006", "password": "123456", "verify_code": "8888"},
"status_code": 200,
"status": 1,
"msg": "登陆成功"
},
{
"req_body": {"username": "13048392845", "password": "123456", "verify_code": "8888"},
"status_code": 200,
"status": -1,
"msg": "账号不存在"
},
{
"req_body": {"username": "13800138006", "password": "123456890", "verify_code": "8888"},
"status_code": 200,
"status": -2,
"msg": "密码错误"
},
{
"req_body": {"username": None, "password": "123456", "verify_code": "8888"},
"status_code": 200,
"status": -2,
"msg": "密码错误"
},
{
"req_body": {"username": "13800138006", "password": None, "verify_code": "8888"},
"status_code": 200,
"status": -2,
"msg": "密码错误"
}
]
- 封装函数,将数据转换为元组列表
# 定义函数,读取 [{},{},{}] --> [(),(),()]
def read_json_data():
list_data = []
for item in json_data:
tmp = tuple(item.values())
list_data.append(tmp)
print(list_data)
# 循环结束后,将 list_data 为 [(),(),()] 数据, 返回
return list_data
参数化步骤
导包 from parameterized import parameterized
在 通⽤测试⽅法,上⼀⾏,添加 @parameterized.expand()
给 expand()传⼊[(),(),()](调⽤ 转换[{},{},{}] --> [(),(),()]的函数)
修改通⽤测试⽅法,添加形参,个数、顺序,与 [{},{},{}]中{ } 内的所有key完全⼀⼀对应
在 通⽤测试⽅法内,使⽤形参。
class TestTpshopLogin(unittest.TestCase): # 添加类属性 session = None @classmethod def setUpClass(cls) -> None: cls.session = requests.Session() def setUp(self) -> None: # 调用 自己封装的接口,获取验证码 TpshopLoginApi.get_verify(self.session) # 测试 tpshop 登录 @parameterized.expand(read_json_data()) def test_tpshop_login(self, req_body, status_code, status, msg): resp = TpshopLoginApi.login(self.session, req_body) print(msg, resp.json()) common_assert(self, resp, status_code, status, msg)
代码详情:\testProject\test_code\ad_ihrm_level_a
2. 封装iHRM登录
1. 登录接⼝
1. 普通⽅式实现
import unittest
import requests
class TestIhrmLogin(unittest.TestCase):
# 登陆成功
def test01_login_success(self):
resp = requests.post(
url="http://ihrm-java.ithiema.net/api/sys/login",
json={"mobile": "13800000002", "password": "123456"}
)
print(resp.json())
# 断言
self.assertEqual(200, resp.status_code)
self.assertEqual(True, resp.json().get("success"))
self.assertEqual(10000, resp.json().get("code"))
self.assertIn("操作成功", resp.json().get("message"))
2. 登录接⼝对象层
思路
动态变化的,写⼊参数
固定不变,直接写到⽅法实现内
响应结果,通过返回值 return
分析
- 封装实现
# 接口对象层
from typing import Any
import requests
class IhrmLoginApi(object):
@classmethod
def login(cls, json_data: Any):
"""
登陆接口
:param json_data: 登陆数据
:return: 响应结果
"""
resp = requests.post(
url="http://ihrm-java.ithiema.net/api/sys/login",
json=json_data
)
return resp
- 登录接⼝测试⽤例层
import unittest
# 定义测试类
from assert_util import common_assert
from ihrm_login_api import IhrmLoginApi
class TestIhrmLogin(unittest.TestCase):
# 测试方法 - 登录成功
def test01_login_success(self):
# 调用 自己封装 login
login_data = {"mobile": "13800000002", "password": "123456"}
resp = IhrmLoginApi.login(login_data)
print("登录成功:", resp.json())
# 断言
common_assert(self, resp, 200, True, 10000, "操作成功")
# self.assertEqual(200, resp.status_code)
# self.assertEqual(True, resp.json().get("success"))
# self.assertEqual(10000, resp.json().get("code"))
# self.assertIn("操作成功", resp.json().get("message"))
# 测试方法 - 手机号未注册
def test02_mobile_not_register(self):
# 调用 自己封装 login
login_data = {"mobile": "1384780932", "password": "123456"}
resp = IhrmLoginApi.login(login_data)
print("手机号未注册:", resp.json())
# 断言
common_assert(self, resp, 200, False, 20001, "用户名或密码错误")
# 测试方法 - 密码错误
def test03_pwd_error(self):
# 调用 自己封装 login
login_data = {"mobile": "13800000002", "password": "890"}
resp = IhrmLoginApi.login(login_data)
print("密码错误:", resp.json())
# 断言
common_assert(self, resp, 200, False, 20001, "用户名或密码错误")
# 测试方法 - 手机号为空
def test04_mobile_is_none(self):
# 调用 自己封装 login
login_data = {"mobile": None, "password": "123456"}
resp = IhrmLoginApi.login(login_data)
print("手机号为空:", resp.json())
# 断言
common_assert(self, resp, 200, False, 20001, "用户名或密码错误")
# 测试方法 - 多参
def test12_more_params(self):
# 调用 自己封装 login
login_data = {"mobile": "13800000002", "password": "123456", "abc": "123"}
resp = IhrmLoginApi.login(login_data)
print("手机号为空:", resp.json())
# 断言
common_assert(self, resp, 200, True, 10000, "操作成功")
# 测试方法 - 无参
def test14_none_params(self):
# 调用 自己封装 login
login_data = None
resp = IhrmLoginApi.login(login_data)
print("手机号为空:", resp.json())
# 断言
common_assert(self, resp, 200, False, 99999, "抱歉,系统繁忙,请稍后重试")
- 封装断⾔⽅法
- 创建 ⽂件 assert_util.py
- 在 ⽂件内,定义 common_assert() 函数
- 直接粘贴 unittest框架中的断⾔代码,修改参数。
- 回到 unittest框架 实现的 测试脚本中, 调⽤该函数,实现断⾔,传递 实际参数。
""" ihrm 断言的工具文件 """
# 定义 断言 函数
# def common_assert():
# self.assertEqual(200, resp.status_code) # self / resp 报错
# self.assertEqual(True, resp.json().get("success"))
# self.assertEqual(10000, resp.json().get("code"))
# self.assertIn("操作成功", resp.json().get("message"))
# 定义 断言 函数
import requests
def common_assert(self, resp: requests.Response, status_code: int, success: bool, code: int, message: str):
"""
公共断言
:param self: unittest子类
:param resp: 响应对象
:param status_code: 响应状态码
:param success: 响应状态
:param code: 响应码
:param message: 响应提示消息
:return:
"""
self.assertEqual(status_code, resp.status_code)
self.assertEqual(success, resp.json().get("success"))
self.assertEqual(code, resp.json().get("code"))
self.assertIn(message, resp.json().get("message"))
- 导包注意事项