testcontainers-mockserver 7.1.0__py3-none-any.whl

testcontainers_mockserver/__init__.py

@@ -0,0 +1,20 @@
+"""Testcontainers module for MockServer.
+
+Provides a ``MockServerContainer`` that starts a ``mockserver/mockserver`` Docker
+image, waits for readiness, and exposes convenience accessors for the mapped
+host, port, and base URL.
+
+Example::
+
+    from testcontainers_mockserver import MockServerContainer
+
+    with MockServerContainer() as mockserver:
+        url = mockserver.get_url()
+        # url is e.g. "http://localhost:49152"
+        # Use requests or any HTTP client to interact with MockServer at this URL.
+"""
+
+from testcontainers_mockserver.container import MockServerContainer
+
+__all__ = ["MockServerContainer"]
+__version__ = "7.0.0"

testcontainers_mockserver/container.py

@@ -0,0 +1,139 @@
+"""MockServerContainer — Testcontainers module for MockServer.
+
+This module provides a thin wrapper around testcontainers' ``DockerContainer`` that
+starts a ``mockserver/mockserver`` image, waits for readiness via the
+``/mockserver/status`` HTTP endpoint (PUT, returns 200), and exposes convenience
+methods for the mapped host, port, and URL.
+"""
+
+from __future__ import annotations
+
+from typing import Optional
+
+from testcontainers.core.container import DockerContainer
+from testcontainers.core.wait_strategies import HttpWaitStrategy
+
+#: Default port MockServer listens on inside the container (HTTP, HTTPS, SOCKS,
+#: and HTTP CONNECT all served on this single unified port).
+MOCKSERVER_PORT = 1080
+
+#: Default Docker image name for MockServer.
+_IMAGE_NAME = "mockserver/mockserver"
+
+#: Default image tag, pinned to the current MockServer release version.
+_DEFAULT_TAG = "mockserver-7.0.0"
+
+
+class MockServerContainer(DockerContainer):
+    """A Testcontainers wrapper that starts a MockServer Docker container.
+
+    The container starts the ``mockserver/mockserver`` image on port 1080 and waits
+    for the ``PUT /mockserver/status`` endpoint to return HTTP 200 before yielding
+    control.
+
+    Parameters
+    ----------
+    image : str, optional
+        Full Docker image reference. Defaults to
+        ``mockserver/mockserver:mockserver-7.0.0``.
+    port : int, optional
+        The port MockServer listens on inside the container. Defaults to 1080.
+
+    Example
+    -------
+    ::
+
+        from testcontainers_mockserver import MockServerContainer
+
+        with MockServerContainer() as server:
+            url = server.get_url()
+            # e.g. "http://localhost:49152"
+    """
+
+    def __init__(
+        self,
+        image: str = f"{_IMAGE_NAME}:{_DEFAULT_TAG}",
+        port: int = MOCKSERVER_PORT,
+        **kwargs,
+    ) -> None:
+        super().__init__(image=image, **kwargs)
+        self._port = port
+        self.with_exposed_ports(self._port)
+        self.with_env("SERVER_PORT", str(self._port))
+
+    def _build_wait_strategy(self) -> HttpWaitStrategy:
+        """Build the readiness wait strategy.
+
+        MockServer's ``/mockserver/status`` endpoint requires a PUT request and
+        returns HTTP 200 with a JSON body containing ``{ "ports": [...] }`` when
+        the server is ready.
+        """
+        return (
+            HttpWaitStrategy(self._port, "/mockserver/status")
+            .with_method("PUT")
+            .with_startup_timeout(60)
+        )
+
+    def start(self) -> "MockServerContainer":
+        """Start the container and wait for MockServer to become ready."""
+        super().start()
+        self._build_wait_strategy().wait_until_ready(self)
+        return self
+
+    # ------------------------------------------------------------------
+    # Convenience accessors
+    # ------------------------------------------------------------------
+
+    def get_host(self) -> str:
+        """Return the host IP to connect to MockServer from the test process."""
+        return self.get_container_host_ip()
+
+    def get_port(self) -> int:
+        """Return the mapped host port for MockServer's container port."""
+        return int(self.get_exposed_port(self._port))
+
+    def get_url(self) -> str:
+        """Return the HTTP base URL for MockServer (e.g. ``http://localhost:49152``)."""
+        return f"http://{self.get_host()}:{self.get_port()}"
+
+    def get_secure_url(self) -> str:
+        """Return the HTTPS base URL for MockServer (same port, different scheme)."""
+        return f"https://{self.get_host()}:{self.get_port()}"
+
+    # ------------------------------------------------------------------
+    # Configuration helpers (fluent)
+    # ------------------------------------------------------------------
+
+    def with_server_port(self, port: int) -> "MockServerContainer":
+        """Override the MockServer listen port inside the container.
+
+        This replaces the exposed port so the wait strategy targets the correct port.
+        """
+        self._port = port
+        # Reset exposed ports to only the new port
+        self.ports = {}
+        self.with_exposed_ports(port)
+        self.with_env("SERVER_PORT", str(port))
+        return self
+
+    def with_log_level(self, level: str) -> "MockServerContainer":
+        """Set the MockServer log level (e.g. INFO, DEBUG, WARN, ERROR, TRACE)."""
+        self.with_env("MOCKSERVER_LOG_LEVEL", level)
+        return self
+
+    def with_property(self, key: str, value: str) -> "MockServerContainer":
+        """Set a MockServer configuration property as an environment variable.
+
+        The key must be in MockServer env-var form (e.g. ``MOCKSERVER_LOG_LEVEL``).
+        """
+        self.with_env(key, value)
+        return self
+
+    def with_initialization_json(self, container_path: str) -> "MockServerContainer":
+        """Configure MockServer to load expectations from a JSON file at startup.
+
+        The file must already be mounted/copied into the container at *container_path*.
+        This sets the ``MOCKSERVER_INITIALIZATION_JSON_PATH`` environment variable.
+        """
+        self.with_env("MOCKSERVER_INITIALIZATION_JSON_PATH", container_path)
+        return self

testcontainers_mockserver-7.1.0.dist-info/METADATA

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: testcontainers-mockserver
+Version: 7.1.0
+Summary: Testcontainers module for MockServer
+Author-email: James D Bloom <jamesdbloom@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://www.mock-server.com
+Project-URL: Repository, https://github.com/mock-server/mockserver
+Project-URL: Documentation, https://www.mock-server.com/mock_server/mockserver_testcontainers.html
+Keywords: testing,docker,mockserver,testcontainers,mocking
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: testcontainers>=4.0.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: requests>=2.20; extra == "test"
+
+# testcontainers-mockserver
+
+A [Testcontainers](https://testcontainers.com) module for [MockServer](https://www.mock-server.com) in Python.
+
+Starts a `mockserver/mockserver` Docker container, waits for readiness, and provides
+convenient accessors for the mapped host, port, and URL.
+
+## Installation
+
+```bash
+pip install testcontainers-mockserver
+```
+
+## Usage
+
+```python
+from testcontainers_mockserver import MockServerContainer
+import requests
+
+with MockServerContainer() as mockserver:
+    url = mockserver.get_url()  # e.g. "http://localhost:49152"
+
+    # Create an expectation
+    requests.put(f"{url}/mockserver/expectation", json={
+        "httpRequest": {"method": "GET", "path": "/hello"},
+        "httpResponse": {"statusCode": 200, "body": "world"},
+    })
+
+    # Match it
+    resp = requests.get(f"{url}/hello")
+    assert resp.text == "world"
+```
+
+## API
+
+### `MockServerContainer(image=..., port=1080)`
+
+- `image` — Docker image to use. Defaults to `mockserver/mockserver:mockserver-7.1.0`.
+- `port` — Container port MockServer listens on. Defaults to `1080`.
+
+### Methods
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `get_url()` | `str` | HTTP base URL (e.g. `http://localhost:49152`) |
+| `get_secure_url()` | `str` | HTTPS base URL (same port, `https://` scheme) |
+| `get_host()` | `str` | Mapped host IP |
+| `get_port()` | `int` | Mapped host port |
+| `with_server_port(port)` | `self` | Override the listen port |
+| `with_log_level(level)` | `self` | Set `MOCKSERVER_LOG_LEVEL` |
+| `with_property(key, value)` | `self` | Set any MockServer env var |
+| `with_initialization_json(path)` | `self` | Point to a startup expectations JSON file |
+
+## Building and Testing
+
+```bash
+# Install in editable mode with test dependencies
+pip install -e .[test]
+
+# Run unit tests (no Docker needed)
+pytest tests/test_container_config.py
+
+# Run all tests including integration (requires Docker)
+pytest
+
+# Skip Docker-dependent tests
+pytest -m "not docker"
+```
+
+## Requirements
+
+- Python >= 3.9
+- Docker (for integration tests and actual usage)
+- `testcontainers` >= 4.0.0

testcontainers_mockserver-7.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+testcontainers_mockserver/__init__.py,sha256=R_s74zXKFen4EkQLE50aCBdFPrDMuIihI66YLtFetD0,643
+testcontainers_mockserver/container.py,sha256=BMzdJzSGmExZYBSFltw3F_KVWR9QYE16-wp4IQXwvq4,5181
+testcontainers_mockserver-7.1.0.dist-info/METADATA,sha256=c0MjNZ4EoQD3qV6blHXB_IfnpquwS1uVH7kqt8VTqVY,3286
+testcontainers_mockserver-7.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+testcontainers_mockserver-7.1.0.dist-info/top_level.txt,sha256=qXB8zu0gPvNlC2F2oRYU9hqeWIT8rjmftL_uvi_aghw,26
+testcontainers_mockserver-7.1.0.dist-info/RECORD,,

testcontainers_mockserver-7.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

testcontainers_mockserver-7.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+testcontainers_mockserver