correctness_bundle_validation.py

Go to the documentation of this file.

#!/usr/bin/env python3
"""Validation: density-matrix correctness-evidence package.

Builds the shared correctness-evidence package by joining positive supported
records and stage-separated unsupported-boundary evidence through one stable
machine-reviewable surface.

Run with:
    python benchmarks/density_matrix/correctness_evidence/correctness_bundle_validation.py
"""

from __future__ import annotations

import argparse
from pathlib import Path

from benchmarks.density_matrix.correctness_evidence.bundle import (
    build_correctness_package_payload,
)
from benchmarks.density_matrix.correctness_evidence.common import (
    CORRECTNESS_PACKAGE_SCHEMA_VERSION,
    build_package_software_metadata,
    correctness_evidence_output_dir,
    write_artifact_bundle,
)
from benchmarks.density_matrix.correctness_evidence.records import (
    counted_supported_case,
)
from benchmarks.density_matrix.validation_scaffold import require_bundle_fields

SUITE_NAME = "correctness_evidence_correctness_package"
ARTIFACT_FILENAME = "correctness_package_bundle.json"
DEFAULT_OUTPUT_DIR = correctness_evidence_output_dir("correctness_package")
ARTIFACT_CORE_FIELDS = (
    "suite_name",
    "status",
    "schema_version",
    "software",
    "selected_candidate",
    "summary",
    "cases",
    "negative_cases",
)


def build_cases() -> list[dict]:
    return build_correctness_package_payload()["cases"]


def build_artifact_bundle() -> dict:
    payload = build_correctness_package_payload()
    cases = payload["cases"]
    negative_cases = payload["negative_cases"]
    counted_supported_cases = sum(counted_supported_case(case) for case in cases)
    bundle = {
        "suite_name": SUITE_NAME,
        "status": "pass"
        if counted_supported_cases == len(cases)
        and len(negative_cases) > 0
        and all(case["status"] == "unsupported" for case in negative_cases)
        else "fail",
        "schema_version": CORRECTNESS_PACKAGE_SCHEMA_VERSION,
        "software": build_package_software_metadata(),
        "selected_candidate": payload["selected_candidate"],
        "summary": payload["summary"],
        "cases": cases,
        "negative_cases": negative_cases,
    }
    require_bundle_fields(bundle, ARTIFACT_CORE_FIELDS, "Correctness package bundle")
    return bundle


def main(argv: list[str] | None = None) -> int:
    parser = argparse.ArgumentParser(description=__doc__)
    parser.add_argument(
        "--output-dir",
        type=Path,
        default=DEFAULT_OUTPUT_DIR,
        help="Directory to write the correctness package bundle into.",
    )
    parser.add_argument(
        "--quiet",
        action="store_true",
        help="Suppress per-case console output.",
    )
    args = parser.parse_args(argv)

    bundle = build_artifact_bundle()
    output_path = write_artifact_bundle(bundle, args.output_dir, ARTIFACT_FILENAME)

    if not args.quiet:
        print(
            "counted_supported_cases={counted_supported_cases}, unsupported_boundary_cases={unsupported_boundary_cases}".format(
                **bundle["summary"]
            )
        )
        print("Wrote {}".format(output_path))

    return 0 if bundle["status"] == "pass" else 1


if __name__ == "__main__":
    raise SystemExit(main())