mockly-driver 0.4.3__tar.gz

mockly_driver-0.4.3/.gitignore

@@ -0,0 +1,56 @@
+# Binaries
+/mockly
+/mockly.exe
+dist/
+
+# UI build
+ui/dist/
+ui/node_modules/
+
+# Assets (built by make)
+assets/dist/
+
+# Go
+*.test
+*.out
+vendor/
+coverage.txt
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Config (user-specific, not example)
+mockly.yaml
+
+# Node client
+clients/node/node_modules/
+clients/node/dist/
+clients/node/bin/
+
+# Python client
+clients/python/.pytest_cache/
+clients/python/__pycache__/
+clients/python/src/**/__pycache__/
+clients/python/*.egg-info/
+clients/python/dist/
+clients/python/.venv/
+
+# Python cache (all locations)
+**/__pycache__/
+**/*.pyc
+
+# Java client
+clients/java/target/
+
+# .NET client
+clients/dotnet/**/bin/
+clients/dotnet/**/obj/
+
+# Rust client
+clients/rust/target/

mockly_driver-0.4.3/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to **mockly-driver** will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [0.1.0] - 2024-01-01
+
+### Added
+
+- `MocklyServer.create()` — start a Mockly server using an already-installed binary; retries up to 3× on port conflicts.
+- `MocklyServer.ensure()` — download binary if needed, then start the server.
+- `MocklyServer.stop()` — kill the Mockly process and clean up the temp config file.
+- `MocklyServer.add_mock()` — register a dynamic HTTP mock at runtime.
+- `MocklyServer.delete_mock()` — remove a mock by ID.
+- `MocklyServer.reset()` — remove all dynamic mocks, deactivate scenarios, and clear faults.
+- `MocklyServer.activate_scenario()` / `deactivate_scenario()` — toggle pre-configured scenarios.
+- `MocklyServer.set_fault()` / `clear_fault()` — inject latency, status overrides, and error rates.
+- `install()` — download the platform-correct Mockly binary with proxy and mirror support.
+- `get_binary_path()` — locate an existing binary via `MOCKLY_BINARY_PATH`, explicit dir, or `./bin/`.
+- `mockly-install` CLI entry point for one-step binary setup.
+- Dataclasses: `Mock`, `MockRequest`, `MockResponse`, `Scenario`, `ScenarioPatch`, `FaultConfig`.
+- Environment variable support: `MOCKLY_BINARY_PATH`, `MOCKLY_VERSION`, `MOCKLY_DOWNLOAD_BASE_URL`, `MOCKLY_NO_INSTALL`, `HTTPS_PROXY`, `HTTP_PROXY`.
+- Stdlib-only runtime — no third-party dependencies.
+- pytest unit tests covering port allocation, binary discovery, and install guards.
+
+

mockly_driver-0.4.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 dever-labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mockly_driver-0.4.3/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: mockly-driver
+Version: 0.4.3
+Summary: Python client for Mockly — start/stop servers and manage HTTP mocks in tests
+Project-URL: Homepage, https://github.com/dever-labs/mockly/tree/main/clients/python
+Project-URL: Repository, https://github.com/dever-labs/mockly
+Project-URL: Issues, https://github.com/dever-labs/mockly/issues
+License: MIT
+License-File: LICENSE
+Keywords: http,integration-test,mock,mockly,testing
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# mockly-driver
+
+Python client for [Mockly](https://github.com/dever-labs/mockly) — download, start, and control a Mockly mock HTTP server from your Python/pytest test suite.
+
+---
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [API Reference](#api-reference)
+- [Environment Variables](#environment-variables)
+- [Proxy / Artifactory / Air-gap](#proxy--artifactory--air-gap)
+- [CLI](#cli)
+
+---
+
+## Installation
+
+```bash
+pip install mockly-driver
+```
+
+Then download the Mockly binary once:
+
+```bash
+mockly-install
+# binary is placed in ./bin/mockly (or ./bin/mockly.exe on Windows)
+```
+
+---
+
+## Quick Start
+
+### pytest fixture
+
+```python
+import pytest
+from mockly_driver import MocklyServer, Mock, MockRequest, MockResponse
+
+@pytest.fixture(scope="session")
+def mockly():
+    # Downloads binary if needed, then starts the server
+    server = MocklyServer.ensure()
+    yield server
+    server.stop()
+
+def test_my_service(mockly):
+    mockly.add_mock(Mock(
+        id="get-users",
+        request=MockRequest(method="GET", path="/users"),
+        response=MockResponse(status=200, body='[{"id":1}]',
+                              headers={"Content-Type": "application/json"}),
+    ))
+
+    # Your service under test talks to mockly.http_base
+    import urllib.request
+    with urllib.request.urlopen(f"{mockly.http_base}/users") as resp:
+        assert resp.status == 200
+
+    mockly.reset()
+```
+
+### Scenarios
+
+```python
+from mockly_driver import Scenario, ScenarioPatch
+
+server = MocklyServer.ensure(
+    scenarios=[
+        Scenario(
+            id="slow-api",
+            name="Slow API",
+            patches=[ScenarioPatch(mock_id="get-users", delay="2s")],
+        )
+    ]
+)
+
+server.activate_scenario("slow-api")
+# ... run slow-path tests ...
+server.deactivate_scenario("slow-api")
+```
+
+### Faults
+
+```python
+from mockly_driver import FaultConfig
+
+server.set_fault(FaultConfig(enabled=True, status_override=503, error_rate=0.5))
+# ... run fault-tolerance tests ...
+server.clear_fault()
+```
+
+---
+
+## API Reference
+
+### `MocklyServer.ensure(scenarios=None, **install_kwargs) -> MocklyServer`
+
+Downloads the binary (if not already present) and starts the server.
+`install_kwargs` are forwarded to `install()` — see below.
+
+### `MocklyServer.create(scenarios=None) -> MocklyServer`
+
+Starts the server using an already-installed binary.
+Raises `RuntimeError` if no binary is found.
+
+### `server.stop() -> None`
+
+Kills the Mockly process and removes the temp config file.
+
+### `server.add_mock(mock: Mock) -> None`
+
+Registers a new HTTP mock at runtime.
+
+```python
+Mock(
+    id="my-mock",
+    request=MockRequest(method="POST", path="/echo",
+                        headers={"X-Api-Key": "secret"}),
+    response=MockResponse(status=201, body='{"ok":true}',
+                          headers={"Content-Type": "application/json"},
+                          delay="10ms"),
+)
+```
+
+### `server.delete_mock(mock_id: str) -> None`
+
+Removes a previously registered mock by ID.
+
+### `server.reset() -> None`
+
+Removes all dynamic mocks, deactivates all scenarios, and clears any active fault.
+
+### `server.activate_scenario(scenario_id: str) -> None`
+
+Activates a pre-configured scenario.
+
+### `server.deactivate_scenario(scenario_id: str) -> None`
+
+Deactivates a scenario.
+
+### `server.set_fault(config: FaultConfig) -> None`
+
+Enables a fault injection policy.
+
+```python
+FaultConfig(
+    enabled=True,
+    delay="200ms",        # add latency to all responses
+    status_override=503,  # force every response to 503
+    error_rate=0.3,       # randomly fail 30% of requests
+)
+```
+
+### `server.clear_fault() -> None`
+
+Removes the active fault policy.
+
+### `install(version=None, base_url=None, bin_dir=None, force=False) -> str`
+
+Downloads the Mockly binary for the current platform. Returns the path.
+
+### `get_binary_path(bin_dir=None) -> str | None`
+
+Returns the path to an existing binary, or `None` if not found.
+
+---
+
+## Environment Variables
+
+| Variable | Description | Default |
+|---|---|---|
+| `MOCKLY_BINARY_PATH` | Absolute path to a pre-staged binary — skips all download logic | — |
+| `MOCKLY_VERSION` | Binary version to download | `v0.1.0` |
+| `MOCKLY_DOWNLOAD_BASE_URL` | Override the GitHub releases base URL (for mirrors/Artifactory) | `https://github.com/dever-labs/mockly/releases/download` |
+| `MOCKLY_NO_INSTALL` | If set, `install()` raises `RuntimeError` instead of downloading | — |
+| `HTTPS_PROXY` / `HTTP_PROXY` | Route downloads through an HTTP proxy | — |
+
+---
+
+## Proxy / Artifactory / Air-gap
+
+### HTTP/HTTPS proxy
+
+```bash
+export HTTPS_PROXY=http://proxy.corp.example.com:3128
+mockly-install
+```
+
+### Internal mirror / Artifactory
+
+Set `MOCKLY_DOWNLOAD_BASE_URL` to your internal artifact repository:
+
+```bash
+export MOCKLY_DOWNLOAD_BASE_URL=https://artifactory.corp.example.com/mockly/releases/download
+mockly-install
+```
+
+### Air-gap / pre-staged binary
+
+Copy the binary for your platform to a known location and set:
+
+```bash
+export MOCKLY_BINARY_PATH=/opt/mockly/mockly
+export MOCKLY_NO_INSTALL=1   # optional: prevents accidental downloads
+```
+
+---
+
+## CLI
+
+```
+mockly-install [--version VERSION] [--base-url URL] [--bin-dir DIR] [--force]
+```
+
+Downloads the platform binary to `<bin-dir>/mockly[.exe]` (default: `./bin/`).
+
+---
+
+## License
+
+MIT © dever-labs

mockly_driver-0.4.3/README.md

@@ -0,0 +1,223 @@
+# mockly-driver
+
+Python client for [Mockly](https://github.com/dever-labs/mockly) — download, start, and control a Mockly mock HTTP server from your Python/pytest test suite.
+
+---
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [API Reference](#api-reference)
+- [Environment Variables](#environment-variables)
+- [Proxy / Artifactory / Air-gap](#proxy--artifactory--air-gap)
+- [CLI](#cli)
+
+---
+
+## Installation
+
+```bash
+pip install mockly-driver
+```
+
+Then download the Mockly binary once:
+
+```bash
+mockly-install
+# binary is placed in ./bin/mockly (or ./bin/mockly.exe on Windows)
+```
+
+---
+
+## Quick Start
+
+### pytest fixture
+
+```python
+import pytest
+from mockly_driver import MocklyServer, Mock, MockRequest, MockResponse
+
+@pytest.fixture(scope="session")
+def mockly():
+    # Downloads binary if needed, then starts the server
+    server = MocklyServer.ensure()
+    yield server
+    server.stop()
+
+def test_my_service(mockly):
+    mockly.add_mock(Mock(
+        id="get-users",
+        request=MockRequest(method="GET", path="/users"),
+        response=MockResponse(status=200, body='[{"id":1}]',
+                              headers={"Content-Type": "application/json"}),
+    ))
+
+    # Your service under test talks to mockly.http_base
+    import urllib.request
+    with urllib.request.urlopen(f"{mockly.http_base}/users") as resp:
+        assert resp.status == 200
+
+    mockly.reset()
+```
+
+### Scenarios
+
+```python
+from mockly_driver import Scenario, ScenarioPatch
+
+server = MocklyServer.ensure(
+    scenarios=[
+        Scenario(
+            id="slow-api",
+            name="Slow API",
+            patches=[ScenarioPatch(mock_id="get-users", delay="2s")],
+        )
+    ]
+)
+
+server.activate_scenario("slow-api")
+# ... run slow-path tests ...
+server.deactivate_scenario("slow-api")
+```
+
+### Faults
+
+```python
+from mockly_driver import FaultConfig
+
+server.set_fault(FaultConfig(enabled=True, status_override=503, error_rate=0.5))
+# ... run fault-tolerance tests ...
+server.clear_fault()
+```
+
+---
+
+## API Reference
+
+### `MocklyServer.ensure(scenarios=None, **install_kwargs) -> MocklyServer`
+
+Downloads the binary (if not already present) and starts the server.
+`install_kwargs` are forwarded to `install()` — see below.
+
+### `MocklyServer.create(scenarios=None) -> MocklyServer`
+
+Starts the server using an already-installed binary.
+Raises `RuntimeError` if no binary is found.
+
+### `server.stop() -> None`
+
+Kills the Mockly process and removes the temp config file.
+
+### `server.add_mock(mock: Mock) -> None`
+
+Registers a new HTTP mock at runtime.
+
+```python
+Mock(
+    id="my-mock",
+    request=MockRequest(method="POST", path="/echo",
+                        headers={"X-Api-Key": "secret"}),
+    response=MockResponse(status=201, body='{"ok":true}',
+                          headers={"Content-Type": "application/json"},
+                          delay="10ms"),
+)
+```
+
+### `server.delete_mock(mock_id: str) -> None`
+
+Removes a previously registered mock by ID.
+
+### `server.reset() -> None`
+
+Removes all dynamic mocks, deactivates all scenarios, and clears any active fault.
+
+### `server.activate_scenario(scenario_id: str) -> None`
+
+Activates a pre-configured scenario.
+
+### `server.deactivate_scenario(scenario_id: str) -> None`
+
+Deactivates a scenario.
+
+### `server.set_fault(config: FaultConfig) -> None`
+
+Enables a fault injection policy.
+
+```python
+FaultConfig(
+    enabled=True,
+    delay="200ms",        # add latency to all responses
+    status_override=503,  # force every response to 503
+    error_rate=0.3,       # randomly fail 30% of requests
+)
+```
+
+### `server.clear_fault() -> None`
+
+Removes the active fault policy.
+
+### `install(version=None, base_url=None, bin_dir=None, force=False) -> str`
+
+Downloads the Mockly binary for the current platform. Returns the path.
+
+### `get_binary_path(bin_dir=None) -> str | None`
+
+Returns the path to an existing binary, or `None` if not found.
+
+---
+
+## Environment Variables
+
+| Variable | Description | Default |
+|---|---|---|
+| `MOCKLY_BINARY_PATH` | Absolute path to a pre-staged binary — skips all download logic | — |
+| `MOCKLY_VERSION` | Binary version to download | `v0.1.0` |
+| `MOCKLY_DOWNLOAD_BASE_URL` | Override the GitHub releases base URL (for mirrors/Artifactory) | `https://github.com/dever-labs/mockly/releases/download` |
+| `MOCKLY_NO_INSTALL` | If set, `install()` raises `RuntimeError` instead of downloading | — |
+| `HTTPS_PROXY` / `HTTP_PROXY` | Route downloads through an HTTP proxy | — |
+
+---
+
+## Proxy / Artifactory / Air-gap
+
+### HTTP/HTTPS proxy
+
+```bash
+export HTTPS_PROXY=http://proxy.corp.example.com:3128
+mockly-install
+```
+
+### Internal mirror / Artifactory
+
+Set `MOCKLY_DOWNLOAD_BASE_URL` to your internal artifact repository:
+
+```bash
+export MOCKLY_DOWNLOAD_BASE_URL=https://artifactory.corp.example.com/mockly/releases/download
+mockly-install
+```
+
+### Air-gap / pre-staged binary
+
+Copy the binary for your platform to a known location and set:
+
+```bash
+export MOCKLY_BINARY_PATH=/opt/mockly/mockly
+export MOCKLY_NO_INSTALL=1   # optional: prevents accidental downloads
+```
+
+---
+
+## CLI
+
+```
+mockly-install [--version VERSION] [--base-url URL] [--bin-dir DIR] [--force]
+```
+
+Downloads the platform binary to `<bin-dir>/mockly[.exe]` (default: `./bin/`).
+
+---
+
+## License
+
+MIT © dever-labs

mockly_driver-0.4.3/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "mockly-driver"
+version = "0.4.3"
+description = "Python client for Mockly — start/stop servers and manage HTTP mocks in tests"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.10"
+keywords = ["mock", "testing", "http", "integration-test", "mockly"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Software Development :: Testing",
+]
+dependencies = []   # stdlib only
+
+[project.urls]
+Homepage = "https://github.com/dever-labs/mockly/tree/main/clients/python"
+Repository = "https://github.com/dever-labs/mockly"
+Issues = "https://github.com/dever-labs/mockly/issues"
+
+[project.scripts]
+mockly-install = "mockly_driver._install:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/mockly_driver"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

mockly_driver-0.4.3/src/mockly_driver/__init__.py

@@ -0,0 +1,24 @@
+"""mockly-driver — Python client for Mockly mock server."""
+
+from ._install import get_binary_path, install
+from ._server import MocklyServer
+from ._types import (
+    FaultConfig,
+    Mock,
+    MockRequest,
+    MockResponse,
+    Scenario,
+    ScenarioPatch,
+)
+
+__all__ = [
+    "MocklyServer",
+    "install",
+    "get_binary_path",
+    "Mock",
+    "MockRequest",
+    "MockResponse",
+    "Scenario",
+    "ScenarioPatch",
+    "FaultConfig",
+]