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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sefrone_api_e2e
-Version: 1.3.4
+Version: 1.3.6
 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.3.4 → sefrone_api_e2e-1.3.6}/sefrone_api_e2e/__init__.py

@@ -5,6 +5,7 @@ from .runner_email_mock import EmailMockRunner
 from .runner_webhook_mock import WebhookMockRunner
 from .runner_assets import AssetsRunner
 from .runner_satim_mock import SatimMockRunner
+from .runner_csv import CsvRunner
 from .json_mock_server import JsonMockServer
 from .e2e_scenarios_manager import E2EScenariosManager
 
@@ -19,6 +20,7 @@ __all__ = [
     "WebhookMockRunner",
     "AssetsRunner",
     "SatimMockRunner",
+    "CsvRunner",
     "JsonMockServer",
     "E2EScenariosManager",
 ]

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

@@ -10,9 +10,10 @@ import requests
 from pathlib import Path
 from typing import Any, Dict, List, Optional
 
-from .step_runner import StepRunner, RunContext, StepResult
+from .step_runner import StepRunner, RunContext
 from .runner_rest_api import RestApiRunner
-from .runner_email_mock import EmailMockRunner
+from .runner_assets import AssetsRunner
+from .runner_csv import CsvRunner
 
 
 class ScenarioSkippedException(Exception):
@@ -41,9 +42,22 @@ class ApiE2ETestsManager:
         ApiE2ETestsManager.global_store = {}
         ApiE2ETestsManager.scenario_results = []
 
-        active_runners: List[StepRunner] = [RestApiRunner()]
+        # 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()]
         if runners:
+            # make sure to distinct on runner name
             active_runners.extend(runners)
+            # distinct on runner name
+            seen = set()
+            unique_runners = []
+            for r in active_runners:
+                if r.name not in seen:
+                    seen.add(r.name)
+                    unique_runners.append(r)
+            active_runners = unique_runners
 
         default_runner = active_runners[0]
         extra_runners = active_runners[1:]
@@ -309,6 +323,7 @@ class ApiE2ETestsManager:
         type_map = {
             "string": str, "number": (int, float),
             "boolean": bool, "datetime": str,
+            "object": dict,
         }
         if base_type not in type_map:
             raise ValueError(f"Unknown type in YAML: {expected_type}")

sefrone_api_e2e-1.3.6/sefrone_api_e2e/e2e/Scenarios/Auth/9_project_account_access_control_flow.yaml

@@ -0,0 +1,337 @@
+name: "Project & Account Access Control Flow"
+skip_if:
+  - "Projects not in {$stored.0_check_features.enabled_features}"
+  - "Accounts not in {$stored.0_check_features.enabled_features}"
+base_url: "http://localhost:$var(API_PUBLIC_PORT)"
+steps:
+  - name: "Login root admin"
+    retry:
+      attempts: 10
+      delay_seconds: 5
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/login"
+    send_as: "json"
+    body:
+      device: "e2e_test_device"
+      pseudo: "$var(DEFAULT_USERNAME)"
+      password: "$var(DEFAULT_PASSWORD)"
+    expect:
+      status: 200
+      body:
+        response:
+          accountId: string
+          accountType: string
+          token: string
+    save:
+      root_token: "{{body.response.token}}"
+      root_account_id: "{{body.response.accountId}}"
+    assertions:
+      - "{{body.response.accountType}} == 'root'"
+
+  - name: "Generate unique test suffix"
+    randomize:
+      seed_id: 8
+
+  # --- Only root can create projects ---
+
+  - name: "Root creates second project (project B)"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/project"
+    request_headers:
+      - x-api-token: "{$stored.root_token}"
+    send_as: "json"
+    body:
+      name: "e2e_access_project_{$stored.seed_id}"
+      description: "E2E cross-project access control project"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          id: string
+          name: string
+    save:
+      project_b_id: "{{body.response.id}}"
+      project_b_name: "{{body.response.name}}"
+    assertions:
+      - "{{body.response.name}} == 'e2e_access_project_{$stored.seed_id}'"
+
+  # --- Setup: one admin in the default project (A), one admin in project B, and one standard account in project A ---
+
+  - name: "Root creates admin in project A"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/create?accountType=admin"
+    request_headers:
+      - x-api-token: "{$stored.root_token}"
+    send_as: "json"
+    body:
+      username: "e2e_admin_a_{$stored.seed_id}"
+      password: "e2e_admin_a_pwd_v1"
+    expect:
+      status: 200
+      body:
+        response:
+          accountId: string
+          accountType: string
+    save:
+      admin_a_account_id: "{{body.response.accountId}}"
+    assertions:
+      - "{{body.response.accountType}} == 'admin'"
+
+  - name: "Root creates admin in project B"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/{$stored.project_b_name}/create?accountType=admin"
+    request_headers:
+      - x-api-token: "{$stored.root_token}"
+    send_as: "json"
+    body:
+      username: "e2e_admin_b_{$stored.seed_id}"
+      password: "e2e_admin_b_pwd_v1"
+    expect:
+      status: 200
+      body:
+        response:
+          accountId: string
+          accountType: string
+    save:
+      admin_b_account_id: "{{body.response.accountId}}"
+    assertions:
+      - "{{body.response.accountType}} == 'admin'"
+
+  - name: "Root creates standard account in project A"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/create?accountType=standard"
+    request_headers:
+      - x-api-token: "{$stored.root_token}"
+    send_as: "json"
+    body:
+      username: "e2e_standard_{$stored.seed_id}"
+      password: "e2e_standard_pwd_v1"
+    expect:
+      status: 200
+      body:
+        response:
+          accountId: string
+          accountType: string
+    save:
+      standard_account_id: "{{body.response.accountId}}"
+    assertions:
+      - "{{body.response.accountType}} == 'standard'"
+
+  - name: "Login admin of project A"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/login"
+    send_as: "json"
+    body:
+      device: "e2e_test_device"
+      pseudo: "e2e_admin_a_{$stored.seed_id}"
+      password: "e2e_admin_a_pwd_v1"
+    expect:
+      status: 200
+      body:
+        response:
+          token: string
+    save:
+      admin_a_token: "{{body.response.token}}"
+
+  - name: "Login admin of project B"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/{$stored.project_b_name}/login"
+    send_as: "json"
+    body:
+      device: "e2e_test_device"
+      pseudo: "e2e_admin_b_{$stored.seed_id}"
+      password: "e2e_admin_b_pwd_v1"
+    expect:
+      status: 200
+      body:
+        response:
+          token: string
+    save:
+      admin_b_token: "{{body.response.token}}"
+
+  - name: "Login standard account of project A"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/login"
+    send_as: "json"
+    body:
+      device: "e2e_test_device"
+      pseudo: "e2e_standard_{$stored.seed_id}"
+      password: "e2e_standard_pwd_v1"
+    expect:
+      status: 200
+      body:
+        response:
+          token: string
+    save:
+      standard_token: "{{body.response.token}}"
+
+  # --- Only root can create projects: admin and standard accounts are rejected ---
+
+  - name: "Admin cannot create a project"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/project"
+    request_headers:
+      - x-api-token: "{$stored.admin_a_token}"
+    send_as: "json"
+    body:
+      name: "e2e_forbidden_project_admin_{$stored.seed_id}"
+      description: "Should not be created"
+    expect:
+      status: 403
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Standard account cannot create a project"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/project"
+    request_headers:
+      - x-api-token: "{$stored.standard_token}"
+    send_as: "json"
+    body:
+      name: "e2e_forbidden_project_std_{$stored.seed_id}"
+      description: "Should not be created"
+    expect:
+      status: 403
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  # --- An admin cannot manage accounts outside of its own project ---
+
+  - name: "Admin of project A cannot create an account in project B"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/{$stored.project_b_name}/create?accountType=standard"
+    request_headers:
+      - x-api-token: "{$stored.admin_a_token}"
+    send_as: "json"
+    body:
+      username: "e2e_cross_project_a_to_b_{$stored.seed_id}"
+      password: "e2e_cross_project_pwd"
+    expect:
+      status: 422
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Admin of project B cannot create an account in project A"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/create?accountType=standard"
+    request_headers:
+      - x-api-token: "{$stored.admin_b_token}"
+    send_as: "json"
+    body:
+      username: "e2e_cross_project_b_to_a_{$stored.seed_id}"
+      password: "e2e_cross_project_pwd"
+    expect:
+      status: 422
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Admin of project A can still create an account within its own project"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/create?accountType=standard"
+    request_headers:
+      - x-api-token: "{$stored.admin_a_token}"
+    send_as: "json"
+    body:
+      username: "e2e_own_project_{$stored.seed_id}"
+      password: "e2e_own_project_pwd"
+    expect:
+      status: 200
+      body:
+        response:
+          accountId: string
+          accountType: string
+    save:
+      admin_a_created_account_id: "{{body.response.accountId}}"
+    assertions:
+      - "{{body.response.accountType}} == 'standard'"
+
+  # --- A standard account cannot create an admin account ---
+
+  - name: "Standard account cannot create an admin account"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/create?accountType=admin"
+    request_headers:
+      - x-api-token: "{$stored.standard_token}"
+    send_as: "json"
+    body:
+      username: "e2e_std_forbidden_admin_{$stored.seed_id}"
+      password: "e2e_std_forbidden_admin_pwd"
+    expect:
+      status: 403
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  # --- Cleanup ---
+
+  - name: "Cleanup: Delete account created by admin of project A"
+    method: "DELETE"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/delete/{$stored.admin_a_created_account_id}"
+    request_headers:
+      - x-api-token: "{$stored.root_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Cleanup: Delete standard account"
+    method: "DELETE"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/delete/{$stored.standard_account_id}"
+    request_headers:
+      - x-api-token: "{$stored.root_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Cleanup: Delete admin of project A"
+    method: "DELETE"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/delete/{$stored.admin_a_account_id}"
+    request_headers:
+      - x-api-token: "{$stored.root_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Cleanup: Delete admin of project B"
+    method: "DELETE"
+    endpoint: "/api/v1/apiAuth/account/{$stored.project_b_name}/delete/{$stored.admin_b_account_id}"
+    request_headers:
+      - x-api-token: "{$stored.root_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Cleanup: Delete project B"
+    method: "DELETE"
+    endpoint: "/api/v1/apiAuth/project/{$stored.project_b_id}"
+    request_headers:
+      - x-api-token: "{$stored.root_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string

sefrone_api_e2e-1.3.6/sefrone_api_e2e/runner_csv.py

@@ -0,0 +1,188 @@
+import csv
+import os
+from typing import Any, Dict, List, Set
+
+from .step_runner import StepRunner, RunContext, StepResult
+
+
+class CsvRunner(StepRunner):
+    """
+    Runner for generating and reading CSV files during scenario execution, so a
+    downloaded CSV (e.g. a settlement export) can be asserted on by structured
+    row/column content instead of only a checksum.
+
+    This runner never makes HTTP requests itself -- pair a normal HTTP step's
+    ``save_file:`` (already supported by the default rest runner) with a
+    ``read`` step to assert on a downloaded file's content.
+
+    Step syntax — read (parse an existing/just-downloaded CSV file)::
+
+        - name: "Download daily settlement file"
+          method: "GET"
+          endpoint: "/api/v1/SettlementLedger/file/{$stored.acquirer_id}/{$stored.file_id}"
+          request_headers:
+            - x-api-token: "{$stored.token}"
+          expect:
+            status: 200
+          save_file: "./e2e/tmp/daily_withholding.csv"
+
+        - name: "Verify settlement file content"
+          runner: csv
+          csv:
+            action: read              # optional, default: read
+            path: "./e2e/tmp/daily_withholding.csv"
+          assertions:
+            - "{{csv.row_count}} == 3"
+            - "{{csv.headers}} include 'LineType'"
+            - "{{csv.rows[0].LineType}} == 'charge'"
+            - "{{csv.rows[0].CurrencyCode}} == 'JOD'"
+          save:
+            first_line_type: "{{csv.rows[0].LineType}}"
+
+    Step syntax — generate (write a CSV fixture with specific content)::
+
+        - name: "Generate CSV fixture"
+          runner: csv
+          csv:
+            action: generate
+            path: "./e2e/assets/test_import.csv"
+            headers: ["Name", "Amount"]
+            rows:
+              - ["Alice", "100.00"]
+              - ["Bob", "200.50"]
+
+    ``csv.rows`` in the read context is a list of dicts keyed by header name
+    (e.g. ``{{csv.rows[0].Amount}}``); ``csv.raw_rows`` is the same data as
+    plain lists (positional access) for files with duplicate/blank headers.
+    Runner-generated files are removed during teardown, matching AssetsRunner;
+    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 "csv"
+
+    def handles(self, step: dict) -> bool:
+        return "csv" in step and "method" not in step
+
+    def execute(self, step: dict, ctx: RunContext) -> StepResult:
+        try:
+            spec = step.get("csv")
+            if not isinstance(spec, dict):
+                return StepResult.failed("csv step requires a 'csv' 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 csv 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"[csv] Removed: {path}")
+            except FileNotFoundError:
+                pass
+            except Exception as e:
+                print(f"[csv] 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("csv.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"csv file not found: '{resolved_path}'")
+
+        # utf-8-sig transparently strips a BOM if the file has one, and behaves
+        # like plain utf-8 otherwise -- ClosedXML/Excel-adjacent tooling
+        # sometimes writes a BOM, our own CsvWriter does not.
+        encoding = str(spec.get("encoding", "utf-8-sig"))
+        with open(resolved_path, "r", encoding=encoding, newline="") as f:
+            all_rows = list(csv.reader(f))
+
+        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] = {
+            "csv": {
+                "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", [])
+
+        if not isinstance(path, str) or not path.strip():
+            return StepResult.failed("csv.path is required and must be a non-empty string")
+        if not isinstance(headers, list) or not headers:
+            return StepResult.failed("csv.headers is required and must be a non-empty list")
+        if not isinstance(rows, list):
+            return StepResult.failed("csv.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]
+
+        with open(resolved_path, "w", encoding="utf-8", newline="") as f:
+            writer = csv.writer(f)
+            writer.writerow(resolved_headers)
+            writer.writerows(resolved_rows)
+
+        self._generated_paths.add(resolved_path)
+        print(f"[csv] Generated: {resolved_path} ({len(resolved_rows)} row(s))")
+        return StepResult.passed()

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sefrone_api_e2e
-Version: 1.3.4
+Version: 1.3.6
 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.3.4 → sefrone_api_e2e-1.3.6}/sefrone_api_e2e.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ 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_csv.py
 sefrone_api_e2e/runner_email_mock.py
 sefrone_api_e2e/runner_rest_api.py
 sefrone_api_e2e/runner_satim_mock.py
@@ -25,6 +26,7 @@ sefrone_api_e2e/e2e/Scenarios/Auth/5_apikey_endpoints.yaml
 sefrone_api_e2e/e2e/Scenarios/Auth/6_project_endpoints.yaml
 sefrone_api_e2e/e2e/Scenarios/Auth/7_email_2fa_flow.yaml
 sefrone_api_e2e/e2e/Scenarios/Auth/8_temporary_passwords_flow.yaml
+sefrone_api_e2e/e2e/Scenarios/Auth/9_project_account_access_control_flow.yaml
 sefrone_api_e2e/e2e/Scenarios/Oidc/1_relying_party_admin.yaml
 sefrone_api_e2e/e2e/Scenarios/Oidc/2_authorization_code_flow.yaml
 sefrone_api_e2e/e2e/Scenarios/Oidc/3_disable_propagation_flow.yaml

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

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