hook机制

Posted 2023-03-23

参考技术A HttpRunner 已实现了全新的 hook 机制，可以在请求前和请求后调用钩子函数。

hook 机制分为两个层级：

在 pyttest 测试用例的 RunTestCase 中增加关键字 setup_hooks 和 teardown_hooks 。

在 pytest 测试用例的 RunRequest 中新增关键字 setup_hooks 和 teardown_hooks 。

hook 函数的定义放置在项目的 debugtalk.py 中，在 pytest/YAML/JSON 中调用 hook 函数仍然是采用 $func($a, $b) 的形式。

对于测试用例层面的 hook 函数，与 YAML/JSON 中自定义的函数完全相同，可通过自定义参数传参的形式来实现灵活应用。

对于单个测试请求层面的 hook 函数，除了可传入自定义参数外，还可以传入与当前测试用例相关的信息，包括请求的 $request 和响应的 $response ，用于实现更复杂场景的灵活应用。

在测试步骤层面的 setup_hooks 函数中，除了可传入自定义参数外，还可以传入 $request ，该参数对应着当前测试步骤 request 的全部内容。因为 request 是可变参数类型（dict），因此该函数参数为引用传递，当我们需要对请求参数进行预处理时尤其有用。
e.g.

通过上述的 setup_hook_prepare_kwargs 函数，可以实现根据请求方法和请求的 Content-Type 来对请求的 data 进行加工处理；通过 setup_hook_httpntlmauth 函数，可以实现 HttpNtlmAuth 权限授权。

在测试步骤层面的 teardown_hooks 函数中，除了可传入自定义参数外，还可以传入 $response ，该参数对应着当前请求的响应实例（requests.Response）。

e.g.

通过上述的 teardown_hook_sleep_N_secs 函数，可以根据接口响应的状态码来进行不同时间的延迟等待。

另外，在 teardown_hooks 函数中还可以对 response 进行修改。当我们需要先对响应内容进行处理（例如加解密、参数运算），再进行参数提取（extract）和校验（validate）时尤其有用。

例如在下面的测试步骤中，在执行测试后，通过 teardown_hooks 函数将响应结果的状态码和 headers 进行了修改，然后再进行了校验。