我没有看过专门的测试书籍,都是自己瞎琢磨的,如果不对的地方欢迎评论区交流
测试真的很重要
需求场景
要测试的代码涉及到对外部接口的HTTP请求,要请求的接口因为不是测试内容,没法控制也不应该控制。举两个我现在项目中的例子:
-
login接口接受小程序发送的登录code,并向微信登录接口请求session_key
这里前端的code是在测试中拿不到的,所以真实请求也是不可能的。
-
中间件需要请求远程分析接口,这个接口是项目中独立的部分,不在中间件的测试内容中
你可以想一想,这个需求场景是非常常见的。
解决思路
两个例子我讲两个不同的解决思路,适应不同的场景,后面一个是我今晚上开脑洞搞的。
小程序登录
这个需求中,不管是请求参数还是业务逻辑中的外部请求,都是不可以模拟的,所以我在这里使用的思路是mock。这也是遇到这种情况一个常见的思路
为了方便测试,我专门封装了一个请求的方法来mock
@staticmethod
def get_code2session(code):
"""
将接口请求独立封装以方便测试时mock.
返回请求后的json
"""
api_url = 'https://api.weixin.qq.com/sns/jscode2session'
return requests.get(api_url,{
'appid': CONFIG['app_id'],
'secret': CONFIG['app_secret'],
'js_code': code,
'grant_type': 'authorization_code'
}).json()
复制代码
测试部分
api_res_mock = [
({
'errcode': -1,
}),({
'errcode': 0,
'session_key': '55ba1e5f7a5ce1d8cfc48e28cfb77a6e',
'openid': openid
}),({
'errcode': 40029,
}),({
'errcode': 45011,
}),
]
@pytest.mark.parametrize('api_res', api_res_mock)
def test_login(mock_user, mocker, api_res):
"""mock了和微信服务器通信的方法来完成其他部分的测试.
和微信服务器的通信结果作为测试用例"""
mocker.patch('core.user.User.get_code2session', return_value=api_res)
user = User(open_id=mock_user.open_id)
assert user.user.id == mock_user.id
if api_res['errcode'] == 0:
user.login('mock_code')
mock_user.reload()
assert api_res['session_key'] == mock_user.session_key
if api_res['errcode'] == -1:
with pytest.raises(LoginFailed):
user.login('mock_code')
if api_res['errcode'] == 40029:
with pytest.raises(CodeInvalid):
user.login('mock_code')
if api_res['errcode'] == 45011:
with pytest.raises(LoginOverFrequency):
user.login('mock_code')
复制代码
讲一下细节
- 直接把请求函数的返回值mock了
- 把微信服务器的返回作为了测试用例,就和传入的code没有任何关系了
- 做了一个
mock_user
的fixture来创建和删除测试用户 - 根据返回值的不同做异常推断
这个是比较常规的思路,主要说一下今天晚上开的脑洞。
中间件的接口请求
这个需求中中间件请求的部分实际是可控的,但是我并不想在测试中控制多余的模块。当然这里也可以用mock来做,但是要mock HTTP请求的话,只有两个办法:
- 把request给mock掉。如果你有很多用到request的地方就不行了
- 封装。麻烦
所以脑洞一开,写了个工具类,上代码
class TestServe:
"""
测试服务,在需要测试代码向接口发送了请求时使用,
返回包含所有请求参数的json。
该类适用于模块测试。
"""
class RequestLog:
"""TestServe内部类,用于记录请求内容"""
def __init__(self, remote_addr, method, response, values, json):
self.remote_addr = remote_addr
self.method = method
self.response = response
self.values = values
self.json = json
def __init__(self):
self.app = Flask(__name__)
self.request_log = []
def add_rule(self, rule, view_func=None, methods=None, *args, **kwargs):
"""添加rule,该类不内置任何路由。默认的试图函数会返回所有请求参数"""
if view_func is None:
view_func = self.default_view_func
if methods is None:
methods = ['GET']
self.app.add_url_rule(rule, view_func=self.view_func_wrapper(view_func),
methods=methods, *args, **kwargs)
@staticmethod
def default_view_func():
return jsonify({
'code': 200,
'msg': 'success',
'args': dict(request.args or {}),
'form': dict(request.form or {}),
'values': dict(request.values or {}),
'json': dict(request.json or {})
})
def view_func_wrapper(self, f):
"""记录request信息的装饰器"""
def decorator():
res = f()
rq_log = self.RequestLog(request.remote_addr, request.method, res,
request.values or {}, request.json or {})
self.request_log.append(rq_log)
return res
return decorator
def run(self, port=8888, *args, **kwargs):
kwargs = {'port': port, **kwargs}
serve = Thread(target=self.app.run, args=args, kwargs=kwargs)
serve.setDaemon(True)
serve.start()
# Usage
test_serve = TestServe()
test_serve.add_rule(rule, methods=['POST'])
test_serve.run(port)
res = requsts.get('http://127.0.0.1:8888', {'test': 777})
assert res.json()['values']['test'] == 777
log = test_serve.request_log[0]
assert log.values.get('xxx') == xxx
复制代码
讲一讲思路
核心思路是以多线程的方式挂起一个Flask服务接收HTTP请求,然后原样返回。
允许使用时传入自定义的视图函数。试图函数会被view_func_wrapper
装饰,目的是记录response的情况方便测试的时候查看。这样一来,每个请求的结果都能在测试中访问到。
其实直接把
request
扔进RequestLog
就好了,找时间改一改。
这种方法来写测试可控性会高很多,但是注意只适用于http的外部请求。
如果好用可以回来点个赞~