sefrone-api-e2e 1.1.8__tar.gz → 1.2.0__tar.gz

{sefrone_api_e2e-1.1.8 → sefrone_api_e2e-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sefrone_api_e2e
-Version: 1.1.8
+Version: 1.2.0
 Summary: A Python package to provide e2e testing helpers for sefrone API projects
 Home-page: https://bitbucket.org/sefrone/sefrone_pypi
 Author: Sefrone

sefrone_api_e2e-1.2.0/sefrone_api_e2e/env_patch.py

@@ -0,0 +1,77 @@
+import os
+from typing import Dict, Optional
+
+
+def apply_env_overrides(
+    env_file_path: str,
+    overrides: Dict[str, Optional[str]],
+    process_env_strategy: str = "none",
+) -> None:
+    """
+    Apply key/value overrides to a .env file.
+
+    - value is None: remove key from .env
+    - value is str: set/replace key in .env
+
+    process_env_strategy:
+      - "none": do not modify os.environ
+      - "sync": apply same set/unset semantics to os.environ
+      - "unset": remove every overridden key from os.environ
+    """
+    if process_env_strategy == "sync":
+        for key, val in overrides.items():
+            if val is None:
+                os.environ.pop(key, None)
+            else:
+                os.environ[key] = str(val)
+    elif process_env_strategy == "unset":
+        for key in overrides.keys():
+            os.environ.pop(key, None)
+
+    try:
+        with open(env_file_path, "r", encoding="utf-8") as f:
+            lines = f.readlines()
+    except FileNotFoundError:
+        lines = []
+
+    new_lines = []
+    replaced = set()
+
+    for line in lines:
+        stripped = line.strip()
+        if stripped.startswith("#") or "=" not in stripped:
+            new_lines.append(line)
+            continue
+
+        key = stripped.split("=", 1)[0].strip()
+        if key not in overrides:
+            new_lines.append(line)
+            continue
+
+        val = overrides[key]
+        if val is not None:
+            new_lines.append(f"{key}={val}\n")
+        replaced.add(key)
+
+    for key, val in overrides.items():
+        if key not in replaced and val is not None:
+            new_lines.append(f"{key}={val}\n")
+
+    with open(env_file_path, "w", encoding="utf-8") as f:
+        f.writelines(new_lines)
+
+
+def read_env_value(env_file_path: str, key: str) -> Optional[str]:
+    """Read one key from .env and strip optional surrounding quotes."""
+    try:
+        with open(env_file_path, "r", encoding="utf-8") as f:
+            for line in f:
+                stripped = line.strip()
+                if stripped.startswith("#") or "=" not in stripped:
+                    continue
+                k, _, v = stripped.partition("=")
+                if k.strip() == key:
+                    return v.strip().strip('"').strip("'")
+    except FileNotFoundError:
+        pass
+    return None

{sefrone_api_e2e-1.1.8 → sefrone_api_e2e-1.2.0}/sefrone_api_e2e/runner_email_mock.py

@@ -1,4 +1,3 @@
-import os
 import re
 import time
 from typing import Optional
@@ -6,6 +5,7 @@ from typing import Optional
 import requests
 
 from .step_runner import StepRunner, RunContext, StepResult
+from .env_patch import apply_env_overrides, read_env_value
 
 class EmailMockRunner(StepRunner):
     """
@@ -110,54 +110,25 @@ class EmailMockRunner(StepRunner):
         Variables with string values will be set to those values.
 
         Note: this also applies the same overrides to the current Python
-        process environment (os.environ). This is important because Docker
-        Compose resolves ${VAR} from the process env before reading .env.
+        process environment key space by unsetting every patched key. This
+        prevents Docker Compose from resolving stale ${VAR} values from the
+        process env before reading .env.
         """
         overrides = {
             **EmailMockRunner._ENV_OVERRIDES,
             "MAIL_SERVER": host,
             "MAIL_SERVER_PORT": str(smtp_port),
         }
-
-        # Keep process env in sync with file overrides so docker-compose
-        # interpolation does not pick stale MAIL_* values from OS env vars.
-        for key, val in overrides.items():
-            if val is None:
-                os.environ.pop(key, None)
-            else:
-                os.environ[key] = val
-
         try:
-            with open(env_file_path, "r", encoding="utf-8") as f:
-                lines = f.readlines()
-        except FileNotFoundError:
-            print(f"[WARN] env file not found for EmailMockRunner patch: {env_file_path}")
+            apply_env_overrides(
+                env_file_path=env_file_path,
+                overrides=overrides,
+                process_env_strategy="unset",
+            )
+        except Exception as e:
+            print(f"[WARN] env file patch failed for EmailMockRunner: {env_file_path} -> {e}")
             return
 
-        new_lines = []
-        replaced = set()
-        for line in lines:
-            stripped = line.strip()
-            if stripped.startswith("#") or "=" not in stripped:
-                new_lines.append(line)
-                continue
-            key = stripped.split("=", 1)[0].strip()
-            if key in overrides:
-                # If override value is None, skip (unset) this variable
-                if overrides[key] is not None:
-                    new_lines.append(f"{key}={overrides[key]}\n")
-                replaced.add(key)
-            else:
-                new_lines.append(line)
-
-        # Add any new overrides that weren't in the original file
-        for key, val in overrides.items():
-            if key not in replaced and val is not None:
-                new_lines.append(f"{key}={val}\n")
-
-        with open(env_file_path, "w", encoding="utf-8") as f:
-            f.writelines(new_lines)
-
         unset_vars = [k for k, v in EmailMockRunner._ENV_OVERRIDES.items() if v is None]
         print(f"[EmailMockRunner] Patched {env_file_path}:")
         print(f"  Set: MAIL_SERVER={host}:{smtp_port}, MAIL_USE_SECURITY=false")
@@ -435,15 +406,4 @@ class EmailMockRunner(StepRunner):
     @staticmethod
     def _read_env_value(env_file_path: str, key: str) -> Optional[str]:
         """Read a single key's value from a .env file, stripping surrounding quotes."""
-        try:
-            with open(env_file_path, "r", encoding="utf-8") as f:
-                for line in f:
-                    stripped = line.strip()
-                    if stripped.startswith("#") or "=" not in stripped:
-                        continue
-                    k, _, v = stripped.partition("=")
-                    if k.strip() == key:
-                        return v.strip().strip('"').strip("'")
-        except FileNotFoundError:
-            pass
-        return None
+        return read_env_value(env_file_path, key)

{sefrone_api_e2e-1.1.8 → sefrone_api_e2e-1.2.0}/sefrone_api_e2e/runner_satim_mock.py

@@ -1,4 +1,3 @@
-import json
 import os
 import re
 import time
@@ -7,6 +6,7 @@ from typing import Optional
 import requests
 
 from .step_runner import StepRunner, RunContext, StepResult
+from .env_patch import apply_env_overrides, read_env_value
 
 
 _SERVER_SCRIPT = r"""
@@ -338,45 +338,12 @@ class SatimMockRunner(StepRunner):
 
     @staticmethod
     def _patch_env_file(env_file_path: str, key: str, value: str) -> None:
-        try:
-            with open(env_file_path, "r", encoding="utf-8") as f:
-                lines = f.readlines()
-        except FileNotFoundError:
-            lines = []
-
-        new_lines = []
-        found = False
-        for line in lines:
-            stripped = line.strip()
-            if stripped.startswith("#") or "=" not in stripped:
-                new_lines.append(line)
-                continue
-            k = stripped.split("=", 1)[0].strip()
-            if k == key:
-                new_lines.append(f"{key}={value}\n")
-                found = True
-            else:
-                new_lines.append(line)
-
-        if not found:
-            if new_lines and not new_lines[-1].endswith("\n"):
-                new_lines[-1] = new_lines[-1] + "\n"
-            new_lines.append(f"{key}={value}\n")
-
-        with open(env_file_path, "w", encoding="utf-8") as f:
-            f.writelines(new_lines)
+        apply_env_overrides(
+            env_file_path=env_file_path,
+            overrides={key: value},
+            process_env_strategy="unset",
+        )
 
     @staticmethod
     def _read_env_value(env_file_path: str, key: str) -> Optional[str]:
-        try:
-            with open(env_file_path, "r", encoding="utf-8") as f:
-                for line in f:
-                    stripped = line.strip()
-                    if stripped.startswith("#") or "=" not in stripped:
-                        continue
-                    k, _, v = stripped.partition("=")
-                    if k.strip() == key:
-                        return v.strip()
-        except FileNotFoundError:
-            pass
-        return None
+        return read_env_value(env_file_path, key)

{sefrone_api_e2e-1.1.8 → sefrone_api_e2e-1.2.0}/sefrone_api_e2e/runner_webhook_mock.py

@@ -8,6 +8,7 @@ from typing import Optional
 import requests
 
 from .step_runner import StepRunner, RunContext, StepResult
+from .env_patch import apply_env_overrides, read_env_value
 
 
 # ---------------------------------------------------------------------------
@@ -498,49 +499,13 @@ class WebhookMockRunner(StepRunner):
 
     @staticmethod
     def _patch_env_file(env_file_path: str, key: str, value: str) -> None:
-        """Set or add a key=value line in the env file."""
-        try:
-            with open(env_file_path, "r", encoding="utf-8") as f:
-                lines = f.readlines()
-        except FileNotFoundError:
-            lines = []
-
-        new_lines = []
-        found = False
-        for line in lines:
-            stripped = line.strip()
-            if stripped.startswith("#") or "=" not in stripped:
-                new_lines.append(line)
-                continue
-            k = stripped.split("=", 1)[0].strip()
-            if k == key:
-                new_lines.append(f"{key}={value}\n")
-                found = True
-            else:
-                new_lines.append(line)
-
-        if not found:
-            # Ensure the previously copied last line ends with a newline,
-            # otherwise the new key gets concatenated and corrupts .env.
-            if new_lines and not new_lines[-1].endswith("\n"):
-                new_lines[-1] = new_lines[-1] + "\n"
-            new_lines.append(f"{key}={value}\n")
-
-        with open(env_file_path, "w", encoding="utf-8") as f:
-            f.writelines(new_lines)
+        apply_env_overrides(
+            env_file_path=env_file_path,
+            overrides={key: value},
+            process_env_strategy="unset",
+        )
 
     @staticmethod
     def _read_env_value(env_file_path: str, key: str) -> Optional[str]:
         """Read a single value from an env file."""
-        try:
-            with open(env_file_path, "r", encoding="utf-8") as f:
-                for line in f:
-                    stripped = line.strip()
-                    if stripped.startswith("#") or "=" not in stripped:
-                        continue
-                    k, _, v = stripped.partition("=")
-                    if k.strip() == key:
-                        return v.strip()
-        except FileNotFoundError:
-            pass
-        return None
+        return read_env_value(env_file_path, key)

{sefrone_api_e2e-1.1.8 → sefrone_api_e2e-1.2.0}/sefrone_api_e2e.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sefrone_api_e2e
-Version: 1.1.8
+Version: 1.2.0
 Summary: A Python package to provide e2e testing helpers for sefrone API projects
 Home-page: https://bitbucket.org/sefrone/sefrone_pypi
 Author: Sefrone

{sefrone_api_e2e-1.1.8 → sefrone_api_e2e-1.2.0}/sefrone_api_e2e.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ setup.py
 sefrone_api_e2e/__init__.py
 sefrone_api_e2e/api_e2e_manager.py
 sefrone_api_e2e/e2e_scenarios_manager.py
+sefrone_api_e2e/env_patch.py
 sefrone_api_e2e/json_mock_server.py
 sefrone_api_e2e/runner_assets.py
 sefrone_api_e2e/runner_email_mock.py

{sefrone_api_e2e-1.1.8 → sefrone_api_e2e-1.2.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="sefrone_api_e2e",
-    version="1.1.8",
+    version="1.2.0",
     author="Sefrone",
     author_email="contact@sefrone.com",
     description="A Python package to provide e2e testing helpers for sefrone API projects",