mockstack 0.4.0__tar.gz → 0.4.2__tar.gz

{mockstack-0.4.0/mockstack.egg-info → mockstack-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.4.0
+Version: 0.4.2
 Summary: An API mocking workhorse
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/adamhadani/mockstack
@@ -18,6 +18,7 @@ Requires-Dist: opentelemetry-instrumentation-fastapi>=0.53b1
 Requires-Dist: pydantic>=2.11.3
 Requires-Dist: pydantic-settings>=2.9.1
 Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=14.0.0
 Requires-Dist: typer>=0.15.2
 Requires-Dist: uvicorn>=0.34.2
 Dynamic: license-file
@@ -104,4 +105,6 @@ If you are contributing to development, you will want to clone this project, and
 
 Run in development mode (for live-reload of changes when developing):
 
-    uv run -- mockstack --debug
+    uv run uvicorn --factory mockstack.main:create_app --reload
+
+Note that when you run using the uvicorn CLI, you will need to set any configuration via `.env` file or environment variables.

{mockstack-0.4.0 → mockstack-0.4.2}/README.md

@@ -80,4 +80,6 @@ If you are contributing to development, you will want to clone this project, and
 
 Run in development mode (for live-reload of changes when developing):
 
-    uv run -- mockstack --debug
+    uv run uvicorn --factory mockstack.main:create_app --reload
+
+Note that when you run using the uvicorn CLI, you will need to set any configuration via `.env` file or environment variables.

{mockstack-0.4.0 → mockstack-0.4.2}/mockstack/config.py

@@ -103,10 +103,8 @@ class Settings(BaseSettings):
         },
         "handlers": {
             "console": {
-                "class": "logging.StreamHandler",
+                "class": "rich.logging.RichHandler",
                 "level": "INFO",
-                "formatter": "standard",
-                "stream": "ext://sys.stdout",
             },
         },
         "loggers": {
@@ -128,7 +126,7 @@ class Settings(BaseSettings):
         },
         "root": {
             "handlers": ["console"],
-            "level": "DEBUG",
+            "level": "NOTSET",
             "propagate": False,
         },
     }

mockstack-0.4.2/mockstack/display.py

@@ -0,0 +1,27 @@
+"""Display and logging functionality."""
+
+import logging
+
+from fastapi import FastAPI
+
+from mockstack.config import Settings
+
+
+def announce(app: FastAPI, settings: Settings):
+    """Log the startup message with the active settings."""
+    logger = logging.getLogger("uvicorn")
+    extra = {"markup": True}
+
+    logger.info(
+        f"[bold medium_purple]mockstack[/bold medium_purple] ready to roll. "
+        f"debug: [medium_purple]{settings.debug}[/medium_purple]. "
+        f"strategy: [medium_purple]{settings.strategy}[/medium_purple]. ",
+        extra=extra,
+    )
+    logger.info(str(app.state.strategy), extra=extra)
+    logger.info(
+        f"OpenTelemetry enabled: [medium_purple]{settings.opentelemetry.enabled}[/medium_purple], "
+        f"endpoint: [medium_purple]{settings.opentelemetry.endpoint}[/medium_purple], "
+        f"capture_response_body: [medium_purple]{settings.opentelemetry.capture_response_body}[/medium_purple]",
+        extra=extra,
+    )

{mockstack-0.4.0 → mockstack-0.4.2}/mockstack/intent.py

@@ -51,3 +51,18 @@ def looks_like_a_command(request: Request) -> bool:
             request.url.path.endswith("/execute"),
         )
     )
+
+
+def looks_like_a_create(request: Request) -> bool:
+    """Check if the request looks like a create.
+
+    This is a heuristic to try and identify cases where a POST
+    request is used for creating a new resource.
+
+    """
+    return any(
+        (
+            request.method == "POST",
+            request.url.path.endswith("/create"),
+        ),
+    )

mockstack-0.4.2/mockstack/middleware.py

@@ -0,0 +1,55 @@
+"""Middleware definitionsfor the mockstack app."""
+
+import time
+
+from fastapi import FastAPI, Request, Response
+from opentelemetry import trace
+from opentelemetry.propagate import extract
+
+from mockstack.config import Settings
+from mockstack.telemetry import extract_body, span_name_for
+
+
+def middleware_provider(app: FastAPI, settings: Settings) -> None:
+    """Instrument the middlewares to the mockstack app."""
+
+    @app.middleware("http")
+    async def add_process_time_header(request: Request, call_next):
+        start_time = time.time()
+        response = await call_next(request)
+        process_time = time.time() - start_time
+        response.headers["X-Process-Time"] = str(process_time)
+        return response
+
+    @app.middleware("http")
+    async def instrument_opentelemetry(request: Request, call_next):
+        tracer = trace.get_tracer(__name__)
+        ctx = extract(request.headers)
+        with tracer.start_as_current_span(span_name_for(request), context=ctx) as span:
+            span.set_attribute("http.method", request.method)
+            span.set_attribute("http.url", str(request.url))
+
+            response = await call_next(request)
+
+            span.set_attribute("http.status_code", response.status_code)
+
+            # Nb. persisting response body can hamper performance,
+            # expose sensitive / PII data, and / or may not be needed.
+            # it is therefore an opt-in setting.
+            if settings.opentelemetry.capture_response_body:
+                body = await extract_body(response)
+
+                # for semantics of payload collection see:
+                # https://github.com/open-telemetry/oteps/pull/234
+                span.set_attribute("http.response.body", body)
+
+                # recreate response with the same body since when consuming it to log it above
+                # we effectively "deplete" the iterator.
+                response = Response(
+                    content=body,
+                    status_code=response.status_code,
+                    headers=dict(response.headers),
+                    media_type=response.media_type,
+                )
+
+            return response

mockstack-0.4.2/mockstack/routers/catchall.py

@@ -0,0 +1,14 @@
+"""Routes for the mockstack app."""
+
+from fastapi import FastAPI, Request
+
+from mockstack.config import Settings
+
+
+def catchall_router_provider(app: FastAPI, settings: Settings) -> None:
+    """Create the catch-all routes for the mockstack app."""
+
+    @app.route("/{full_path:path}", methods=["GET", "PATCH", "POST", "PUT", "DELETE"])
+    async def catch_all(request: Request):
+        """Catch all requests and delegate to the strategy."""
+        return await app.state.strategy.apply(request)

{mockstack-0.4.0 → mockstack-0.4.2}/mockstack/strategies/filefixtures.py

@@ -8,7 +8,6 @@ from fastapi import HTTPException, Request, Response, status
 from jinja2 import Environment, FileSystemLoader
 
 from mockstack.config import Settings
-from mockstack.display import ANSIColors
 from mockstack.intent import (
     looks_like_a_command,
     looks_like_a_search,
@@ -39,12 +38,9 @@ class FileFixturesStrategy(BaseStrategy, CreateMixin):
         self.env = Environment(loader=FileSystemLoader(self.templates_dir))
 
     def __str__(self) -> str:
-        HIGHLIGHT = ANSIColors.HEADER
-        ENDC = ANSIColors.ENDC
-
         return (
-            f"{HIGHLIGHT}[filefixtures]{ENDC} "
-            f"templates_dir: {HIGHLIGHT}{self.templates_dir}{ENDC}. "
+            f"[medium_purple]filefixtures[/medium_purple] "
+            f"templates_dir: [medium_purple]{self.templates_dir}[/medium_purple]. "
         )
 
     async def apply(self, request: Request) -> Response:
@@ -85,6 +81,7 @@ class FileFixturesStrategy(BaseStrategy, CreateMixin):
                 request, status_code=status.HTTP_201_CREATED
             )
         else:
+            # simulate resource creation:
             return await self._create(
                 request,
                 env=self.env,

{mockstack-0.4.0 → mockstack-0.4.2}/mockstack/strategies/proxyrules.py

@@ -15,7 +15,7 @@ from starlette.datastructures import Headers
 
 from mockstack.config import Settings
 from mockstack.constants import ProxyRulesRedirectVia
-from mockstack.display import ANSIColors
+from mockstack.intent import looks_like_a_create
 from mockstack.strategies.base import BaseStrategy
 from mockstack.strategies.create_mixin import CreateMixin
 
@@ -69,14 +69,11 @@ class ProxyRulesStrategy(BaseStrategy, CreateMixin):
         self.env = Environment()
 
     def __str__(self) -> str:
-        HIGHLIGHT = ANSIColors.HEADER
-        ENDC = ANSIColors.ENDC
-
         return (
-            f"{HIGHLIGHT}[proxyrules]{ENDC} "
-            f"rules_filename: {HIGHLIGHT}{self.rules_filename}{ENDC}. "
-            f"redirect_via: {HIGHLIGHT}{self.proxyrules_redirect_via}{ENDC}. "
-            f"simulate_create_on_missing: {HIGHLIGHT}{self.proxyrules_simulate_create_on_missing}{ENDC}"
+            f"[medium_purple]proxyrules[/medium_purple] "
+            f"rules_filename: [medium_purple]{self.rules_filename}[/medium_purple]. "
+            f"redirect_via: [medium_purple]{self.proxyrules_redirect_via}[/medium_purple]. "
+            f"simulate_create_on_missing: [medium_purple]{self.proxyrules_simulate_create_on_missing}[/medium_purple]"
         )
 
     @cached_property
@@ -103,9 +100,12 @@ class ProxyRulesStrategy(BaseStrategy, CreateMixin):
             self.logger.warning(
                 f"No rule found for request: {request.method} {request.url.path}"
             )
-            if self.proxyrules_simulate_create_on_missing:
+
+            if self.proxyrules_simulate_create_on_missing and looks_like_a_create(
+                request
+            ):
                 self.logger.info(
-                    "Simulating resource creation for missing rule for {request.method} {request.url.path}"
+                    f"Simulating resource creation for missing rule for {request.method} {request.url.path}"
                 )
                 return await self._create(
                     request,
@@ -113,6 +113,7 @@ class ProxyRulesStrategy(BaseStrategy, CreateMixin):
                     created_resource_metadata=self.created_resource_metadata,
                 )
             else:
+                # no rule found and we are not simulating resource creation
                 return Response(status_code=status.HTTP_404_NOT_FOUND)
 
         url = rule.apply(request)
@@ -141,13 +142,13 @@ class ProxyRulesStrategy(BaseStrategy, CreateMixin):
     async def reverse_proxy(self, request: Request, url: str) -> Response:
         """Reverse proxy the request to the target URL."""
         async with httpx.AsyncClient() as client:
-            method = request.method
             request_content = await request.body()
+            request_headers = self.reverse_proxy_headers(request.headers, url=url)
             req = client.build_request(
-                method,
+                request.method,
                 url,
                 content=request_content,
-                headers=self.reverse_proxy_headers(request.headers, url=url),
+                headers=request_headers,
                 params=request.url.query,
             )
 

{mockstack-0.4.0 → mockstack-0.4.2}/mockstack/telemetry.py

@@ -8,6 +8,7 @@ from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExport
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from starlette.responses import StreamingResponse
 
 from mockstack.config import Settings
 
@@ -17,6 +18,24 @@ def span_name_for(request: Request) -> str:
     return f"{request.method.upper()} {request.url.path}"
 
 
+async def extract_body(response: StreamingResponse) -> str:
+    """Extract the body of a response."""
+
+    async def read_response_body(response: StreamingResponse) -> bytes:
+        """Helper function to read response body asynchronously into memory."""
+        body = b""
+        async for chunk in response.body_iterator:
+            if isinstance(chunk, str):
+                body += chunk.encode()
+            else:
+                body += chunk
+        return body
+
+    body = await read_response_body(response)
+
+    return body.decode()
+
+
 def opentelemetry_provider(app: FastAPI, settings: Settings) -> None:
     """Initialize OpenTelemetry for the mockstack app."""
     if not settings.opentelemetry.enabled:

{mockstack-0.4.0 → mockstack-0.4.2}/mockstack/tests/test_display.py

@@ -2,20 +2,7 @@
 
 from unittest.mock import patch
 
-from mockstack.display import ANSIColors, announce
-
-
-def test_ansicolors_constants():
-    """Test that ANSIColors constants are defined correctly."""
-    assert ANSIColors.HEADER == "\033[95m"
-    assert ANSIColors.OKBLUE == "\033[94m"
-    assert ANSIColors.OKCYAN == "\033[96m"
-    assert ANSIColors.OKGREEN == "\033[92m"
-    assert ANSIColors.WARNING == "\033[93m"
-    assert ANSIColors.FAIL == "\033[91m"
-    assert ANSIColors.ENDC == "\033[0m"
-    assert ANSIColors.BOLD == "\033[1m"
-    assert ANSIColors.UNDERLINE == "\033[4m"
+from mockstack.display import announce
 
 
 def test_announce(app, settings):

{mockstack-0.4.0 → mockstack-0.4.2/mockstack.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.4.0
+Version: 0.4.2
 Summary: An API mocking workhorse
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/adamhadani/mockstack
@@ -18,6 +18,7 @@ Requires-Dist: opentelemetry-instrumentation-fastapi>=0.53b1
 Requires-Dist: pydantic>=2.11.3
 Requires-Dist: pydantic-settings>=2.9.1
 Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=14.0.0
 Requires-Dist: typer>=0.15.2
 Requires-Dist: uvicorn>=0.34.2
 Dynamic: license-file
@@ -104,4 +105,6 @@ If you are contributing to development, you will want to clone this project, and
 
 Run in development mode (for live-reload of changes when developing):
 
-    uv run -- mockstack --debug
+    uv run uvicorn --factory mockstack.main:create_app --reload
+
+Note that when you run using the uvicorn CLI, you will need to set any configuration via `.env` file or environment variables.

{mockstack-0.4.0 → mockstack-0.4.2}/mockstack.egg-info/requires.txt

@@ -7,5 +7,6 @@ opentelemetry-instrumentation-fastapi>=0.53b1
 pydantic>=2.11.3
 pydantic-settings>=2.9.1
 pyyaml>=6.0.2
+rich>=14.0.0
 typer>=0.15.2
 uvicorn>=0.34.2

{mockstack-0.4.0 → mockstack-0.4.2}/pyproject.toml

@@ -20,6 +20,7 @@ dependencies = [
     "pydantic>=2.11.3",
     "pydantic-settings>=2.9.1",
     "pyyaml>=6.0.2",
+    "rich>=14.0.0",
     "typer>=0.15.2",
     "uvicorn>=0.34.2",
 ]