ntf-sample-plugin 0.1.8__tar.gz

ntf_sample_plugin-0.1.8/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: ntf_sample_plugin
+Version: 0.1.8
+Summary: Sample plugin pack for PytestOps (ntf)
+Description-Content-Type: text/markdown
+Requires-Dist: PytestOps-framework>=0.1.0
+Requires-Dist: jsonpath>=0.82.2
+
+# ntf-sample-plugin
+
+Sample plugin pack for PytestOps (`ntf`). It demonstrates all plugin entry-points:
+
+- `ntf.assertions` (custom assertion)
+- `ntf.functions` (custom renderer functions)
+- `ntf.reporters` (custom report output)
+- `ntf.transports` (custom transport factory)
+- `ntf.renderers` (custom renderer)
+
+## Install (local)
+
+```bash
+cd plugins/ntf_sample_plugin
+python -m pip install -e .
+```
+
+## Usage
+
+### Custom assertion: `startswith`
+
+```yaml
+validate:
+  - startswith: {"body.message": "ok"}
+```
+
+### Custom functions
+
+```yaml
+request:
+  json:
+    ts: "${now_iso()}"
+    rid: "${rand_int(1000,9999)}"
+```
+
+### Custom reporter
+
+```bash
+ntf run-yaml --config configs/default.yaml --cases tests/data --reporter print
+```
+
+Optionally write JSON report with:
+
+```bash
+set NTF_SAMPLE_REPORT=report/sample-plugin.json
+```
+
+### Custom transport
+
+```bash
+ntf run-yaml --config configs/default.yaml --cases tests/data --transport requests_no_session
+```
+
+### Custom renderer
+
+```bash
+ntf run-yaml --config configs/default.yaml --cases tests/data --renderer upper
+```

ntf_sample_plugin-0.1.8/README.md

@@ -0,0 +1,58 @@
+# ntf-sample-plugin
+
+Sample plugin pack for PytestOps (`ntf`). It demonstrates all plugin entry-points:
+
+- `ntf.assertions` (custom assertion)
+- `ntf.functions` (custom renderer functions)
+- `ntf.reporters` (custom report output)
+- `ntf.transports` (custom transport factory)
+- `ntf.renderers` (custom renderer)
+
+## Install (local)
+
+```bash
+cd plugins/ntf_sample_plugin
+python -m pip install -e .
+```
+
+## Usage
+
+### Custom assertion: `startswith`
+
+```yaml
+validate:
+  - startswith: {"body.message": "ok"}
+```
+
+### Custom functions
+
+```yaml
+request:
+  json:
+    ts: "${now_iso()}"
+    rid: "${rand_int(1000,9999)}"
+```
+
+### Custom reporter
+
+```bash
+ntf run-yaml --config configs/default.yaml --cases tests/data --reporter print
+```
+
+Optionally write JSON report with:
+
+```bash
+set NTF_SAMPLE_REPORT=report/sample-plugin.json
+```
+
+### Custom transport
+
+```bash
+ntf run-yaml --config configs/default.yaml --cases tests/data --transport requests_no_session
+```
+
+### Custom renderer
+
+```bash
+ntf run-yaml --config configs/default.yaml --cases tests/data --renderer upper
+```

ntf_sample_plugin-0.1.8/ntf_sample_plugin/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["__version__"]
+
+__version__ = "0.1.0"

ntf_sample_plugin-0.1.8/ntf_sample_plugin/assertions.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from typing import Any
+
+import jsonpath
+
+
+def _resolve_actual(actual_json: Any, status_code: int, locator: str) -> tuple[bool, Any]:
+    if locator == "status_code":
+        return True, status_code
+
+    if locator.startswith("$"):
+        values = jsonpath.jsonpath(actual_json, locator)
+        if not values:
+            return False, None
+        return True, values[0]
+
+    if isinstance(actual_json, dict) and locator in actual_json:
+        return True, actual_json.get(locator)
+
+    values = jsonpath.jsonpath(actual_json, f"$..{locator}")
+    if not values:
+        return False, None
+    return True, values[0]
+
+
+def assert_startswith(payload: Any, actual_json: Any, status_code: int) -> None:
+    if not isinstance(payload, dict) or len(payload) != 1:
+        raise AssertionError("startswith payload must be a dict with one locator")
+
+    locator, expected_prefix = next(iter(payload.items()))
+    found, actual = _resolve_actual(actual_json, status_code, str(locator))
+    if not found:
+        raise AssertionError(f"startswith locator not found: {locator}")
+
+    if not str(actual).startswith(str(expected_prefix)):
+        raise AssertionError(
+            "startswith failed: locator={locator} expected_prefix={expected!r} actual={actual!r}".format(
+                locator=locator,
+                expected=expected_prefix,
+                actual=actual,
+            )
+        )

ntf_sample_plugin-0.1.8/ntf_sample_plugin/functions.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+import datetime
+import random
+
+
+def now_iso() -> str:
+    return datetime.datetime.now().isoformat()
+
+
+def rand_int(a: str = "0", b: str = "100") -> int:
+    try:
+        lo = int(a)
+    except Exception:
+        lo = 0
+    try:
+        hi = int(b)
+    except Exception:
+        hi = 100
+    if lo > hi:
+        lo, hi = hi, lo
+    return random.randint(lo, hi)
+
+
+FUNCTIONS = {
+    "now_iso": now_iso,
+    "rand_int": rand_int,
+}

ntf_sample_plugin-0.1.8/ntf_sample_plugin/renderer.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from typing import Any
+
+from ntf.renderer import RenderContext, Renderer
+
+
+class UpperRenderer:
+    def __init__(self, ctx: RenderContext, functions: Any | None = None) -> None:
+        self._inner = Renderer(ctx, functions=functions)
+
+    def render(self, data: Any) -> Any:
+        return self._upper(self._inner.render(data))
+
+    def _upper(self, data: Any) -> Any:
+        if isinstance(data, str):
+            return data.upper()
+        if isinstance(data, list):
+            return [self._upper(i) for i in data]
+        if isinstance(data, dict):
+            return {k: self._upper(v) for k, v in data.items()}
+        return data

ntf_sample_plugin-0.1.8/ntf_sample_plugin/reporter.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+import json
+import os
+from pathlib import Path
+from typing import Any
+
+
+def print_report(summary: dict[str, Any], failures: list[dict[str, Any]]) -> None:
+    print("[ntf-sample-plugin] summary:", summary)
+    if failures:
+        print("[ntf-sample-plugin] failures:", len(failures))
+
+    out_path = os.getenv("NTF_SAMPLE_REPORT")
+    if not out_path:
+        return
+    p = Path(out_path)
+    p.parent.mkdir(parents=True, exist_ok=True)
+    payload = {"summary": summary, "failures": failures}
+    p.write_text(json.dumps(payload, ensure_ascii=False, indent=2), encoding="utf-8")

ntf_sample_plugin-0.1.8/ntf_sample_plugin/transport.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from typing import Any
+
+from ntf.http import RequestsTransport
+
+
+def requests_no_session(cfg: Any) -> RequestsTransport:
+    return RequestsTransport(
+        proxy=cfg.http_proxy,
+        verify=cfg.http_verify,
+        cert=cfg.http_cert,
+        session_persist=False,
+    )

ntf_sample_plugin-0.1.8/ntf_sample_plugin.egg-info/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: ntf-sample-plugin
+Version: 0.1.8
+Summary: Sample plugin pack for PytestOps (ntf)
+Description-Content-Type: text/markdown
+Requires-Dist: PytestOps-framework>=0.1.0
+Requires-Dist: jsonpath>=0.82.2
+
+# ntf-sample-plugin
+
+Sample plugin pack for PytestOps (`ntf`). It demonstrates all plugin entry-points:
+
+- `ntf.assertions` (custom assertion)
+- `ntf.functions` (custom renderer functions)
+- `ntf.reporters` (custom report output)
+- `ntf.transports` (custom transport factory)
+- `ntf.renderers` (custom renderer)
+
+## Install (local)
+
+```bash
+cd plugins/ntf_sample_plugin
+python -m pip install -e .
+```
+
+## Usage
+
+### Custom assertion: `startswith`
+
+```yaml
+validate:
+  - startswith: {"body.message": "ok"}
+```
+
+### Custom functions
+
+```yaml
+request:
+  json:
+    ts: "${now_iso()}"
+    rid: "${rand_int(1000,9999)}"
+```
+
+### Custom reporter
+
+```bash
+ntf run-yaml --config configs/default.yaml --cases tests/data --reporter print
+```
+
+Optionally write JSON report with:
+
+```bash
+set NTF_SAMPLE_REPORT=report/sample-plugin.json
+```
+
+### Custom transport
+
+```bash
+ntf run-yaml --config configs/default.yaml --cases tests/data --transport requests_no_session
+```
+
+### Custom renderer
+
+```bash
+ntf run-yaml --config configs/default.yaml --cases tests/data --renderer upper
+```

ntf_sample_plugin-0.1.8/ntf_sample_plugin.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+ntf_sample_plugin/__init__.py
+ntf_sample_plugin/assertions.py
+ntf_sample_plugin/functions.py
+ntf_sample_plugin/renderer.py
+ntf_sample_plugin/reporter.py
+ntf_sample_plugin/transport.py
+ntf_sample_plugin.egg-info/PKG-INFO
+ntf_sample_plugin.egg-info/SOURCES.txt
+ntf_sample_plugin.egg-info/dependency_links.txt
+ntf_sample_plugin.egg-info/entry_points.txt
+ntf_sample_plugin.egg-info/requires.txt
+ntf_sample_plugin.egg-info/top_level.txt

ntf_sample_plugin-0.1.8/ntf_sample_plugin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ntf_sample_plugin-0.1.8/ntf_sample_plugin.egg-info/entry_points.txt

@@ -0,0 +1,14 @@
+[ntf.assertions]
+startswith = ntf_sample_plugin.assertions:assert_startswith
+
+[ntf.functions]
+functions = ntf_sample_plugin.functions:FUNCTIONS
+
+[ntf.renderers]
+upper = ntf_sample_plugin.renderer:UpperRenderer
+
+[ntf.reporters]
+print = ntf_sample_plugin.reporter:print_report
+
+[ntf.transports]
+requests_no_session = ntf_sample_plugin.transport:requests_no_session

ntf_sample_plugin-0.1.8/ntf_sample_plugin.egg-info/requires.txt

@@ -0,0 +1,2 @@
+PytestOps-framework>=0.1.0
+jsonpath>=0.82.2

ntf_sample_plugin-0.1.8/ntf_sample_plugin.egg-info/top_level.txt

@@ -0,0 +1 @@
+ntf_sample_plugin

ntf_sample_plugin-0.1.8/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61,<69", "wheel"]
+build-backend = "setuptools.build_meta:__legacy__"

ntf_sample_plugin-0.1.8/setup.cfg

@@ -0,0 +1,34 @@
+[metadata]
+name = ntf_sample_plugin
+version = 0.1.8
+description = Sample plugin pack for PytestOps (ntf)
+long_description = file: README.md
+long_description_content_type = text/markdown
+requires_python = >=3.12
+
+[options]
+packages = find:
+install_requires = 
+	PytestOps-framework>=0.1.0
+	jsonpath>=0.82.2
+
+[options.entry_points]
+ntf.assertions = 
+	startswith = ntf_sample_plugin.assertions:assert_startswith
+ntf.functions = 
+	functions = ntf_sample_plugin.functions:FUNCTIONS
+ntf.reporters = 
+	print = ntf_sample_plugin.reporter:print_report
+ntf.transports = 
+	requests_no_session = ntf_sample_plugin.transport:requests_no_session
+ntf.renderers = 
+	upper = ntf_sample_plugin.renderer:UpperRenderer
+
+[options.packages.find]
+include = 
+	ntf_sample_plugin*
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

ntf_sample_plugin-0.1.8/setup.py

@@ -0,0 +1,4 @@
+from setuptools import setup
+
+if __name__ == "__main__":
+    setup()