api-test-toolkit 0.2.0__py3-none-any.whl

api_test_kit/templates/scripts/new-endpoint.sh

@@ -0,0 +1,75 @@
+#!/usr/bin/env bash
+# 生成新的端点模型 + 测试文件模板
+# 用法：./scripts/new-endpoint.sh <资源名>
+#
+# 示例：./scripts/new-endpoint.sh products
+#   创建：
+#     src/{{ package_name }}/endpoints/products.py
+#     tests/endpoints/test_products.py
+
+set -euo pipefail
+
+NAME="${1:?用法: $0 <资源名>}"
+
+# 用 Python 推导类名
+CLASS_NAME="$(python3 -c "
+import sys
+name = sys.argv[1]
+if name.endswith('s'):
+    name = name[:-1]
+parts = name.replace('-', '_').split('_')
+result = ''.join(p.capitalize() for p in parts)
+print(result + 'Endpoint')
+" "$NAME")"
+
+SRC_DIR="src/{{ package_name }}/endpoints"
+TEST_DIR="tests/endpoints"
+
+mkdir -p "$SRC_DIR" "$TEST_DIR"
+
+# ── 端点模型 ────────────────────────────────────────────────
+cat > "$SRC_DIR/$NAME.py" <<PYEOF
+"""${CLASS_NAME} — ${NAME} 的 API 端点模型."""
+from __future__ import annotations
+
+from api_test_kit.client import ApiResponse
+from api_test_kit.endpoints._base import BaseEndpoint
+
+
+class ${CLASS_NAME}(BaseEndpoint):
+    """${NAME} 的 CRUD 操作."""
+
+    path = "/${NAME}"
+
+    # --- 自定义方法写在这里 ---
+PYEOF
+
+# ── 测试文件 ─────────────────────────────────────────────────
+cat > "$TEST_DIR/test_${NAME}.py" <<PYEOF
+"""${NAME} 端点测试."""
+from __future__ import annotations
+
+import pytest
+
+from api_test_kit.assertions import assert_status, assert_ok, assert_json_has
+from api_test_kit.endpoints.${NAME} import ${CLASS_NAME}
+
+
+class Test${CLASS_NAME}List:
+    """${NAME} 列表测试."""
+
+    def test_list_success(self, client):
+        """应返回 200 带分页结果."""
+        ep = ${CLASS_NAME}(client)
+        resp = ep.list(page=1, size=10)
+        assert_status(resp, 200)
+        assert_ok(resp)
+        assert_json_has(resp, r"\$.data.items")
+PYEOF
+
+# ── 完成 ─────────────────────────────────────────────────────
+echo "✅ 已创建："
+echo "   $SRC_DIR/$NAME.py"
+echo "   $TEST_DIR/test_${NAME}.py"
+echo ""
+echo "下一步：运行 pytest $TEST_DIR/test_${NAME}.py -v"

api_test_kit/templates/tests/__init__.py

@@ -0,0 +1 @@
+# tests/__init__.py

api_test_kit/templates/tests/conftest.py

@@ -0,0 +1,44 @@
+"""全局 fixtures。"""
+from __future__ import annotations
+
+import os
+
+import pytest
+
+from api_test_kit.client import BaseClient, BearerTokenProvider
+from api_test_kit.config import HarnessConfig
+from api_test_kit.e2e.context import ScenarioContext
+from api_test_kit.logger import setup_logging
+
+
+@pytest.fixture(scope="session")
+def env_config() -> HarnessConfig:
+    """加载测试环境配置。
+
+    通过 ``API_TEST_ENV`` 环境变量切换环境（默认: staging）。
+    """
+    env_name = os.getenv("API_TEST_ENV", "staging")
+    return HarnessConfig.from_env(env_name)
+
+
+@pytest.fixture(scope="session")
+def client(env_config: HarnessConfig) -> BaseClient:
+    """已鉴权的 HTTP 客户端，session 级别复用。"""
+    setup_logging(env_config.log_level)
+    client = BaseClient(env_config)
+    token = env_config.client_secret
+    if token and env_config.auth_type in ("bearer", "api_key"):
+        client.authenticate(BearerTokenProvider(token))
+    return client
+
+
+@pytest.fixture
+def unauthenticated_client(env_config: HarnessConfig) -> BaseClient:
+    """无鉴权的客户端，用于测试鉴权/错误流程。"""
+    return BaseClient(env_config)
+
+
+@pytest.fixture
+def e2e_context() -> ScenarioContext:
+    """每个 E2E 场景的独立上下文。"""
+    return ScenarioContext()

api_test_toolkit-0.2.0.dist-info/METADATA

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: api-test-toolkit
+Version: 0.2.0
+Summary: AI 友好的 API 自动化测试工具包
+Requires-Python: >=3.11
+Requires-Dist: requests>=2.31
+Requires-Dist: pydantic<3,>=2.5
+Requires-Dist: pydantic-settings>=2.1
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: jsonpath-ng>=1.6
+Requires-Dist: deepdiff>=7.0
+Requires-Dist: typer<1,>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.5; extra == "dev"
+Requires-Dist: pytest-html>=4.1; extra == "dev"
+Requires-Dist: allure-pytest>=2.13; extra == "dev"
+Requires-Dist: responses>=0.25; extra == "dev"
+Requires-Dist: faker>=22.0; extra == "dev"
+Requires-Dist: ruff>=0.3; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"

api_test_toolkit-0.2.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+api_test_kit/__init__.py,sha256=ZI9BDQpIDWrtXM_Tib995EM-ZxSbfq6kLGb9XaPuSdg,483
+api_test_kit/assertions.py,sha256=ET78wN_l98CLbO_s-_RsQ0z1K7igs5mjj13BxEFUeDo,4060
+api_test_kit/cli.py,sha256=DGPhQ-LWLLvNaCHYqtsyRJ4bMq9xVBFRhyuDBTkIKkU,1296
+api_test_kit/client.py,sha256=ychiytV8694MlWXbY36gF7HpP3Q3s5qNz-y3K7rQD8s,7923
+api_test_kit/config.py,sha256=Y9-38f9Ir39FR8gqPVbj0lkm-pw3ZxgYRXO3fjT4QZ8,2903
+api_test_kit/logger.py,sha256=NcfvdXvaOkTYUg7MYzfIIb5ome_15bJnyYxo0s0-6jg,760
+api_test_kit/scaffold.py,sha256=7MK7Lk4Lvp-Dj6mi4xhxM155afn8SZnrFM11_ctG4rc,5921
+api_test_kit/e2e/__init__.py,sha256=GRETcT34TdWBoBLzvB1ueI7xB1jQCL5bq3sxsggajgo,435
+api_test_kit/e2e/context.py,sha256=QrWHGT9IFsoPsLTO3ui5bVd6OG5GDuSnwtsJ7OnSp5s,1997
+api_test_kit/e2e/helpers.py,sha256=02tcX0fEtkD0MJi2VdyK5B3fjeB8lAoJ1ufdS_2E_qs,889
+api_test_kit/e2e/scenario.py,sha256=0a0mnjCnIGCcYaFAjJsvopDEvnohgx90oPdPDkx7tjw,3500
+api_test_kit/e2e/step.py,sha256=htGSZdPZNFxDe1DrGt3aldOSYe4m7bq5h5Elra3gcu0,2926
+api_test_kit/endpoints/__init__.py,sha256=une6WuX1_wRCcOfl005tSb5i986lN_TP7NjF1bTGCEU,1338
+api_test_kit/endpoints/_base.py,sha256=9BAL0a6-3vRc7-43V6SC-acznVlaNAeVHKm_gU5rlDw,1347
+api_test_kit/templates/AGENTS.md,sha256=vadIg8o_ovYL2_fhtRyH14vpHR5LF-hZzSvyYfs8XGE,1397
+api_test_kit/templates/README.md,sha256=tkc-Nuh2cMcp_cR5ScXhq2vDmxbIwHNH9P2DTQRdV8Y,670
+api_test_kit/templates/pyproject.toml,sha256=7Oaq_AAf2gt9RzCBulyD3nmPUTujdzRddi8J3kTkzE8,453
+api_test_kit/templates/pytest.ini,sha256=YGH8NZsDDUwKcDQA4DJZnrEYo6cLDAx4jeSrHmNFQ6o,238
+api_test_kit/templates/scripts/new-endpoint.sh,sha256=oIVONvY2vR2YeUekAAMk9rAeDw4hNn2a5AH5ZSaVvxA,2318
+api_test_kit/templates/tests/__init__.py,sha256=iViLDCvp2HIGDniqaMz5X5TKJ-pry3mkNQnWbClsc84,20
+api_test_kit/templates/tests/conftest.py,sha256=y1itnNbVBj0oZ8uT_Ix6fTc48KsdhX19O-cOc7PvHl0,1310
+api_test_toolkit-0.2.0.dist-info/METADATA,sha256=weM_jvp29UWChMnmCeBuN1HxGRLX264iyJSRZ9l9lNc,743
+api_test_toolkit-0.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+api_test_toolkit-0.2.0.dist-info/entry_points.txt,sha256=7N5ZGnaCauNMusu97hWGAdAZmCbgk3v4dJGqD7kIJYo,58
+api_test_toolkit-0.2.0.dist-info/top_level.txt,sha256=aZR715fS60fIKUfQr62k00_KEFB1BdAtUeGXxvKPe8M,13
+api_test_toolkit-0.2.0.dist-info/RECORD,,

api_test_toolkit-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

api_test_toolkit-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+api-test-toolkit = api_test_kit.cli:app

api_test_toolkit-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+api_test_kit