pytest-charisma 0.3.1__tar.gz

pytest_charisma-0.3.1/.gitignore

@@ -0,0 +1,134 @@
+# Dependencies
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# IDE
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Build outputs
+dist/
+build/
+*.log
+
+# Local pipeline secrets (do not commit)
+.env.pipeline
+
+# Database
+*.sqlite
+*.db
+
+# Test coverage
+coverage/
+.nyc_output/
+
+# Temporary files
+tmp/
+temp/
+*.tmp
+
+# Confluence sync metadata (optional - can be committed)
+# .amazonq/knowledge-base/.confluence-sync.json
+
+# Nuxt build outputs
+.nuxt/
+.output/
+dist/
+
+# Python cache
+*.pyc
+*/__pycache__/
+
+# Python virtual environments
+.venv/
+venv/
+
+# Hypothesys cache
+.hypothesis/
+
+# Kiro hooks (auto-generated)
+.kiro/hooks/
+.kiro/settings/*
+.kiro/settings/mcp.json
+
+# Kiro spec config (local)
+.kiro/specs/**/.config.kiro
+
+# Coverage
+.coverage
+
+# AWS SAM build artifacts
+.aws-sam/
+
+# Zip files in repo root (test artifacts, allure exports, etc.)
+*.zip
+
+# Playwright test results
+frontend/test-results/
+frontend/playwright-report/
+frontend/e2e-results/
+test-results/
+
+# E2E auth state (contains secrets)
+frontend/e2e/.auth/
+
+# E2E test environment (contains secrets)
+frontend/.env.e2e
+
+
+test-reporting.code-workspace
+
+
+.vscode/extensions.json
+Aurora.session.sql
+Charisma DB.session.sql
+
+
+# API integration test setup scripts (contains sensitive token generation)
+backend/api_integration_test_setup_scripts/
+
+# Local test/debug scripts
+scripts/test-ingestion-token.py
+
+# vs code settings
+.vscode/settings.json
+backend/integration_test_report.xml
+backend/unit_test_report.xml
+frontend/app/pages/proto.vue
+scripts/connect-aurora.ps1
+
+# mock test result files
+test-data-junit-debug*
+
+# scripts for creating mock data
+scripts/ingest-test-run/*
+
+# --- ltm-power ---
+ltm/*
+ltm/store/*.jsonl
+ltm/runtime/*
+ltm/reports/*
+ltm/snapshots/*
+.kiro/steering/ltm-memory-format.md
+.kiro/steering/ltm-operations.md
+backend/coverage.json
+*/__pycache__/*
+allure-results/*

pytest_charisma-0.3.1/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.5
+Name: pytest-charisma
+Version: 0.3.1
+Summary: A pytest plugin that streams test results to the Charisma ingestion API as tests execute.
+Author: Charisma Team
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: httpx<1.0,>=0.24
+Requires-Dist: pytest<10.0,>=7.0
+Provides-Extra: dev
+Requires-Dist: hypothesis; extra == 'dev'
+Requires-Dist: pytest-xdist; extra == 'dev'
+Requires-Dist: respx; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pytest-charisma
+
+A pytest plugin that streams test results to the Charisma ingestion API as tests execute.
+
+Results are batched and sent in a background thread so test execution is not blocked by network I/O. The plugin implements retry-once semantics and a circuit breaker (3 consecutive failures disables streaming for the rest of the session).
+
+## Installation
+
+```bash
+pip install pytest-charisma
+```
+
+No token, no index URL — works on any laptop and in any CI. The package is published to public PyPI; the Charisma repo itself stays private (only this client plugin wheel is public).
+
+For local development from a checkout of the repo:
+
+```bash
+pip install -e packages/pytest-charisma
+```
+
+## Publishing (maintainers)
+
+Releases publish to public PyPI automatically from the merge-queue workflow using a **PyPI API token**.
+
+> Trusted publishing (OIDC) is not used because this repo runs on **GitHub Enterprise Server**, whose OIDC issuer PyPI does not trust. A stored API token is required instead.
+
+One-time setup (done once by a PyPI project owner):
+
+1. Sign in to [PyPI](https://pypi.org) with the team-owned account (2FA enabled).
+2. Go to **Account settings → API tokens → Add API token**. Scope it to the `pytest-charisma` project once the project exists; for the very first publish use an account-scoped token, then re-scope it to the project afterward.
+3. Copy the token (starts with `pypi-`).
+4. In the GitHub Enterprise repo, add it as an Actions secret named **`PYPI_API_TOKEN`** (org-level secret recommended so both packages share it).
+5. Bump `version` in `pyproject.toml` and merge — the workflow builds and publishes on the next release.
+
+Rotate the token periodically and store it in the team secret manager.
+
+---
+
+## Quick start
+
+```bash
+pytest \
+  --charisma-url https://api.charisma.example.com \
+  --charisma-token $CHARISMA_TOKEN \
+  --charisma-project-alias my-project
+```
+
+The plugin activates automatically when `charisma_url` is configured. If the URL is absent, the plugin stays silent and does nothing.
+
+## Configuration
+
+Options are resolved with priority: **CLI flag > pytest.ini / pyproject.toml > environment variable**.
+
+| CLI flag                   | ini key                  | Env var                  | Required | Description                           |
+| -------------------------- | ------------------------ | ------------------------ | -------- | ------------------------------------- |
+| `--charisma-url`           | `charisma_url`           | `CHARISMA_URL`           | Yes      | API base URL                          |
+| `--charisma-token`         | `charisma_token`         | `CHARISMA_TOKEN`         | Yes      | Bearer token for authentication       |
+| `--charisma-project-alias` | `charisma_project_alias` | `CHARISMA_PROJECT_ALIAS` | Yes      | Project alias in Charisma             |
+| `--charisma-batch-size`    | `charisma_batch_size`    | `CHARISMA_BATCH_SIZE`    | No       | Results per batch, 1–50 (default: 20) |
+| `--charisma-build-id`      | `charisma_build_id`      | `CHARISMA_BUILD_ID`      | No       | CI build number or identifier         |
+| `--charisma-commit-sha`    | `charisma_commit_sha`    | `CHARISMA_COMMIT_SHA`    | No       | Git commit SHA                        |
+| `--charisma-branch`        | `charisma_branch`        | `CHARISMA_BRANCH`        | No       | Git branch name                       |
+| `--charisma-component`     | `charisma_component`     | `CHARISMA_COMPONENT`     | No       | Component alias within the project    |
+| `--charisma-source-url`    | `charisma_source_url`    | `CHARISMA_SOURCE_URL`    | No       | Link back to CI/CD run                |
+
+## Configuration via pyproject.toml
+
+```toml
+[tool.pytest.ini_options]
+charisma_url = "https://api.charisma.example.com"
+charisma_project_alias = "my-project"
+charisma_batch_size = "10"
+charisma_branch = "main"
+# Token should come from env var for security:
+# export CHARISMA_TOKEN=your-token
+```
+
+## Configuration via pytest.ini
+
+```ini
+[pytest]
+charisma_url = https://api.charisma.example.com
+charisma_project_alias = my-project
+charisma_batch_size = 10
+```
+
+## Environment variables only (CI-friendly)
+
+```bash
+export CHARISMA_URL=https://api.charisma.example.com
+export CHARISMA_TOKEN=your-api-token
+export CHARISMA_PROJECT_ALIAS=my-project
+export CHARISMA_BUILD_ID=$CI_BUILD_NUMBER
+export CHARISMA_COMMIT_SHA=$CI_COMMIT_SHA
+export CHARISMA_BRANCH=$CI_BRANCH
+export CHARISMA_SOURCE_URL=$CI_BUILD_URL
+
+pytest
+```
+
+## How it works
+
+1. **Collection** — After pytest collects tests, the plugin opens a launch session via `POST /api/v1/launches`.
+2. **Execution** — As each test completes, results are buffered. When the buffer reaches `batch_size`, the batch is submitted to a background worker thread.
+3. **Flush** — At session end, remaining results are flushed and the worker drains its queue (up to 30s timeout).
+4. **Resilience** — Each batch gets one retry on failure. After 3 consecutive batch failures, the circuit breaker trips and streaming is disabled for the rest of the session. Test execution is never affected.
+
+## Outcome mapping
+
+| pytest outcome            | Charisma status |
+| ------------------------- | --------------- |
+| `passed` (call phase)     | `passed`        |
+| `failed` (call phase)     | `failed`        |
+| `skipped`                 | `skipped`       |
+| `failed` (setup/teardown) | `broken`        |
+
+## Requirements
+
+- Python ≥ 3.10
+- pytest ≥ 7.0, < 9.0
+- httpx ≥ 0.24, < 1.0
+
+## Development
+
+```bash
+cd packages/pytest-charisma
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+MIT

pytest_charisma-0.3.1/README.md

@@ -0,0 +1,133 @@
+# pytest-charisma
+
+A pytest plugin that streams test results to the Charisma ingestion API as tests execute.
+
+Results are batched and sent in a background thread so test execution is not blocked by network I/O. The plugin implements retry-once semantics and a circuit breaker (3 consecutive failures disables streaming for the rest of the session).
+
+## Installation
+
+```bash
+pip install pytest-charisma
+```
+
+No token, no index URL — works on any laptop and in any CI. The package is published to public PyPI; the Charisma repo itself stays private (only this client plugin wheel is public).
+
+For local development from a checkout of the repo:
+
+```bash
+pip install -e packages/pytest-charisma
+```
+
+## Publishing (maintainers)
+
+Releases publish to public PyPI automatically from the merge-queue workflow using a **PyPI API token**.
+
+> Trusted publishing (OIDC) is not used because this repo runs on **GitHub Enterprise Server**, whose OIDC issuer PyPI does not trust. A stored API token is required instead.
+
+One-time setup (done once by a PyPI project owner):
+
+1. Sign in to [PyPI](https://pypi.org) with the team-owned account (2FA enabled).
+2. Go to **Account settings → API tokens → Add API token**. Scope it to the `pytest-charisma` project once the project exists; for the very first publish use an account-scoped token, then re-scope it to the project afterward.
+3. Copy the token (starts with `pypi-`).
+4. In the GitHub Enterprise repo, add it as an Actions secret named **`PYPI_API_TOKEN`** (org-level secret recommended so both packages share it).
+5. Bump `version` in `pyproject.toml` and merge — the workflow builds and publishes on the next release.
+
+Rotate the token periodically and store it in the team secret manager.
+
+---
+
+## Quick start
+
+```bash
+pytest \
+  --charisma-url https://api.charisma.example.com \
+  --charisma-token $CHARISMA_TOKEN \
+  --charisma-project-alias my-project
+```
+
+The plugin activates automatically when `charisma_url` is configured. If the URL is absent, the plugin stays silent and does nothing.
+
+## Configuration
+
+Options are resolved with priority: **CLI flag > pytest.ini / pyproject.toml > environment variable**.
+
+| CLI flag                   | ini key                  | Env var                  | Required | Description                           |
+| -------------------------- | ------------------------ | ------------------------ | -------- | ------------------------------------- |
+| `--charisma-url`           | `charisma_url`           | `CHARISMA_URL`           | Yes      | API base URL                          |
+| `--charisma-token`         | `charisma_token`         | `CHARISMA_TOKEN`         | Yes      | Bearer token for authentication       |
+| `--charisma-project-alias` | `charisma_project_alias` | `CHARISMA_PROJECT_ALIAS` | Yes      | Project alias in Charisma             |
+| `--charisma-batch-size`    | `charisma_batch_size`    | `CHARISMA_BATCH_SIZE`    | No       | Results per batch, 1–50 (default: 20) |
+| `--charisma-build-id`      | `charisma_build_id`      | `CHARISMA_BUILD_ID`      | No       | CI build number or identifier         |
+| `--charisma-commit-sha`    | `charisma_commit_sha`    | `CHARISMA_COMMIT_SHA`    | No       | Git commit SHA                        |
+| `--charisma-branch`        | `charisma_branch`        | `CHARISMA_BRANCH`        | No       | Git branch name                       |
+| `--charisma-component`     | `charisma_component`     | `CHARISMA_COMPONENT`     | No       | Component alias within the project    |
+| `--charisma-source-url`    | `charisma_source_url`    | `CHARISMA_SOURCE_URL`    | No       | Link back to CI/CD run                |
+
+## Configuration via pyproject.toml
+
+```toml
+[tool.pytest.ini_options]
+charisma_url = "https://api.charisma.example.com"
+charisma_project_alias = "my-project"
+charisma_batch_size = "10"
+charisma_branch = "main"
+# Token should come from env var for security:
+# export CHARISMA_TOKEN=your-token
+```
+
+## Configuration via pytest.ini
+
+```ini
+[pytest]
+charisma_url = https://api.charisma.example.com
+charisma_project_alias = my-project
+charisma_batch_size = 10
+```
+
+## Environment variables only (CI-friendly)
+
+```bash
+export CHARISMA_URL=https://api.charisma.example.com
+export CHARISMA_TOKEN=your-api-token
+export CHARISMA_PROJECT_ALIAS=my-project
+export CHARISMA_BUILD_ID=$CI_BUILD_NUMBER
+export CHARISMA_COMMIT_SHA=$CI_COMMIT_SHA
+export CHARISMA_BRANCH=$CI_BRANCH
+export CHARISMA_SOURCE_URL=$CI_BUILD_URL
+
+pytest
+```
+
+## How it works
+
+1. **Collection** — After pytest collects tests, the plugin opens a launch session via `POST /api/v1/launches`.
+2. **Execution** — As each test completes, results are buffered. When the buffer reaches `batch_size`, the batch is submitted to a background worker thread.
+3. **Flush** — At session end, remaining results are flushed and the worker drains its queue (up to 30s timeout).
+4. **Resilience** — Each batch gets one retry on failure. After 3 consecutive batch failures, the circuit breaker trips and streaming is disabled for the rest of the session. Test execution is never affected.
+
+## Outcome mapping
+
+| pytest outcome            | Charisma status |
+| ------------------------- | --------------- |
+| `passed` (call phase)     | `passed`        |
+| `failed` (call phase)     | `failed`        |
+| `skipped`                 | `skipped`       |
+| `failed` (setup/teardown) | `broken`        |
+
+## Requirements
+
+- Python ≥ 3.10
+- pytest ≥ 7.0, < 9.0
+- httpx ≥ 0.24, < 1.0
+
+## Development
+
+```bash
+cd packages/pytest-charisma
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+MIT

pytest_charisma-0.3.1/charisma.ini.example

@@ -0,0 +1,27 @@
+# pytest-charisma example configuration
+# Copy this file to pytest.ini or merge into pyproject.toml [tool.pytest.ini_options]
+#
+# Configuration priority: CLI flags > ini values > environment variables
+# Required fields: charisma_url, charisma_token, charisma_project_alias
+
+[pytest]
+# --- Required ---
+# Charisma API base URL
+charisma_url = https://yv1d62map2.execute-api.us-east-1.amazonaws.com/prod
+
+# Project alias (must match a project configured in Charisma)
+charisma_project_alias = tdg-service
+
+# API token — prefer env var CHARISMA_TOKEN for security
+# charisma_token = eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjaS1iYW1ib28tcHJvZCIsImVtYWlsIjoiY2lAaW50ZXJuYWwiLCJuYW1lIjoiYmFtYm9vLXByb2QiLCJ0b2tlblR5cGUiOiJjaSIsImlhdCI6MTc3ODc3MzExMSwiZXhwIjoxODEwMzA5MTExLCJqdGkiOiI0ZDgwNTlhNS1lNDMzLTRlY2ItYmY2YS02YWY0MDFhZDdhZjMifQ.blnhhElVsswcW9oYqnTeKecYGcBZXqstZEW4n9TiX1rtjC7Je4ZG-4vJ-dLgOBVOkJWfuaa_RaZT7fC73B2EFkrPoTe89-C3afCNEmpLWyiq6N7SZjQW6tPWj5MOlbjaEDlxlgr4oSjOluCe1midHZOG9IO22kXaxxBmOQmz6kucLQUnlDWXu9OdRFZl-zmdUg5qir-XxV6LWBEGsAUYIu_LzvodPHMyNcjxnPbmuwVZJn_Wn6VYdLuFXFs59lb8BByhENmFTci8pd-fRqJwXWgOt3AKBUsfzLnnjY8JtqmHUNLQ27SzG622pygN7tE-N9heUptJhMIJUAal9uBDzg
+
+# --- Optional ---
+# Number of test results per batch (1–50, default: 20)
+charisma_batch_size = 20
+
+# CI metadata (typically set via env vars in CI pipelines)
+# charisma_build_id = 1234
+# charisma_commit_sha = abc123def456
+# charisma_branch = main
+# charisma_component = backend
+# charisma_source_url = https://ci.example.com/builds/1234

pytest_charisma-0.3.1/py.typed

@@ -0,0 +1 @@
+

pytest_charisma-0.3.1/pyproject.toml

@@ -0,0 +1,53 @@
+# Build: hatchling
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pytest-charisma"
+version = "0.3.1"
+description = "A pytest plugin that streams test results to the Charisma ingestion API as tests execute."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "Charisma Team" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Testing",
+]
+dependencies = [
+    "pytest>=7.0,<10.0",
+    "httpx>=0.24,<1.0",
+]
+
+[project.entry-points.pytest11]
+charisma = "pytest_charisma.plugin"
+
+[project.optional-dependencies]
+dev = [
+    "respx",
+    "hypothesis",
+    "pytest-xdist",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pytest_charisma"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]

pytest_charisma-0.3.1/pyrightconfig.json

@@ -0,0 +1,4 @@
+{
+  "include": ["src", "tests"],
+  "extraPaths": ["src"]
+}

pytest_charisma-0.3.1/src/pytest_charisma/__init__.py

@@ -0,0 +1,3 @@
+"""pytest-charisma: A pytest plugin that streams test results to the Charisma ingestion API."""
+
+__version__ = "0.3.1"

pytest_charisma-0.3.1/src/pytest_charisma/client.py

@@ -0,0 +1,121 @@
+"""HTTP client wrapper for Charisma API communication.
+
+Provides CharismaClient for opening launches and flushing test result batches
+to the Charisma streaming ingestion API. Uses httpx with connection pooling
+and configured timeouts.
+"""
+
+from __future__ import annotations
+
+import logging
+
+import httpx
+
+logger = logging.getLogger("pytest-charisma")
+
+
+class CharismaClient:
+    """HTTP client for the Charisma ingestion API.
+
+    Wraps httpx.Client with connection pooling, Bearer token auth,
+    and configured timeouts (5s connect, 10s read).
+
+    Args:
+        base_url: Base URL of the Charisma API (e.g. "https://api.charisma.dev").
+        token: Bearer token for API authentication.
+    """
+
+    CONNECT_TIMEOUT = 5.0
+    READ_TIMEOUT = 10.0
+
+    def __init__(self, base_url: str, token: str) -> None:
+        self._http = httpx.Client(
+            base_url=base_url,
+            headers={
+                "Authorization": f"Bearer {token}",
+                "Content-Type": "application/json",
+            },
+            timeout=httpx.Timeout(self.CONNECT_TIMEOUT, read=self.READ_TIMEOUT),
+        )
+
+    def open_launch(self, payload: dict) -> str:
+        """Open a new launch session.
+
+        POST /api/v1/launches with the given payload. Returns the launchId
+        from the response body. Raises on any non-2xx response or missing launchId.
+
+        Args:
+            payload: Launch request body containing projectAlias, expectedTests,
+                and optional fields (buildId, commitSha, branch, etc.).
+
+        Returns:
+            The launchId string from the API response.
+
+        Raises:
+            httpx.HTTPStatusError: On non-2xx response status.
+            ValueError: If the response body does not contain a launchId.
+        """
+        url = "/api/v1/launches"
+        response = self._http.post(url, json=payload)
+        if response.status_code >= 400:
+            logger.warning("open_launch failed: status=%d, body=%s", response.status_code, response.text[:500])
+        response.raise_for_status()
+        data = response.json()
+        launch_id = data.get("launchId")
+        if not launch_id:
+            raise ValueError(f"API response missing 'launchId': {data}")
+        return launch_id
+
+    def flush_batch(self, launch_id: str, results: list[dict]) -> bool:
+        """Flush a batch of test results to the API.
+
+        POST /api/v1/launches/{launch_id}/results with results wrapped in
+        a {"results": [...]} payload. Returns True on HTTP 200, False on
+        any failure (HTTP errors, network errors). Never raises.
+
+        Args:
+            launch_id: The launch session ID to append results to.
+            results: List of serialized test result dicts.
+
+        Returns:
+            True if the API returned 200, False otherwise.
+        """
+        try:
+            response = self._http.post(
+                f"/api/v1/launches/{launch_id}/results",
+                json={"results": results},
+            )
+            if response.status_code != 200:
+                logger.warning("flush_batch got status=%d, body=%s", response.status_code, response.text[:200])
+            return response.status_code == 200
+        except Exception as e:
+            logger.warning("flush_batch exception: %s", e)
+            return False
+
+    def close_launch(self, launch_id: str) -> bool:
+        """Close a streaming launch, finalizing its status.
+
+        POST /api/v1/launches/{launch_id}/close. Signals the API that no more
+        results will be sent and the launch should compute its final status
+        from whatever results were received. Idempotent.
+
+        Args:
+            launch_id: The launch session ID to close.
+
+        Returns:
+            True if the API returned 200, False otherwise.
+        """
+        try:
+            response = self._http.post(
+                f"/api/v1/launches/{launch_id}/close",
+            )
+            if response.status_code != 200:
+                logger.warning("close_launch got status=%d, body=%s", response.status_code, response.text[:200])
+            return response.status_code == 200
+        except Exception as e:
+            logger.warning("close_launch exception: %s", e)
+            return False
+
+    def close(self) -> None:
+        """Close the underlying httpx.Client and release connection pool."""
+        self._http.close()