mockstack 0.5.0__tar.gz → 0.5.2__tar.gz

{mockstack-0.5.0 → mockstack-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.5.0
+Version: 0.5.2
 Summary: An API mocking workhorse
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/adamhadani/mockstack

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/display.py

@@ -20,8 +20,8 @@ def announce(app: FastAPI, settings: Settings):
     )
     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"[medium_purple]OpenTelemetry[/medium_purple] enabled: [medium_purple]{settings.opentelemetry.enabled}[/medium_purple],\n "
+        f"endpoint: [medium_purple]{settings.opentelemetry.endpoint}[/medium_purple],\n "
         f"capture_response_body: [medium_purple]{settings.opentelemetry.capture_response_body}[/medium_purple]",
         extra=extra,
     )

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/middleware.py

@@ -36,6 +36,11 @@ def middleware_provider(app: FastAPI, settings: Settings) -> None:
                 request, span, sensitive_headers=SENSITIVE_HEADERS
             )
 
+            # Make the current opentelemetry span available to the request.
+            # This is useful for strategies that need to add custom attributes
+            # to the span associated with the request.
+            request.state.span = span
+
             response = await call_next(request)
 
             span = with_response_attributes(

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/strategies/base.py

@@ -17,3 +17,12 @@ class BaseStrategy(ABC):
     async def apply(self, request: Request) -> Response:
         """Apply the strategy to the request and response."""
         pass
+
+    def update_opentelemetry(self, request: Request, *args, **kwargs) -> None:
+        """Update the opentelemetry span with strategy-specific attributes.
+
+        A span is made available on `request.state.span` to use.
+        When OpenTelemetry is not enabled, this span will exist but will not be reported.
+
+        """
+        pass

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/strategies/create_mixin.py

@@ -2,6 +2,7 @@
 
 from datetime import datetime, timezone
 from uuid import uuid4
+import json
 
 from fastapi import Request, Response, status
 from fastapi.responses import JSONResponse
@@ -16,6 +17,9 @@ class CreateMixin:
     async def _create(
         self, request: Request, *, env: Environment, created_resource_metadata: dict
     ) -> Response:
+        """Simulate creation of a resource."""
+        self._create_mixin_update_opentelemetry(request, created_resource_metadata)
+
         if wants_json(request):
             # We return a 201 CREATED response with the resource as the body,
             # potentially injecting the resource ID into the response.
@@ -79,3 +83,13 @@ class CreateMixin:
             "uuid4": uuid4,
             "request": request,
         }
+
+    def _create_mixin_update_opentelemetry(
+        self, request: Request, created_resource_metadata: dict
+    ) -> None:
+        """Update the opentelemetry span with the create mixin details."""
+        span = request.state.span
+        span.set_attribute(
+            "mockstack.create_mixin.created_resource_metadata",
+            json.dumps(created_resource_metadata),
+        )

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/strategies/filefixtures.py

@@ -39,7 +39,7 @@ class FileFixturesStrategy(BaseStrategy, CreateMixin):
 
     def __str__(self) -> str:
         return (
-            f"[medium_purple]filefixtures[/medium_purple] "
+            f"[medium_purple]filefixtures[/medium_purple]\n "
             f"templates_dir: [medium_purple]{self.templates_dir}[/medium_purple]. "
         )
 
@@ -129,6 +129,7 @@ class FileFixturesStrategy(BaseStrategy, CreateMixin):
                 continue
 
             self.logger.debug("Found template filename: %s", filename)
+            self.update_opentelemetry(request, template_args)
             template = self.env.get_template(template_args["name"])
 
             return Response(
@@ -149,3 +150,11 @@ class FileFixturesStrategy(BaseStrategy, CreateMixin):
             status_code=status.HTTP_404_NOT_FOUND,
         )
         """
+
+    def update_opentelemetry(self, request: Request, template_args: dict) -> None:
+        """Update the opentelemetry span with the file fixtures details."""
+        span = request.state.span
+
+        span.set_attribute(
+            "mockstack.filefixtures.template_name", template_args["name"]
+        )

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/strategies/proxyrules.py

@@ -23,10 +23,17 @@ from mockstack.strategies.create_mixin import CreateMixin
 class Rule:
     """A rule for the proxy rules strategy."""
 
-    def __init__(self, pattern: str, replacement: str, method: str | None = None):
+    def __init__(
+        self,
+        pattern: str,
+        replacement: str,
+        method: str | None = None,
+        name: str | None = None,
+    ):
         self.pattern = pattern
         self.replacement = replacement
         self.method = method
+        self.name = name
 
     @classmethod
     def from_dict(cls, data: dict[str, str]) -> Self:
@@ -34,6 +41,7 @@ class Rule:
             pattern=data["pattern"],
             replacement=data["replacement"],
             method=data.get("method", None),
+            name=data.get("name", None),
         )
 
     def matches(self, request: Request) -> bool:
@@ -69,10 +77,11 @@ class ProxyRulesStrategy(BaseStrategy, CreateMixin):
 
     def __str__(self) -> str:
         return (
-            f"[medium_purple]proxyrules[/medium_purple] "
-            f"rules_filename: [medium_purple]{self.rules_filename}[/medium_purple]. "
-            f"redirect_via: [medium_purple]{self.redirect_via}[/medium_purple]. "
-            f"simulate_create_on_missing: [medium_purple]{self.simulate_create_on_missing}[/medium_purple]"
+            f"[medium_purple]proxyrules[/medium_purple]\n "
+            f"rules_filename: {self.rules_filename}.\n "
+            f"redirect_via: [medium_purple]{self.redirect_via}[/medium_purple].\n "
+            f"simulate_create_on_missing: {self.simulate_create_on_missing}.\n "
+            f"reverse_proxy_timeout: {self.reverse_proxy_timeout}"
         )
 
     @cached_property
@@ -115,6 +124,7 @@ class ProxyRulesStrategy(BaseStrategy, CreateMixin):
 
         url = rule.apply(request)
         self.logger.info(f"Redirecting to: {url}")
+        self.update_opentelemetry(request, rule, url)
 
         match self.redirect_via:
             case ProxyRulesRedirectVia.HTTP_TEMPORARY_REDIRECT:
@@ -165,3 +175,15 @@ class ProxyRulesStrategy(BaseStrategy, CreateMixin):
         _headers["host"] = urlparse(url).netloc
 
         return _headers
+
+    def update_opentelemetry(self, request: Request, rule: Rule, url: str) -> None:
+        """Update the opentelemetry span with the proxy rules rule details."""
+        span = request.state.span
+        if rule.name is not None:
+            span.set_attribute("mockstack.proxyrules.rule_name", rule.name)
+        if rule.method is not None:
+            span.set_attribute("mockstack.proxyrules.rule_method", rule.method)
+
+        span.set_attribute("mockstack.proxyrules.rule_pattern", rule.pattern)
+        span.set_attribute("mockstack.proxyrules.rule_replacement", rule.replacement)
+        span.set_attribute("mockstack.proxyrules.rewritten_url", url)

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/tests/conftest.py

@@ -1,6 +1,7 @@
 """Shared fixtures for the unit-tests."""
 
 import os
+from unittest.mock import MagicMock
 
 import pytest
 from fastapi import FastAPI
@@ -11,10 +12,19 @@ from mockstack.strategies.filefixtures import FileFixturesStrategy
 
 
 @pytest.fixture
-def app(settings):
+def span():
+    """Create a mock span object for testing."""
+    span = MagicMock()
+    span.set_attribute = MagicMock()
+    return span
+
+
+@pytest.fixture
+def app(settings, span):
     """Create a FastAPI app for testing."""
     app = FastAPI()
     app.state.strategy = FileFixturesStrategy(settings)
+    app.state.span = span
     return app
 
 

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/tests/strategies/test_filefixtures.py

@@ -18,7 +18,7 @@ def test_filefixtures_strategy_init(settings):
 
 
 @pytest.mark.asyncio
-async def test_filefixtures_strategy_apply(settings):
+async def test_filefixtures_strategy_apply(settings, span):
     """Test the FileFixturesStrategy apply method."""
     strategy = FileFixturesStrategy(settings)
     request = Request(
@@ -30,6 +30,7 @@ async def test_filefixtures_strategy_apply(settings):
             "headers": [],
         }
     )
+    request.state.span = span
 
     with pytest.raises(HTTPException) as exc_info:
         await strategy.apply(request)
@@ -38,7 +39,7 @@ async def test_filefixtures_strategy_apply(settings):
 
 
 @pytest.mark.asyncio
-async def test_file_fixtures_strategy_apply_success(settings):
+async def test_file_fixtures_strategy_apply_success(settings, span):
     """Test the FileFixturesStrategy apply method when template exists."""
     # Setup
     strategy = FileFixturesStrategy(settings)
@@ -61,6 +62,7 @@ async def test_file_fixtures_strategy_apply_success(settings):
                 "headers": [],
             }
         )
+        request.state.span = span
 
         # Execute
         response = await strategy.apply(request)
@@ -72,7 +74,7 @@ async def test_file_fixtures_strategy_apply_success(settings):
 
 
 @pytest.mark.asyncio
-async def test_file_fixtures_strategy_apply_template_not_found(settings):
+async def test_file_fixtures_strategy_apply_template_not_found(settings, span):
     """Test the FileFixturesStrategy apply method when template doesn't exist."""
     # Setup
     strategy = FileFixturesStrategy(settings)
@@ -88,6 +90,7 @@ async def test_file_fixtures_strategy_apply_template_not_found(settings):
                 "headers": [],
             }
         )
+        request.state.span = span
 
         # Execute and Assert
         with pytest.raises(HTTPException) as exc_info:

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/tests/strategies/test_proxyrules.py

@@ -124,7 +124,7 @@ def test_proxy_rules_strategy_load_rules(settings):
     assert all(isinstance(rule, Rule) for rule in rules)
 
 
-def test_proxy_rules_strategy_rule_for(settings):
+def test_proxy_rules_strategy_rule_for(settings, span):
     """Test finding a matching rule for a request."""
     strategy = ProxyRulesStrategy(settings)
     request = Request(
@@ -136,12 +136,13 @@ def test_proxy_rules_strategy_rule_for(settings):
             "headers": [],
         }
     )
+    request.state.span = span
     rule = strategy.rule_for(request)
     assert rule is not None
     assert isinstance(rule, Rule)
 
 
-def test_proxy_rules_strategy_rule_for_no_match(settings):
+def test_proxy_rules_strategy_rule_for_no_match(settings, span):
     """Test when no rule matches a request."""
     strategy = ProxyRulesStrategy(settings)
     request = Request(
@@ -153,12 +154,13 @@ def test_proxy_rules_strategy_rule_for_no_match(settings):
             "headers": [],
         }
     )
+    request.state.span = span
     rule = strategy.rule_for(request)
     assert rule is None
 
 
 @pytest.mark.asyncio
-async def test_proxy_rules_strategy_apply(settings):
+async def test_proxy_rules_strategy_apply(settings, span):
     """Test applying a rule to a request."""
     strategy = ProxyRulesStrategy(settings)
     request = Request(
@@ -170,13 +172,14 @@ async def test_proxy_rules_strategy_apply(settings):
             "headers": [],
         }
     )
+    request.state.span = span
     response = await strategy.apply(request)
     assert isinstance(response, RedirectResponse)
     assert response.headers["location"] == "/projects/123"
 
 
 @pytest.mark.asyncio
-async def test_proxy_rules_strategy_apply_no_match(settings):
+async def test_proxy_rules_strategy_apply_no_match(settings, span):
     """Test applying strategy when no rule matches."""
     strategy = ProxyRulesStrategy(settings)
     request = Request(
@@ -188,13 +191,14 @@ async def test_proxy_rules_strategy_apply_no_match(settings):
             "headers": [],
         }
     )
+    request.state.span = span
     response = await strategy.apply(request)
     assert response.status_code == 404
 
 
 @pytest.mark.asyncio
 @pytest.mark.skip(reason="TODO: Fix this test")
-async def test_proxy_rules_strategy_apply_reverse_proxy(settings_reverse_proxy):
+async def test_proxy_rules_strategy_apply_reverse_proxy(settings_reverse_proxy, span):
     """Test applying a rule to a request with reverse proxy enabled."""
     # Mock the httpx.AsyncClient to avoid making real HTTP requests
     mock_response = MagicMock()  # Use MagicMock for response to avoid async attributes
@@ -218,6 +222,7 @@ async def test_proxy_rules_strategy_apply_reverse_proxy(settings_reverse_proxy):
                 "headers": [("host", "example.com")],
             }
         )
+        request.state.span = span
         response = await strategy.apply(request)
 
         # Verify the response

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack/tests/test_display.py

@@ -17,4 +17,4 @@ def test_announce(app, settings):
 
         # Check that the log message contains the expected information
         first_log_message = mock_logger.info.call_args[0][0]
-        assert "OpenTelemetry enabled:" in first_log_message
+        assert "OpenTelemetry" in first_log_message

{mockstack-0.5.0 → mockstack-0.5.2}/mockstack.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.5.0
+Version: 0.5.2
 Summary: An API mocking workhorse
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/adamhadani/mockstack