httprunner学习05-hook机制实现异步调用时的延时等待

前言：
运行测试用例的时候，遇到一个问题。异步资源创建API调用后，往往需要等待一段时间资源才能创建出来，继续后续的操作。
这个时候，就希望用例执行可以延时等待。等异步资源创建出来后在进行下一步的调用。
一般自动化测试框架如unittest，在用例执行前后可以通过setup和teardown来处理初始化数据和清理测试数据或者延时，httprunner也有对应的hook机制，来实现相同的效果。

httprunner的hook 机制分为两个层级：
测试用例层面（testcase）
测试步骤层面（teststep）

测试用例层面（testcase）：
在 YAML/JSON 测试用例的 config 中新增关键字 setup_hooks 和 teardown_hooks。
setup_hooks: 在整个用例开始执行前触发 hook 函数，主要用于准备工作。
teardown_hooks: 在整个用例结束执行后触发 hook 函数，主要用于测试后的清理工作。

- config:
    name: basic test with httpbin
    request:
        base_url: http://127.0.0.1:3458/
    setup_hooks:
        - ${hook_print(setup)}
    teardown_hooks:
        - ${hook_print(teardown)}

测试步骤层面（teststep）：
在 YAML/JSON 测试步骤的 test 中新增关键字 setup_hooks 和 teardown_hooks。
setup_hooks: 在 HTTP 请求发送前执行 hook 函数，主要用于准备工作；也可以实现对请求的 request 内容进行预处理。
teardown_hooks: 在 HTTP 请求发送后执行 hook 函数，主要用于测试后的清理工作；也可以实现对响应的 response 进行修改，例如进行加解密等处理。

"test": {
    "name": "get token with $user_agent, $os_platform, $app_version",
    "request": {
        "url": "/api/get-token",
        "method": "POST",
        "headers": {
            "app_version": "$app_version",
            "os_platform": "$os_platform",
            "user_agent": "$user_agent"
        },
        "json": {
            "sign": "${get_sign($user_agent, $device_sn, $os_platform, $app_version)}"
        }
    },
    "validate": [
        {"eq": ["status_code", 200]}
    ],
    "setup_hooks": [
        "${setup_hook_prepare_kwargs($request)}",
        "${setup_hook_httpntlmauth($request)}"
    ],
    "teardown_hooks": [
        "${teardown_hook_sleep_N_secs($response, 2)}"
    ]
}

编写 hook 函数
hook 函数的定义放置在项目的 debugtalk.py 中，在 YAML/JSON 中调用 hook 函数仍然是采用 KaTeX parse error: Expected '}', got 'EOF' at end of input: {func(a, $b)} 的形式。
对于测试用例层面的 hook 函数，与 YAML/JSON 中自定义的函数完全相同，可通过自定义参数传参的形式来实现灵活应用。

def hook_print(msg):
    print(msg)

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

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

def setup_hook_prepare_kwargs(request):
    if request["method"] == "POST":
        content_type = request.get("headers", {}).get("content-type")
        if content_type and "data" in request:
            # if request content-type is application/json, request data should be dumped
            if content_type.startswith("application/json") and isinstance(request["data"], (dict, list)):
                request["data"] = json.dumps(request["data"])

            if isinstance(request["data"], str):
                request["data"] = request["data"].encode('utf-8')

def setup_hook_httpntlmauth(request):
    if "httpntlmauth" in request:
        from requests_ntlm import HttpNtlmAuth
        auth_account = request.pop("httpntlmauth")
        request["auth"] = HttpNtlmAuth(
            auth_account["username"], auth_account["password"])

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

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

回到一开始的需求，希望异步资源创建接口调用完成后，用例进行延时等待，则可通过下文的函数实现。

def teardown_hook_sleep_N_secs(response, n_secs):
    """ sleep n seconds after request
    """
    if response.status_code == 200:
        time.sleep(n_secs)
    else:
        time.sleep(0.5)

通过上述的 teardown_hook_sleep_N_secs 函数，可以根据接口响应的状态码来进行不同时间的延迟等待。
在测试用例步骤中加入该hook：

config:
    name: 登录用例
    base_url: ${ENV(BASE_URL)}

teststeps:
-   name: 000 登录cmc成功
    api: api/cmc/Common_API/cmc_login.yml
    validate:
    -  eq: [status_code, 200]
    -  eq: [content.success, true]
    -  eq: [content.message, 管理员登录成功]
    teardown_hooks:
        - ${teardown_hook_sleep_N_secs($response, 5)}   #配合以上函数，实现接口调用成功则休眠5秒

至此，当异步接口调用成功后，用例将休眠5秒或者更多时间。等资源创建完成后，继续执行后续API。

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

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

- test:
    name: alter response
    request:
        url: /headers
        method: GET
    teardown_hooks:
        - ${alter_response($response)}
    validate:
        - eq: ["status_code", 500]
        - eq: ["headers.content-type", "html/text"]

def alter_response(response):
    response.status_code = 500
    response.headers["Content-Type"] = "html/text"

总结：
关于httprunner的hook机制，我在实际工作中使用不多，没能深入的进行应用。希望日后有时间，可以更深入的挖掘一下相应的应用场景。