local-web-services-python-sdk 0.1.1__tar.gz → 0.1.2__tar.gz

{local_web_services_python_sdk-0.1.1 → local_web_services_python_sdk-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: local-web-services-python-sdk
-Version: 0.1.1
+Version: 0.1.2
 Summary: Python testing SDK for local-web-services — in-process pytest fixtures and boto3 helpers
 Project-URL: Homepage, https://local-web-services.github.io/www
 Project-URL: Repository, https://github.com/local-web-services/local-web-services-sdk-python

{local_web_services_python_sdk-0.1.1 → local_web_services_python_sdk-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "local-web-services-python-sdk"
-version = "0.1.1"
+version = "0.1.2"
 description = "Python testing SDK for local-web-services — in-process pytest fixtures and boto3 helpers"
 readme = "README.md"
 license = "MIT"

{local_web_services_python_sdk-0.1.1 → local_web_services_python_sdk-0.1.2}/src/lws_testing/session.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import asyncio
+import os
 import shutil
 import socket
 import tempfile
@@ -12,6 +13,26 @@ from contextlib import contextmanager
 from pathlib import Path
 from typing import Any
 
+# Maps boto3 service name → AWS SDK endpoint URL env var.
+# Setting these redirects *any* boto3 client created in the process to the
+# local LWS service — no production-code changes required.
+_SERVICE_ENV_VARS: dict[str, str] = {
+    "dynamodb": "AWS_ENDPOINT_URL_DYNAMODB",
+    "sqs": "AWS_ENDPOINT_URL_SQS",
+    "s3": "AWS_ENDPOINT_URL_S3",
+    "sns": "AWS_ENDPOINT_URL_SNS",
+    "stepfunctions": "AWS_ENDPOINT_URL_STEPFUNCTIONS",
+    "ssm": "AWS_ENDPOINT_URL_SSM",
+    "secretsmanager": "AWS_ENDPOINT_URL_SECRETSMANAGER",
+}
+
+# Credential / region overrides so boto3 never tries to contact IAM or STS.
+_TEST_CREDENTIALS: dict[str, str] = {
+    "AWS_ACCESS_KEY_ID": "test",
+    "AWS_SECRET_ACCESS_KEY": "test",
+    "AWS_DEFAULT_REGION": "us-east-1",
+}
+
 
 def _free_port() -> int:
     """Return a free ephemeral TCP port on localhost."""
@@ -70,6 +91,7 @@ class LwsSession:
         self._thread: threading.Thread | None = None
         self._data_dir: Path | None = None
         self._log_handler: Any = None
+        self._saved_env: dict[str, str | None] = {}
 
     # ── Constructors ──────────────────────────────────────────────────────────
 
@@ -139,6 +161,8 @@ class LwsSession:
             exc = error_holder[0]
             raise RuntimeError(f"LwsSession failed to start: {exc}") from exc
 
+        self._patch_env()
+
     async def _async_start(self, ready: threading.Event) -> None:
         """Create providers, build apps, start servers."""
         from lws_testing._transport.inprocess import start_services
@@ -150,6 +174,8 @@ class LwsSession:
 
     def _stop(self) -> None:
         """Stop all servers and clean up temporary state."""
+        self._restore_env()
+
         if self._loop and self._loop.is_running():
             future = asyncio.run_coroutine_threadsafe(self._async_stop(), self._loop)
             future.result(timeout=10)
@@ -167,6 +193,33 @@ class LwsSession:
 
         await stop_services(self._servers)
 
+    # ── Environment patching ──────────────────────────────────────────────────
+
+    def _patch_env(self) -> None:
+        """Set AWS SDK endpoint env vars so any boto3 client hits local LWS.
+
+        This is the drop-in mechanism: production code that creates boto3
+        clients the normal way (``boto3.client("dynamodb")``) is automatically
+        redirected to the local services without any code changes.
+        """
+        for service, env_var in _SERVICE_ENV_VARS.items():
+            port = self._ports.get(service)
+            if port:
+                self._saved_env[env_var] = os.environ.get(env_var)
+                os.environ[env_var] = f"http://127.0.0.1:{port}"
+        for key, val in _TEST_CREDENTIALS.items():
+            self._saved_env[key] = os.environ.get(key)
+            os.environ[key] = val
+
+    def _restore_env(self) -> None:
+        """Restore all env vars that were overridden by :meth:`_patch_env`."""
+        for key, saved in self._saved_env.items():
+            if saved is None:
+                os.environ.pop(key, None)
+            else:
+                os.environ[key] = saved
+        self._saved_env = {}
+
     # ── boto3 client factory ──────────────────────────────────────────────────
 
     def client(self, service: str) -> Any:
@@ -279,6 +332,15 @@ class LwsSession:
 
         return S3Helper(bucket_name, self.client("s3"))
 
+    def queue_url(self, queue_name: str) -> str:
+        """Return the local SQS URL for *queue_name*.
+
+        Use this to set the queue URL env var that production code reads::
+
+            os.environ["ORDER_QUEUE_URL"] = session.queue_url("OrderQueue")
+        """
+        return f"http://127.0.0.1:{self._ports['sqs']}/000000000000/{queue_name}"
+
     # ── Mock / chaos / IAM builders ───────────────────────────────────────────
 
     def mock(self, service: str) -> Any:

{local_web_services_python_sdk-0.1.1 → local_web_services_python_sdk-0.1.2}/tests/unit/test_session_lifecycle.py

@@ -103,3 +103,47 @@ def test_all_services_available(session):
     for svc in expected_services:
         client = session.client(svc)
         assert client is not None, f"Expected service {svc!r} to be available"
+
+
+def test_vanilla_boto3_client_is_redirected_to_lws(session):
+    # Arrange — env vars are set by the session; a plain boto3 client should
+    # hit LWS without any explicit endpoint_url
+    import boto3
+
+    # Act
+    vanilla_client = boto3.client("dynamodb", region_name="us-east-1")
+    response = vanilla_client.list_tables()
+
+    # Assert — LWS responded (real AWS would also return this key, but if the
+    # env var wasn't set the call would fail with NoCredentialsError or timeout)
+    assert "TableNames" in response
+
+
+def test_env_vars_are_restored_after_session_closes():
+    # Arrange — capture state before any session starts
+    import os
+
+    expected_key = "AWS_ENDPOINT_URL_DYNAMODB"
+    value_before = os.environ.get(expected_key)
+
+    # Act
+    with LwsSession(tables=[{"name": "Tmp", "partition_key": "id"}]):
+        actual_during = os.environ.get(expected_key)
+
+    actual_after = os.environ.get(expected_key)
+
+    # Assert
+    assert actual_during is not None, "Expected env var to be set during session"
+    assert actual_after == value_before, "Expected env var to be restored after session"
+
+
+def test_queue_url_returns_local_url(session):
+    # Arrange
+    expected_queue_name = "OrderQueue"
+
+    # Act
+    actual_url = session.queue_url(expected_queue_name)
+
+    # Assert
+    assert "127.0.0.1" in actual_url
+    assert expected_queue_name in actual_url