单元测试中Mock一个Python装饰器

2018-08-09

场景

测试一些方法时, 可能会遇到该方法需要鉴权的情况(如login_required之类), 需要想办法绕过装饰器.

解决方案

  1. 为装饰器加开关. 在装饰器中通过读取某个配置判断是否开启该装饰器;
  2. mock掉装饰器.

前者操作起来方便, 但是在遇到不同装饰器都需要mock时, 为每个装饰器添加开关有些工作量;
而后者也有弊端, 即此次测试中, 所有测试都基于该装饰器不生效的情况下测试. 因此对于如权限等的测试, 需要添加其他测试手段(如接口测试)来完成.

本文讲述的是第二个解决方案的具体实现.

技术点

Mock装饰器与普通方法的不同之处在于, 装饰器在方法声明时就已经产生影响, 而不像普通方法被调用前mock即可, 因此需要在测试执行的最开始, 还没初始化服务端代码时就mock装饰器.

写一个自己的装饰器

  1. from functools import wraps
  2. def mock_decorator(*args, **kwargs):
  3.     def decorator(f):
  4.         @wraps(f)
  5.         def decorated_function(*args, **kwargs):
  6.             return f(*args, **kwargs)
  7.         return decorated_function
  8.     return decorator

mock原来装饰器

在测试模块的__init__.py下执行Mock操作, 即可在运行测试前先替换原来的装饰器.

  1. from unittest import mock
  3. mock.patch('decoretor.path.to.mock',mock_decorator).start()

参考

[1] Can I patch a Python decorator before it wraps a function?, Stack Overflow