iflow-mcp_galaxyxieyu_api-auto-test 0.1.0__py3-none-any.whl

atf/utils/helpers.py

@@ -0,0 +1,155 @@
+"""
+测试数据工厂 - 提供常用的数据生成函数
+用法: {{ tools.timestamp() }}, {{ tools.uuid() }}, {{ tools.random_int(1, 100) }}
+"""
+
+import random
+import string
+import time
+import uuid as _uuid
+from datetime import datetime, timedelta
+
+
+# ==================== 时间相关 ====================
+
+def timestamp():
+    """当前时间戳（秒）"""
+    return int(time.time())
+
+
+def timestamp_ms():
+    """当前时间戳（毫秒）"""
+    return int(time.time() * 1000)
+
+
+def datetime_now(fmt: str = "%Y-%m-%d %H:%M:%S"):
+    """当前时间字符串"""
+    return datetime.now().strftime(fmt)
+
+
+def date_today(fmt: str = "%Y-%m-%d"):
+    """今天日期"""
+    return datetime.now().strftime(fmt)
+
+
+def date_offset(days: int = 0, fmt: str = "%Y-%m-%d"):
+    """偏移日期，days 可为负数"""
+    return (datetime.now() + timedelta(days=days)).strftime(fmt)
+
+
+# ==================== 随机数据 ====================
+
+def uuid():
+    """生成 UUID"""
+    return str(_uuid.uuid4())
+
+
+def uuid_short():
+    """生成短 UUID（8位）"""
+    return str(_uuid.uuid4())[:8]
+
+
+def random_int(min_val: int = 1, max_val: int = 10000):
+    """随机整数"""
+    return random.randint(min_val, max_val)
+
+
+def random_float(min_val: float = 0.0, max_val: float = 100.0, precision: int = 2):
+    """随机浮点数"""
+    return round(random.uniform(min_val, max_val), precision)
+
+
+def random_str(length: int = 8):
+    """随机字符串（字母+数字）"""
+    return ''.join(random.choices(string.ascii_letters + string.digits, k=length))
+
+
+def random_letters(length: int = 8):
+    """随机字母"""
+    return ''.join(random.choices(string.ascii_letters, k=length))
+
+
+def random_digits(length: int = 6):
+    """随机数字字符串"""
+    return ''.join(random.choices(string.digits, k=length))
+
+
+def random_choice(*items):
+    """从给定选项中随机选择"""
+    return random.choice(items) if items else None
+
+
+# ==================== 模拟数据 ====================
+
+def fake_email(prefix: str = "test"):
+    """生成测试邮箱"""
+    return f"{prefix}_{timestamp()}@test.com"
+
+
+def fake_phone():
+    """生成测试手机号（中国）"""
+    prefixes = ['138', '139', '150', '151', '152', '158', '159', '186', '187', '188']
+    return random.choice(prefixes) + random_digits(8)
+
+
+def fake_username(prefix: str = "user"):
+    """生成测试用户名"""
+    return f"{prefix}_{uuid_short()}"
+
+
+def fake_name():
+    """生成随机中文姓名"""
+    first_names = ['张', '李', '王', '刘', '陈', '杨', '赵', '黄', '周', '吴']
+    last_names = ['伟', '芳', '娜', '敏', '静', '强', '磊', '洋', '勇', '艳', '杰', '娟', '涛', '明', '超']
+    return random.choice(first_names) + ''.join(random.choices(last_names, k=random.randint(1, 2)))
+
+
+def fake_address():
+    """生成随机地址"""
+    cities = ['北京市', '上海市', '广州市', '深圳市', '杭州市', '成都市', '武汉市', '南京市']
+    districts = ['朝阳区', '海淀区', '浦东新区', '天河区', '南山区', '西湖区', '武侯区', '江宁区']
+    streets = ['科技路', '创新大道', '人民路', '中山路', '解放路', '建设路']
+    return f"{random.choice(cities)}{random.choice(districts)}{random.choice(streets)}{random_int(1, 999)}号"
+
+
+def fake_id_card():
+    """生成测试身份证号（非真实）"""
+    area = random_digits(6)
+    year = random.randint(1970, 2000)
+    month = str(random.randint(1, 12)).zfill(2)
+    day = str(random.randint(1, 28)).zfill(2)
+    seq = random_digits(3)
+    check = random.choice('0123456789X')
+    return f"{area}{year}{month}{day}{seq}{check}"
+
+
+def fake_company():
+    """生成测试公司名"""
+    prefixes = ['华', '中', '东', '西', '南', '北', '新', '金', '银', '瑞']
+    mids = ['科', '创', '智', '信', '达', '联', '通', '盛', '鑫', '源']
+    suffixes = ['科技有限公司', '网络有限公司', '信息技术有限公司', '电子商务有限公司']
+    return random.choice(prefixes) + random.choice(mids) + random.choice(suffixes)
+
+
+# ==================== 兼容旧函数 ====================
+
+def demo_get_id():
+    """兼容旧版本"""
+    return random_int(1, 1000)
+
+
+def demo_func(a=None, b=None, c=None):
+    """兼容旧版本"""
+    vals = [v for v in [a, b, c] if v is not None]
+    return sum(vals) if vals else 0
+
+
+# ==================== 使用示例 ====================
+if __name__ == '__main__':
+    print(f"timestamp: {timestamp()}")
+    print(f"uuid: {uuid()}")
+    print(f"random_int: {random_int(1, 100)}")
+    print(f"fake_email: {fake_email()}")
+    print(f"fake_phone: {fake_phone()}")
+    print(f"fake_name: {fake_name()}")
+    print(f"fake_address: {fake_address()}")

iflow_mcp_galaxyxieyu_api_auto_test-0.1.0.dist-info/METADATA

@@ -0,0 +1,409 @@
+Metadata-Version: 2.4
+Name: iflow-mcp_galaxyxieyu_api-auto-test
+Version: 0.1.0
+Summary: API Auto Test Framework with MCP Server
+Author-email: GalaxyXieyu <galaxyxieyu@github.com>
+License: MIT
+Keywords: api,automation,mcp,pytest,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: allure-pytest>=2.13
+Requires-Dist: dingtalkchatbot>=1.5.7
+Requires-Dist: loguru>=0.4.1
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: mysql-connector-python>=8.0.33
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pytest-html>=2.1.1
+Requires-Dist: pytest>=7.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.31
+Requires-Dist: urllib3<2
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img src="docs/images/mcp-architecture.png" alt="MCP Architecture" width="100%"/>
+</div>
+
+# API Auto Test Framework
+
+![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+![pytest](https://img.shields.io/badge/pytest-8.0%2B-yellow)
+
+**YAML Declarative API Testing Framework, Optimized for AI Coding Assistants**
+
+[Quick Start](#quick-start) | [MCP Integration](#mcp-server-integration) | [YAML Spec](#yaml-test-case-spec) | [Unit Testing](#unit-testing)
+
+---
+
+## Why This Framework?
+
+When asking AI to write API tests, you might encounter these issues:
+
+**Scenario 1: Repetitive Work**
+
+Every time you ask AI to generate tests, you need to re-describe the project structure, authentication method, and assertion style. For 10 API tests, the same fixture and setup code gets generated 10 times.
+
+**Scenario 2: Token Black Hole**
+
+A simple login API test generates 200 lines of code. You find an assertion is wrong, ask AI to fix it, and it generates another 200 lines. After 3 revisions, you've consumed 2000+ Tokens, and you still end up fixing it manually.
+
+**Scenario 3: Debugging Dead Loop**
+
+AI-generated tests fail to run. You paste the error message, AI fixes it but still wrong. After 5 rounds of conversation, the problem persists, and you've burned 5000+ Tokens.
+
+**This Framework's Solution:**
+
+```
+Traditional: Natural Language -> AI Generates Full Code -> Run Error -> Paste Error -> AI Regenerates -> Loop...
+This Framework: Natural Language -> AI Generates YAML -> Framework Executes -> Locate Issue -> Fix 1 Line YAML
+```
+
+| Metric | Traditional AI | This Framework |
+|--------|---------------|----------------|
+| Test 1 API | ~200 lines code | ~20 lines YAML |
+| Modify Assertion | Regenerate all code | Fix 1-2 lines YAML |
+| 10 API Tests | Repeat setup 10x | Shared config, 0 repeat |
+| Debug Issue | 3-5 rounds avg | Usually 1 round |
+
+---
+
+## Key Features
+
+| Feature | Description |
+|---------|-------------|
+| **YAML Declarative Tests** | Test logic separated from execution code, AI generates structured data only |
+| **MCP Server** | Seamless integration with Claude/Cursor and other AI editors |
+| **API Workflow Orchestration** | Multi-step API calls in single file, with data passing and assertions between steps |
+| **Variable Resolution Engine** | Support for cross-step data transfer, global variables, and dynamic function calls |
+| **Auto Authentication** | Token acquisition and refresh handled by framework |
+| **Data Factory** | Built-in mock data generation, no Java dependencies |
+| **Multi-format Reports** | Allure (offline/online), pytest-html (standalone HTML, styled) |
+| **Multi-channel Notifications** | DingTalk, Feishu, WeCom |
+| **Unit Testing** | Python code unit testing with automatic mock dependency injection |
+
+---
+
+## Quick Start
+
+### Installation
+
+```bash
+# 1. Install uv (if not installed)
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# 2. Install MCP server (recommended: install as a tool)
+uv tool install git+https://github.com/GalaxyXieyu/Api-Test-MCP.git
+
+# Verify
+api-auto-test-mcp --help
+
+# Manage tools
+uv tool list
+uv tool uninstall api-auto-test   # use the tool name shown by `uv tool list`
+```
+
+**Run without installing (uvx):**
+
+```bash
+uvx --from git+https://github.com/GalaxyXieyu/Api-Test-MCP.git api-auto-test-mcp --help
+```
+
+**Common mistake:** `uvx install ...` is **wrong**. `uvx` treats the first word after it as the tool name, so it will try to resolve a package literally named `install` and fail.
+
+### Configure Editor
+
+Add the following to your editor's MCP settings:
+
+```json
+{
+  "mcpServers": {
+    "api-auto-test": {
+      "command": "api-auto-test-mcp"
+    }
+  }
+}
+```
+
+| Editor | Config Location |
+|--------|-----------------|
+| Claude Desktop | `~/Library/Application Support/Claude/claude_desktop_config.json` |
+| Cursor | Settings -> MCP Servers |
+| VSCode + Continue | `.vscode/mcp.json` |
+
+### Local Development
+
+```bash
+# Recommended with uv
+uv pip install -r requirements.txt
+
+# Or with pip
+pip install -r requirements.txt
+```
+
+### Create Test Case
+
+```yaml
+# tests/cases/user_login.yaml
+testcase:
+  name: user_login
+  description: User login API test
+  host: http://localhost:8000
+  steps:
+    - id: login
+      path: /api/auth/login
+      method: POST
+      data:
+        username: "test_user"
+        password: "123456"
+      assert:
+        - type: status_code
+          expected: 200
+        - type: equals
+          field: data.code
+          expected: 0
+```
+
+### Generate and Run
+
+```bash
+# Generate pytest scripts
+python -m atf.case_generator
+
+# Run tests
+pytest tests/scripts/ -v
+
+# Generate Allure report
+pytest tests/scripts/ --alluredir=tests/allure-results
+allure serve tests/allure-results
+
+# Generate pytest-html report
+pytest tests/scripts/ --html=report.html
+```
+
+---
+
+## MCP Server Integration
+
+Through MCP, AI editors can directly call framework tools to generate and execute tests.
+
+### Efficiency Comparison
+
+| Metric | Without MCP | With MCP | Improvement |
+|--------|-------------|----------|-------------|
+| Total Cost | $0.0214 | $0.0099 | **-54%** |
+| API Latency | 11 sec | 4 sec | **-64%** |
+| Output Tokens | 585 | 238 | **-59%** |
+| Cache Read | 42.0k | 21.0k | **-50%** |
+
+**Test Scenario**: Same API test generation task (pure consultation/analysis conversation)
+
+**Core Advantages**:
+- **54% cost reduction**: MCP directly calls tools, avoiding lengthy code generation context
+- **64% faster API response**: Tool calls are more efficient than natural language interaction
+- **59% less token consumption**: Only necessary parameters needed, no need to repeat project structure
+
+### Available Tools
+
+| Tool | Description |
+|------|-------------|
+| `list_testcases` | List test cases |
+| `get_testcase` | Read test case content |
+| `write_testcase` | Create/update test case and generate pytest script |
+| `write_unittest` | Create unit test |
+| `delete_testcase` | Delete test case |
+| `run_tests` | Execute tests |
+| `get_test_results` | Get test execution history |
+| `health_check` | Service health check |
+
+### Usage Example
+
+Tell AI:
+
+```
+Create a test for /api/users interface, verify returned user list length > 0
+```
+
+AI will call `write_testcase` to generate YAML and corresponding pytest script.
+
+---
+
+## Project Structure
+
+```
+api-auto-test/
+├── atf/                    # Framework core
+│   ├── core/               # Request, assertion, variable resolution modules
+│   ├── mcp/                # MCP Server implementation
+│   └── handlers/           # Notification, report handlers
+├── tests/
+│   ├── cases/              # YAML test cases
+│   └── scripts/            # Generated pytest scripts
+├── config.yaml             # Project config (environment, database, notifications)
+└── pyproject.toml
+```
+
+---
+
+## YAML Test Case Spec
+
+### Basic Structure
+
+```yaml
+testcase:
+  name: test_name              # Case name, used for filename
+  description: Description     # Optional
+  host: http://localhost:8000  # API host, can also be configured globally in config.yaml
+  steps:
+    - id: step1                # Step ID, used for later reference
+      path: /api/endpoint
+      method: POST
+      headers:
+        Authorization: "Bearer {{ login.data.token }}"  # Reference response from other step
+      data:
+        key: value
+      assert:
+        - type: status_code
+          expected: 200
+        - type: equals
+          field: data.id
+          expected: 1
+```
+
+### Assertion Types
+
+| Type | Description | Example |
+|------|-------------|---------|
+| `status_code` | HTTP status code | `expected: 200` |
+| `equals` | Exact match | `field: data.id, expected: 1` |
+| `contains` | Contains | `field: data.name, expected: "test"` |
+| `length` | Array/string length | `field: data.list, expected: 10` |
+| `regex` | Regex match | `field: data.email, expected: "^\\w+@"` |
+
+### Variable Reference
+
+```yaml
+# Reference response data from other steps
+token: "{{ login.data.token }}"
+
+# Reference global config
+host: "{{ merchant.host }}"
+
+# Call built-in functions
+timestamp: "{{ tools.get_timestamp() }}"
+uuid: "{{ tools.generate_uuid() }}"
+```
+
+### Teardown
+
+```yaml
+testcase:
+  name: create_and_delete_user
+  steps:
+    - id: create_user
+      path: /api/users
+      method: POST
+      data:
+        name: "test_user"
+  teardowns:
+    - id: delete_user
+      operation_type: api
+      path: /api/users/{{ create_user.data.id }}
+      method: DELETE
+```
+
+---
+
+## Unit Testing
+
+Support for writing unit tests for Python code, automatically generating test cases through MCP tools.
+
+### Unit Test YAML Format
+
+```yaml
+unittest:
+  name: UserService Test
+  target:
+    module: app.services.user_service
+    class: UserService
+    function: get_user
+  fixtures:
+    setup:
+      - type: patch
+        target: app.services.user_service.UserRepository
+        return_value:
+          id: 1
+          name: "test_user"
+  cases:
+    - id: test_get_user_success
+      description: Test get user success
+      inputs:
+        args: [1]
+        kwargs: {}
+      assert:
+        - type: equals
+          field: result.id
+          expected: 1
+        - type: equals
+          field: result.name
+          expected: "test_user"
+```
+
+### Assertion Types
+
+| Type | Description |
+|------|-------------|
+| `equals` | Exact match |
+| `not_equals` | Not equal |
+| `contains` | Contains |
+| `raises` | Expect exception to be raised |
+| `is_none` | Result is None |
+| `is_not_none` | Result is not None |
+| `called_once` | Mock called once |
+| `called_with` | Mock called with specific arguments |
+
+---
+
+## Configuration File
+
+```yaml
+# config.yaml
+projects:
+  merchant:
+    test:
+      host: http://192.168.1.100:8080
+      is_need_login: true
+      login:
+        url: http://192.168.1.100:8080/login
+        method: POST
+        data:
+          username: admin
+          password: "123456"
+    online:
+      host: https://api.example.com
+      is_need_login: true
+
+notifications:
+  dingtalk:
+    webhook: "https://oapi.dingtalk.com/robot/send?access_token=xxx"
+    secret: "SECxxx"
+```
+
+---
+
+## License
+
+MIT License
+
+---
+
+## Links
+
+- [GitHub](https://github.com/GalaxyXieyu/Api-Test-MCP)
+- [Issue Report](https://github.com/GalaxyXieyu/Api-Test-MCP/issues)

iflow_mcp_galaxyxieyu_api_auto_test-0.1.0.dist-info/RECORD

@@ -0,0 +1,37 @@
+atf/__init__.py,sha256=QetjM3D_EbtvBwNjUDYwmdrJUun2eBaO1m6St5CWT88,1191
+atf/auth.py,sha256=DCMPDAz1Vnoj7hxuWRRfZ0ug-kb4e9Ey4nnhDVw6LRk,3293
+atf/case_generator.py,sha256=nRTI6WNi3DSvtn7UFZ11utaNLsNJX0wIWSLdRwWNS8E,30026
+atf/conftest.py,sha256=XRUQSHB_UAdLEt3-yPQxm84TQqwZ0yLqxnFMOzi24UA,2219
+atf/mcp_server.py,sha256=GJHBIjpPX8p0xS9bqunjfNurLcWs-gcyS0nNTMbFIa8,4857
+atf/runner.py,sha256=OqFkBUVvfL9nR9LoepmNrq07XK2k3eRDYZJm1qYeZIY,5281
+atf/unit_case_generator.py,sha256=paIAgxv6kCvZJRSiWYlzOFhH8zsXIB7OnAAOOqMc9DY,12464
+atf/assets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+atf/assets/report.css,sha256=ALlK-Sjom1CntJAfBhnHUmET78-VvJ8HS4cdQed145g,4818
+atf/core/__init__.py,sha256=l1aHMcuadmCsEUuxCQLYEC1A8AZs3fEKJwixDabh120,1007
+atf/core/assert_handler.py,sha256=TyvlOONdEeAZsCLRFjUHrDIrLdOiwwQCiu4hEDbZMK4,14745
+atf/core/config_manager.py,sha256=haCEunh6fd_H5VbScH96vlea2HOT38ItNrWfNG29lr8,3952
+atf/core/globals.py,sha256=7rfXhfpUoK8K3x6i90WKePEgxFEigipzMl1PtCs95RQ,1350
+atf/core/log_manager.py,sha256=sJcVZL2NAVQE5BV4BOCkAMTpGlUa_K4KDq3g12XK25M,1584
+atf/core/login_handler.py,sha256=9Y7b7j_4xGyuswgzzgW58GHSnw-yR91fIOa2aiVYGPc,2363
+atf/core/request_handler.py,sha256=sGV7EXdPJslJEZBGxp4dzrbqTXC9hiz28DF670ccnh0,8035
+atf/core/variable_resolver.py,sha256=QNKIUNPAj6C5JGwSyVnba4YCN2Ur1r459wTxqrZOLkE,6617
+atf/handlers/__init__.py,sha256=ClFew48CqBCtXDt3bG8XLib8_zLVmL0WVrNFGrazCII,252
+atf/handlers/notification_handler.py,sha256=67xQbiPYr8wjq9KGrkgoxnnAnuOjBFrYRD6xybxFB0w,3189
+atf/handlers/report_generator.py,sha256=NA-y_378Gud5oEdtI00B1fiq8TpfpK1jh4oizdTqL2E,6431
+atf/handlers/teardown_handler.py,sha256=93kS2BrO_OilXbhOWgpUkSaZeLyiKrEFtwkl8jGbbsU,3328
+atf/mcp/__init__.py,sha256=fZsU_7U8cOD1nFGAGfDkQkbkqTGP6MIfyQu3V_avYWM,21
+atf/mcp/executor.py,sha256=LE1CowMJJ8tFaeKGJbOSYrKJBBv2E9otl7URDnwAFjI,16112
+atf/mcp/models.py,sha256=_MSSibvcwWwSEHfOsoZPhaCJgkgFfZcWT7TLPf8yS9A,16330
+atf/mcp/utils.py,sha256=OnmGjvk05PD5fzP_IgAIKinKCfAaKkfIOfF7WtjcEOQ,12327
+atf/mcp/tools/__init__.py,sha256=WOt8D_cjUg7poNypfi_C21hfdbitOmXM2VLuyTuLL5I,20
+atf/mcp/tools/health_tool.py,sha256=fvcEh6G0ZU_ERRY2PGZiBvHG0o3eAfGT1edwQXNEFlw,1685
+atf/mcp/tools/metrics_tools.py,sha256=QfmaTzCd1Db-BjrZB6m2zK2IWu21qqVSH1h9t7jXFLI,4451
+atf/mcp/tools/runner_tools.py,sha256=TTUnTrHwvEXe6PWtFqRzXOvdadD_d_jg0jNqhME3D7g,15016
+atf/mcp/tools/testcase_tools.py,sha256=w0XzQzD4IMlbJP7ruJ0Z008lJuB5vruzX1srx1KMrUg,25602
+atf/mcp/tools/unittest_tools.py,sha256=nL5G7gfrU7aCK1glJfcJWp8nu2ykhYmjWpGB3-Lb2h0,7764
+atf/utils/__init__.py,sha256=3WjDRQfBXan1IRUDDZGIy4zFocdvXBV8fPtU1pTuBME,66
+atf/utils/helpers.py,sha256=YyzZpGjI5wUNk7WxujHrTf_QX-8QVfemqOWyYXouF2o,4720
+iflow_mcp_galaxyxieyu_api_auto_test-0.1.0.dist-info/METADATA,sha256=TrL-E8am3fUe7Pm7VMKwL5KX_lfYj23DDO0xbn_C11k,11310
+iflow_mcp_galaxyxieyu_api_auto_test-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+iflow_mcp_galaxyxieyu_api_auto_test-0.1.0.dist-info/entry_points.txt,sha256=U0JuJR1z3QNxTQO1Un8YSQy1dQvqXkwLwxAd0K13peY,76
+iflow_mcp_galaxyxieyu_api_auto_test-0.1.0.dist-info/RECORD,,

iflow_mcp_galaxyxieyu_api_auto_test-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

iflow_mcp_galaxyxieyu_api_auto_test-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+iflow-mcp-galaxyxieyu-api-auto-test = atf.mcp_server:main