mockserver-client 7.0.0__tar.gz → 7.2.0__tar.gz

{mockserver_client-7.0.0 → mockserver_client-7.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockserver-client
-Version: 7.0.0
+Version: 7.2.0
 Summary: Official Python client for MockServer — create expectations, verify requests, and register dynamic callbacks via WebSocket
 Author-email: James Bloom <jamesdbloom@gmail.com>
 License-Expression: Apache-2.0
@@ -273,6 +273,118 @@ response = (
 )
 ```
 
+## Interactive Breakpoints
+
+The client supports matcher-driven interactive breakpoints over the callback WebSocket. Register a breakpoint matcher to pause forwarded/proxied exchanges at specific phases and inspect/modify/continue them via callback handlers.
+
+### Register a breakpoint (sync client)
+
+```python
+from mockserver import MockServerClient, HttpRequest, HttpResponse
+
+client = MockServerClient("localhost", 1080)
+
+# REQUEST phase only
+bp_id = client.add_request_breakpoint(
+    HttpRequest(path="/api/.*"),
+    lambda request: request,  # continue unchanged (or return HttpResponse to abort)
+)
+
+# REQUEST + RESPONSE
+bp_id = client.add_request_and_response_breakpoint(
+    HttpRequest(path="/api/.*"),
+    lambda request: request,                      # REQUEST handler
+    lambda request, response: response,           # RESPONSE handler
+)
+
+# All phases with stream frame handler
+bp_id = client.add_breakpoint(
+    HttpRequest(path="/stream/.*"),
+    ["REQUEST", "RESPONSE", "RESPONSE_STREAM", "INBOUND_STREAM"],
+    request_handler=lambda request: request,
+    response_handler=lambda request, response: response,
+    stream_frame_handler=lambda frame: {"action": "CONTINUE"},
+    # Other actions: MODIFY (with body), DROP, INJECT (with body), CLOSE
+)
+```
+
+### Manage breakpoints
+
+```python
+# List all matchers
+matchers = client.list_breakpoint_matchers()  # {"matchers": [...]}
+
+# Remove a specific matcher
+client.remove_breakpoint_matcher(bp_id)
+
+# Clear all matchers
+client.clear_breakpoint_matchers()
+```
+
+The async client (`AsyncMockServerClient`) exposes the same methods as coroutines.
+
+## Start / Launch MockServer
+
+The Python client can download and launch a local MockServer instance directly -- no Java installation and no Docker required. The launcher downloads a self-contained platform bundle (`mockserver-<version>-<os>-<arch>`) from the GitHub Release, verifies its SHA-256, caches it per-user, and starts it.
+
+### Quick start
+
+```python
+from mockserver.launcher import start, MockServerProcess
+
+# Download (first run) and start MockServer on port 1080
+with start(port=1080) as server:
+    print(f"MockServer running on port {server.port}, PID {server.pid}")
+    # ... use MockServer ...
+# Server is stopped automatically when the context manager exits
+```
+
+### Just ensure the binary is present
+
+```python
+from mockserver.launcher import ensure_binary
+
+launcher_path = ensure_binary()  # returns Path to the launcher executable
+```
+
+### Specify a version
+
+```python
+from mockserver.launcher import start
+
+server = start(port=1080, version="7.2.0")
+# ...
+server.stop()
+```
+
+### API reference
+
+| Function / Class | Description |
+|---|---|
+| `ensure_binary(version=None, *, log=True)` | Download, verify, cache, and return the launcher `Path`. Defaults to the client's own version. |
+| `start(port, version=None, *, extra_args=None, log=True)` | Ensure the binary and start MockServer. Returns a `MockServerProcess`. |
+| `MockServerProcess` | Handle to the running process. Properties: `port`, `pid`, `launcher`, `returncode`. Methods: `stop(timeout=10.0)`. Supports `with` statement. |
+
+### Supported platforms
+
+| OS | Architecture |
+|---|---|
+| Linux | x86_64, aarch64 |
+| macOS (darwin) | x86_64, aarch64 |
+| Windows | x86_64, aarch64 |
+
+### Environment variables
+
+| Variable | Purpose |
+|---|---|
+| `MOCKSERVER_BINARY_BASE_URL` | Mirror host for the release assets (corporate / air-gapped networks) |
+| `MOCKSERVER_BINARY_CACHE` | Override the cache directory (default: `~/.cache/mockserver/binaries` on Unix) |
+| `MOCKSERVER_SKIP_BINARY_DOWNLOAD` | Fail instead of downloading (use with a pre-seeded cache in CI) |
+
+### Version
+
+By default the launcher downloads the MockServer version matching this client package (currently the version set in `pyproject.toml`). Pass an explicit `version` argument to override.
+
 ## Requirements
 
 - Python 3.9+

{mockserver_client-7.0.0 → mockserver_client-7.2.0}/README.md

@@ -243,6 +243,118 @@ response = (
 )
 ```
 
+## Interactive Breakpoints
+
+The client supports matcher-driven interactive breakpoints over the callback WebSocket. Register a breakpoint matcher to pause forwarded/proxied exchanges at specific phases and inspect/modify/continue them via callback handlers.
+
+### Register a breakpoint (sync client)
+
+```python
+from mockserver import MockServerClient, HttpRequest, HttpResponse
+
+client = MockServerClient("localhost", 1080)
+
+# REQUEST phase only
+bp_id = client.add_request_breakpoint(
+    HttpRequest(path="/api/.*"),
+    lambda request: request,  # continue unchanged (or return HttpResponse to abort)
+)
+
+# REQUEST + RESPONSE
+bp_id = client.add_request_and_response_breakpoint(
+    HttpRequest(path="/api/.*"),
+    lambda request: request,                      # REQUEST handler
+    lambda request, response: response,           # RESPONSE handler
+)
+
+# All phases with stream frame handler
+bp_id = client.add_breakpoint(
+    HttpRequest(path="/stream/.*"),
+    ["REQUEST", "RESPONSE", "RESPONSE_STREAM", "INBOUND_STREAM"],
+    request_handler=lambda request: request,
+    response_handler=lambda request, response: response,
+    stream_frame_handler=lambda frame: {"action": "CONTINUE"},
+    # Other actions: MODIFY (with body), DROP, INJECT (with body), CLOSE
+)
+```
+
+### Manage breakpoints
+
+```python
+# List all matchers
+matchers = client.list_breakpoint_matchers()  # {"matchers": [...]}
+
+# Remove a specific matcher
+client.remove_breakpoint_matcher(bp_id)
+
+# Clear all matchers
+client.clear_breakpoint_matchers()
+```
+
+The async client (`AsyncMockServerClient`) exposes the same methods as coroutines.
+
+## Start / Launch MockServer
+
+The Python client can download and launch a local MockServer instance directly -- no Java installation and no Docker required. The launcher downloads a self-contained platform bundle (`mockserver-<version>-<os>-<arch>`) from the GitHub Release, verifies its SHA-256, caches it per-user, and starts it.
+
+### Quick start
+
+```python
+from mockserver.launcher import start, MockServerProcess
+
+# Download (first run) and start MockServer on port 1080
+with start(port=1080) as server:
+    print(f"MockServer running on port {server.port}, PID {server.pid}")
+    # ... use MockServer ...
+# Server is stopped automatically when the context manager exits
+```
+
+### Just ensure the binary is present
+
+```python
+from mockserver.launcher import ensure_binary
+
+launcher_path = ensure_binary()  # returns Path to the launcher executable
+```
+
+### Specify a version
+
+```python
+from mockserver.launcher import start
+
+server = start(port=1080, version="7.2.0")
+# ...
+server.stop()
+```
+
+### API reference
+
+| Function / Class | Description |
+|---|---|
+| `ensure_binary(version=None, *, log=True)` | Download, verify, cache, and return the launcher `Path`. Defaults to the client's own version. |
+| `start(port, version=None, *, extra_args=None, log=True)` | Ensure the binary and start MockServer. Returns a `MockServerProcess`. |
+| `MockServerProcess` | Handle to the running process. Properties: `port`, `pid`, `launcher`, `returncode`. Methods: `stop(timeout=10.0)`. Supports `with` statement. |
+
+### Supported platforms
+
+| OS | Architecture |
+|---|---|
+| Linux | x86_64, aarch64 |
+| macOS (darwin) | x86_64, aarch64 |
+| Windows | x86_64, aarch64 |
+
+### Environment variables
+
+| Variable | Purpose |
+|---|---|
+| `MOCKSERVER_BINARY_BASE_URL` | Mirror host for the release assets (corporate / air-gapped networks) |
+| `MOCKSERVER_BINARY_CACHE` | Override the cache directory (default: `~/.cache/mockserver/binaries` on Unix) |
+| `MOCKSERVER_SKIP_BINARY_DOWNLOAD` | Fail instead of downloading (use with a pre-seeded cache in CI) |
+
+### Version
+
+By default the launcher downloads the MockServer version matching this client package (currently the version set in `pyproject.toml`). Pass an explicit `version` argument to override.
+
 ## Requirements
 
 - Python 3.9+

{mockserver_client-7.0.0 → mockserver_client-7.2.0}/mockserver/__init__.py

@@ -3,6 +3,8 @@ from mockserver.models import (
     BinaryResponse,
     Body,
     ConnectionOptions,
+    CrossProtocolScenario,
+    CrossProtocolTrigger,
     Delay,
     DelayDistribution,
     DnsRecord,
@@ -26,12 +28,18 @@ from mockserver.models import (
     HttpSseResponse,
     HttpTemplate,
     HttpWebSocketResponse,
+    JsonPathBody,
     JsonRpcBody,
     KeyToMultiValue,
+    LoadProfile,
+    LoadScenario,
+    LoadStage,
+    LoadStep,
     OpenAPIDefinition,
     OpenAPIExpectation,
     Ports,
     RequestDefinition,
+    ResponseMode,
     SocketAddress,
     SseEvent,
     TimeToLive,
@@ -41,6 +49,37 @@ from mockserver.models import (
     VerificationTimes,
     WebSocketMessage,
 )
+from mockserver.llm import (
+    Completion,
+    ConversationPredicates,
+    EmbeddingResponse,
+    HttpLlmResponse,
+    IsolationSource,
+    LlmChaosProfile,
+    LlmConversationBuilder,
+    LlmFailoverBuilder,
+    LlmMockBuilder,
+    NormalizationOptions,
+    Provider,
+    Role,
+    StreamingPhysics,
+    ToolUse,
+    TurnBuilder,
+    Usage,
+    completion,
+    conversation,
+    cookie,
+    embedding,
+    header,
+    llm_failover,
+    llm_mock,
+    llm_response,
+    query_parameter,
+    streaming_physics,
+    time_to_first_token,
+    tool_use,
+    usage,
+)
 from mockserver.exceptions import (
     MockServerCallbackError,
     MockServerConnectionError,
@@ -49,7 +88,22 @@ from mockserver.exceptions import (
     MockServerWebSocketError,
 )
 from mockserver.client import MockServerClient
+from mockserver.mcp import (
+    McpMockBuilder,
+    McpPromptBuilder,
+    McpResourceBuilder,
+    McpToolBuilder,
+    mcp_mock,
+)
 from mockserver.async_client import AsyncMockServerClient
+from mockserver.launcher import (
+    MockServerProcess,
+    bundle_base_name,
+    cache_dir,
+    ensure_binary,
+    resolve_platform,
+    start as start_server,
+)
 
 __all__ = [
     "AfterAction",
@@ -57,6 +111,8 @@ __all__ = [
     "BinaryResponse",
     "Body",
     "ConnectionOptions",
+    "CrossProtocolScenario",
+    "CrossProtocolTrigger",
     "Delay",
     "DelayDistribution",
     "DnsRecord",
@@ -80,8 +136,47 @@ __all__ = [
     "HttpSseResponse",
     "HttpTemplate",
     "HttpWebSocketResponse",
+    "JsonPathBody",
     "JsonRpcBody",
     "KeyToMultiValue",
+    "LoadProfile",
+    "LoadScenario",
+    "LoadStage",
+    "LoadStep",
+    "Completion",
+    "ConversationPredicates",
+    "EmbeddingResponse",
+    "HttpLlmResponse",
+    "IsolationSource",
+    "LlmChaosProfile",
+    "LlmConversationBuilder",
+    "LlmFailoverBuilder",
+    "LlmMockBuilder",
+    "NormalizationOptions",
+    "Provider",
+    "Role",
+    "StreamingPhysics",
+    "ToolUse",
+    "TurnBuilder",
+    "Usage",
+    "completion",
+    "conversation",
+    "cookie",
+    "embedding",
+    "header",
+    "llm_failover",
+    "llm_mock",
+    "llm_response",
+    "query_parameter",
+    "streaming_physics",
+    "time_to_first_token",
+    "tool_use",
+    "usage",
+    "McpMockBuilder",
+    "McpPromptBuilder",
+    "McpResourceBuilder",
+    "McpToolBuilder",
+    "mcp_mock",
     "MockServerCallbackError",
     "MockServerClient",
     "MockServerConnectionError",
@@ -92,6 +187,7 @@ __all__ = [
     "OpenAPIExpectation",
     "Ports",
     "RequestDefinition",
+    "ResponseMode",
     "SocketAddress",
     "SseEvent",
     "TimeToLive",
@@ -100,4 +196,10 @@ __all__ = [
     "VerificationSequence",
     "VerificationTimes",
     "WebSocketMessage",
+    "MockServerProcess",
+    "bundle_base_name",
+    "cache_dir",
+    "ensure_binary",
+    "resolve_platform",
+    "start_server",
 ]