api-forge-cli 1.0.0__py3-none-any.whl

api_forge/parser.py

@@ -0,0 +1,291 @@
+"""YAML test suite parser."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import yaml
+
+from .models import (
+    Assertion,
+    AssertionType,
+    HttpMethod,
+    LoadTestConfig,
+    MockEndpoint,
+    MockServerConfig,
+    RequestConfig,
+    TestSuite,
+)
+
+
+def parse_test_suite(file_path: str | Path) -> TestSuite:
+    """Parse a YAML test suite file."""
+    path = Path(file_path)
+    if not path.exists():
+        raise FileNotFoundError(f"Test suite file not found: {path}")
+
+    with open(path, encoding="utf-8") as f:
+        data = yaml.safe_load(f)
+
+    if not isinstance(data, dict):
+        raise ValueError("Invalid test suite format: expected YAML object")
+
+    suite = TestSuite(
+        name=data.get("name", path.stem),
+        base_url=data.get("base_url", ""),
+        variables=data.get("variables", {}),
+        headers=data.get("headers", {}),
+    )
+
+    for req_data in data.get("requests", []):
+        suite.requests.append(_parse_request(req_data))
+
+    return suite
+
+
+def _parse_request(data: dict) -> RequestConfig:
+    """Parse a single request configuration."""
+    method_str = data.get("method", "GET").upper()
+    try:
+        method = HttpMethod(method_str)
+    except ValueError:
+        method = HttpMethod.GET
+
+    config = RequestConfig(
+        name=data.get("name", "Unnamed Request"),
+        url=data.get("url", ""),
+        method=method,
+        headers=data.get("headers", {}),
+        body=data.get("body"),
+        timeout=data.get("timeout", 30.0),
+        variables=data.get("variables", {}),
+        depends_on=data.get("depends_on"),
+    )
+
+    # Parse assertions
+    for assertion_data in data.get("assertions", []):
+        config.assertions.append(_parse_assertion(assertion_data))
+
+    return config
+
+
+def _parse_assertion(data: dict) -> Assertion:
+    """Parse a single assertion."""
+    type_str = data.get("type", "status").lower()
+    try:
+        assertion_type = AssertionType(type_str)
+    except ValueError:
+        assertion_type = AssertionType.STATUS
+
+    return Assertion(
+        type=assertion_type,
+        expected=data.get("expected", data.get("value")),
+        path=data.get("path", data.get("header")),
+    )
+
+
+def parse_load_test_config(file_path: str | Path) -> LoadTestConfig:
+    """Parse a YAML load test configuration file."""
+    path = Path(file_path)
+    if not path.exists():
+        raise FileNotFoundError(f"Load test config file not found: {path}")
+
+    with open(path, encoding="utf-8") as f:
+        data = yaml.safe_load(f)
+
+    method_str = data.get("method", "GET").upper()
+    try:
+        method = HttpMethod(method_str)
+    except ValueError:
+        method = HttpMethod.GET
+
+    return LoadTestConfig(
+        url=data.get("url", ""),
+        method=method,
+        headers=data.get("headers", {}),
+        body=data.get("body"),
+        concurrency=data.get("concurrency", 10),
+        requests_per_second=data.get("requests_per_second", 0),
+        duration_seconds=data.get("duration_seconds", 10),
+        timeout=data.get("timeout", 30.0),
+    )
+
+
+def parse_mock_config(file_path: str | Path) -> MockServerConfig:
+    """Parse a YAML mock server configuration file."""
+    path = Path(file_path)
+    if not path.exists():
+        raise FileNotFoundError(f"Mock config file not found: {path}")
+
+    with open(path, encoding="utf-8") as f:
+        data = yaml.safe_load(f)
+
+    config = MockServerConfig(
+        name=data.get("name", "api-forge-mock"),
+        host=data.get("host", "127.0.0.1"),
+        port=data.get("port", 8000),
+        default_status=data.get("default_status", 404),
+        default_body=data.get("default_body", '{"error": "Not Found"}'),
+        cors=data.get("cors", True),
+    )
+
+    for ep_data in data.get("endpoints", []):
+        config.endpoints.append(_parse_mock_endpoint(ep_data))
+
+    return config
+
+
+def _parse_mock_endpoint(data: dict) -> MockEndpoint:
+    """Parse a single mock endpoint."""
+    method_str = data.get("method", "GET").upper()
+    try:
+        method = HttpMethod(method_str)
+    except ValueError:
+        method = HttpMethod.GET
+
+    body = data.get("body", "")
+    if isinstance(body, dict):
+        import json
+
+        body = json.dumps(body)
+
+    return MockEndpoint(
+        path=data.get("path", "/"),
+        method=method,
+        status_code=data.get("status", 200),
+        headers=data.get("headers", {}),
+        body=body,
+        delay_ms=data.get("delay_ms", 0),
+        match_headers=data.get("match_headers", {}),
+        match_body=data.get("match_body"),
+    )
+
+
+def generate_example_suite() -> str:
+    """Generate an example test suite YAML."""
+    return """# API Test Suite Example
+name: "User API Tests"
+base_url: "https://jsonplaceholder.typicode.com"
+
+# Global headers applied to all requests
+headers:
+  Content-Type: "application/json"
+  Accept: "application/json"
+
+# Global variables
+variables:
+  api_version: "v1"
+
+requests:
+  - name: "Get all users"
+    url: "/users"
+    method: GET
+    assertions:
+      - type: status
+        expected: 200
+      - type: response_time
+        expected: 2000
+      - type: body_contains
+        expected: '"email"'
+
+  - name: "Get single user"
+    url: "/users/1"
+    method: GET
+    assertions:
+      - type: status
+        expected: 200
+      - type: json_path
+        path: "id"
+        expected: 1
+    variables:
+      user_name: "name"  # Extract name for next request
+
+  - name: "Create post"
+    url: "/posts"
+    method: POST
+    headers:
+      X-Custom-Header: "test"
+    body:
+      title: "Test Post"
+      body: "This is a test"
+      userId: 1
+    assertions:
+      - type: status
+        expected: 201
+      - type: json_path
+        path: "id"
+        expected: 101
+"""
+
+
+def generate_example_load_test() -> str:
+    """Generate an example load test YAML."""
+    return """# Load Test Configuration
+url: "https://jsonplaceholder.typicode.com/posts/1"
+method: GET
+
+# Concurrency settings
+concurrency: 50
+requests_per_second: 100  # 0 = unlimited
+duration_seconds: 30
+
+# Request configuration
+timeout: 10.0
+headers:
+  Accept: "application/json"
+"""
+
+
+def generate_example_mock_config() -> str:
+    """Generate an example mock server YAML."""
+    return """# Mock Server Configuration
+name: "Test API Mock"
+host: "127.0.0.1"
+port: 8000
+cors: true
+
+# Default response for unmatched routes
+default_status: 404
+default_body: '{"error": "Not Found"}'
+
+endpoints:
+  - path: "/health"
+    method: GET
+    status: 200
+    body:
+      status: "healthy"
+      version: "1.0.0"
+
+  - path: "/users"
+    method: GET
+    status: 200
+    headers:
+      X-Total-Count: "100"
+    body:
+      - id: 1
+        name: "Alice"
+        email: "alice@example.com"
+      - id: 2
+        name: "Bob"
+        email: "bob@example.com"
+
+  - path: "/users"
+    method: POST
+    status: 201
+    body:
+      id: 3
+      message: "User created"
+
+  - path: "/slow"
+    method: GET
+    status: 200
+    delay_ms: 2000  # Simulate slow response
+    body:
+      message: "This took a while"
+
+  - path: "/error"
+    method: GET
+    status: 500
+    body:
+      error: "Internal Server Error"
+"""

api_forge_cli-1.0.0.dist-info/METADATA

@@ -0,0 +1,393 @@
+Metadata-Version: 2.4
+Name: api-forge-cli
+Version: 1.0.0
+Summary: CLI tool for API testing, load testing, and mock server generation
+Project-URL: Homepage, https://github.com/SanjaySundarMurthy/api-forge
+Project-URL: Repository, https://github.com/SanjaySundarMurthy/api-forge
+Project-URL: Issues, https://github.com/SanjaySundarMurthy/api-forge/issues
+Author-email: Sanjay Sundar Murthy <sanjaysundarmurthy@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,cli,http,load-testing,mock,rest,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Requires-Dist: click>=8.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# api-forge
+
+**CLI tool for API testing, load testing, and mock server generation.**
+
+[![PyPI version](https://badge.fury.io/py/api-forge-cli.svg)](https://pypi.org/project/api-forge-cli/)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+---
+
+## Why api-forge?
+
+Testing APIs shouldn't require heavy frameworks or complex setup. **api-forge** is a lightweight CLI tool that provides:
+
+- **Test Suites** — Define API tests in simple YAML files
+- **Assertions** — Validate status codes, headers, JSON paths, response times
+- **Variable Chaining** — Extract values from responses for use in subsequent requests
+- **Load Testing** — Stress test endpoints with configurable concurrency
+- **Mock Server** — Spin up mock APIs from YAML for development/testing
+- **Quick Requests** — cURL-like commands with pretty output
+
+---
+
+## Installation
+
+```bash
+pip install api-forge-cli
+```
+
+---
+
+## Quick Start
+
+```bash
+# Make a quick GET request
+api-forge get https://jsonplaceholder.typicode.com/posts/1
+
+# Run a test suite
+api-forge test suite.yaml
+
+# Load test an endpoint
+api-forge load https://api.example.com/health -n 50 -d 10
+
+# Start a mock server
+api-forge mock mock.yaml
+
+# Generate example configs
+api-forge init --type test -o suite.yaml
+```
+
+---
+
+## Commands
+
+### `get` / `post` / `put` / `delete` — Quick Requests
+
+```bash
+# GET request
+api-forge get https://api.example.com/users
+
+# POST with JSON body
+api-forge post https://api.example.com/users -d '{"name": "Alice"}'
+
+# With custom headers
+api-forge get https://api.example.com/users -H "Authorization:Bearer token"
+
+# PUT request
+api-forge put https://api.example.com/users/1 -d '{"name": "Bob"}'
+
+# DELETE request
+api-forge delete https://api.example.com/users/1
+```
+
+### `test` — Run API Test Suites
+
+```bash
+api-forge test suite.yaml
+api-forge test tests/api-tests.yaml -v
+```
+
+Test suites are defined in YAML:
+
+```yaml
+name: "User API Tests"
+base_url: "https://api.example.com"
+
+headers:
+  Authorization: "Bearer {{token}}"
+
+variables:
+  token: "your-api-token"
+
+requests:
+  - name: "Get all users"
+    url: "/users"
+    method: GET
+    assertions:
+      - type: status
+        expected: 200
+      - type: response_time
+        expected: 2000
+
+  - name: "Create user"
+    url: "/users"
+    method: POST
+    body:
+      name: "Alice"
+      email: "alice@example.com"
+    assertions:
+      - type: status
+        expected: 201
+      - type: json_path
+        path: "id"
+        expected: 1
+    variables:
+      new_user_id: "id"  # Extract for next request
+
+  - name: "Get created user"
+    url: "/users/{{new_user_id}}"
+    method: GET
+    assertions:
+      - type: status
+        expected: 200
+```
+
+### `load` — Load Testing
+
+```bash
+# Quick load test
+api-forge load https://api.example.com/health -n 50 -d 30
+
+# From config file
+api-forge load -c loadtest.yaml
+```
+
+| Option | Description |
+|--------|-------------|
+| `-n, --concurrency` | Number of concurrent connections (default: 10) |
+| `-d, --duration` | Test duration in seconds (default: 10) |
+| `--rps` | Requests per second limit (0 = unlimited) |
+| `-c, --config` | Load test config YAML file |
+
+Load test config:
+
+```yaml
+url: "https://api.example.com/users"
+method: GET
+concurrency: 100
+duration_seconds: 60
+requests_per_second: 500
+timeout: 10.0
+headers:
+  Authorization: "Bearer token"
+```
+
+**Output includes:**
+- Total requests, success/failure counts
+- Requests per second achieved
+- Latency percentiles (min, avg, p50, p95, p99, max)
+- Status code distribution
+- Error samples
+
+### `mock` — Mock Server
+
+```bash
+# Start mock server from config
+api-forge mock mock.yaml
+
+# Custom port
+api-forge mock mock.yaml -p 3000
+
+# Default server (returns 404 for all)
+api-forge mock
+```
+
+Mock server config:
+
+```yaml
+name: "Test API"
+port: 8000
+cors: true
+
+endpoints:
+  - path: "/health"
+    method: GET
+    status: 200
+    body:
+      status: "healthy"
+
+  - path: "/users"
+    method: GET
+    status: 200
+    headers:
+      X-Total-Count: "100"
+    body:
+      - id: 1
+        name: "Alice"
+      - id: 2
+        name: "Bob"
+
+  - path: "/users"
+    method: POST
+    status: 201
+    body:
+      id: 3
+      message: "Created"
+
+  - path: "/slow"
+    method: GET
+    status: 200
+    delay_ms: 2000  # Simulate latency
+    body:
+      message: "Slow response"
+
+  - path: "/users/*"  # Wildcard matching
+    method: GET
+    status: 200
+    body:
+      id: 1
+      name: "User"
+```
+
+### `init` — Generate Examples
+
+```bash
+api-forge init --type test -o suite.yaml
+api-forge init --type load -o loadtest.yaml
+api-forge init --type mock -o mock.yaml
+```
+
+---
+
+## Assertion Types
+
+| Type | Description | Example |
+|------|-------------|---------|
+| `status` | HTTP status code | `expected: 200` or `expected: [200, 201]` |
+| `header` | Header value contains | `header: Content-Type`, `expected: json` |
+| `body_contains` | Body contains string | `expected: "success"` |
+| `json_path` | JSON path equals value | `path: user.id`, `expected: 123` |
+| `body_regex` | Body matches regex | `expected: "\\d{5}"` |
+| `response_time` | Max response time (ms) | `expected: 500` |
+
+---
+
+## Variable Substitution
+
+Use `{{variable_name}}` syntax in URLs, headers, and body:
+
+```yaml
+variables:
+  api_key: "secret123"
+  user_id: "456"
+
+requests:
+  - name: "Get user"
+    url: "/users/{{user_id}}"
+    headers:
+      X-API-Key: "{{api_key}}"
+```
+
+**Extract variables from responses** for request chaining:
+
+```yaml
+requests:
+  - name: "Login"
+    url: "/auth/login"
+    method: POST
+    body:
+      username: "admin"
+      password: "secret"
+    variables:
+      auth_token: "token"  # Extract $.token from response
+
+  - name: "Protected endpoint"
+    url: "/protected"
+    headers:
+      Authorization: "Bearer {{auth_token}}"
+```
+
+---
+
+## Examples
+
+### Full Test Suite with Chaining
+
+```yaml
+name: "E-commerce API"
+base_url: "https://api.shop.example.com"
+
+requests:
+  - name: "Create product"
+    url: "/products"
+    method: POST
+    body:
+      name: "Widget"
+      price: 29.99
+    assertions:
+      - type: status
+        expected: 201
+    variables:
+      product_id: "id"
+
+  - name: "Get product"
+    url: "/products/{{product_id}}"
+    assertions:
+      - type: json_path
+        path: "name"
+        expected: "Widget"
+
+  - name: "Delete product"
+    url: "/products/{{product_id}}"
+    method: DELETE
+    assertions:
+      - type: status
+        expected: 204
+```
+
+### Load Test with Detailed Config
+
+```yaml
+url: "https://api.example.com/search"
+method: POST
+concurrency: 200
+duration_seconds: 120
+requests_per_second: 1000
+timeout: 5.0
+headers:
+  Content-Type: "application/json"
+body:
+  query: "test"
+  limit: 10
+```
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/SanjaySundarMurthy/api-forge.git
+cd api-forge
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+---
+
+## Author
+
+**Sanjay Sundar Murthy**
+- GitHub: [@SanjaySundarMurthy](https://github.com/SanjaySundarMurthy)
+- Email: sanjaysundarmurthy@gmail.com
+
+---
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.

api_forge_cli-1.0.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+api_forge/__init__.py,sha256=Pfo_n30AQ_JA8qP7gNez3yV3N7wqb7ephFe7mFVXMUI,77
+api_forge/__main__.py,sha256=lG27aFqY6oNO-ZaZ5J-Ts3w4ZF3zaYhCngJ8Aa7MqEQ,119
+api_forge/cli.py,sha256=Bipbg-K49klNJR_Q8XbEtKZeqSdrW67023HWywEBhdo,8591
+api_forge/client.py,sha256=9Kxe5xVvRmKoNBrh9TFownQYL8Vl_YiU3eZREOivzIk,6214
+api_forge/mock_server.py,sha256=D_ImoHO0MKAfl3zQ3peev12NZnLTGsKtpIhen_9LmqQ,6274
+api_forge/models.py,sha256=1m0vcF0abwkVvUdvZT3H0WZtz8AGopyXYAwsN1ILYJg,9384
+api_forge/output.py,sha256=ey5VbXFO1IFJNb2xx5ge1rkZdSJcnohz67J7XXuVHoQ,7339
+api_forge/parser.py,sha256=Bi9afyX-RC1ythWxTHC9jNsYTMmdj5fqjGvbz8KoVLM,7399
+api_forge_cli-1.0.0.dist-info/METADATA,sha256=ZVKl60movPZUli6zLNJUKJqbMvO32aWzzNarAyjvpJU,8607
+api_forge_cli-1.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+api_forge_cli-1.0.0.dist-info/entry_points.txt,sha256=PsVFVdY6IzEsywDE2K0BvN5G8r7YGlq_Aq4ZGwVihhc,48
+api_forge_cli-1.0.0.dist-info/licenses/LICENSE,sha256=kuYe0v68w5WHNJfYvCLtnsYEEr6NzB-jhnE_qRkxu1g,1098
+api_forge_cli-1.0.0.dist-info/RECORD,,

api_forge_cli-1.0.0.dist-info/WHEEL

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

api_forge_cli-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+api-forge = api_forge.cli:cli