- 借助Mitmproxy来抓取产品使用中的http api接口数据( record_http_apis.py )
- 运行 generate_newcases_from_api_record.py 处理抓取到的接口数据，生成新api的测试数据。
- 根据需要设置api的测试数据，补充到框架中。如完善status code, 指定运行环境和优先级，提取参数变量等。
- 执行新增api的测试。
- 通过requests session会话，一次登录，免除cookie关联处理
- 测试数据驱动，csv方便版本比较，补充完善用例
- 自动生成测试用例（含断言），小白也很好用
- 支持接口间传参
- 支持多进程，加速测试执行过程
- 支持多环境切换，仅需改动一处
- 断言：除了status code，还支持json schema断言
- 漂亮的Allure报告，可查看每个接口的请求和响应数据，以及断言，方便排查
- Slack告警（老东家用的，这里已去除）
- ......
-
flask_http_methods_demo 是一个简单的Flask项目，在本地创建一些http接口，方便用于测试本框架。执行命令
python app.py即可在本地启动一个http服务器，默认监听5000端口。 -
record_HTTP_API_via_mitmproxy 启动
mitmproxy监听一个端口，可抓取产品使用中的http api接口数据并存到csv文件中，例如 apirecord_demo.csv -
generate_newcase_from_apirecord_csv 处理
mitmproxy抓取的api数据文件，生成新api的测试数据"*_cases.csv"，例如 apirecode_demo_cases.csv -
app_apibase.py：核心类，包括登录、发送 http 请求（get、post...）以及以 json 格式返回数据 注：登录接口请求后，通常需要往
headers增加字段，请根据实际情况完善login_session函数结尾已注释部分。 -
jsonschema_handle.py 主要功能有两个：
-
- 读取 .json 文件并返回 JSON Schema。
-
- 验证 JSON Schema 并将结果添加到 Allure 报告中。
-
通过
pytest框架管理测试用例，建议按功能模块分区。已覆盖功能范围： -
feature A Demo API
-
feature B Demo API
-
base_config.py：读取 'config.yaml' 文件以获取 base_url、email和password，...
-
config.yaml: 填写测试环境，base_url, 账号、密码，要执行的case优先级等信息。 对于
case_pytest_lst里每项实际是pytest的参数，如-n表示pytest-xdist多进程。 -
保存脚本生成的日志
-
http接口请求数据记录（csv格式）
-
保存 Allure 生成的测试报告
- csv_parse.py：将.csv转换为测试用例
- handle_request.py：处理每个测试用例的 request_url、params、payload, 发送http请求
- common_funs.py：一些常用函数
- report_post_handle.py：用例执行完毕后，分析统计生成的Allure记录数据，形成报告。 还可以从请求csv记录中筛选出状态码不是200，以及响应时间超过3秒的数据，生成html文件，方便查看。
- write_csv.py：辅助模块，记录 Http API 请求数据到 .csv 文件
- 安装 Python 3.7+
- 下载代码。
- 在当前文件夹中，运行
pip install -r requirement.txt安装依赖包 - 通过“allure2”安装 allure 2.1.38+
- 参考“config”子文件夹中的
config_sample.yaml生成config.yaml文件，并进行配置。 - 如果是想体验下效果，可先进入 flask demo 目录，执行
python app.py命令在本地启动一个http测试服务端，否则请忽略。 - 执行
python3 run_api_cases.py，完成后默认会自动打开测试报告网页。 另外，我们可以在第一个参数中指定运行环境，例如python3 run_api_cases.py prod
报告会展示每个case的请求和返回数据，如果失败会注明原因，如下图所示：
-
Q: 各功能模块的测试用例
.csv文件和jsonschema文件是如何得到的？
方法有两种：- 手动方式(不推荐)。根据示例，手动填入新case的每个字段，包括request url, method, params, payload, status code等，同样
jsonschema文件也要手动写这种验证选项。 - 自动方式(强烈推荐)。先用
mitmproxy抓取产品使用过程中的数据，再用脚本自动生成新接口的测试用例.csv文件和jsonschema文件。
- 手动方式(不推荐)。根据示例，手动填入新case的每个字段，包括request url, method, params, payload, status code等，同样
-
Q: 如何用
mitmproxy自动抓取产品使用中的http api接口数据？
启动 record_http_apis.py 监听一个端口，设置产品通过该代理访问，这样脚本可将产品使用过程中的http api请求数据自动记录到csv文件中，内容可参考示例文件 api reocde demo ，具体用法详情可参考 这里 -
Q: 如何根据跟
mitmproxy自动记录的数据，生成新的测试用例csv文件和jsonschema文件？
将mitmproxy抓取得到的csv文件，放到 generate_newcase_from_apirecord_csv 下， 运行python generate_newcases_from_api_record.py，可得到新api的用例数据文件*_cases.csv, 每行数据即是一个接口用例，其包括request url,method,params,payload,status code等，以及用于校验返回数据的jsonschema文件(验证返回json数据的结构和数据内容，如字段是否缺失，字段类型是否正确、字段值是否符合预期等)，这些新api的jsonschema文件在new_jsonschema_files_dir下，根据实际将其完善后放到cases/jsonfiles下。 -
Q: 某些接口的响应状态码可能有多个，如
200和502都符合预期，该如何处理？
通常来说，响应状态码status_code字段的值为200，如果可以是多个，则可将该字段值改成[200, 502]，如 测试用例csv demo, 第15-16行。 -
Q: 某些接口仅允许在特定环境，或某个测试账号才执行，该如何处理？
如果某些接口只允许在指定的环境运行, 可修改run_env字段，其默认值为all，表示在所有环境都运行。如果改成prod，则表示仅在prod环境才运行。 -
Q: 某些接口仅允许某个测试账号才执行，该如何处理？
如果某些接口只允许某个账号身份登录才运行，可修改run_env字段，其默认值为all，表示所有用户都运行。如果改成[email protected]，则表示仅测试账号为[email protected]时才运行。 -
Q: 如何提取响应数据为变量，供之后的接口用例所使调用？
在测试过程中，经常遇到下一个接口B需要用到上一个接口A响应数据的情况，这个时候就涉及到参数的提取。 本框架在csv用例数据中定义了字段var_extract来进行后置参数的提取，根据接口返回响应数据（暂仅支持JSON，若是text则需要进一步完善）提取参数，保存在变量中，可供之后的接口用例所使调用。字段var_extract可转为dict，其key为变量名，v是jsonnpath表达式。 假设接口A的返回为{"data": [{"name": "Lucy", "age": "10", "grade": 4}, {"name": "John", "age": "12", "grade": 6}] }若
var_extract字段为{"name": "$..name", "age": "$..age"}，则表示将接口返回的json中的第一个name字段值Lucy，存到变量name中，该模块之后的用例接口B可通过${name}来引用，age同理。关于jsonpath表达式，可自行查询该库的更多具体用法。 如果还有更它需要，如要取返回的最后一个字段，或者某个返回字段值中的部分，可以在注释step 2: extract variables结束部分再自行补充。 如 测试用例csv示例文件, 第2行的var_extract字段，就表示从该接口返回数据取第一个"name"字段，然后在第3行的payload中引用该字段。