pytest-devant-cloud 0.1.0__tar.gz

pytest_devant_cloud-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+__pycache__/
+*.pyc
+*.pyo
+.pytest_cache/
+*.egg-info/
+dist/
+build/

pytest_devant_cloud-0.1.0/LICENSE

@@ -0,0 +1,88 @@
+DevQ Cloud Enterprise License
+
+Copyright (c) 2026 DevQ Cloud. All rights reserved.
+
+================================================================================
+THIS IS A TEMPLATE. Review with legal counsel before publishing to npm.
+================================================================================
+
+1. DEFINITIONS
+
+   "Software" means this npm package and its source code, including all
+   modifications and derivative works.
+
+   "Service" means the DevQ Cloud hosted product made available by DevQ Cloud
+   to its customers.
+
+   "Subscription" means a current, paid commercial agreement between you and
+   DevQ Cloud authorising use of the Service, OR a free-tier registration
+   accepted by DevQ Cloud.
+
+   "You" means the individual or legal entity exercising rights under this
+   License.
+
+2. GRANT OF USE
+
+   Subject to the terms below and the existence of an active Subscription,
+   DevQ Cloud grants You a non-exclusive, non-transferable, revocable license
+   to:
+
+   (a) install and run the Software on Your own systems and continuous
+       integration infrastructure;
+   (b) use the Software solely to connect to and interact with the Service;
+   (c) make modifications to the Software for Your own internal use, provided
+       such modifications are not distributed.
+
+3. RESTRICTIONS
+
+   You may not, except to the extent expressly permitted by applicable law:
+
+   (a) redistribute, sublicense, sell, rent, lease, or otherwise transfer the
+       Software or any modified version of the Software to any third party;
+   (b) use the Software to provide a managed, hosted, or commercial service
+       that competes with the Service;
+   (c) remove, alter, or obscure any proprietary notices in the Software;
+   (d) reverse engineer, decompile, or disassemble the Software, except as
+       expressly permitted by applicable law notwithstanding this limitation;
+   (e) use the Software in violation of any applicable law or regulation.
+
+4. NO TRANSFER OF OWNERSHIP
+
+   The Software is licensed, not sold. DevQ Cloud retains all right, title,
+   and interest in and to the Software, including all intellectual property
+   rights.
+
+5. TERMINATION
+
+   This License terminates automatically and immediately if Your Subscription
+   ends, expires, or is terminated for any reason. Upon termination, You must
+   cease all use of the Software and destroy all copies in Your possession.
+
+6. NO WARRANTY
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.
+
+7. LIMITATION OF LIABILITY
+
+   IN NO EVENT SHALL DEVQ CLOUD OR ITS CONTRIBUTORS BE LIABLE FOR ANY CLAIM,
+   DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR
+   OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE
+   USE OR OTHER DEALINGS IN THE SOFTWARE. DEVQ CLOUD'S TOTAL LIABILITY FOR
+   ALL CLAIMS RELATED TO THE SOFTWARE SHALL NOT EXCEED THE FEES PAID BY YOU
+   FOR THE SUBSCRIPTION IN THE TWELVE (12) MONTHS PRECEDING THE CLAIM.
+
+8. GOVERNING LAW
+
+   This License is governed by the laws of the jurisdiction in which DevQ
+   Cloud is incorporated, without regard to its conflict of law principles.
+
+9. ENTIRE AGREEMENT
+
+   This License, together with the Subscription terms, constitutes the
+   entire agreement between You and DevQ Cloud concerning the Software and
+   supersedes all prior or contemporaneous agreements, proposals, or
+   communications.
+
+For commercial licensing inquiries, contact: licensing@devq.cloud

pytest_devant_cloud-0.1.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: pytest-devant-cloud
+Version: 0.1.0
+Summary: pytest plugin that streams runs, results, and step trees to Devant Cloud's /v1/runs API.
+Project-URL: Homepage, https://github.com/devant-net/devq-cloud/tree/main/packages/pytest-devant-cloud
+Project-URL: Repository, https://github.com/devant-net/devq-cloud
+Author: Devant Cloud
+License: DevQ Cloud Enterprise License
+        
+        Copyright (c) 2026 DevQ Cloud. All rights reserved.
+        
+        ================================================================================
+        THIS IS A TEMPLATE. Review with legal counsel before publishing to npm.
+        ================================================================================
+        
+        1. DEFINITIONS
+        
+           "Software" means this npm package and its source code, including all
+           modifications and derivative works.
+        
+           "Service" means the DevQ Cloud hosted product made available by DevQ Cloud
+           to its customers.
+        
+           "Subscription" means a current, paid commercial agreement between you and
+           DevQ Cloud authorising use of the Service, OR a free-tier registration
+           accepted by DevQ Cloud.
+        
+           "You" means the individual or legal entity exercising rights under this
+           License.
+        
+        2. GRANT OF USE
+        
+           Subject to the terms below and the existence of an active Subscription,
+           DevQ Cloud grants You a non-exclusive, non-transferable, revocable license
+           to:
+        
+           (a) install and run the Software on Your own systems and continuous
+               integration infrastructure;
+           (b) use the Software solely to connect to and interact with the Service;
+           (c) make modifications to the Software for Your own internal use, provided
+               such modifications are not distributed.
+        
+        3. RESTRICTIONS
+        
+           You may not, except to the extent expressly permitted by applicable law:
+        
+           (a) redistribute, sublicense, sell, rent, lease, or otherwise transfer the
+               Software or any modified version of the Software to any third party;
+           (b) use the Software to provide a managed, hosted, or commercial service
+               that competes with the Service;
+           (c) remove, alter, or obscure any proprietary notices in the Software;
+           (d) reverse engineer, decompile, or disassemble the Software, except as
+               expressly permitted by applicable law notwithstanding this limitation;
+           (e) use the Software in violation of any applicable law or regulation.
+        
+        4. NO TRANSFER OF OWNERSHIP
+        
+           The Software is licensed, not sold. DevQ Cloud retains all right, title,
+           and interest in and to the Software, including all intellectual property
+           rights.
+        
+        5. TERMINATION
+        
+           This License terminates automatically and immediately if Your Subscription
+           ends, expires, or is terminated for any reason. Upon termination, You must
+           cease all use of the Software and destroy all copies in Your possession.
+        
+        6. NO WARRANTY
+        
+           THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+           IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+           FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.
+        
+        7. LIMITATION OF LIABILITY
+        
+           IN NO EVENT SHALL DEVQ CLOUD OR ITS CONTRIBUTORS BE LIABLE FOR ANY CLAIM,
+           DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR
+           OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE
+           USE OR OTHER DEALINGS IN THE SOFTWARE. DEVQ CLOUD'S TOTAL LIABILITY FOR
+           ALL CLAIMS RELATED TO THE SOFTWARE SHALL NOT EXCEED THE FEES PAID BY YOU
+           FOR THE SUBSCRIPTION IN THE TWELVE (12) MONTHS PRECEDING THE CLAIM.
+        
+        8. GOVERNING LAW
+        
+           This License is governed by the laws of the jurisdiction in which DevQ
+           Cloud is incorporated, without regard to its conflict of law principles.
+        
+        9. ENTIRE AGREEMENT
+        
+           This License, together with the Subscription terms, constitutes the
+           entire agreement between You and DevQ Cloud concerning the Software and
+           supersedes all prior or contemporaneous agreements, proposals, or
+           communications.
+        
+        For commercial licensing inquiries, contact: licensing@devq.cloud
+License-File: LICENSE
+Keywords: ci,devant,devq,pytest,reporter,test-reporting
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+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 :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.24
+Requires-Dist: pytest>=7.0
+Description-Content-Type: text/markdown
+
+# pytest-devant-cloud
+
+pytest plugin that streams runs, results, and per-test step trees into
+[Devant Cloud](https://github.com/devant-net/devq-cloud) as your suite
+executes — the Python sibling of `@devant-net/playwright-reporter`.
+
+## Install
+
+```bash
+pip install pytest-devant-cloud
+```
+
+The plugin auto-registers via the `pytest11` entry-point group. No
+`conftest.py` changes are needed.
+
+## Configure
+
+Set env vars before invoking pytest:
+
+| Var | Default | Notes |
+|---|---|---|
+| `DEVQ_API_URL` | `http://localhost:32124` | Your tenant's URL |
+| `DEVQ_TOKEN` | `dev-admin-token` | Bearer token (CI/CD settings) |
+| `DEVQ_PROJECT_ID` | `1` | Devant Cloud project id |
+| `DEVQ_RUN_NAME` | `pytest — <ISO date>` | Display name on the run |
+| `DEVQ_RUN_ID` | _(unset)_ | Attach to an externally-created run instead of creating one |
+
+Or with CLI flags:
+
+```bash
+pytest \
+  --devant-api-url=https://acme.devq.cloud \
+  --devant-token=$DEVQ_TOKEN \
+  --devant-project-id=1
+```
+
+To disable the plugin for one run without uninstalling:
+
+```bash
+pytest -p no:devant_cloud
+```
+
+## How tests bind to test cases
+
+Each pytest item resolves to a Devant Cloud `test_case` row in this order:
+
+1. **`@pytest.mark.devant("DEF-AB12")` marker** on the test — looked up
+   via `GET /v1/test-cases/by-key/DEF-AB12`.
+2. **Exact name match** (`<file>::<test>` nodeid) in the project →
+   `GET /v1/test-cases?search=…`.
+3. **Auto-create** → `POST /v1/test-cases`. The plugin prints the new key:
+   ```
+   [devant] minted DEF-XYZ9 for "tests/test_auth.py::test_login"
+            — add @pytest.mark.devant("DEF-XYZ9") to bind it
+   ```
+
+Bind the key in source once and future runs (even with renames) reuse the
+same case.
+
+## What gets sent
+
+| pytest hook | Devant Cloud call |
+|---|---|
+| `pytest_sessionstart` | `POST /v1/runs` (skipped if `DEVQ_RUN_ID` is set) |
+| `pytest_runtest_makereport` (wrapper) | stashes setup/call/teardown reports on the item |
+| `pytest_runtest_logreport` (teardown phase) | resolve test case → `POST /v1/runs/:id/results` with step tree |
+| `pytest_sessionfinish` | `POST /v1/runs/:id/complete` (skipped if `DEVQ_RUN_ID` is set) |
+
+The step tree includes one node per phase (setup / call / teardown) with
+status, duration, and longrepr captured as `error_message`.
+
+## CI metadata
+
+Auto-detected for GitHub Actions, GitLab CI, CircleCI, Jenkins, and Azure
+DevOps, plus a generic `CI=true` fallback. Populates the `ci_*` columns
+on the run so the dashboard can deep-link to commits and PRs.

pytest_devant_cloud-0.1.0/README.md

@@ -0,0 +1,76 @@
+# pytest-devant-cloud
+
+pytest plugin that streams runs, results, and per-test step trees into
+[Devant Cloud](https://github.com/devant-net/devq-cloud) as your suite
+executes — the Python sibling of `@devant-net/playwright-reporter`.
+
+## Install
+
+```bash
+pip install pytest-devant-cloud
+```
+
+The plugin auto-registers via the `pytest11` entry-point group. No
+`conftest.py` changes are needed.
+
+## Configure
+
+Set env vars before invoking pytest:
+
+| Var | Default | Notes |
+|---|---|---|
+| `DEVQ_API_URL` | `http://localhost:32124` | Your tenant's URL |
+| `DEVQ_TOKEN` | `dev-admin-token` | Bearer token (CI/CD settings) |
+| `DEVQ_PROJECT_ID` | `1` | Devant Cloud project id |
+| `DEVQ_RUN_NAME` | `pytest — <ISO date>` | Display name on the run |
+| `DEVQ_RUN_ID` | _(unset)_ | Attach to an externally-created run instead of creating one |
+
+Or with CLI flags:
+
+```bash
+pytest \
+  --devant-api-url=https://acme.devq.cloud \
+  --devant-token=$DEVQ_TOKEN \
+  --devant-project-id=1
+```
+
+To disable the plugin for one run without uninstalling:
+
+```bash
+pytest -p no:devant_cloud
+```
+
+## How tests bind to test cases
+
+Each pytest item resolves to a Devant Cloud `test_case` row in this order:
+
+1. **`@pytest.mark.devant("DEF-AB12")` marker** on the test — looked up
+   via `GET /v1/test-cases/by-key/DEF-AB12`.
+2. **Exact name match** (`<file>::<test>` nodeid) in the project →
+   `GET /v1/test-cases?search=…`.
+3. **Auto-create** → `POST /v1/test-cases`. The plugin prints the new key:
+   ```
+   [devant] minted DEF-XYZ9 for "tests/test_auth.py::test_login"
+            — add @pytest.mark.devant("DEF-XYZ9") to bind it
+   ```
+
+Bind the key in source once and future runs (even with renames) reuse the
+same case.
+
+## What gets sent
+
+| pytest hook | Devant Cloud call |
+|---|---|
+| `pytest_sessionstart` | `POST /v1/runs` (skipped if `DEVQ_RUN_ID` is set) |
+| `pytest_runtest_makereport` (wrapper) | stashes setup/call/teardown reports on the item |
+| `pytest_runtest_logreport` (teardown phase) | resolve test case → `POST /v1/runs/:id/results` with step tree |
+| `pytest_sessionfinish` | `POST /v1/runs/:id/complete` (skipped if `DEVQ_RUN_ID` is set) |
+
+The step tree includes one node per phase (setup / call / teardown) with
+status, duration, and longrepr captured as `error_message`.
+
+## CI metadata
+
+Auto-detected for GitHub Actions, GitLab CI, CircleCI, Jenkins, and Azure
+DevOps, plus a generic `CI=true` fallback. Populates the `ci_*` columns
+on the run so the dashboard can deep-link to commits and PRs.

pytest_devant_cloud-0.1.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pytest-devant-cloud"
+version = "0.1.0"
+description = "pytest plugin that streams runs, results, and step trees to Devant Cloud's /v1/runs API."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.10"
+authors = [{ name = "Devant Cloud" }]
+keywords = ["pytest", "reporter", "devant", "devq", "test-reporting", "ci"]
+classifiers = [
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Quality Assurance",
+]
+dependencies = [
+    "pytest>=7.0",
+    "httpx>=0.24",
+]
+
+[project.urls]
+Homepage = "https://github.com/devant-net/devq-cloud/tree/main/packages/pytest-devant-cloud"
+Repository = "https://github.com/devant-net/devq-cloud"
+
+# Pytest discovers this plugin automatically via the `pytest11` entry-point
+# group. `plugin` is the module name pytest imports; pytest then registers
+# every hook function it finds at module scope.
+[project.entry-points."pytest11"]
+devant_cloud = "pytest_devant_cloud.plugin"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pytest_devant_cloud"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+    "/pyproject.toml",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+# Don't auto-load the plugin under test against its own unit tests — they
+# only exercise pure helpers and shouldn't open HTTP connections.
+addopts = "-p no:devant_cloud"

pytest_devant_cloud-0.1.0/src/pytest_devant_cloud/__init__.py

@@ -0,0 +1,12 @@
+"""pytest plugin that streams runs, results, and step trees to Devant Cloud.
+
+Public API is intentionally tiny — the plugin is registered via the
+`pytest11` entry-point group and configured via env vars or CLI flags. See
+the README for the contract.
+"""
+
+from . import mapping
+from .client import DevqClient
+
+__all__ = ["DevqClient", "mapping"]
+__version__ = "0.1.0"

pytest_devant_cloud-0.1.0/src/pytest_devant_cloud/client.py

@@ -0,0 +1,238 @@
+"""HTTP client for Devant Cloud's `/v1/runs/*` endpoints.
+
+Thin wrapper around `httpx` with bearer auth, retry on 5xx/429/network
+errors, and the resolve-test-case fallback chain. The plugin owns the
+lifecycle (createRun → submitResults → completeRun); the client owns the
+wire-level concerns (auth, retries, JSON encoding).
+"""
+
+from __future__ import annotations
+
+import time
+from dataclasses import dataclass
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from .mapping import CIInfo
+
+
+# ── data classes ─────────────────────────────────────────────────────────
+
+
+@dataclass
+class ResolvedCase:
+    """Result of resolveTestCase — matches JS reporter-core's ResolvedCase."""
+
+    id: int
+    key: str
+    minted: bool
+
+
+# ── client ───────────────────────────────────────────────────────────────
+
+
+class DevqClient:
+    """Devant Cloud REST client. One instance per pytest session."""
+
+    def __init__(
+        self,
+        api_url: str,
+        api_token: str,
+        project_id: int,
+        *,
+        timeout: float = 30.0,
+        max_retries: int = 3,
+    ) -> None:
+        # Strip trailing slash so url joins don't double up.
+        self.api_url = api_url.rstrip("/")
+        self.project_id = project_id
+        self.max_retries = max_retries
+        # Re-use one Connection pool for the whole session — pytest can
+        # easily emit hundreds of POSTs in a fast suite, and TCP setup
+        # cost dwarfs the request itself otherwise.
+        self._http = httpx.Client(
+            headers={
+                "Authorization": f"Bearer {api_token}",
+                "Content-Type": "application/json",
+                "Accept": "application/json",
+            },
+            timeout=timeout,
+        )
+
+    # ── lifecycle ────────────────────────────────────────────────────────
+
+    def close(self) -> None:
+        self._http.close()
+
+    def __enter__(self) -> "DevqClient":
+        return self
+
+    def __exit__(self, *_: object) -> None:
+        self.close()
+
+    # ── low-level request with retry ─────────────────────────────────────
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        *,
+        json_body: Any | None = None,
+    ) -> httpx.Response:
+        """One request with bounded retry.
+
+        Retries on 5xx, 429, and network errors with exponential backoff
+        (0.25s, 0.5s, 1s). 4xx errors fail fast so callers see schema
+        problems immediately.
+        """
+        url = f"{self.api_url}{path}"
+        last_exc: Exception | None = None
+        for attempt in range(self.max_retries + 1):
+            try:
+                resp = self._http.request(method, url, json=json_body)
+            except httpx.RequestError as exc:
+                last_exc = exc
+                if attempt >= self.max_retries:
+                    raise
+                time.sleep(0.25 * (2 ** attempt))
+                continue
+
+            if resp.status_code >= 500 or resp.status_code == 429:
+                if attempt >= self.max_retries:
+                    resp.raise_for_status()
+                time.sleep(0.25 * (2 ** attempt))
+                continue
+
+            resp.raise_for_status()
+            return resp
+
+        # Should be unreachable — every path above either returns or raises.
+        if last_exc:
+            raise last_exc
+        raise RuntimeError("retry loop exited without response")
+
+    # ── API surface ──────────────────────────────────────────────────────
+
+    def create_run(
+        self,
+        *,
+        name: str,
+        framework: str = "pytest",
+        ci: CIInfo | None = None,
+        mode: str = "automated",
+    ) -> dict[str, Any]:
+        payload: dict[str, Any] = {
+            "project_id": self.project_id,
+            "mode": mode,
+            "name": name,
+            "framework": framework,
+        }
+        if ci:
+            payload["ci"] = ci
+        resp = self._request("POST", "/v1/runs", json_body=payload)
+        return resp.json()
+
+    def resolve_test_case(
+        self,
+        *,
+        explicit_key: str | None,
+        full_name: str,
+    ) -> ResolvedCase:
+        """Mirrors reporter-core/src/resolve.ts.
+
+        Order: explicit @KEY → exact name search → auto-create.
+        """
+        # 1. explicit @KEY.
+        if explicit_key:
+            try:
+                resp = self._http.get(
+                    f"{self.api_url}/v1/test-cases/by-key/{quote(explicit_key)}",
+                    params={"project_id": self.project_id},
+                )
+                if resp.status_code == 200:
+                    body = resp.json()
+                    return ResolvedCase(
+                        id=int(body["id"]),
+                        key=str(body["key"]),
+                        minted=False,
+                    )
+            except httpx.HTTPError:
+                # Fall through to search → mint.
+                pass
+
+        # 2. exact name search.
+        try:
+            resp = self._http.get(
+                f"{self.api_url}/v1/test-cases",
+                params={"project_id": self.project_id, "search": full_name},
+            )
+            if resp.status_code == 200:
+                items = resp.json().get("items", [])
+                for it in items:
+                    if it.get("name") == full_name:
+                        return ResolvedCase(
+                            id=int(it["id"]),
+                            key=str(it["key"]),
+                            minted=False,
+                        )
+        except httpx.HTTPError:
+            pass
+
+        # 3. auto-create.
+        resp = self._request(
+            "POST",
+            "/v1/test-cases",
+            json_body={
+                "project_id": self.project_id,
+                "name": full_name,
+                "is_automated": True,
+            },
+        )
+        body = resp.json()
+        return ResolvedCase(
+            id=int(body["id"]),
+            key=str(body["key"]),
+            minted=True,
+        )
+
+    def submit_results(
+        self,
+        run_id: int,
+        results: list[dict[str, Any]],
+    ) -> list[dict[str, Any]]:
+        resp = self._request(
+            "POST",
+            f"/v1/runs/{run_id}/results",
+            json_body={"results": results},
+        )
+        body = resp.json()
+        return body.get("results", [])
+
+    def submit_coverage(
+        self,
+        run_id: int,
+        summary: dict[str, Any],
+    ) -> None:
+        self._request(
+            "POST",
+            f"/v1/runs/{run_id}/coverage",
+            json_body=summary,
+        )
+
+    def complete_run(
+        self,
+        run_id: int,
+        *,
+        status: str = "complete",
+        html_report_url: str | None = None,
+    ) -> None:
+        payload: dict[str, Any] = {"status": status}
+        if html_report_url is not None:
+            payload["html_report_url"] = html_report_url
+        self._request(
+            "POST",
+            f"/v1/runs/{run_id}/complete",
+            json_body=payload,
+        )