dd-apitest 0.2.0__py3-none-any.whl

core/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.0"

core/__main__.py

@@ -0,0 +1,99 @@
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+from dotenv import load_dotenv
+
+from core.errors import ConfigError
+from core.init_cmd import init_user_data
+from core.loader import discover_suites, find_suite_by_name
+from core.menu import run_menu
+from core.paths import resolve_data_root, script_root, set_runtime_data_root, suites_template_source
+from core.report import write_run_report
+from core.runner import run_all_groups, run_group
+
+
+def _file_uri(path: Path) -> str:
+    return path.resolve().as_uri()
+
+
+def _cmd_run(args: argparse.Namespace) -> int:
+    suite = find_suite_by_name(args.suite)
+    session_env = args.env or suite.default_env
+    if args.all:
+        result = run_all_groups(suite, session_env=session_env)
+    else:
+        if not args.group:
+            print("--group or --all is required", file=sys.stderr)
+            return 2
+        result = run_group(suite, args.group, session_env=session_env)
+    out = write_run_report(suite_name=suite.name, session_env=session_env, result=result)
+    report_html = (out / "report.html").resolve()
+    total = result.total
+    rate = (result.passed / total * 100) if total else 0
+    print(f"Summary: passed={result.passed} failed={result.failed} total={total} ({rate:.0f}%)")
+    print(f"Report: {report_html}")
+    print(f"Report URL: {_file_uri(report_html)}")
+    return 0 if result.failed == 0 else 1
+
+
+def _cmd_init(args: argparse.Namespace) -> int:
+    source = suites_template_source()
+    target = resolve_data_root(user_data=args.user_data, data_dir=args.data_dir)
+    initialized = init_user_data(source_data_root=source, target_data_root=target, force=args.force)
+    print(f"Initialized data root: {initialized}")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(prog="apitest")
+    parser.add_argument("--user-data", action="store_true", help="Use ~/.apitest as data root")
+    parser.add_argument("--data-dir", help="Custom data root directory")
+    sub = parser.add_subparsers(dest="command")
+
+    run_parser = sub.add_parser("run", help="Run suite groups non-interactively")
+    run_parser.add_argument("--suite", required=True)
+    run_parser.add_argument("--group")
+    run_parser.add_argument("--all", action="store_true")
+    run_parser.add_argument("--env")
+    run_parser.set_defaults(func=_cmd_run)
+
+    sub.add_parser("menu", help="Interactive menu")
+    init_parser = sub.add_parser("init", help="Initialize data root with suites template")
+    init_parser.add_argument("--force", action="store_true")
+    init_parser.set_defaults(func=_cmd_init)
+
+    args = parser.parse_args(argv)
+    root = resolve_data_root(user_data=args.user_data, data_dir=args.data_dir)
+    set_runtime_data_root(root)
+    # Keep compatibility with current repos; user-space .env should override script/.env.
+    load_dotenv(script_root() / ".env")
+    load_dotenv(root / ".env", override=True)
+
+    if args.command == "run":
+        try:
+            return _cmd_run(args)
+        except ConfigError as exc:
+            print(exc, file=sys.stderr)
+            return 1
+    if args.command == "init":
+        try:
+            return _cmd_init(args)
+        except ConfigError as exc:
+            print(exc, file=sys.stderr)
+            return 1
+
+    if args.command == "menu" or (args.command is None and sys.stdin.isatty()):
+        return run_menu()
+
+    if args.command is None:
+        parser.print_help()
+        return 0
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

core/assert_engine.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from typing import Any
+
+
+def _json_subset(expected: Any, actual: Any) -> bool:
+    if isinstance(expected, dict):
+        if not isinstance(actual, dict):
+            return False
+        return all(k in actual and _json_subset(expected[k], actual[k]) for k in expected)
+    return expected == actual
+
+
+def check_success(
+    http_status: int,
+    body: Any,
+    rules: dict[str, Any],
+) -> tuple[bool, list[str]]:
+    reasons: list[str] = []
+    expected_status = rules.get("httpStatus")
+    if expected_status is not None and http_status not in expected_status:
+        reasons.append(f"httpStatus expected {expected_status}, got {http_status}")
+
+    json_rule = rules.get("json")
+    if json_rule is not None:
+        if isinstance(body, dict):
+            if not _json_subset(json_rule, body):
+                reasons.append(f"json subset mismatch: expected {json_rule}, got {body}")
+        elif body is not None and not isinstance(body, dict):
+            pass
+        else:
+            reasons.append("json rule configured but response body is not a JSON object")
+
+    return (len(reasons) == 0, reasons)

core/bundled/__init__.py

@@ -0,0 +1 @@
+"""Bundled suite templates (populated at wheel build time)."""

core/bundled/suites/demo-ui/cases/flows/post_then_get.json

@@ -0,0 +1,23 @@
+{
+  "id": "post-then-get",
+  "type": "flow",
+  "name": "POST 写入变量再 GET",
+  "steps": [
+    {
+      "name": "post-seed",
+      "method": "POST",
+      "path": "/post",
+      "bodyFile": "payloads/post_seed.json",
+      "extract": { "echoToken": "$.json.echoToken" }
+    },
+    {
+      "name": "get-echo",
+      "method": "GET",
+      "path": "/get",
+      "query": {
+        "echoToken": "{{echoToken}}",
+        "tag": "{{demoTag}}"
+      }
+    }
+  ]
+}

core/bundled/suites/demo-ui/cases/get-basic.json

@@ -0,0 +1,6 @@
+{
+  "id": "get-basic",
+  "name": "GET 连通性",
+  "method": "GET",
+  "path": "/get"
+}

core/bundled/suites/demo-ui/cases/get-delay.json

@@ -0,0 +1,6 @@
+{
+  "id": "get-delay",
+  "name": "GET 延迟 2s（看进度）",
+  "method": "GET",
+  "path": "/delay/2"
+}

core/bundled/suites/demo-ui/cases/get-query.json

@@ -0,0 +1,7 @@
+{
+  "id": "get-query",
+  "name": "GET 带 Query",
+  "method": "GET",
+  "path": "/get",
+  "queryFile": "payloads/get_query.json"
+}

core/bundled/suites/demo-ui/cases/post-form.json

@@ -0,0 +1,8 @@
+{
+  "id": "post-form",
+  "name": "POST 表单",
+  "method": "POST",
+  "path": "/post",
+  "bodyType": "form-urlencoded",
+  "formFile": "forms/post_form.json"
+}

core/bundled/suites/demo-ui/cases/post-json.json

@@ -0,0 +1,7 @@
+{
+  "id": "post-json",
+  "name": "POST JSON",
+  "method": "POST",
+  "path": "/post",
+  "bodyFile": "payloads/post_json.json"
+}

core/bundled/suites/demo-ui/forms/post_form.json

@@ -0,0 +1,6 @@
+{
+  "fields": {
+    "field1": "hello",
+    "tag": "{{demoTag}}"
+  }
+}

core/bundled/suites/demo-ui/groups/flows/group.json

@@ -0,0 +1,9 @@
+{
+  "name": "flows",
+  "tags": ["flow", "demo"],
+  "env": "httpbin",
+  "inheritSuccess": true,
+  "cases": [
+    { "id": "post-then-get", "file": "cases/flows/post_then_get.json" }
+  ]
+}

core/bundled/suites/demo-ui/groups/readonly/group.json

@@ -0,0 +1,11 @@
+{
+  "name": "readonly",
+  "tags": ["read-only", "demo"],
+  "env": "httpbin",
+  "inheritSuccess": true,
+  "cases": [
+    { "id": "get-basic", "file": "cases/get-basic.json" },
+    { "id": "get-query", "file": "cases/get-query.json" },
+    { "id": "get-delay", "file": "cases/get-delay.json" }
+  ]
+}

core/bundled/suites/demo-ui/groups/write/group.json

@@ -0,0 +1,10 @@
+{
+  "name": "write",
+  "tags": ["write", "demo"],
+  "env": "httpbin",
+  "inheritSuccess": true,
+  "cases": [
+    { "id": "post-json", "file": "cases/post-json.json" },
+    { "id": "post-form", "file": "cases/post-form.json" }
+  ]
+}

core/bundled/suites/demo-ui/payloads/get_query.json

@@ -0,0 +1,4 @@
+{
+  "foo": "bar",
+  "tag": "{{demoTag}}"
+}

core/bundled/suites/demo-ui/payloads/post_json.json

@@ -0,0 +1,4 @@
+{
+  "name": "apitest-demo",
+  "tag": "{{demoTag}}"
+}

core/bundled/suites/demo-ui/payloads/post_seed.json

@@ -0,0 +1,3 @@
+{
+  "echoToken": "token-{{demoTag}}-001"
+}

core/bundled/suites/demo-ui/suite.json

@@ -0,0 +1,48 @@
+{
+  "name": "demo-ui",
+  "version": "1",
+  "defaultEnv": "httpbin",
+  "plugins": {
+    "paths": ["plugins"]
+  },
+  "auth": { "plugin": "none" },
+  "environments": {
+    "httpbin": {
+      "baseUrl": "https://httpbin.org",
+      "variables": {
+        "demoTag": "apitest-tui"
+      }
+    },
+    "httpbin-delay": {
+      "baseUrl": "https://httpbin.org",
+      "variables": {
+        "demoTag": "apitest-slow"
+      }
+    },
+    "playground": {
+      "baseUrl": "https://httpbin.org",
+      "variables": {
+        "demoTag": "playground",
+        "note": "按 e 切到此环境后跑 get-query，可在响应 args 里看到 tag"
+      }
+    },
+    "sandbox": {
+      "baseUrl": "https://httpbin.org",
+      "variables": {
+        "demoTag": "sandbox",
+        "channel": "tui-round-robin"
+      }
+    }
+  },
+  "success": {
+    "httpStatus": [200]
+  },
+  "hooks": {
+    "module": "hooks.py",
+    "enabled": false
+  },
+  "http": {
+    "timeout": 15,
+    "retries": 1
+  }
+}

core/bundled/suites/xsiam-credential/cases/agent-list.json

@@ -0,0 +1,7 @@
+{
+  "id": "agent-list",
+  "name": "智能体凭据列表",
+  "method": "GET",
+  "path": "/open/api/v2/credential/agent/list",
+  "queryFile": "payloads/agent_list.json"
+}

core/bundled/suites/xsiam-credential/cases/associate-by-mcp-name.json

@@ -0,0 +1,7 @@
+{
+  "id": "associate-by-mcp-name",
+  "name": "按 MCP 名称关联",
+  "method": "POST",
+  "path": "/open/api/v2/credential/agent/associate-by-mcp-name",
+  "bodyFile": "payloads/associate_by_mcp_name.json"
+}

core/bundled/suites/xsiam-credential/cases/associate.json

@@ -0,0 +1,7 @@
+{
+  "id": "associate",
+  "name": "租户级关联凭据",
+  "method": "POST",
+  "path": "/open/api/v2/credential/agent/associate",
+  "bodyFile": "payloads/associate.json"
+}

core/bundled/suites/xsiam-credential/cases/detail.json

@@ -0,0 +1,7 @@
+{
+  "id": "detail",
+  "name": "凭据详情",
+  "method": "GET",
+  "path": "/open/api/v2/credential/detail",
+  "queryFile": "payloads/detail.json"
+}

core/bundled/suites/xsiam-credential/cases/disassociate.json

@@ -0,0 +1,7 @@
+{
+  "id": "disassociate",
+  "name": "租户级解绑凭据",
+  "method": "POST",
+  "path": "/open/api/v2/credential/agent/disassociate",
+  "bodyFile": "payloads/disassociate.json"
+}

core/bundled/suites/xsiam-credential/cases/flows/create_then_delete.json

@@ -0,0 +1,20 @@
+{
+  "id": "create-then-delete",
+  "type": "flow",
+  "name": "创建后删除凭据",
+  "steps": [
+    {
+      "name": "create",
+      "method": "POST",
+      "path": "/open/api/v2/credential/create",
+      "bodyFile": "payloads/create.json",
+      "extract": { "credentialId": "$.data.id" }
+    },
+    {
+      "name": "delete",
+      "method": "POST",
+      "path": "/open/api/v2/credential/delete",
+      "body": { "ids": ["{{credentialId}}"] }
+    }
+  ]
+}

core/bundled/suites/xsiam-credential/cases/page.json

@@ -0,0 +1,7 @@
+{
+  "id": "page",
+  "name": "凭据分页",
+  "method": "POST",
+  "path": "/open/api/v2/credential/page",
+  "bodyFile": "payloads/page.json"
+}

core/bundled/suites/xsiam-credential/cases/restore.json

@@ -0,0 +1,7 @@
+{
+  "id": "restore",
+  "name": "恢复凭据",
+  "method": "POST",
+  "path": "/open/api/v2/credential/agent/restore",
+  "bodyFile": "payloads/restore.json"
+}

core/bundled/suites/xsiam-credential/groups/readonly/group.json

@@ -0,0 +1,11 @@
+{
+  "name": "readonly",
+  "tags": ["read-only"],
+  "env": "dev",
+  "inheritSuccess": true,
+  "cases": [
+    { "id": "page", "file": "cases/page.json" },
+    { "id": "detail", "file": "cases/detail.json" },
+    { "id": "agent-list", "file": "cases/agent-list.json" }
+  ]
+}

core/bundled/suites/xsiam-credential/groups/write/group.json

@@ -0,0 +1,12 @@
+{
+  "name": "write",
+  "env": "dev",
+  "inheritSuccess": true,
+  "cases": [
+    { "id": "create-then-delete", "file": "cases/flows/create_then_delete.json" },
+    { "id": "associate", "file": "cases/associate.json" },
+    { "id": "disassociate", "file": "cases/disassociate.json" },
+    { "id": "restore", "file": "cases/restore.json" },
+    { "id": "associate-by-mcp-name", "file": "cases/associate-by-mcp-name.json" }
+  ]
+}

core/bundled/suites/xsiam-credential/payloads/agent_list.json

@@ -0,0 +1,3 @@
+{
+  "agentId": "51f39d22-11bc-4e76-80a6-ee62aa862ec1"
+}

core/bundled/suites/xsiam-credential/payloads/associate.json

@@ -0,0 +1,5 @@
+{
+  "agentId": "1987654321000000002",
+  "originalCredentialId": "1987654321000000003",
+  "myCredentialId": "1987654321000000001"
+}

core/bundled/suites/xsiam-credential/payloads/associate_by_mcp_name.json

@@ -0,0 +1,4 @@
+{
+  "mcpServerName": "MCP共享插件",
+  "myCredentialId": "2059930349805682689"
+}

core/bundled/suites/xsiam-credential/payloads/create.json

@@ -0,0 +1,12 @@
+{
+  "name": "xsiam-mcp-oauth2",
+  "description": "XSIAM 对接 MCP OAuth2（测试示例）",
+  "credentialType": "oauth",
+  "credentialSubType": "authorization_code_mcp",
+  "authorizationCodeMcpConfig": {
+    "issuerUrl": "https://10.20.152.211/mcp",
+    "redirectUrl": "http://10.20.152.90:9092/credential/oauth/callback",
+    "clientId": "already-registered-client-id",
+    "scopes": ["openid", "profile"]
+  }
+}

core/bundled/suites/xsiam-credential/payloads/delete.json

@@ -0,0 +1,3 @@
+{
+  "ids": ["1987654321000000001", "1987654321000000002"]
+}

core/bundled/suites/xsiam-credential/payloads/detail.json

@@ -0,0 +1,3 @@
+{
+  "id": "2059930349805682689"
+}

core/bundled/suites/xsiam-credential/payloads/disassociate.json

@@ -0,0 +1,4 @@
+{
+  "agentId": "1987654321000000002",
+  "originalCredentialId": "1987654321000000001"
+}

core/bundled/suites/xsiam-credential/payloads/page.json

@@ -0,0 +1,5 @@
+{
+  "page": 1,
+  "size": 10,
+  "name": "xsiam"
+}

core/bundled/suites/xsiam-credential/payloads/restore.json

@@ -0,0 +1,4 @@
+{
+  "agentId": "1987654321000000002",
+  "myCredentialId": "1987654321000000001"
+}

core/bundled/suites/xsiam-credential/payloads/token_bind.json

@@ -0,0 +1,6 @@
+{
+  "credentialId": "2059930349805682689",
+  "accessToken": "REPLACE_ME",
+  "expiresIn": 3600,
+  "tokenType": "Bearer"
+}

core/bundled/suites/xsiam-credential/payloads/update.json

@@ -0,0 +1,13 @@
+{
+  "id": "2059930349805682689",
+  "name": "xsiam-mcp-oauth-updated",
+  "description": "更新 MCP OAuth2 配置（测试示例）",
+  "credentialType": "oauth",
+  "credentialSubType": "authorization_code_mcp",
+  "authorizationCodeMcpConfig": {
+    "issuerUrl": "https://10.20.152.211/mcp",
+    "redirectUrl": "http://10.20.152.90:9092/credential/oauth/callback",
+    "clientId": "already-registered-client-id",
+    "scopes": ["openid", "profile"]
+  }
+}

core/bundled/suites/xsiam-credential/suite.json

@@ -0,0 +1,30 @@
+{
+  "name": "xsiam-credential",
+  "version": "1",
+  "defaultEnv": "dev",
+  "plugins": {
+    "paths": ["plugins"]
+  },
+  "auth": { "plugin": "hengnao_openapi", "options": {} },
+  "environments": {
+    "dev": {
+      "baseUrl": "http://10.20.152.90:9092",
+      "variables": {
+        "appKey": "${HENGNAO_APPKEY}",
+        "appSecret": "${HENGNAO_APPSECRET}"
+      }
+    }
+  },
+  "success": {
+    "httpStatus": [200],
+    "json": { "code": 0 }
+  },
+  "hooks": {
+    "module": "hooks.py",
+    "enabled": false
+  },
+  "http": {
+    "timeout": 10,
+    "retries": 3
+  }
+}

core/context.py

@@ -0,0 +1,67 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any
+
+
+@dataclass
+class HttpRequest:
+    method: str
+    url: str
+    path: str
+    headers: dict[str, str] = field(default_factory=dict)
+    body_type: str = "none"
+    body: dict[str, Any] | None = None
+    form: dict[str, Any] | None = None
+    query: dict[str, str] | None = None
+
+
+@dataclass
+class HttpResponse:
+    status_code: int
+    headers: dict[str, str]
+    json_body: dict[str, Any] | list[Any] | str | None
+    text: str
+    elapsed_ms: float
+
+
+class RunContext:
+    def __init__(
+        self,
+        *,
+        suite: str,
+        group: str,
+        case_id: str,
+        case_type: str,
+        env: str,
+        base_url: str,
+        session_env: str,
+        env_variables: dict[str, Any],
+    ) -> None:
+        self.suite = suite
+        self.group = group
+        self.case_id = case_id
+        self.case_type = case_type
+        self.env = env
+        self.base_url = base_url
+        self.session_env = session_env
+        self._env_variables = dict(env_variables)
+        self._case_variables: dict[str, Any] = {}
+        self.step_name: str | None = None
+
+    def reset_case_variables(self) -> None:
+        self._case_variables = {}
+
+    def set_case(self, key: str, value: Any) -> None:
+        self._case_variables[key] = value
+
+    def set_env(self, key: str, value: Any) -> None:
+        raise ValueError("env_variables are read-only for hooks")
+
+    def resolve(self, key: str) -> Any:
+        if key in self._case_variables:
+            return self._case_variables[key]
+        return self._env_variables.get(key)
+
+    def resolver(self):
+        return self.resolve

core/errors.py

@@ -0,0 +1,6 @@
+class ConfigError(Exception):
+    """Invalid suite/group/case configuration."""
+
+
+class HookError(Exception):
+    """Suite hook raised an error."""

core/extract.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from typing import Any
+
+
+def extract_path(path: str, body: dict[str, Any]) -> Any:
+    normalized = path[2:] if path.startswith("$.") else path
+    if not normalized:
+        raise KeyError("empty extract path")
+    current: Any = body
+    for segment in normalized.split("."):
+        if not isinstance(current, dict) or segment not in current:
+            raise KeyError(f"missing path segment: {segment}")
+        current = current[segment]
+    return current