sefrone-api-e2e 1.3.6__tar.gz → 1.3.7__tar.gz

{sefrone_api_e2e-1.3.6 → sefrone_api_e2e-1.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sefrone_api_e2e
-Version: 1.3.6
+Version: 1.3.7
 Summary: A Python package to provide e2e testing helpers for sefrone API projects
 Home-page: https://bitbucket.org/sefrone/sefrone_pypi
 Author: Sefrone
@@ -12,6 +12,7 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 Requires-Dist: PyYAML>=6.0.1
 Requires-Dist: requests
+Requires-Dist: openpyxl>=3.1.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{sefrone_api_e2e-1.3.6 → sefrone_api_e2e-1.3.7}/sefrone_api_e2e/__init__.py

@@ -6,6 +6,7 @@ from .runner_webhook_mock import WebhookMockRunner
 from .runner_assets import AssetsRunner
 from .runner_satim_mock import SatimMockRunner
 from .runner_csv import CsvRunner
+from .runner_excel import ExcelRunner
 from .json_mock_server import JsonMockServer
 from .e2e_scenarios_manager import E2EScenariosManager
 
@@ -21,6 +22,7 @@ __all__ = [
     "AssetsRunner",
     "SatimMockRunner",
     "CsvRunner",
+    "ExcelRunner",
     "JsonMockServer",
     "E2EScenariosManager",
 ]

{sefrone_api_e2e-1.3.6 → sefrone_api_e2e-1.3.7}/sefrone_api_e2e/api_e2e_manager.py

@@ -14,6 +14,7 @@ from .step_runner import StepRunner, RunContext
 from .runner_rest_api import RestApiRunner
 from .runner_assets import AssetsRunner
 from .runner_csv import CsvRunner
+from .runner_excel import ExcelRunner
 
 
 class ScenarioSkippedException(Exception):
@@ -42,11 +43,12 @@ class ApiE2ETestsManager:
         ApiE2ETestsManager.global_store = {}
         ApiE2ETestsManager.scenario_results = []
 
-        # RestApiRunner (default), AssetsRunner and CsvRunner are stateless/self-contained
-        # (no external config needed), so they're always available without callers having to
-        # construct and pass them in. Runners that need caller-supplied config (mail/webhook
-        # mocks, etc.) still come in through the `runners` param.
-        active_runners: List[StepRunner] = [RestApiRunner(), AssetsRunner(), CsvRunner()]
+        # RestApiRunner (default), AssetsRunner, CsvRunner and ExcelRunner are
+        # stateless/self-contained (no external config needed), so they're always
+        # available without callers having to construct and pass them in. Runners
+        # that need caller-supplied config (mail/webhook mocks, etc.) still come in
+        # through the `runners` param.
+        active_runners: List[StepRunner] = [RestApiRunner(), AssetsRunner(), CsvRunner(), ExcelRunner()]
         if runners:
             # make sure to distinct on runner name
             active_runners.extend(runners)

sefrone_api_e2e-1.3.7/sefrone_api_e2e/runner_excel.py

@@ -0,0 +1,215 @@
+import datetime
+import os
+from typing import Any, Dict, List, Set
+
+from openpyxl import Workbook, load_workbook
+
+from .step_runner import StepRunner, RunContext, StepResult
+
+
+class ExcelRunner(StepRunner):
+    """
+    Runner for generating and reading .xlsx files during scenario execution, so a
+    batch-upload fixture (e.g. a tenant import file) can be built with values tied
+    to the scenario's own dynamically-created data (workspace, register, etc.)
+    instead of relying on a static file that silently drifts out of sync with
+    whatever the setup steps actually created, and so a downloaded/generated
+    workbook can be asserted on by structured row/column content.
+
+    This runner never makes HTTP requests itself -- pair a normal HTTP step's
+    ``files:`` upload (already supported by the default rest runner) with a
+    ``generate`` step to build the fixture first, or pair a ``save_file:``
+    download with a ``read`` step to assert on what came back.
+
+    Step syntax — generate (write an .xlsx fixture with specific content)::
+
+        - name: "Generate tenant batch fixture"
+          runner: excel
+          excel:
+            action: generate
+            path: "./e2e/tmp/tenants_batch_{$stored.seed_id}.xlsx"
+            sheet_name: "Tenants"                # optional, default: "Sheet1"
+            headers: ["wilaya", "code caisse", "matricule locataire", "nom"]
+            rows:
+              - ["Alger", "{$stored.register_number}", "E2E-{$stored.seed_id}-001", "Benali"]
+
+    Step syntax — read (parse an existing/just-downloaded .xlsx file)::
+
+        - name: "Verify exported workbook content"
+          runner: excel
+          excel:
+            action: read              # optional, default: read
+            path: "./e2e/tmp/export_{$stored.seed_id}.xlsx"
+            sheet_name: "Tenants"     # optional, defaults to the first sheet
+          assertions:
+            - "{{excel.row_count}} == 3"
+            - "{{excel.headers}} include 'code caisse'"
+            - "{{excel.rows[0].nom}} == 'Benali'"
+          save:
+            first_row_name: "{{excel.rows[0].nom}}"
+
+    ``excel.rows`` in the read context is a list of dicts keyed by header name
+    (e.g. ``{{excel.rows[0].nom}}``); ``excel.raw_rows`` is the same data as
+    plain lists (positional access) for files with duplicate/blank headers.
+    Every cell value is read back as a **string** (matching CsvRunner), so
+    compare numeric-looking values against a quoted literal (``== '500'``, not
+    ``== 500``). Runner-generated files are removed during teardown, matching
+    AssetsRunner/CsvRunner; files a ``read`` step merely reads (e.g. ones saved
+    by an HTTP step) are left alone since this runner doesn't own them.
+    """
+
+    def __init__(self):
+        self._generated_paths: Set[str] = set()
+
+    @property
+    def name(self) -> str:
+        return "excel"
+
+    def handles(self, step: dict) -> bool:
+        return "excel" in step and "method" not in step
+
+    def execute(self, step: dict, ctx: RunContext) -> StepResult:
+        try:
+            spec = step.get("excel")
+            if not isinstance(spec, dict):
+                return StepResult.failed("excel step requires an 'excel' object")
+
+            action = str(spec.get("action", "read")).strip().lower()
+
+            if action == "read":
+                return self._read(step, spec, ctx)
+            if action == "generate":
+                return self._generate(spec, ctx)
+
+            return StepResult.failed(f"Unsupported excel action: '{action}'. Supported: 'read', 'generate'")
+        except AssertionError as e:
+            return StepResult.failed(str(e))
+        except Exception as e:
+            return StepResult.failed(str(e))
+
+    def teardown(self) -> None:
+        for path in list(self._generated_paths):
+            try:
+                os.remove(path)
+                print(f"[excel] Removed: {path}")
+            except FileNotFoundError:
+                pass
+            except Exception as e:
+                print(f"[excel] Failed removing '{path}': {e}")
+        self._generated_paths.clear()
+
+    # ------------------------------------------------------------------ #
+    #  read
+    # ------------------------------------------------------------------ #
+
+    def _read(self, step: dict, spec: Dict[str, Any], ctx: RunContext) -> StepResult:
+        path = spec.get("path")
+        if not isinstance(path, str) or not path.strip():
+            return StepResult.failed("excel.path is required and must be a non-empty string")
+
+        resolved_path = os.path.normpath(ctx.substitute_stored(path))
+
+        if not os.path.exists(resolved_path):
+            return StepResult.failed(f"excel file not found: '{resolved_path}'")
+
+        sheet_name = spec.get("sheet_name")
+        workbook = load_workbook(filename=resolved_path, read_only=True, data_only=True)
+        try:
+            worksheet = workbook[ctx.substitute_stored(sheet_name)] if sheet_name else workbook.worksheets[0]
+            all_rows = [
+                [self._cell_to_str(cell) for cell in row]
+                for row in worksheet.iter_rows(values_only=True)
+            ]
+        finally:
+            workbook.close()
+
+        if not all_rows:
+            headers: List[str] = []
+            raw_rows: List[List[str]] = []
+        else:
+            headers, raw_rows = all_rows[0], all_rows[1:]
+
+        row_dicts = [dict(zip(headers, row)) for row in raw_rows]
+
+        template_context: Dict[str, Any] = {
+            "excel": {
+                "headers": headers,
+                "rows": row_dicts,
+                "raw_rows": raw_rows,
+                "row_count": len(row_dicts),
+            }
+        }
+
+        if "assertions" in step:
+            for expr in step["assertions"]:
+                try:
+                    rendered_expr = ctx.substitute_stored(expr)
+                    rendered = ctx.render_template(rendered_expr, template_context, add_quotes=True)
+                    ctx.try_eval(rendered, rendered_expr)
+                except Exception as e:
+                    raise AssertionError(f"Assertion failed for expression\n    -->'{expr}'\n    -->{e}")
+
+        if "save" in step:
+            for key, path_expr in step["save"].items():
+                rendered_path = ctx.substitute_stored(str(path_expr))
+                rendered = ctx.render_template(rendered_path, template_context)
+                ctx.store_value(key, rendered)
+
+        return StepResult.passed()
+
+    # ------------------------------------------------------------------ #
+    #  generate
+    # ------------------------------------------------------------------ #
+
+    def _generate(self, spec: Dict[str, Any], ctx: RunContext) -> StepResult:
+        path = spec.get("path")
+        headers = spec.get("headers")
+        rows = spec.get("rows", [])
+        sheet_name = spec.get("sheet_name", "Sheet1")
+
+        if not isinstance(path, str) or not path.strip():
+            return StepResult.failed("excel.path is required and must be a non-empty string")
+        if not isinstance(headers, list) or not headers:
+            return StepResult.failed("excel.headers is required and must be a non-empty list")
+        if not isinstance(rows, list):
+            return StepResult.failed("excel.rows must be a list of row lists")
+
+        resolved_path = os.path.normpath(ctx.substitute_stored(path))
+        parent_dir = os.path.dirname(resolved_path)
+        if parent_dir:
+            os.makedirs(parent_dir, exist_ok=True)
+
+        resolved_headers = [ctx.substitute_stored(str(h)) for h in headers]
+        resolved_rows = [[ctx.substitute_stored(str(cell)) for cell in row] for row in rows]
+
+        workbook = Workbook()
+        worksheet = workbook.active
+        worksheet.title = ctx.substitute_stored(str(sheet_name))
+        worksheet.append(resolved_headers)
+        for row in resolved_rows:
+            worksheet.append(row)
+        workbook.save(resolved_path)
+
+        self._generated_paths.add(resolved_path)
+        print(f"[excel] Generated: {resolved_path} ({len(resolved_rows)} row(s))")
+        return StepResult.passed()
+
+    # ------------------------------------------------------------------ #
+    #  helpers
+    # ------------------------------------------------------------------ #
+
+    @staticmethod
+    def _cell_to_str(value: Any) -> str:
+        if value is None:
+            return ""
+        if isinstance(value, bool):
+            return str(value)
+        if isinstance(value, float):
+            # Avoid scientific notation / trailing ".0" for integral values, mirroring
+            # how the .NET ExcelFileParser formats numeric cells on the reading side.
+            if value.is_integer():
+                return str(int(value))
+            return repr(value)
+        if isinstance(value, (datetime.datetime, datetime.date)):
+            return value.isoformat()
+        return str(value).strip()

{sefrone_api_e2e-1.3.6 → sefrone_api_e2e-1.3.7}/sefrone_api_e2e.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sefrone_api_e2e
-Version: 1.3.6
+Version: 1.3.7
 Summary: A Python package to provide e2e testing helpers for sefrone API projects
 Home-page: https://bitbucket.org/sefrone/sefrone_pypi
 Author: Sefrone
@@ -12,6 +12,7 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 Requires-Dist: PyYAML>=6.0.1
 Requires-Dist: requests
+Requires-Dist: openpyxl>=3.1.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{sefrone_api_e2e-1.3.6 → sefrone_api_e2e-1.3.7}/sefrone_api_e2e.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ sefrone_api_e2e/json_mock_server.py
 sefrone_api_e2e/runner_assets.py
 sefrone_api_e2e/runner_csv.py
 sefrone_api_e2e/runner_email_mock.py
+sefrone_api_e2e/runner_excel.py
 sefrone_api_e2e/runner_rest_api.py
 sefrone_api_e2e/runner_satim_mock.py
 sefrone_api_e2e/runner_webhook_mock.py

{sefrone_api_e2e-1.3.6 → sefrone_api_e2e-1.3.7}/sefrone_api_e2e.egg-info/requires.txt

@@ -1,2 +1,3 @@
 PyYAML>=6.0.1
 requests
+openpyxl>=3.1.0

{sefrone_api_e2e-1.3.6 → sefrone_api_e2e-1.3.7}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="sefrone_api_e2e",
-    version="1.3.6",
+    version="1.3.7",
     author="Sefrone",
     author_email="contact@sefrone.com",
     description="A Python package to provide e2e testing helpers for sefrone API projects",
@@ -21,7 +21,8 @@ setup(
     python_requires=">=3.7",
     install_requires=[
         "PyYAML>=6.0.1",
-        "requests"
+        "requests",
+        "openpyxl>=3.1.0"
     ],
     package_data={
         "sefrone_api_e2e": ["e2e/Scenarios/Auth/*.yaml", "e2e/Scenarios/Oidc/*.yaml"]