charisma-cli 0.3.0__tar.gz → 0.4.0__tar.gz

{charisma_cli-0.3.0 → charisma_cli-0.4.0}/.gitignore

@@ -65,6 +65,10 @@ venv/
 # Hypothesys cache
 .hypothesis/
 
+# mypy incremental cache
+.mypy_cache/
+backend/.mypy_cache/
+
 # Kiro hooks (auto-generated)
 .kiro/hooks/
 .kiro/settings/*
@@ -109,6 +113,9 @@ backend/api_integration_test_setup_scripts/
 # Local test/debug scripts
 scripts/test-ingestion-token.py
 
+# Local-only migration verification test (run manually when migration 044 is applied; not part of the suite)
+backend/tests/integration/test_backfill_variant_history_id_migration_local.py
+
 # vs code settings
 .vscode/settings.json
 backend/integration_test_report.xml
@@ -136,3 +143,12 @@ allure-results/*
 allure-results-live/
 *tasks.meta.json
 *.code-workspace
+
+# Session-specific work-state tracking (see .kiro update-work-state skill)
+.current-task.md
+
+# Local agent verdicts, RCAs, and pipeline state — never tracked in the repo
+.agents/
+
+# sql files for locally run DB queries
+/*.sql

{charisma_cli-0.3.0 → charisma_cli-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: charisma-cli
-Version: 0.3.0
+Version: 0.4.0
 Summary: CLI tool that watches allure-results and streams test results + attachments to Charisma.
 Author: Charisma Team
 License-Expression: MIT
@@ -75,15 +75,31 @@ charismactl watch --results allure-results -- uv run pytest -n 4 tests/
 | `CHARISMA_TOKEN`      | Yes      | Service or CI bearer token                         |
 | `CHARISMA_PROJECT_ID` | Yes      | Project alias for result routing                   |
 | `CHARISMA_RESULTS`    | No       | Path to allure-results (default: `allure-results`) |
+| `CHARISMA_RUN_KEY`    | No       | Run identity / merge key (`--run-key` fallback)    |
+| `BUILD_ID`            | No       | CI build identifier (`--build-id` fallback; `CHARISMA_BUILD_ID` also honored) |
+| `BUILD_PLAN_KEY`      | No       | Build plan key (`--build-plan-key` fallback; `CHARISMA_BUILD_PLAN_KEY` also honored) |
+| `ENVIRONMENT`         | No       | Environment code (`--environment` fallback; `CHARISMA_ENVIRONMENT` also honored) |
+| `COMPONENT`           | No       | Component alias (`--component` fallback; `CHARISMA_COMPONENT` also honored) |
+| `SOURCE_URL`          | No       | CI/CD build link (`--source-url` fallback; `CHARISMA_SOURCE_URL` also honored) |
 
 ## Flags
 
-| Flag             | Description                                  |
-| ---------------- | -------------------------------------------- |
-| `--results PATH` | Allure results directory (overrides env var) |
-| `--project ID`   | Project alias (overrides env var)            |
-| `--silent`       | Don't fail pipeline if upload errors occur   |
-| `--skip-too-big` | Skip result files larger than 2MB            |
+Both `upload` and `watch` accept the identical option set.
+
+| Flag                 | Description                                                      |
+| -------------------- | --------------------------------------------------------------- |
+| `--endpoint URL`     | Charisma API endpoint (overrides `CHARISMA_ENDPOINT`)           |
+| `--token TOKEN`      | Bearer token (overrides `CHARISMA_TOKEN`)                       |
+| `--results PATH`     | Allure results directory (overrides env var)                    |
+| `--project ID`       | Project alias (overrides env var)                               |
+| `--silent`           | Don't fail pipeline if upload errors occur                      |
+| `--skip-too-big`     | Skip result files larger than 2MB                               |
+| `--component ALIAS`  | Component alias within the project                              |
+| `--source-url URL`   | CI/CD build link for this run                                   |
+| `--build-plan-key K` | Explicit build plan key for resolution (forwarded as `buildPlanKey`) |
+| `--build-id ID`      | CI build identifier for this run (forwarded as `buildId`)       |
+| `--environment ENV`  | Environment code (e.g. `qat`, `prod`), stored on the launch     |
+| `--run-key KEY`      | Run identity / merge key (reruns + parallel workers share it)   |
 
 ## Launch URL in CI
 

{charisma_cli-0.3.0 → charisma_cli-0.4.0}/README.md

@@ -50,15 +50,31 @@ charismactl watch --results allure-results -- uv run pytest -n 4 tests/
 | `CHARISMA_TOKEN`      | Yes      | Service or CI bearer token                         |
 | `CHARISMA_PROJECT_ID` | Yes      | Project alias for result routing                   |
 | `CHARISMA_RESULTS`    | No       | Path to allure-results (default: `allure-results`) |
+| `CHARISMA_RUN_KEY`    | No       | Run identity / merge key (`--run-key` fallback)    |
+| `BUILD_ID`            | No       | CI build identifier (`--build-id` fallback; `CHARISMA_BUILD_ID` also honored) |
+| `BUILD_PLAN_KEY`      | No       | Build plan key (`--build-plan-key` fallback; `CHARISMA_BUILD_PLAN_KEY` also honored) |
+| `ENVIRONMENT`         | No       | Environment code (`--environment` fallback; `CHARISMA_ENVIRONMENT` also honored) |
+| `COMPONENT`           | No       | Component alias (`--component` fallback; `CHARISMA_COMPONENT` also honored) |
+| `SOURCE_URL`          | No       | CI/CD build link (`--source-url` fallback; `CHARISMA_SOURCE_URL` also honored) |
 
 ## Flags
 
-| Flag             | Description                                  |
-| ---------------- | -------------------------------------------- |
-| `--results PATH` | Allure results directory (overrides env var) |
-| `--project ID`   | Project alias (overrides env var)            |
-| `--silent`       | Don't fail pipeline if upload errors occur   |
-| `--skip-too-big` | Skip result files larger than 2MB            |
+Both `upload` and `watch` accept the identical option set.
+
+| Flag                 | Description                                                      |
+| -------------------- | --------------------------------------------------------------- |
+| `--endpoint URL`     | Charisma API endpoint (overrides `CHARISMA_ENDPOINT`)           |
+| `--token TOKEN`      | Bearer token (overrides `CHARISMA_TOKEN`)                       |
+| `--results PATH`     | Allure results directory (overrides env var)                    |
+| `--project ID`       | Project alias (overrides env var)                               |
+| `--silent`           | Don't fail pipeline if upload errors occur                      |
+| `--skip-too-big`     | Skip result files larger than 2MB                               |
+| `--component ALIAS`  | Component alias within the project                              |
+| `--source-url URL`   | CI/CD build link for this run                                   |
+| `--build-plan-key K` | Explicit build plan key for resolution (forwarded as `buildPlanKey`) |
+| `--build-id ID`      | CI build identifier for this run (forwarded as `buildId`)       |
+| `--environment ENV`  | Environment code (e.g. `qat`, `prod`), stored on the launch     |
+| `--run-key KEY`      | Run identity / merge key (reruns + parallel workers share it)   |
 
 ## Launch URL in CI
 

{charisma_cli-0.3.0 → charisma_cli-0.4.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "charisma-cli"
-version = "0.3.0"
+version = "0.4.0"
 description = "CLI tool that watches allure-results and streams test results + attachments to Charisma."
 readme = "README.md"
 license = "MIT"

charisma_cli-0.4.0/src/charisma_cli/__init__.py

@@ -0,0 +1,7 @@
+"""charisma-cli: Stream allure results to Charisma in real time."""
+
+# Single source of truth for the CLI version. At build time the wheel metadata
+# is generated from pyproject.toml [project].version, so keeping this literal
+# equal to pyproject guarantees `--version` reports the published version. The
+# prepare-commit step owns the PATCH bump — do not hand-bump here.
+__version__ = "0.4.0"

charisma_cli-0.4.0/src/charisma_cli/config.py

@@ -0,0 +1,163 @@
+"""Configuration dataclass with env var + CLI flag resolution."""
+
+import os
+from dataclasses import dataclass
+
+import click
+
+
+def _resolve_env(bare_name: str) -> str | None:
+    """Resolve an env var by its bare name, falling back to the CHARISMA_ prefix.
+
+    Bare-name-first (e.g. ``BUILD_ID``) keeps parity with CI systems that export
+    generic build metadata, while the ``CHARISMA_`` prefixed form (e.g.
+    ``CHARISMA_BUILD_ID``) is honored as a namespaced fallback. Returns the first
+    non-empty value, or None.
+    """
+    for name in (bare_name, f"CHARISMA_{bare_name}"):
+        value = os.getenv(name)
+        if value and value.strip():
+            return value.strip()
+    return None
+
+
+@dataclass
+class Config:
+    """Resolved configuration for charismactl.
+
+    Fields are populated via from_env() which merges CLI flag overrides
+    with environment variable fallbacks.
+    """
+
+    endpoint: str
+    token: str
+    project: str
+    results_dir: str
+    silent: bool
+    skip_too_big: bool
+    drain_timeout: int
+    build_id: str | None
+    commit_sha: str | None
+    branch: str | None
+    component: str | None = None
+    source_url: str | None = None
+    build_plan_key: str | None = None
+    environment: str | None = None
+    name: str | None = None
+    tags: list[str] | None = None
+    run_key: str | None = None
+
+    @classmethod
+    def from_env(
+        cls,
+        *,
+        endpoint: str | None = None,
+        token: str | None = None,
+        project: str | None = None,
+        results: str | None = None,
+        silent: bool = False,
+        skip_too_big: bool = False,
+        drain_timeout: int = 30,
+        component: str | None = None,
+        source_url: str | None = None,
+        build_plan_key: str | None = None,
+        build_id: str | None = None,
+        environment: str | None = None,
+        run_key: str | None = None,
+    ) -> "Config":
+        """Build Config by resolving CLI flags over environment variables.
+
+        Resolution order: CLI flag (if not None) > env var > default.
+
+        Args:
+            endpoint: --endpoint flag override
+            token: --token flag override
+            project: --project flag override
+            results: --results flag override
+            silent: --silent flag
+            skip_too_big: --skip-too-big flag
+            drain_timeout: drain timeout in seconds
+            component: --component flag override (component alias within the
+                project). Env: COMPONENT, fallback CHARISMA_COMPONENT.
+            source_url: --source-url flag override (CI/CD build link). Env:
+                SOURCE_URL, fallback CHARISMA_SOURCE_URL.
+            build_plan_key: --build-plan-key flag override (explicit build plan
+                key). Env: BUILD_PLAN_KEY, fallback CHARISMA_BUILD_PLAN_KEY.
+            build_id: --build-id flag override (CI build identifier). Env:
+                BUILD_ID, fallback CHARISMA_BUILD_ID. Flag wins over env.
+            environment: --environment flag override (env code, e.g. "qat").
+                Persisted to the first-class launch environment column. Env:
+                ENVIRONMENT, fallback CHARISMA_ENVIRONMENT.
+            run_key: --run-key flag override. Client-supplied merge key: the
+                backend derives the launch id as uuid5(project/run_key) and
+                get-or-creates, so reruns and parallel producers sharing a key
+                land in one launch. Empty/whitespace resolves to None (a new
+                random launch, unchanged behavior).
+
+        Returns:
+            Fully resolved Config instance.
+
+        Raises:
+            click.UsageError: If required fields (endpoint, token) are missing.
+        """
+        # Connection config resolves from the CHARISMA_-prefixed name ONLY (no
+        # bare form): a generic ENDPOINT/TOKEN/PROJECT_ID/RUN_KEY in the
+        # environment must not silently reconfigure the client. Build/run
+        # metadata below uses _resolve_env (bare-first, prefixed fallback) so it
+        # picks up generic CI variables. Do NOT "unify" these — the split is
+        # intentional and mirrors pytest-charisma (bare_env_var=None for config).
+        resolved_endpoint = (endpoint or os.getenv("CHARISMA_ENDPOINT", "")).strip()
+        resolved_token = (token or os.getenv("CHARISMA_TOKEN", "")).strip()
+        resolved_project = (project or os.getenv("CHARISMA_PROJECT_ID", "")).strip()
+        resolved_results = results or os.getenv("CHARISMA_RESULTS", "allure-results")
+        resolved_run_key = (run_key or os.getenv("CHARISMA_RUN_KEY", "")).strip() or None
+        resolved_component = (component or _resolve_env("COMPONENT") or "").strip() or None
+        resolved_source_url = (source_url or _resolve_env("SOURCE_URL") or "").strip() or None
+        resolved_build_plan_key = (build_plan_key or _resolve_env("BUILD_PLAN_KEY") or "").strip() or None
+        resolved_build_id = (build_id or _resolve_env("BUILD_ID") or "").strip() or None
+        resolved_environment = (environment or _resolve_env("ENVIRONMENT") or "").strip() or None
+        # Human-readable launch name (LAUNCH_NAME) and comma-separated tags
+        # (TAGS, e.g. "CI/CD,performance") shown on the Launches page.
+        resolved_name = (_resolve_env("LAUNCH_NAME") or "").strip() or None
+        resolved_tags = [t.strip() for t in (_resolve_env("TAGS") or "").split(",") if t.strip()] or None
+
+        # Merge Bamboo agent labels into resolved_tags (zero-config, opportunistic).
+        # bamboo_agentLabelString is a space-separated list of CI agent labels set
+        # automatically by Bamboo. Tokens are deduplicated against any explicit TAGS.
+        bamboo_raw = os.environ.get("bamboo_agentLabelString", "").strip()
+        if bamboo_raw:
+            base = list(resolved_tags or [])
+            seen: set[str] = set(base)
+            for label in bamboo_raw.split():
+                label = label.strip()
+                if label and label not in seen:
+                    base.append(label)
+                    seen.add(label)
+            resolved_tags = base or None
+
+        if not resolved_endpoint:
+            raise click.UsageError(
+                "Missing required configuration: endpoint. Set CHARISMA_ENDPOINT or pass --endpoint."
+            )
+        if not resolved_token:
+            raise click.UsageError("Missing required configuration: token. Set CHARISMA_TOKEN or pass --token.")
+
+        return cls(
+            endpoint=resolved_endpoint,
+            token=resolved_token,
+            project=resolved_project,
+            results_dir=resolved_results,
+            silent=silent,
+            skip_too_big=skip_too_big,
+            drain_timeout=drain_timeout,
+            build_id=resolved_build_id,
+            commit_sha=_resolve_env("COMMIT_SHA"),
+            branch=_resolve_env("BRANCH"),
+            component=resolved_component,
+            source_url=resolved_source_url,
+            build_plan_key=resolved_build_plan_key,
+            environment=resolved_environment,
+            name=resolved_name,
+            tags=resolved_tags,
+            run_key=resolved_run_key,
+        )

{charisma_cli-0.3.0 → charisma_cli-0.4.0}/src/charisma_cli/main.py

@@ -2,6 +2,7 @@
 
 import signal
 import sys
+from collections.abc import Callable
 from pathlib import Path
 from queue import PriorityQueue
 
@@ -39,6 +40,11 @@ def _resolve_config(
     results: str,
     silent: bool,
     skip_too_big: bool,
+    component: str | None = None,
+    source_url: str | None = None,
+    build_plan_key: str | None = None,
+    build_id: str | None = None,
+    environment: str | None = None,
     run_key: str | None = None,
 ) -> Config:
     """Resolve CLI config from flags + env vars. Re-raises UsageError on failure."""
@@ -49,6 +55,11 @@ def _resolve_config(
         results=results,
         silent=silent,
         skip_too_big=skip_too_big,
+        component=component,
+        source_url=source_url,
+        build_plan_key=build_plan_key,
+        build_id=build_id,
+        environment=environment,
         run_key=run_key,
     )
 
@@ -135,23 +146,50 @@ def _print_summary(uploader: Uploader) -> None:
     )
 
 
+def _common_options(func: Callable) -> Callable:
+    """Apply the shared connection + launch-metadata options to a command.
+
+    `watch` and `upload` accept the identical option set; defining it once here
+    keeps them from drifting (a new launch field is added in one place, not two).
+    Decorators apply bottom-up, so the visible order on the command matches the
+    order below.
+    """
+    options = [
+        click.option("--endpoint", envvar="CHARISMA_ENDPOINT", default=None, help="Charisma API endpoint."),
+        click.option("--token", envvar="CHARISMA_TOKEN", default=None, help="Bearer token."),
+        click.option(
+            "--results", envvar="CHARISMA_RESULTS", default="allure-results", help="Allure results directory."
+        ),
+        click.option("--project", envvar="CHARISMA_PROJECT_ID", required=True, help="Project alias."),
+        click.option("--silent", is_flag=True, default=False, help="Don't fail if upload errors occur."),
+        click.option("--skip-too-big", is_flag=True, default=False, help="Skip result files larger than 2MB."),
+        click.option("--component", default=None, help="Component alias within the project."),
+        click.option("--source-url", default=None, help="CI/CD build link for this run."),
+        click.option("--build-plan-key", default=None, help="Explicit build plan key for resolution."),
+        click.option("--build-id", default=None, help="CI build identifier for this run (forwarded as buildId)."),
+        click.option(
+            "--environment",
+            default=None,
+            help="Environment code (e.g. 'qat', 'prod'). Stored as the launch environment.",
+        ),
+        click.option(
+            "--run-key",
+            envvar="CHARISMA_RUN_KEY",
+            default=None,
+            help="Run identity / merge key (NOT the build id). Producers sharing this key "
+            "stream into one launch (launch id = uuid5(project/run-key)) — powers "
+            "rerun-in-place and parallel workers; reruns record retry attempts. Use your "
+            "CI run/pipeline id (e.g. GITHUB_RUN_ID) so retries merge but separate runs "
+            "stay separate. Omit for a new launch.",
+        ),
+    ]
+    for option in reversed(options):
+        func = option(func)
+    return func
+
+
 @cli.command()
-@click.option("--endpoint", envvar="CHARISMA_ENDPOINT", default=None, help="Charisma API endpoint.")
-@click.option("--token", envvar="CHARISMA_TOKEN", default=None, help="Bearer token.")
-@click.option("--results", envvar="CHARISMA_RESULTS", default="allure-results", help="Allure results directory.")
-@click.option("--project", envvar="CHARISMA_PROJECT_ID", required=True, help="Project alias.")
-@click.option("--silent", is_flag=True, default=False, help="Don't fail if upload errors occur.")
-@click.option("--skip-too-big", is_flag=True, default=False, help="Skip result files larger than 2MB.")
-@click.option(
-    "--run-key",
-    envvar="CHARISMA_RUN_KEY",
-    default=None,
-    help="Run identity / merge key (NOT the build id). Producers sharing this key "
-    "stream into one launch (launch id = uuid5(project/run-key)) — powers "
-    "rerun-in-place and parallel workers; reruns record retry attempts. Use your "
-    "CI run/pipeline id (e.g. GITHUB_RUN_ID) so retries merge but separate runs "
-    "stay separate. Omit for a new launch.",
-)
+@_common_options
 @click.argument("command", nargs=-1, required=True)
 def watch(
     endpoint: str | None,
@@ -160,6 +198,11 @@ def watch(
     project: str,
     silent: bool,
     skip_too_big: bool,
+    component: str | None,
+    source_url: str | None,
+    build_plan_key: str | None,
+    build_id: str | None,
+    environment: str | None,
     run_key: str | None,
     command: tuple[str, ...],
 ) -> None:
@@ -167,7 +210,20 @@ def watch(
 
     Usage: charismactl watch --project my-project -- pytest -n 4 tests/
     """
-    config = _resolve_config(endpoint, token, project, results, silent, skip_too_big, run_key)
+    config = _resolve_config(
+        endpoint,
+        token,
+        project,
+        results,
+        silent,
+        skip_too_big,
+        component,
+        source_url,
+        build_plan_key,
+        build_id,
+        environment,
+        run_key,
+    )
 
     queue: PriorityQueue[FileEvent] = PriorityQueue()
     uploader = Uploader(config, queue)
@@ -220,7 +276,12 @@ def watch(
 
     # Drain and close — stop the watcher AFTER drain so the consumer's final
     # queue flush still sees anything the observer enqueued during drain.
-    uploader.drain(timeout=config.drain_timeout)
+    # drain() is progress-based and returns False if it stalled or any send
+    # failed — same partial-send guard as `upload`. In watch mode a dropped
+    # upload must not be masked by a passing test run (exit 0), so an incomplete
+    # drain forces a non-zero exit while still preserving a failing test's own
+    # exit code.
+    fully_drained = uploader.drain(timeout=config.drain_timeout)
     watcher.stop()
     uploader.stop()
 
@@ -232,26 +293,22 @@ def watch(
 
     _warn_if_results_unsent(uploader, config)
     _print_summary(uploader)
+
+    if not fully_drained:
+        click.echo(
+            "Error: upload did not finish — the consumer stalled or results "
+            "failed to send; some results were dropped. Exiting non-zero so this "
+            "run is not treated as a successful upload.",
+            err=True,
+        )
+        # Preserve a failing test's exit code; otherwise surface the upload
+        # failure as exit 1 instead of letting a passing test mask it.
+        sys.exit(exit_code if exit_code != 0 else 1)
     sys.exit(exit_code)
 
 
 @cli.command()
-@click.option("--endpoint", envvar="CHARISMA_ENDPOINT", default=None, help="Charisma API endpoint.")
-@click.option("--token", envvar="CHARISMA_TOKEN", default=None, help="Bearer token.")
-@click.option("--results", envvar="CHARISMA_RESULTS", default="allure-results", help="Allure results directory.")
-@click.option("--project", envvar="CHARISMA_PROJECT_ID", required=True, help="Project alias.")
-@click.option("--silent", is_flag=True, default=False, help="Don't fail if upload errors occur.")
-@click.option("--skip-too-big", is_flag=True, default=False, help="Skip result files larger than 2MB.")
-@click.option(
-    "--run-key",
-    envvar="CHARISMA_RUN_KEY",
-    default=None,
-    help="Run identity / merge key (NOT the build id). Producers sharing this key "
-    "stream into one launch (launch id = uuid5(project/run-key)) — powers "
-    "rerun-in-place and parallel workers; reruns record retry attempts. Use your "
-    "CI run/pipeline id (e.g. GITHUB_RUN_ID) so retries merge but separate runs "
-    "stay separate. Omit for a new launch.",
-)
+@_common_options
 def upload(
     endpoint: str | None,
     token: str | None,
@@ -259,13 +316,31 @@ def upload(
     project: str,
     silent: bool,
     skip_too_big: bool,
+    component: str | None,
+    source_url: str | None,
+    build_plan_key: str | None,
+    build_id: str | None,
+    environment: str | None,
     run_key: str | None,
 ) -> None:
     """Upload completed allure-results to Charisma (post-execution).
 
     Usage: charismactl upload --project my-project --results allure-results
     """
-    config = _resolve_config(endpoint, token, project, results, silent, skip_too_big, run_key)
+    config = _resolve_config(
+        endpoint,
+        token,
+        project,
+        results,
+        silent,
+        skip_too_big,
+        component,
+        source_url,
+        build_plan_key,
+        build_id,
+        environment,
+        run_key,
+    )
 
     queue: PriorityQueue[FileEvent] = PriorityQueue()
     uploader = Uploader(config, queue)
@@ -292,9 +367,14 @@ def upload(
             if category is not None:
                 queue.put(FileEvent(path=filepath, category=category))
 
-    # Process and drain
+    # Process and drain. drain() is progress-based: it runs to completion for a
+    # healthy upload of any size and only returns False if the consumer STALLS
+    # (no progress for drain_timeout seconds). A False return means results were
+    # dropped — we must still close the launch and print the summary, then exit
+    # non-zero so CI sees a failure instead of a green build with a partial send
+    # (the upload results_sent=700/10158-queued bug).
     uploader.start()
-    uploader.drain(timeout=config.drain_timeout)
+    fully_drained = uploader.drain(timeout=config.drain_timeout)
     uploader.stop()
 
     # Close launch
@@ -303,3 +383,12 @@ def upload(
     uploader.stop()
 
     _print_summary(uploader)
+
+    if not fully_drained:
+        click.echo(
+            "Error: upload did not finish — the consumer stalled and some results "
+            "were not sent. Exiting non-zero so this run is not treated as a "
+            "successful upload.",
+            err=True,
+        )
+        sys.exit(1)