mockstack 0.14.1__tar.gz → 0.14.2__tar.gz

{mockstack-0.14.1 → mockstack-0.14.2}/.env.example

@@ -5,6 +5,10 @@
 # the strategy to use: filefixtures (the default) or proxyrules
 MOCKSTACK__STRATEGY = filefixtures
 
+# serve FastAPI's documentation routes (/docs, /redoc, /openapi.json and
+# /docs/oauth2-redirect) instead of passing those paths to the strategy (default: false)
+MOCKSTACK__OPENAPI_DOCS_ENABLED = false
+
 # strategy-specific settings
 
 # base dir for all templates. Required by the 'filefixtures' strategy

{mockstack-0.14.1 → mockstack-0.14.2}/.github/workflows/smoke-test-pypi.yml

@@ -46,16 +46,18 @@ jobs:
         run: |
           set -euo pipefail
           mkdir -p /tmp/mockstack-templates
+          echo '{"message": "Hello from mockstack!"}' > /tmp/mockstack-templates/index.j2
           uvx mockstack --templates-dir /tmp/mockstack-templates --port 18999 \
             > server.log 2>&1 &
           SERVER_PID=$!
           echo "started mockstack pid=$SERVER_PID"
 
-          # Poll for readiness for up to 30s. /openapi.json is served by FastAPI
-          # itself, so a 200 here proves import + app construction + uvicorn boot
-          # + HTTP serving are all healthy end-to-end.
+          # Poll for readiness for up to 30s. GET / is rendered from index.j2 by the
+          # filefixtures strategy, so a 200 here proves import + app construction +
+          # uvicorn boot + request handling are all healthy end-to-end. (FastAPI's
+          # /openapi.json is off by default since mockstack 0.14.2.)
           for i in $(seq 1 30); do
-            if curl -fsS http://127.0.0.1:18999/openapi.json -o /dev/null; then
+            if curl -fsS http://127.0.0.1:18999/ -o /dev/null; then
               echo "ready after ${i}s"
               READY=1
               break
@@ -75,8 +77,15 @@ jobs:
             exit 1
           fi
 
-          # Final assertion + capture status
-          curl -fsS http://127.0.0.1:18999/openapi.json -o /dev/null
+          # Final assertion: the strategy rendered the template.
+          BODY=$(curl -fsS http://127.0.0.1:18999/)
+          echo "GET / -> $BODY"
+          if [ "$BODY" != '{"message": "Hello from mockstack!"}' ]; then
+            echo "unexpected response; logs:"
+            cat server.log
+            kill "$SERVER_PID" 2>/dev/null || true
+            exit 1
+          fi
           echo "smoke test passed"
 
           kill "$SERVER_PID" 2>/dev/null || true

{mockstack-0.14.1 → mockstack-0.14.2}/CLAUDE.md

@@ -32,7 +32,9 @@ CLI flags, `MOCKSTACK__*` environment variables, or a `.env` file.
 - `mockstack/templating.py`: Jinja environment and path-to-template-name resolution
 - `mockstack/intent.py`, `mockstack/identifiers.py`: POST intent (search, command,
   create) and path-identifier heuristics
-- `mockstack/routers/`: the catch-all route; every path, `/` included, reaches the strategy
+- `mockstack/routers/`: the catch-all route; every path, `/` included, reaches the strategy.
+  FastAPI's `/docs`, `/redoc`, `/openapi.json` and `/docs/oauth2-redirect` routes are
+  only registered, ahead of the catch-all, when `openapi_docs_enabled` is set
 - `mockstack/tests/`: unit tests; `conftest.py` holds fixtures shared by unit and live
   tests (`make_settings`, `make_request`, `write_rules`, `write_template`, `span`, and
   `asgi_client`, an httpx client that calls the `app` fixture in-process), and

{mockstack-0.14.1 → mockstack-0.14.2}/Dockerfile

@@ -2,7 +2,7 @@
 
 # Define build argument for version
 ARG PYTHON_IMAGE_VERSION=3.13-slim
-ARG MOCKSTACK_VERSION=0.14.1
+ARG MOCKSTACK_VERSION=0.14.2
 
 # ---------------------------- Base Image --------------------------------
 

{mockstack-0.14.1 → mockstack-0.14.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.14.1
+Version: 0.14.2
 Summary: An API mocking workhorse
 Author-email: Adam Ever-Hadani <mockstack.contact@gmail.com>
 License-Expression: MIT

{mockstack-0.14.1 → mockstack-0.14.2}/docs/configuration.md

@@ -22,6 +22,7 @@ options (`--opentelemetry.enabled`); boolean options are flags with a `--no-` fo
 | `debug` | boolean | `false` | Whether to run in debug mode |
 | `host` | string | `0.0.0.0` | Host to run the server on |
 | `port` | integer | `8000` | Port to run the server on |
+| `openapi_docs_enabled` | boolean | `false` | Whether to serve FastAPI's documentation routes: `/docs`, `/redoc`, `/openapi.json` and `/docs/oauth2-redirect`. They take precedence over the catch-all route and document only that route, so by default they are off and those paths reach the strategy like any other |
 | `strategy` | string | `filefixtures` | Strategy to use for handling requests. Options: `filefixtures`, `proxyrules` |
 
 ## OpenTelemetry Settings

{mockstack-0.14.1 → mockstack-0.14.2}/mockstack/config.py

@@ -55,6 +55,11 @@ class Settings(BaseSettings):
     # port to run the server on
     port: int = 8000
 
+    # whether to serve FastAPI's documentation routes (/docs, /redoc, /openapi.json and
+    # /docs/oauth2-redirect). They take precedence over the catch-all route, so they are
+    # off by default and those paths reach the strategy like any other.
+    openapi_docs_enabled: CliImplicitFlag[bool] = False
+
     # OpenTelemetry configuration
     opentelemetry: OpenTelemetrySettings = OpenTelemetrySettings()
 

{mockstack-0.14.1 → mockstack-0.14.2}/mockstack/main.py

@@ -19,7 +19,12 @@ def create_app(settings: Settings | None = None) -> FastAPI:
     """Create the fastapi app and bootstrap all dependencies."""
     settings = settings or settings_provider()
 
-    app = FastAPI(lifespan=lifespan_provider(settings))
+    # FastAPI adds its documentation routes ahead of the catch-all route; without an
+    # OpenAPI URL it adds none of them.
+    app = FastAPI(
+        lifespan=lifespan_provider(settings),
+        openapi_url="/openapi.json" if settings.openapi_docs_enabled else None,
+    )
 
     strategy_provider(app, settings)
     middleware_provider(app, settings)

{mockstack-0.14.1 → mockstack-0.14.2}/mockstack/tests/test_config.py

@@ -62,6 +62,30 @@ def test_filefixtures_without_templates_dir_names_the_right_strategy():
         Settings(strategy="filefixtures", templates_dir=None)
 
 
+def test_openapi_docs_enabled_defaults_to_off(make_settings, templates_dir):
+    assert make_settings(templates_dir=templates_dir).openapi_docs_enabled is False
+
+
+def test_openapi_docs_enabled_env_var(monkeypatch, templates_dir):
+    """``MOCKSTACK__OPENAPI_DOCS_ENABLED`` turns FastAPI's documentation routes on."""
+    monkeypatch.setenv("MOCKSTACK__OPENAPI_DOCS_ENABLED", "true")
+
+    assert Settings(templates_dir=templates_dir).openapi_docs_enabled is True
+
+
+def test_openapi_docs_enabled_cli_flag(templates_dir):
+    """``--openapi-docs-enabled`` turns the documentation routes on and its ``--no-`` form off."""
+    enabled = CliSettings(
+        _cli_parse_args=["--templates-dir", templates_dir, "--openapi-docs-enabled"]  # type: ignore[call-arg]
+    )
+    assert enabled.openapi_docs_enabled is True
+
+    disabled = CliSettings(
+        _cli_parse_args=["--templates-dir", templates_dir, "--no-openapi-docs-enabled"]  # type: ignore[call-arg]
+    )
+    assert disabled.openapi_docs_enabled is False
+
+
 def test_record_mode_defaults_to_off(make_settings, templates_dir):
     settings = make_settings(templates_dir=templates_dir)
     assert settings.proxyrules_record_mode == ProxyRulesRecordMode.OFF

mockstack-0.14.2/mockstack/tests/test_main.py

@@ -0,0 +1,61 @@
+"""Tests for the application factory."""
+
+import httpx
+import pytest
+
+from mockstack.main import create_app
+
+
+OPENAPI_DOCS_PATHS = ["/openapi.json", "/docs", "/docs/oauth2-redirect", "/redoc"]
+
+
+def _route_paths(app):
+    return {route.path for route in app.routes}
+
+
+@pytest.mark.asyncio
+async def test_create_app_routes_root_path_to_strategy(make_settings, write_template, tmp_path):
+    """``GET /`` reaches the strategy through the catch-all route: the app registers no
+    route of its own at the root path."""
+    write_template("index.j2", '{"message": "root fixture"}')
+    app = create_app(make_settings(strategy="filefixtures", templates_dir=tmp_path))
+
+    async with httpx.AsyncClient(transport=httpx.ASGITransport(app=app), base_url="http://testserver") as client:
+        response = await client.get("/")
+
+    assert response.status_code == 200
+    assert response.json() == {"message": "root fixture"}
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize("path", OPENAPI_DOCS_PATHS)
+async def test_create_app_passes_openapi_docs_paths_to_strategy_by_default(make_settings, tmp_path, path):
+    """FastAPI's documentation routes are off by default, so their paths reach the strategy
+    like any other: a filefixtures app with no templates answers them with its 404."""
+    app = create_app(make_settings(strategy="filefixtures", templates_dir=tmp_path))
+
+    assert not _route_paths(app) & set(OPENAPI_DOCS_PATHS)
+    async with httpx.AsyncClient(transport=httpx.ASGITransport(app=app), base_url="http://testserver") as client:
+        response = await client.get(path)
+
+    assert response.status_code == 404
+    assert response.json()["message"] == "mockstack: resource not found"
+
+
+@pytest.mark.asyncio
+async def test_create_app_serves_openapi_docs_when_enabled(make_settings, tmp_path):
+    """With ``openapi_docs_enabled`` FastAPI serves its documentation routes, ahead of the
+    catch-all route."""
+    app = create_app(make_settings(strategy="filefixtures", templates_dir=tmp_path, openapi_docs_enabled=True))
+
+    assert set(OPENAPI_DOCS_PATHS) <= _route_paths(app)
+    async with httpx.AsyncClient(transport=httpx.ASGITransport(app=app), base_url="http://testserver") as client:
+        docs = await client.get("/docs")
+        # FastAPI gives every method of one route the same operation ID, and says so.
+        with pytest.warns(UserWarning, match="Duplicate Operation ID"):
+            schema = await client.get("/openapi.json")
+
+    assert docs.status_code == 200
+    assert docs.headers["content-type"].startswith("text/html")
+    assert schema.status_code == 200
+    assert "/{full_path}" in schema.json()["paths"]

{mockstack-0.14.1 → mockstack-0.14.2}/mockstack.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.14.1
+Version: 0.14.2
 Summary: An API mocking workhorse
 Author-email: Adam Ever-Hadani <mockstack.contact@gmail.com>
 License-Expression: MIT

{mockstack-0.14.1 → mockstack-0.14.2}/mockstack.egg-info/scm_version.json

@@ -1,7 +1,7 @@
 {
-  "tag": "0.14.1",
+  "tag": "0.14.2",
   "distance": 0,
-  "node": "g6d3026d1e83dfcb152634ce3af4505beac16a54e",
+  "node": "g24d55a15eafcd996e27f2415d9911f4cdea0adf0",
   "dirty": false,
   "branch": "HEAD",
   "node_date": "2026-09-15"

mockstack-0.14.1/mockstack/tests/test_main.py

@@ -1,20 +0,0 @@
-"""Tests for the application factory."""
-
-import httpx
-import pytest
-
-from mockstack.main import create_app
-
-
-@pytest.mark.asyncio
-async def test_create_app_routes_root_path_to_strategy(make_settings, write_template, tmp_path):
-    """``GET /`` reaches the strategy through the catch-all route: the app registers no
-    route of its own at the root path."""
-    write_template("index.j2", '{"message": "root fixture"}')
-    app = create_app(make_settings(strategy="filefixtures", templates_dir=tmp_path))
-
-    async with httpx.AsyncClient(transport=httpx.ASGITransport(app=app), base_url="http://testserver") as client:
-        response = await client.get("/")
-
-    assert response.status_code == 200
-    assert response.json() == {"message": "root fixture"}