- python3 + pytest + parametrize + requests / httpx + yaml / excel ...
- common/: 公共类
- core/: 配置
- data/: 测试数据
- db/: 数据库相关
- log/: 日志文件
- report/: 测试报告存放
- test_case/: 放置接口自动化测试项目和用例
- utils/: 工具包
- conftest.py: pytest.fixture 配置
- pytest.ini pytest 参数配置
- run.py: pytest 主程序运行入口
克隆:
git clone https://gitee.com/wu_cl/automated_api_pytest.git安装依赖包:
pip install -r requirements.txt多项目数据依据目录层级进行隔离
test_case 目录下的一级文件夹视为单个项目目录
在 config.toml 配置中修改 project = xxx 为对应的项目目录名
yaml 数据：
config:
allure:
epic:
feature:
story:
request:
env:
headers:
timeout:
verify:
redirects:
proxies:
requests:
http:
https:
# httpx:
# http://:
# https://:
module:
test_steps:
- name:
case_id:
description:
is_run:
request:
method:
url:
params:
headers:
data_type:
data:
files:
xxx:
setup:
testcase:
- case_id:
key:
jsonpath:
- event_query_001
sql:
- key:
set_type:
sql:
jsonpath:
- select * from xxx where xxx=xxx
hooks:
- func:
wait_time:
teardown:
sql:
hooks:
extract:
- key:
set_type:
jsonpath:
assert:
- check:
value:
type:
jsonpath:
- assert 200 = pm.response.get('status_code')
wait_time:excel 数据：
release 版本已不推荐使用，因为受限于数据 json 结构，对于 excel 来说，编写及修改都略显繁琐，
尽管数据解析时考虑了 excel 数据的情况，但这种方式已经被提前拦截
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| config | dict | Y | 测试用例配置 |
| + allure | dict | Y | allure 测试报告配置 |
| ++ epic | str | Y | allure epic |
| ++ feature | str | Y | allure feature |
| ++ story | str | Y | allure story |
| + request | dict | Y | 请求参数 |
| ++ env | str | Y | 测试环境 |
| ++ headers | dict / null | N | 请求头 |
| ++ timeout | int / null | N | 请超时时长，如果存在且不为空，则应用本数据所有测试用例， 如果不存在或为空，则默认应用 conf 配置文件 |
| ++ verify | bool / null | N | 请求验证，应用同上 |
| ++ redirects | bool / null | N | 重定向，应用同上 |
| ++ proxies | dict / null | N | 代理，应用同上 |
| +++ requests | dict | N | requests 引擎代理，仅当使用 requests 发送请求时，才能使用 |
| ++++ http | str / null | / Y | http 代理 |
| ++++ https | str / null | / Y | https 代理 |
| +++ httpx | dict | N | httpx 引擎代理，仅当使用 httpx 发送请求时，才能使用 |
| ++++ http:// | str / null | / Y | http 代理 |
| ++++ https:// | str / null | / Y | https 代理 |
| + module | str | Y | 用例所属模块 |
| test_steps | list / dict | Y | 测试步骤，多用例时，必须使用 list 格式 |
| + name | str | Y | 用例名称 |
| + case_id | str | Y | 用例 id |
| + description | str | Y | 用例描述 |
| + is_run | bool / null | Y | 是否跳过 |
| + request | dict | Y | 请求参数 |
| ++ method | str | Y | 请求方式 |
| ++ url | str | Y | 请求链接，不包含域名，域名在测试环境中以 host=xxx 配置 |
| ++ params | dict / bytes / null | Y | 请求查询参数 |
| ++ headers | dict / null | Y | 请求头，如果为空，则会应用上方配置中的请求头，如果上方也未配置，则不使用请求头 |
| ++ data_type | str / null | Y | 请求数据类型: data / json |
| ++ data | dict / bytes / Tuple(list) / null | Y | 请求体 |
| ++ files | List[Dict[ list / str ]] / null | Y | 请求文件 |
| + setup | dict | N | 请求前置条件 |
| ++ testcase | List[ dict / str ] / null | N | 请求前置 testcase，当执行测试用例时，格式为 List[str]， 当设置当前测试执行过程中的缓存变量时，格式为 List[dict] |
| ++ sql | List[ dict / str ] / null | N | 请求前置 sql，当为执行 sql 时，格式为 List[str]， 当为设置变量时，格式为 List[dict] |
| ++ hooks | List[str] / null | N | 钩子函数 |
| ++ wait_time | int / null | N | 请求前等待时间 |
| + teardown | dict | N | 请求后置条件 |
| ++ sql | List[ dict / str ] / null | N | 同前置 |
| ++ hooks | List[str] / null | N | 同前置 |
| ++ extract | List[dict] | N | 变量提取 |
| +++ key | str | / Y | 变量 key |
| +++ set_type | str | / Y | 变量类型: env / global / cache |
| +++ jsonpath | dict | / Y | jsonpath 表达式，依赖 response 数据集 |
| ++ assert | List[ dict / str ] | N | 断言 |
| ++ wait_time | int / null | N | 请求后等待时间 |
setup testcase 参数支持两种功能：
- 执行关联测试用例
- 设置当前测试执行过程中的缓存变量，且仅供当前测试用例使用
设置变量格式：
testcase:
- case_id: 关联测试 case_id
key: 变量 key，str
jsonpath: jsonpath 表达式，用作 valueset_up / tear_down 的 sql 参数支持两种功能：
- 设置变量
- 执行 sql 语句
设置变量格式：
sql:
- key: 变量 key，str
set_type: 变量类型：env / global / cache
sql: 执行 sql 查询，str
jsonpath: jsonpath 表达式，数据依赖 sql 查询断言支持多种格式，详细说明请打开 assert_control.py 文件，以 reStructuredText 方式查阅， 以下两点做概要说明：
- 常规断言：像正常 assert 的格式，但是比较值受约束，从 response 数据集进行取值， 并且以 pm.response.get('') 开始取值，后面可以继续 get()，也可以使用其他方法，只要 是 python 可执行代码，并且为了避免引号问题，断言脚本必须使用单引号处理
- jsonpath：使用 jsonpath 从response数据集进行取值比较
- 两种断言方式可以同时使用
常规断言格式举例：
assert:
- assert xxx 条件 pm.response.get('')..., '错误说明'jsonpath 格式举例：
assert:
- check: 检查说明, str
value: 比较值, Any
type: 比较方式，str，请查阅 assert_type.py 文件
jsonpath: jsonpath 表达式变量除了在用例数据中通过运行测试进行定义外，还可以进行手动定义
全局变量手动定义：
仅在 data 目录下的 global_vars.yml 中以键值对形式进行定义，可参考demo
环境变量手动定义：
在测试用例依赖的环境文件中以键=值的形式进行定义
缓存变量手动定义:
通过 hook 函数调用缓存变量设置函数进行定义
仅在 data 目录下的 hooks.py 文件中定义，根据定义结构在用例数据文件中使用，可参考 demo
普通变量：
${var} 或 $var
关联测试用例变量：只在用例中含有关联测试用例并需要引用关联测试用例设置的变量时，使用此方式
^{var} 或 ^var
hooks：仅在前后置 hooks 参数下配置时生效
${func()} 或 ${func($var1, $var2)}
约束：
变量和 hooks 开头: a-zA-Z_
普通变量：
- env：即在当前测试用例数据所调用的测试环境中进行持久化写入，键值不会重复，新值覆盖旧值
- global: 在全局变量文件中进行持久化写入，键值不会重复，新值覆盖旧值
- cache：写入当前整个运行过程的内存中，不会持久化，运行结束后自动清除
请求数据解析时，寻找变量顺序为： cache > env > global，找到变量自动替换数据，未找
到抛出异常
温馨提示: 变量持久化写入会冲刷掉手写注释内容
关联用例变量：
- 默认仅使用 cache 存储变量，不会持久化，运行结束后自动清除
关联用例执行后，在缓存变量中寻找，找到变量自动替换数据，未找到抛出异常
将请求发送后的 response 数据进行整合重组，结构如下：
{
"url": null,
"status_code": 200,
"elapsed": 0,
"headers": null,
"cookies": null,
"json": null,
"content": null,
"text": null,
"stat": {
"execute_time": null
}
}- 根据数据结构及参数说明，手动编写测试用例
- 通过 cli 自动生成测试用例
在项目中使用，确保终端在 fastpt 文件夹下打开：`cd fastpt
cli 使用帮助:
python cli.py --helpcli 生成测试用例:
python cli.py --gtc运行 run.py 文件即可
main 程序参数根据情况进行自定义
运行完之后到 report 文件夹下查看
日志内容需要手动写入, 详细示例demo中几乎都有体现, 请自行查看
html：
自动生成，检查 run 参数是否开启 html 报告创建, 默认开启
excel：
当前 release 版本已不适用，测试报告要手动写入, 并依赖 excel 测试数据
yaml：
测试报告要手动写入, 很少用到，调用方法请查看 yaml_handler.py 文件
allure：
自动生成, 默认开启并自动打开浏览器访问, 前提已正确安装 allure 程序
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent