pytestflow 0.2.0__py3-none-any.whl

pytestflow/steps/string_check.py

@@ -0,0 +1,104 @@
+from prefect.artifacts import create_markdown_artifact
+from pytestflow.core.core import StepWrapper
+from pytestflow.core.pytestflow_states import PyTestflowPassed, PyTestflowFailed
+from pytestflow.core.utils import get_data_for_gui
+from pytestflow.steps.common import get_metadata_from_prefect_context
+from typing import Callable
+from pytestflow.steps.common import get_runtime_value
+import re
+
+
+class StringCheckStep(StepWrapper):
+    def __init__(self, fn, *, expected, match="exact", case_sensitive=True,
+                 name=None, autowire=True, **task_kwargs):
+        super().__init__(fn, name=name, autowire=autowire, **task_kwargs)
+        self.expected = expected
+        self.match = match
+        self.case_sensitive = case_sensitive
+        self.step_type = "string_check"
+
+    def _run(self, *args, **kwargs):
+        actual = super()._run(*args, **kwargs)
+
+        expected_value = get_runtime_value(self.expected)
+        match_mode = get_runtime_value(self.match)
+        is_case_sensitive = get_runtime_value(self.case_sensitive)
+
+        if not isinstance(actual, str):
+            raise TypeError(f"Expected string output, got {type(actual)}")
+
+        compare_actual = actual if is_case_sensitive else actual.lower()
+        compare_expected = expected_value if is_case_sensitive else expected_value.lower()
+
+        if match_mode == "exact":
+            passed = compare_actual == compare_expected
+        elif match_mode == "contains":
+            passed = compare_expected in compare_actual
+        else:
+            raise ValueError(f"Unsupported match mode: {match_mode}")
+
+        result_data = {
+            "step_status": "passed" if passed else "failed",
+            "output": actual,
+            "expected": expected_value,
+            "match": match_mode,
+            "case_sensitive": is_case_sensitive,
+            "step_type": self.step_type,
+        }
+
+        result_data.update(self.get_meta_info())
+        result_data.update(get_metadata_from_prefect_context())
+
+        # Send End data to GUI
+        get_data_for_gui(self, result_data.get("end_time"), result_data)
+
+        # Prefect UI artifact (best-effort)
+        try:
+            safe_step_name = re.sub(r"[^a-z0-9\-]", "-", self.name.lower())
+
+            artifact_md = (
+                f"### Step: `{self.name}`\n"
+                f"- **Actual:** `{actual}`\n"
+                f"- **Expected:** `{expected_value}`\n"
+                f"- **Match mode:** `{match_mode}`\n"
+                f"- **Case sensitive:** `{is_case_sensitive}`\n"
+                f"- **Status:** {'✅ PASSED' if passed else '❌ FAILED'}"
+            )
+
+            create_markdown_artifact(
+                key=f"result-{safe_step_name}",
+                markdown=artifact_md,
+                description=f"String check for `{self.name}`",
+            )
+
+        except Exception:
+            # Runtime might not support artifacts or not be in task context
+            pass
+
+        return (
+            PyTestflowPassed(ptf_result=result_data)
+            if passed
+            else PyTestflowFailed(
+                ptf_result=result_data,
+                message=f"{self.name} failed"
+            )
+        )
+
+
+def string_check_step(*, expected, match="exact", case_sensitive=True,
+                      name=None, autowire=True, **task_kwargs):
+    """
+    Decorator factory for string check steps.
+    """
+    def decorator(fn: Callable):
+        # IMPORTANT: already task-wrapped by StepWrapper
+        return StringCheckStep(
+            fn,
+            expected=expected,
+            match=match,
+            case_sensitive=case_sensitive,
+            name=name,
+            autowire=autowire,
+            **task_kwargs,
+        )
+    return decorator

pytestflow/steps/waveform_limit.py

@@ -0,0 +1,170 @@
+from prefect.artifacts import create_markdown_artifact
+from pytestflow.core.core import StepWrapper
+from pytestflow.core.pytestflow_states import PyTestflowPassed, PyTestflowFailed
+from pytestflow.core.utils import get_data_for_gui
+from pytestflow.steps.common import get_metadata_from_prefect_context, get_runtime_value
+from typing import Callable
+import numpy as np
+import re
+
+
+class WaveformLimitStep(StepWrapper):
+    def __init__(
+        self,
+        fn,
+        *,
+        lower_mask=None,
+        upper_mask=None,
+        mode="between",
+        name=None,
+        autowire=True,
+        **task_kwargs
+    ):
+        super().__init__(fn, name=name, autowire=autowire, **task_kwargs)
+        self.lower_mask = lower_mask
+        self.upper_mask = upper_mask
+        self.mode = mode
+        self.step_type = "waveform_limit"
+
+    def _run(self, *args, **kwargs):
+        wvf = super()._run(*args, **kwargs)
+
+        lower_mask = get_runtime_value(self.lower_mask)
+        upper_mask = get_runtime_value(self.upper_mask)
+        mode = get_runtime_value(self.mode)
+
+        x, y = np.array(wvf["x"]), np.array(wvf["y"])
+
+        result_data = {
+            "step_status": "done",
+            "mode": mode,
+            "output": {"x": x.tolist(), "y": y.tolist()},
+            "violations": [],
+            "step_type": self.step_type,
+        }
+
+        if mode == "ge":
+            assert lower_mask is not None, "GE mode requires lower_mask"
+
+            lx, ly = zip(*lower_mask)
+            lower = np.interp(x, lx, ly)
+
+            if np.any(y < lower):
+                result_data["violations"].append("below_lower_mask")
+                result_data["step_status"] = "failed"
+            else:
+                result_data["step_status"] = "passed"
+
+        elif mode == "le":
+            assert upper_mask is not None, "LE mode requires upper_mask"
+
+            ux, uy = zip(*upper_mask)
+            upper = np.interp(x, ux, uy)
+
+            if np.any(y > upper):
+                result_data["violations"].append("above_upper_mask")
+                result_data["step_status"] = "failed"
+            else:
+                result_data["step_status"] = "passed"
+
+        elif mode == "between":
+            assert lower_mask and upper_mask, "BETWEEN requires both masks"
+
+            lx, ly = zip(*lower_mask)
+            ux, uy = zip(*upper_mask)
+
+            lower = np.interp(x, lx, ly)
+            upper = np.interp(x, ux, uy)
+
+            below = y < lower
+            above = y > upper
+
+            if np.any(below):
+                result_data["violations"].append("below_lower_mask")
+
+            if np.any(above):
+                result_data["violations"].append("above_upper_mask")
+
+            result_data["step_status"] = (
+                "passed" if not (np.any(below) or np.any(above)) else "failed"
+            )
+
+        elif mode == "outside":
+            assert lower_mask and upper_mask, "OUTSIDE requires both masks"
+
+            lx, ly = zip(*lower_mask)
+            ux, uy = zip(*upper_mask)
+
+            lower = np.interp(x, lx, ly)
+            upper = np.interp(x, ux, uy)
+
+            outside = (y < lower) | (y > upper)
+
+            if np.any(~outside):
+                result_data["violations"].append("inside_forbidden_zone")
+                result_data["step_status"] = "failed"
+            else:
+                result_data["step_status"] = "passed"
+
+        else:
+            raise ValueError(f"Unsupported mode: {mode}")
+
+        result_data.update(self.get_meta_info())
+        result_data.update(get_metadata_from_prefect_context())
+
+        get_data_for_gui(self, result_data.get("end_time"), result_data)
+
+        try:
+            safe_step_name = re.sub(r"[^a-z0-9\-]", "-", self.name.lower())
+
+            artifact_lines = [
+                f"### Step: `{self.name}`",
+                f"- **Mode:** `{mode}`",
+                f"- **Status:** {'✅ PASSED' if result_data['step_status'] == 'passed' else '❌ FAILED'}",
+                "",
+            ]
+
+            if result_data["step_status"] != "passed":
+                v_list = result_data["violations"]
+                artifact_lines.append(
+                    f"- **Violations:** {', '.join(v_list[:10]) or 'none'}"
+                )
+
+                if len(v_list) > 10:
+                    artifact_lines.append(
+                        f"- ... and {len(v_list) - 10} more. See full logs for details."
+                    )
+
+            create_markdown_artifact(
+                key=f"result-{safe_step_name}",
+                markdown="\n".join(artifact_lines),
+                description=f"Waveform limit check for `{self.name}`",
+            )
+
+        except Exception:
+            pass
+
+        return (
+            PyTestflowPassed(ptf_result=result_data)
+            if result_data["step_status"] == "passed"
+            else PyTestflowFailed(ptf_result=result_data, message=f"{self.name} failed")
+        )
+
+
+def waveform_limit_step(*, lower_mask=None, upper_mask=None, mode="between",
+                        name=None, autowire=True, **task_kwargs):
+    """
+    Decorator factory for waveform limit steps.
+    """
+    def decorator(fn: Callable):
+        # IMPORTANT: already task-wrapped by StepWrapper
+        return WaveformLimitStep(
+            fn,
+            lower_mask=lower_mask,
+            upper_mask=upper_mask,
+            mode=mode,
+            name=name,
+            autowire=autowire,
+            **task_kwargs,
+        )
+    return decorator

pytestflow-0.2.0.dist-info/METADATA

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: pytestflow
+Version: 0.2.0
+Summary: Test automation framework inspired by NI TestStand, built on Prefect
+Author-email: Alberto Manzoni <alb.manzoni@gmail.com>
+Project-URL: Homepage, https://github.com/Alberto-Manzoni/PyTestFlow
+Project-URL: Repository, https://github.com/Alberto-Manzoni/PyTestFlow
+Project-URL: Issues, https://github.com/Alberto-Manzoni/PyTestFlow/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: prefect==3.6.24
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: rich
+Requires-Dist: bottle
+Requires-Dist: websockets
+Requires-Dist: fakeredis==2.34.1
+Requires-Dist: jinja2
+
+# PyTestFlow
+
+PyTestFlow is a Python test executive built on top of Prefect.
+It turns decorated Python functions into traceable test steps and runs them in
+ordered flows.
+
+> Requires `prefect>=3.4` and Python 3.10+.
+
+## Repositories
+
+- Engine: https://github.com/Alberto-Manzoni/PyTestFlow
+- Frontend: https://github.com/Alberto-Manzoni/PyTestFlow-FrontEnd
+
+## Installation
+
+```bash
+python -m pip install pytestflow
+```
+
+### Init the workspace
+
+```bash
+pytestflow init
+```
+
+Set the environment variable as suggested from the CLI
+
+
+## Usage
+
+```bash
+pytestflow start
+```
+Open the web gui at the url indicated by the CLI.
+
+
+
+## Core concepts
+
+- Steps are Prefect tasks defined using `@step` or specialized step decorators.
+- A `TestSequence` is a Prefect flow that aggregates and executes multiple steps, tracking their states.
+- `ptf_context` is a shared runtime context that provides access to `globals`, `locals`, `results`, and `current_step`.
+- `SequentialProcessModel` orchestrates execution callbacks in a fixed lifecycle:
+  `pre_uut -> main_sequence -> post_uut -> report -> database_logging`.
+- The main output of the process model is stored in both `main_results` and `main_result` for backward compatibility.

pytestflow-0.2.0.dist-info/RECORD

@@ -0,0 +1,63 @@
+bootstrap_templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bootstrap_templates/config.yaml,sha256=6FYQoyTfg_XCK-HDRpO6-A9lZjWEKlvLtv580Yt32fU,219
+bootstrap_templates/custom_step_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bootstrap_templates/custom_step_types/custom_step_template.py,sha256=fMcZdMhdOZ142AfBZx6cBM_3ODZRD3J-PmdH6DJlMMk,167
+bootstrap_templates/process_models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bootstrap_templates/process_models/sequential_model.py,sha256=Y267Rj8tI3OEu_UFQJzl8BPjLw23oDIz3f_tFdBvKxI,5182
+bootstrap_templates/process_models/reporting/README.md,sha256=MNyr1oQTmBHjHIDc3BtBHTrnUY6SS08aTVZfKJZDr1Y,1645
+bootstrap_templates/process_models/reporting/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bootstrap_templates/process_models/reporting/default_report.html.j2,sha256=xleBHhZqB3CuM-zzE6DrxvSpW26frTrVVhGFQNgesHU,3674
+bootstrap_templates/process_models/reporting/html_report.py,sha256=jeYnaJ7eRgJkVuuVAXGf2g_6g3_xn6KhL_BFV6sQ3yE,11314
+bootstrap_templates/test_sequences/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bootstrap_templates/test_sequences/basic_sequence.py,sha256=saWovmg58tWmLNIZjb6iqSRcfuhlDMeqSGUVOy8HW2g,2421
+bootstrap_templates/test_sequences/message_box_and_flow_control.py,sha256=8kh0gE1rKXwzKPU6xBwFVkKUvU9ZiJoD7wLYI3-nGsM,5530
+bootstrap_templates/test_sequences/motherboard_test_sequence.py,sha256=tNnCGbovb5DJfAHGbgNE4Umfh5rCwLwaNOHUlUwlxhs,4029
+bootstrap_templates/test_sequences/step_types_quickstart.py,sha256=MfQ3iFkIC5WATO3i4x8BzCiicIWRnkrQhZFwbLI7UYU,6104
+pytestflow/README.md,sha256=FMFBw82GgmzlUZI9l5a1jL2ouMgDDtx3kCFIX5bUNjw,619
+pytestflow/__init__.py,sha256=SZoMtFvPEt84XVvd2BqNs0zDUd8I61jI5ZRgdhMzB4o,332
+pytestflow/cli.py,sha256=OXhClJZQdX96udhVyVa686dAawZ6K29r1kpgIhKN5nk,5827
+pytestflow/starter_here.md,sha256=toCXJwJvhZNfkLm9EdTSy4LoqJrTAt6ai6HHQMBFZzM,903
+pytestflow/backend/__init__.py,sha256=pgOTXFCXcVcfwJjC0wqqVPs7jCjd7Q_hkuoL45Dzcdk,41
+pytestflow/backend/event_bus.py,sha256=5etZwVeD2dTU6P2FIFuINzFht5qFTWCUI6LPgfwVKtA,719
+pytestflow/backend/handlers.py,sha256=AZVRYX_bkW8CskbqaMZwkcTeMSAktcP3wIifSb8eLb0,7331
+pytestflow/backend/report_manager.py,sha256=csAN-igKV80eQItoWa7uGZywEcCk8fuHXdTPynhq9xs,419
+pytestflow/backend/sequences_info.py,sha256=dzCAYZkiWsAtZ5LDH1W70hEuaqidMWrsPnDaEk-EYq0,4911
+pytestflow/backend/start_backend.py,sha256=9lt0pAQaMIMT2Eo7C34pgt6Jgj06RBA3jYg9fwWd8-s,3049
+pytestflow/backend/uuids_handler.py,sha256=Vu4zcMgY1EXoAX7ea9-dIAz7XuQKtfbYi0ro76KnpCk,2337
+pytestflow/backend/websocket_gateway.py,sha256=-9HIVIzmWDMwe0LHec7yCuPiVsOAlksbyJfgoZQysc4,2987
+pytestflow/backend/frontend/index.html,sha256=I50KarjefeL7Y_NlT_NgTtebIN33TdQo12CBN9Rxz4E,473
+pytestflow/backend/frontend/logo.svg,sha256=u_FtoFuvpXLoemlbRHm8MUaAnbkW3Km4NRDgW6x9eb8,16087
+pytestflow/backend/frontend/assets/full_logo-D1DRTUt8.svg,sha256=u_FtoFuvpXLoemlbRHm8MUaAnbkW3Km4NRDgW6x9eb8,16087
+pytestflow/backend/frontend/assets/index-480TOyh4.js,sha256=Y-jITV27EZzJtDyjcCasOekH_QxNPwg1PMpy8eqsOQU,88162
+pytestflow/backend/frontend/assets/index-qEI3VAQU.css,sha256=QBsF7BUtM9q2dMujOODuJepTEc-guEBD0u6fpeyIEiU,7606
+pytestflow/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytestflow/config/config_manager.py,sha256=Sf6SSC8HdkpCewCo7VX1k0tz6WK5Prq-RW9S9sGRsDY,1182
+pytestflow/core/README.md,sha256=tBWqJ2jVksgEMDPesmhhyFkz6WEpTlIM4c9lEppFwYE,3707
+pytestflow/core/__init__.py,sha256=zcsgFcLygAK1FNoDh41ptMmNxohAhIcyGdXoD4aX-Ww,387
+pytestflow/core/context.py,sha256=0rct317NSPS_T6P-yO4QiOcJtq3Gxm4V9vYFkMIaiwk,1778
+pytestflow/core/core.py,sha256=8h5GOagOcDTsnAfaTIX5Ojtij_aCCibmtdv7aDSAF58,3657
+pytestflow/core/pytestflow_states.py,sha256=yAHoQbp3D0Wnn9gtioqwXUSZ6DB31E8AymnHP4aXsfU,2785
+pytestflow/core/runtime_control.py,sha256=35PPx7QUT_qKu71fBuGCJi2yTMLgf3WC1MfBJPgutz4,5934
+pytestflow/core/seq_file_runner.py,sha256=F1xcWEcJiRYgFyjMCIbdYQz8KF_RzikJoOWaKr0a9nI,1217
+pytestflow/core/sequence.py,sha256=yjkRm3s0f8mxWqAXUiRAICHdP4wjjXEKdq7vRvHTJFU,15782
+pytestflow/core/utils.py,sha256=5eBg4Tvt06Te2lhzNQP7lISv4oE70pE_A5QqrOQGBNA,3074
+pytestflow/flow_utils/README.md,sha256=ms40HYRQBT8M1PH9yy7NzVOzackmjF90iDPo_P89UtQ,319
+pytestflow/flow_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytestflow/flow_utils/conditions.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytestflow/flow_utils/transitions.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytestflow/steps/README.md,sha256=yOXmaEUaKaqukPlHtP1xEV8mt2u4hWBYJE0M3TQRc1E,1899
+pytestflow/steps/__init__.py,sha256=OWnFhQxUPtqzz-j8lFSHZ5Wgq_CZSZvj-E337aEpojA,459
+pytestflow/steps/action_step.py,sha256=MInrWUr7c6f_OUZcvJMcGoNQRLfuqQXiQONI3vqA89Y,3486
+pytestflow/steps/common.py,sha256=WCW45lgRBCur1A7qr5t9sGMmFmYUOu_XtN0Momr7y10,1710
+pytestflow/steps/df_numeric_limits.py,sha256=0GTg_ORkDTSjP7w8ETc-ENwr7Gy9fSMfcM-fkRR9eyc,5168
+pytestflow/steps/flow_control.py,sha256=2OZj1d-KFP8ax61bpufVj2J9-QDTHxc9aOIM8uSh9iE,3180
+pytestflow/steps/message_pop_up.py,sha256=NrwKg7OekHSFOCI9T9TRP8SJQrKWuCIg81QIM2NTKC4,2892
+pytestflow/steps/numeric_limit.py,sha256=azVEBvy_1csb58DyCW_y74YxuQMjBq4MiwVfYn01zIc,3632
+pytestflow/steps/pass_fail.py,sha256=4ZVXuBsG6-Eyy2VAwWR1QVNwg_fZigiuXdJ9q_ru9PE,1659
+pytestflow/steps/string_check.py,sha256=HQzhGwFycNBNqHXweMDWgHIx6Mml6vPQMcJayLFdRLo,3838
+pytestflow/steps/waveform_limit.py,sha256=cfZkxeu1f7ZzwhjuAZn0tAzjeD1n3ccjvvL5KOl-qIs,5650
+pytestflow-0.2.0.dist-info/METADATA,sha256=8XDQeD-nxsTINpo9R2f213rpCk7G2WMq7f0KPxBTXaQ,2381
+pytestflow-0.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pytestflow-0.2.0.dist-info/entry_points.txt,sha256=zAevseDFTil6KPYtATMcV57s_HiBJ1UbwHcifCY4egc,51
+pytestflow-0.2.0.dist-info/top_level.txt,sha256=fsTDlvcqnrA-YeF53nHbc4SdgT0zykleKm_LuBwgMfA,31
+pytestflow-0.2.0.dist-info/RECORD,,

pytestflow-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pytestflow-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pytestflow = pytestflow.cli:main

pytestflow-0.2.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+bootstrap_templates
+pytestflow