testing_conventions/

coverage.rs

//! Coverage rule: the unit suite must clear the configured floor, with test files
//! and the config's exempt paths out of the denominator. Each language pairs a pure
//! `evaluate*` over a parsed report with a `measure*` that shells out to its tool.

use std::collections::{BTreeMap, BTreeSet};
use std::path::{Path, PathBuf};
use std::process::Command;
use std::sync::atomic::{AtomicU64, Ordering};

use anyhow::{bail, Context, Result};
use serde::Deserialize;

/// Omitted from the denominator: colocated unit tests are the suite, not a subject.
const TEST_OMIT: &str = "*_test.py";

/// Omitted too: `conftest.py` is pytest fixtures — test support, not a subject.
const SUPPORT_OMIT: &str = "*conftest.py";

/// The coverage floor to enforce, from a `[<language>].coverage` table.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Thresholds {
    /// Minimum total coverage percent the unit suite must meet.
    pub fail_under: u8,
    /// Whether branch coverage must be measured (and folded into the total).
    pub branch: bool,
}

/// A coverage.py JSON report (`coverage json`), pared to the `totals` the floor reads
/// and the per-file `files` block the diff-scoped floor reads.
#[derive(Debug, Clone, Deserialize)]
pub struct CoverageReport {
    pub totals: Totals,
    /// Per-file line/branch detail, keyed by the path coverage.py reports (relative
    /// to the measured root).
    #[serde(default)]
    pub files: BTreeMap<String, FileCoverage>,
}

/// One `files` entry of a coverage.py report — what patch coverage reads to decide
/// whether a changed line is covered.
#[derive(Debug, Clone, Default, Deserialize)]
pub struct FileCoverage {
    /// Executable lines the suite ran.
    #[serde(default)]
    pub executed_lines: Vec<u64>,
    /// Executable lines the suite never ran — an uncovered changed line is one of these.
    #[serde(default)]
    pub missing_lines: Vec<u64>,
    /// Lines excluded from coverage (e.g. `# pragma: no cover`); never a miss.
    #[serde(default)]
    pub excluded_lines: Vec<u64>,
    /// `[source, dest]` pairs for branches never taken; only `source` matters, and
    /// `dest` may be negative (a function / loop exit). Empty without `--branch`.
    #[serde(default)]
    pub missing_branches: Vec<Vec<i64>>,
    /// `[source, dest]` pairs for branches the suite took; with `missing_branches`
    /// they give branch coverage over the changed lines. Empty without `--branch`.
    #[serde(default)]
    pub executed_branches: Vec<Vec<i64>>,
}

/// The `totals` block of a coverage.py report.
#[derive(Debug, Clone, Deserialize)]
pub struct Totals {
    /// Total covered percent — line coverage, plus branch when measured.
    pub percent_covered: f64,
    /// Branches measured; `0` when branch coverage was not enabled.
    #[serde(default)]
    pub num_branches: u64,
}

/// The result of checking a report against the thresholds.
#[derive(Debug, Clone, PartialEq)]
pub enum Outcome {
    Pass,
    /// The message explains why (actual vs. required).
    Fail(String),
}

/// A run that measured nothing at all — a wrong path, or a suite that never ran.
const NOTHING_MEASURED: &str =
    "the unit suite measured no code — check the path and that the suite runs";

/// `Some` naming the gap when `actual` falls below the `required` floor, else `None`.
/// Tolerance so a percent that rounds to the floor isn't failed by float noise.
pub(crate) fn shortfall(name: &str, actual: f64, required: u8) -> Option<String> {
    if actual + 1e-9 < f64::from(required) {
        Some(format!("{name} {actual:.2}% < {required}%"))
    } else {
        None
    }
}

/// `Pass` when nothing fell short, else one `Fail` naming every shortfall.
pub(crate) fn verdict(shortfalls: Vec<String>) -> Outcome {
    if shortfalls.is_empty() {
        Outcome::Pass
    } else {
        Outcome::Fail(format!(
            "coverage below thresholds: {}",
            shortfalls.join(", ")
        ))
    }
}

/// Parse a coverage.py JSON report (the output of `coverage json`).
pub fn parse_report(json: &str) -> Result<CoverageReport> {
    serde_json::from_str(json).context("parsing coverage.py JSON report")
}

/// Whether `report` meets `thresholds`. `coverage.py` always measures branches, so a
/// zero-branch report means a branchless source, not a misconfigured run — vacuously
/// full branch coverage, already folded into `percent_covered`.
pub fn evaluate(report: &CoverageReport, thresholds: Thresholds) -> Outcome {
    let actual = report.totals.percent_covered;
    let required = f64::from(thresholds.fail_under);
    // Tolerance so a report that rounds to the floor isn't failed by float noise.
    if actual + 1e-9 >= required {
        Outcome::Pass
    } else {
        Outcome::Fail(format!(
            "coverage {actual:.2}% is below the required {}%",
            thresholds.fail_under
        ))
    }
}

/// Run the unit suite under coverage.py in `root` and check it against `thresholds`.
/// `omit` is the `coverage`-rule exemptions as `root`-relative paths. The `coverage`
/// CLI, with `pytest` importable, must be on `PATH`.
pub fn measure(root: &Path, thresholds: Thresholds, omit: &[String]) -> Result<Outcome> {
    let report = run_coverage(root, omit)?;
    Ok(evaluate(&report, thresholds))
}

/// Run the Python unit suite and return the per-file report, the denominator scoped
/// to `root`'s sources (`--source=.`). `omit` is as in [`measure`].
pub fn measure_report(root: &Path, omit: &[String]) -> Result<CoverageReport> {
    run_coverage(root, omit)
}

/// A coverage.py data file under the temp dir — unique per call so parallel checks
/// don't collide, and removed on drop so nothing leaks into the scanned tree.
struct DataFile(PathBuf);

impl DataFile {
    fn new() -> Self {
        static COUNTER: AtomicU64 = AtomicU64::new(0);
        let name = format!(
            "testing-conventions-{}-{}.coverage",
            std::process::id(),
            COUNTER.fetch_add(1, Ordering::Relaxed),
        );
        DataFile(std::env::temp_dir().join(name))
    }
}

impl Drop for DataFile {
    fn drop(&mut self) {
        let _ = std::fs::remove_file(&self.0);
    }
}

/// Run coverage.py over the unit suite in `root` and return the parsed report.
/// `--source=.` scopes the denominator to `root`'s sources; without it coverage.py picks up
/// an editable path dependency's tree. `--ignore=tests` leaves the suite tiers uncollected.
fn run_coverage(root: &Path, omit: &[String]) -> Result<CoverageReport> {
    let data = DataFile::new();
    let omit = build_omit(omit);

    // Byte-code and the pytest cache are suppressed so the scanned tree stays pristine.
    let mut command = Command::new("coverage");
    command
        .current_dir(root)
        .args(["run", "--branch", "--source=."])
        .arg(format!("--omit={omit}"));
    let run = command
        .args([
            "-m",
            "pytest",
            "-q",
            "-p",
            "no:cacheprovider",
            "--ignore=tests",
            ".",
        ])
        .env("COVERAGE_FILE", &data.0)
        .env("PYTHONDONTWRITEBYTECODE", "1")
        .output()
        .context("running `coverage run -m pytest` (is coverage.py installed?)")?;
    if !run.status.success() {
        bail!(
            "the unit suite did not run cleanly under coverage in `{}`:\n{}{}",
            root.display(),
            String::from_utf8_lossy(&run.stdout),
            String::from_utf8_lossy(&run.stderr),
        );
    }

    let json = Command::new("coverage")
        .current_dir(root)
        .args(["json", "-o", "-"])
        .env("COVERAGE_FILE", &data.0)
        .output()
        .context("running `coverage json`")?;
    if !json.status.success() {
        bail!(
            "`coverage json` failed:\n{}",
            String::from_utf8_lossy(&json.stderr),
        );
    }

    parse_report(&String::from_utf8_lossy(&json.stdout))
}

/// The single comma-joined `--omit` for the run: the test and support globs plus every
/// `coverage`-exempt path. coverage.py takes one `--omit` — repeated flags don't
/// accumulate, so the patterns must be joined.
fn build_omit(omit: &[String]) -> String {
    [TEST_OMIT.to_string(), SUPPORT_OMIT.to_string()]
        .into_iter()
        .chain(omit.iter().cloned())
        .collect::<Vec<_>>()
        .join(",")
}

/// What vitest measures: every TypeScript source under the scanned root. The
/// braces are a vitest (picomatch) glob, expanded by vitest, not the shell.
const TS_INCLUDE: &str = "**/*.{ts,tsx,mts,cts}";

/// The installed vitest's own default coverage excludes, resolved live via Node.
/// Passing *any* `--coverage.exclude` replaces vitest's built-in list rather than
/// extending it, so the defaults must be resolved and passed back explicitly.
fn vitest_default_excludes(root: &Path) -> Result<Vec<String>> {
    let run = Command::new("node")
        .current_dir(root)
        .args([
            "-e",
            "process.stdout.write(JSON.stringify(require('vitest/config').coverageConfigDefaults.exclude))",
        ])
        .output()
        .context("resolving vitest's default coverage excludes via node")?;
    if !run.status.success() {
        bail!(
            "could not resolve vitest's default coverage excludes in `{}`. The check runs the \
             project's own vitest via `npx --no-install` and never downloads it, so `vitest` \
             must be installed in the project. node output:\n{}{}",
            root.display(),
            String::from_utf8_lossy(&run.stdout),
            String::from_utf8_lossy(&run.stderr),
        );
    }
    parse_default_excludes(&run.stdout)
}

/// The exclude patterns node printed, parsed and pared to the passable ones.
fn parse_default_excludes(stdout: &[u8]) -> Result<Vec<String>> {
    let excludes: Vec<String> = serde_json::from_slice(stdout).with_context(|| {
        format!(
            "vitest's default coverage excludes were not a JSON string array — got: {}",
            String::from_utf8_lossy(stdout)
        )
    })?;
    // A few of vitest's default patterns embed a literal NUL (its virtual-module
    // markers, e.g. `**/\0*`), which can't be passed as a process argument at all.
    Ok(excludes.into_iter().filter(|p| !p.contains('\0')).collect())
}

/// The four vitest coverage floors, from a `[typescript].coverage` table.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct TypeScriptThresholds {
    pub lines: u8,
    pub branches: u8,
    pub functions: u8,
    pub statements: u8,
}

/// A vitest `coverage-summary.json` report, pared to the `total` block.
#[derive(Debug, Clone, Copy, Deserialize)]
pub struct VitestReport {
    pub total: VitestTotals,
}

/// The `total` block of a vitest json-summary report — the four metrics enforced.
#[derive(Debug, Clone, Copy, Deserialize)]
pub struct VitestTotals {
    pub lines: VitestMetric,
    pub branches: VitestMetric,
    pub functions: VitestMetric,
    pub statements: VitestMetric,
}

/// One metric's totals from a vitest json-summary block.
#[derive(Debug, Clone, Copy, Deserialize)]
pub struct VitestMetric {
    /// Percent covered — `None` when nothing was measured, which vitest writes as
    /// the string `"Unknown"` (and `total` is then `0`).
    #[serde(deserialize_with = "deserialize_pct")]
    pub pct: Option<f64>,
    /// Size of the denominator (statements/branches/functions/lines counted).
    pub total: u64,
}

/// A json-summary `pct`: a number for a measured metric, or the string `"Unknown"`
/// (→ `None`) when the denominator is empty.
fn deserialize_pct<'de, D>(deserializer: D) -> std::result::Result<Option<f64>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    struct PctVisitor;
    impl serde::de::Visitor<'_> for PctVisitor {
        type Value = Option<f64>;

        fn expecting(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
            f.write_str("a coverage percent number or the string \"Unknown\"")
        }

        fn visit_f64<E>(self, value: f64) -> std::result::Result<Self::Value, E> {
            Ok(Some(value))
        }

        // serde_json routes a whole-number percent here; percents are never negative.
        fn visit_u64<E>(self, value: u64) -> std::result::Result<Self::Value, E> {
            Ok(Some(value as f64))
        }

        // vitest writes the literal "Unknown" when the metric had nothing to measure.
        fn visit_str<E>(self, _value: &str) -> std::result::Result<Self::Value, E> {
            Ok(None)
        }
    }
    deserializer.deserialize_any(PctVisitor)
}

/// Parse a vitest json-summary report (`coverage-summary.json`).
pub fn parse_vitest_report(json: &str) -> Result<VitestReport> {
    serde_json::from_str(json).context("parsing vitest coverage-summary JSON report")
}

/// Whether `report` meets every threshold. A run that measured no code at all fails
/// rather than passing vacuously; one metric with an empty denominator amid a
/// non-empty run has nothing to miss and is vacuously satisfied.
pub fn evaluate_typescript(report: &VitestReport, thresholds: TypeScriptThresholds) -> Outcome {
    let total = &report.total;
    // Every source file has lines, so a zero denominator means nothing was measured.
    if total.lines.total == 0 {
        return Outcome::Fail(NOTHING_MEASURED.to_string());
    }
    let checks = [
        ("lines", total.lines, thresholds.lines),
        ("branches", total.branches, thresholds.branches),
        ("functions", total.functions, thresholds.functions),
        ("statements", total.statements, thresholds.statements),
    ];
    verdict(
        checks
            .into_iter()
            .filter_map(|(name, metric, required)| {
                // An empty denominator (branch-free code) has nothing to cover —
                // vacuously full.
                shortfall(name, metric.pct.unwrap_or(100.0), required)
            })
            .collect(),
    )
}

/// Run the unit suite under vitest coverage in `root` and check it against
/// `thresholds`. `exclude` is the `coverage`-rule exemptions as `root`-relative paths;
/// `npx` resolves the project-local `vitest` and `@vitest/coverage-v8`.
pub fn measure_typescript(
    root: &Path,
    thresholds: TypeScriptThresholds,
    exclude: &[String],
) -> Result<Outcome> {
    let report = run_vitest(root, exclude)?;
    Ok(evaluate_typescript(&report, thresholds))
}

/// A vitest reports directory under the temp dir — unique per call so parallel checks
/// don't collide, and removed on drop so nothing leaks into the scanned tree.
struct ReportDir(PathBuf);

impl ReportDir {
    fn new() -> Self {
        static COUNTER: AtomicU64 = AtomicU64::new(0);
        let name = format!(
            "testing-conventions-vitest-{}-{}",
            std::process::id(),
            COUNTER.fetch_add(1, Ordering::Relaxed),
        );
        ReportDir(std::env::temp_dir().join(name))
    }
}

impl Drop for ReportDir {
    fn drop(&mut self) {
        let _ = std::fs::remove_dir_all(&self.0);
    }
}

/// Run vitest over the unit suite in `root` and return the parsed floor report.
fn run_vitest(root: &Path, exclude: &[String]) -> Result<VitestReport> {
    let json = run_vitest_coverage(root, exclude, "json-summary", "coverage-summary.json")?;
    parse_vitest_report(&json)
}

/// Run vitest coverage over the unit suite in `root` and return the contents of the
/// `report_file` the `reporter` wrote.
fn run_vitest_coverage(
    root: &Path,
    exclude: &[String],
    reporter: &str,
    report_file: &str,
) -> Result<String> {
    let reports = ReportDir::new();
    let excludes = vitest_default_excludes(root)?;

    let run = Command::new("npx")
        .current_dir(root)
        .args(vitest_coverage_argv(
            reporter,
            &reports.0,
            excludes.iter().chain(exclude),
        ))
        // CI=1 keeps vitest non-interactive (no watch prompt, plain output).
        .env("CI", "1")
        .output()
        .context("running `npx --no-install vitest run --coverage`")?;
    vitest_exit(run.status.success(), root, &run.stdout, &run.stderr)?;
    read_vitest_report(&reports.0.join(report_file), reporter)
}

/// `Ok` when the vitest run exited clean, else the failure naming both of its streams and why
/// the check never downloads vitest. Held apart from [`run_vitest_coverage`] so that seam is
/// branch-free: its body spawns, so no unit test can judge a replacement of the whole body,
/// but this decision is pure and asserted. The sibling of [`llvm_cov_stdout`].
fn vitest_exit(success: bool, root: &Path, stdout: &[u8], stderr: &[u8]) -> Result<()> {
    if !success {
        bail!(
            "the unit suite did not run cleanly under vitest in `{}`. The check runs the \
             project's own vitest via `npx --no-install` and never downloads it, so `vitest` \
             and `@vitest/coverage-v8` must be installed in the project. vitest output:\n{}{}",
            root.display(),
            String::from_utf8_lossy(stdout),
            String::from_utf8_lossy(stderr),
        );
    }
    Ok(())
}

/// The `npx vitest run` argv for one coverage pass. `--coverage.all=true` counts source files
/// the suite never imported, so an untested file is measured rather than vanishing.
fn vitest_coverage_argv<'a>(
    reporter: &str,
    reports_dir: &Path,
    exclude: impl Iterator<Item = &'a String>,
) -> Vec<String> {
    let mut argv: Vec<String> = [
        // `--no-install`, never `--yes`: with `--yes` a missing vitest is silently
        // downloaded, where the other arms fail clean on a missing binary.
        "--no-install",
        "vitest",
        "run",
        "--no-cache",
        "--coverage.enabled",
        "--coverage.provider=v8",
        "--coverage.all=true",
        // A consumer config's own `coverage.thresholds` neither decide the gate's exit
        // nor rewrite the config file — `autoUpdate` never writes during a gate run.
        "--coverage.thresholds.lines=0",
        "--coverage.thresholds.branches=0",
        "--coverage.thresholds.functions=0",
        "--coverage.thresholds.statements=0",
        "--coverage.thresholds.autoUpdate=false",
    ]
    .iter()
    .map(|arg| (*arg).to_string())
    .collect();
    argv.push(format!("--coverage.reporter={reporter}"));
    argv.push(format!(
        "--coverage.reportsDirectory={}",
        reports_dir.display()
    ));
    argv.push(format!("--coverage.include={TS_INCLUDE}"));
    argv.extend(exclude.map(|path| format!("--coverage.exclude={path}")));
    argv
}

/// The report the vitest run wrote, read back for parsing.
fn read_vitest_report(path: &Path, reporter: &str) -> Result<String> {
    std::fs::read_to_string(path).with_context(|| {
        format!(
            "reading vitest coverage report `{}` (did the run produce a {reporter} report?)",
            path.display()
        )
    })
}

/// One file's entry in a vitest v8 `coverage-final.json` (Istanbul) report, pared to
/// the statement / branch / function maps and their hit counts.
#[derive(Debug, Clone, Deserialize)]
struct IstanbulFile {
    /// Statement id → source span; a `0` count in `s` means its lines are uncovered.
    #[serde(rename = "statementMap", default)]
    statement_map: BTreeMap<String, IstanbulSpan>,
    /// Statement id → execution count.
    #[serde(default)]
    s: BTreeMap<String, u64>,
    /// Branch id → location; a `0` among its `b` counts means a path never taken.
    #[serde(rename = "branchMap", default)]
    branch_map: BTreeMap<String, IstanbulBranch>,
    /// Branch id → per-arm execution counts.
    #[serde(default)]
    b: BTreeMap<String, Vec<u64>>,
    /// Function id → declaration location; a `0` count in `f` means never called.
    #[serde(rename = "fnMap", default)]
    fn_map: BTreeMap<String, IstanbulFn>,
    /// Function id → execution count.
    #[serde(default)]
    f: BTreeMap<String, u64>,
}

/// A source span — only the 1-based line numbers matter to patch coverage.
#[derive(Debug, Clone, Deserialize)]
struct IstanbulSpan {
    start: IstanbulPos,
    end: IstanbulPos,
}

/// A position in a source span; the `column` is ignored.
#[derive(Debug, Clone, Deserialize)]
struct IstanbulPos {
    line: u64,
}

/// A branch entry — only `loc.start.line`, the branch's source line, matters.
#[derive(Debug, Clone, Deserialize)]
struct IstanbulBranch {
    loc: IstanbulSpan,
}

/// A function entry — only `decl.start.line` matters. vitest's v8 export shapes this
/// as `{"name":.., "decl":{"start":{"line":N,..},..}, ..}`.
#[derive(Debug, Clone, Deserialize)]
struct IstanbulFn {
    decl: IstanbulSpan,
}

/// Per-file detail from a vitest Istanbul report — the Istanbul maps reduced to the
/// tuples [`crate::patch_coverage::evaluate_patch_typescript`] restricts to the diff.
#[derive(Debug, Clone, Default)]
pub struct TsPatchCoverage {
    /// One per `statementMap` entry: `(start_line, end_line, covered)`. A statement
    /// counts toward the diff when any line it spans is changed.
    pub statements: Vec<(u64, u64, bool)>,
    /// One per branch **arm**: `(source_line, covered)`, the source line shared by
    /// every arm of a branch.
    pub branch_arms: Vec<(u64, bool)>,
    /// One per `fnMap` entry: `(decl_line, covered)`. A function counts toward the
    /// diff when its declaration line is changed.
    pub functions: Vec<(u64, bool)>,
}

/// Run the TypeScript unit suite under vitest and return the per-file detail for the
/// four metrics, keyed by the absolute path vitest reports. `exclude` is the
/// `coverage`-rule exemptions, dropped so an exempt file's changed lines are lifted.
pub fn measure_patch_typescript_detail(
    root: &Path,
    exclude: &[String],
) -> Result<BTreeMap<String, TsPatchCoverage>> {
    let json = run_vitest_coverage(root, exclude, "json", "coverage-final.json")?;
    istanbul_patch_detail(&json)
}

/// Pure: per-file [`TsPatchCoverage`] from a vitest v8 Istanbul report, keyed by the
/// absolute path vitest reports.
fn istanbul_patch_detail(json: &str) -> Result<BTreeMap<String, TsPatchCoverage>> {
    let files: BTreeMap<String, IstanbulFile> = serde_json::from_str(json)
        .context("parsing vitest coverage-final (Istanbul) JSON report")?;
    let mut out = BTreeMap::new();
    for (path, file) in files {
        let mut detail = TsPatchCoverage::default();
        for (id, span) in &file.statement_map {
            let covered = file.s.get(id).is_some_and(|&count| count > 0);
            detail
                .statements
                .push((span.start.line, span.end.line, covered));
        }
        // v8 models a branch as one arm (a `[count]` array) or several; one tuple per
        // arm either way.
        for (id, branch) in &file.branch_map {
            let line = branch.loc.start.line;
            if let Some(counts) = file.b.get(id) {
                for &count in counts {
                    detail.branch_arms.push((line, count > 0));
                }
            }
        }
        for (id, function) in &file.fn_map {
            let covered = file.f.get(id).is_some_and(|&count| count > 0);
            detail.functions.push((function.decl.start.line, covered));
        }
        out.insert(path, detail);
    }
    Ok(out)
}

/// The `cargo llvm-cov` coverage floors, from a `[rust].coverage` table. `lines` is
/// always enforced; the rest are opt-in, `None` skipping the check. A `branch` floor
/// adds `--branch`, which instruments only on a nightly toolchain.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct RustThresholds {
    pub regions: Option<u8>,
    pub lines: u8,
    pub functions: Option<u8>,
    pub branch: Option<u8>,
}

/// A `cargo llvm-cov --json` export, pared to the totals the floor reads. A single
/// run produces one `data` entry.
#[derive(Debug, Clone, Deserialize)]
pub struct LlvmCovReport {
    pub data: Vec<LlvmCovData>,
}

/// One export entry — `--summary-only` omits everything but its `totals`.
#[derive(Debug, Clone, Copy, Deserialize)]
pub struct LlvmCovData {
    pub totals: LlvmCovTotals,
}

/// The `totals` block of an llvm-cov export. `branches` is optional so an export from
/// a run without branch instrumentation still parses.
#[derive(Debug, Clone, Copy, Default, Deserialize)]
pub struct LlvmCovTotals {
    pub regions: LlvmCovMetric,
    pub lines: LlvmCovMetric,
    pub functions: LlvmCovMetric,
    #[serde(default)]
    pub branches: Option<LlvmCovMetric>,
}

/// One metric's totals from an llvm-cov export.
#[derive(Debug, Clone, Copy, Default, Deserialize)]
pub struct LlvmCovMetric {
    /// Size of the denominator (regions or lines counted).
    pub count: u64,
    pub covered: u64,
    pub percent: f64,
}

/// Parse a `cargo llvm-cov --json` export.
pub fn parse_llvm_cov_report(json: &str) -> Result<LlvmCovReport> {
    serde_json::from_str(json).context("parsing cargo llvm-cov JSON report")
}

/// Whether `report` meets its thresholds. A run that measured no regions at all — a
/// wrong path, or a crate that compiled nothing — fails rather than passing vacuously.
pub fn evaluate_rust(report: &LlvmCovReport, thresholds: RustThresholds) -> Outcome {
    let Some(totals) = report.data.first().map(|entry| &entry.totals) else {
        return Outcome::Fail("the cargo llvm-cov report contained no data".to_string());
    };
    // Every compiled crate has regions, so a zero denominator measured nothing.
    if totals.regions.count == 0 {
        return Outcome::Fail(NOTHING_MEASURED.to_string());
    }
    verdict(
        rust_checks(totals, thresholds)
            .into_iter()
            .filter_map(|(name, actual, required)| shortfall(name, actual, required))
            .collect(),
    )
}

/// The floors that apply to `totals`, as `(metric, measured percent, required percent)`.
/// The zero-config default floors lines only; the rest are opt-in.
fn rust_checks(totals: &LlvmCovTotals, thresholds: RustThresholds) -> Vec<(&'static str, f64, u8)> {
    let mut checks = Vec::new();
    if let Some(regions) = thresholds.regions {
        checks.push(("regions", totals.regions.percent, regions));
    }
    checks.push(("lines", totals.lines.percent, thresholds.lines));
    if let Some(functions) = thresholds.functions {
        checks.push(("functions", totals.functions.percent, functions));
    }
    if let Some(branch) = thresholds.branch {
        // A failed instrumentation is a run error surfaced before this point, so a zero
        // branch denominator means the crate has no branch points — vacuously satisfied.
        if let Some(branches) = totals.branches.filter(|metric| metric.count > 0) {
            checks.push(("branches", branches.percent, branch));
        }
    }
    checks
}

/// Run the unit suite under `cargo llvm-cov` in `root` and check it against
/// `thresholds`. `ignore` is the `coverage`-rule exemptions as `root`-relative paths;
/// `features` the `[rust] features` list to enable. `cargo-llvm-cov` must be installed.
pub fn measure_rust(
    root: &Path,
    thresholds: RustThresholds,
    ignore: &[String],
    features: &[String],
) -> Result<Outcome> {
    let report = run_llvm_cov(root, ignore, features, thresholds.branch.is_some())?;
    Ok(evaluate_rust(&report, thresholds))
}

/// A `CARGO_TARGET_DIR` under the temp dir — unique per call so parallel checks don't
/// collide, and removed on drop so the build never leaks into the scanned tree.
struct TargetDir(PathBuf);

impl TargetDir {
    fn new() -> Self {
        static COUNTER: AtomicU64 = AtomicU64::new(0);
        let name = format!(
            "testing-conventions-llvm-cov-{}-{}",
            std::process::id(),
            COUNTER.fetch_add(1, Ordering::Relaxed),
        );
        TargetDir(std::env::temp_dir().join(name))
    }
}

impl Drop for TargetDir {
    fn drop(&mut self) {
        let _ = std::fs::remove_dir_all(&self.0);
    }
}

/// The totals the floor checks, less the items a `#[cfg(not(test))]` gate keeps out of the
/// test build. `branch` adds `--branch` for a configured branch floor. The run exports in
/// full rather than `--summary-only`, since the per-function detail is what locates those
/// items in the totals.
fn run_llvm_cov(
    root: &Path,
    ignore: &[String],
    features: &[String],
    branch: bool,
) -> Result<LlvmCovReport> {
    let (json, lcov) = run_cargo_llvm_cov_json_and_lcov(root, ignore, features, branch)?;
    let hidden = hidden_lines_by_file(&json)?;
    let mut report = llvm_cov_totals_less_hidden(&parse_llvm_cov_export(&json)?, &hidden);
    let lines = lcov_lines_metric(&lcov, &hidden);
    for data in &mut report.data {
        data.totals.lines = lines;
    }
    Ok(report)
}

/// Every `DA:` record of an lcov export, as `line -> covered` per source file.
fn lcov_lines(lcov: &str) -> BTreeMap<String, BTreeMap<u32, bool>> {
    let mut out: BTreeMap<String, BTreeMap<u32, bool>> = BTreeMap::new();
    let mut file: Option<&str> = None;
    for record in lcov.lines() {
        if let Some(name) = record.strip_prefix("SF:") {
            file = Some(name);
        } else if let Some((number, count)) =
            record.strip_prefix("DA:").and_then(|da| da.split_once(','))
        {
            let (Some(file), Ok(number), Ok(count)) =
                (file, number.parse::<u32>(), count.trim().parse::<u64>())
            else {
                continue;
            };
            *out.entry(file.to_string())
                .or_default()
                .entry(number)
                .or_default() |= count > 0;
        }
    }
    out
}

/// The line metric an lcov export reports, less the lines a `#[cfg(not(test))]` gate hides.
///
/// llvm-cov writes `DA:` records through the merged line view that `show`, `--text` and
/// `--show-missing-lines` all read, where a line maps once however many instantiations carry
/// it. A `--json` export's `totals` instead sum each instantiation group's own line tally, so a
/// line two groups map counts twice — once covered and once not, when only one group ran it.
/// That is how a 100% floor became unsatisfiable on a file where no view could name a missing
/// line (#743): a crate built `--lib --bins` compiles its library twice.
fn lcov_lines_metric(lcov: &str, hidden: &BTreeMap<String, BTreeSet<u32>>) -> LlvmCovMetric {
    let mut tally = Tally::default();
    for (file, lines) in lcov_lines(lcov) {
        let gated = hidden.get(&file);
        for (number, covered) in lines {
            if gated.is_some_and(|gated| gated.contains(&number)) {
                continue;
            }
            tally.count += 1;
            tally.covered += u64::from(covered);
        }
    }
    as_metric(tally.count, tally.covered)
}

/// The 1-based lines a `#[cfg(not(test))]` gate hides, per source file the export measured.
///
/// The unit tier runs `--lib --bins`, which sets `cfg(test)`, so no test can execute a gated
/// item. The `--bins` half links the library a second time as a plain dependency of the binary
/// target's test harness, where `cfg(test)` is unset: the item is compiled and instrumented
/// there and lands as 0-hit, or not, depending on how the linker partitioned that build. An
/// unreadable file hides nothing, leaving every line it maps in the ratios.
fn hidden_lines_by_file(json: &str) -> Result<BTreeMap<String, BTreeSet<u32>>> {
    let export = parse_llvm_cov_export(json)?;
    let mut out = BTreeMap::new();
    for data in &export.data {
        for file in &data.files {
            let Ok(source) = std::fs::read_to_string(&file.filename) else {
                continue;
            };
            let lines = crate::isolation::lines_hidden_from_tests(&source);
            if !lines.is_empty() {
                out.insert(file.filename.clone(), lines);
            }
        }
    }
    Ok(out)
}

/// One metric's count and covered pair, the shape every llvm-cov metric reports.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
struct Tally {
    count: u64,
    covered: u64,
}

impl Tally {
    /// llvm-cov merges the records of one instantiation group by `max`, so a delta over that
    /// group does too — two copies of the same function subtract once.
    fn merge(&mut self, other: Tally) {
        self.count = self.count.max(other.count);
        self.covered = self.covered.max(other.covered);
    }

    fn add(&mut self, other: Tally) {
        self.count += other.count;
        self.covered += other.covered;
    }
}

/// What the items a `#[cfg(not(test))]` gate hides contribute to an export's totals.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
struct HiddenTotals {
    regions: Tally,
    lines: Tally,
    functions: Tally,
    branches: Tally,
}

impl HiddenTotals {
    fn merge(&mut self, other: HiddenTotals) {
        self.regions.merge(other.regions);
        self.lines.merge(other.lines);
        self.functions.merge(other.functions);
        self.branches.merge(other.branches);
    }

    fn add(&mut self, other: HiddenTotals) {
        self.regions.add(other.regions);
        self.lines.add(other.lines);
        self.functions.add(other.functions);
        self.branches.add(other.branches);
    }
}

/// Pure: the export's totals less what its gated items contribute.
fn llvm_cov_totals_less_hidden(
    export: &LlvmCovExport,
    hidden: &BTreeMap<String, BTreeSet<u32>>,
) -> LlvmCovReport {
    LlvmCovReport {
        data: export
            .data
            .iter()
            .map(|data| LlvmCovData {
                totals: totals_less_hidden(data, hidden),
            })
            .collect(),
    }
}

/// One export entry's totals with the gated items' share taken out of every metric.
fn totals_less_hidden(
    data: &LlvmCovExportData,
    hidden: &BTreeMap<String, BTreeSet<u32>>,
) -> LlvmCovTotals {
    let delta = hidden_totals(data, hidden);
    LlvmCovTotals {
        regions: metric_less(data.totals.regions, delta.regions),
        lines: metric_less(data.totals.lines, delta.lines),
        functions: metric_less(data.totals.functions, delta.functions),
        branches: data
            .totals
            .branches
            .map(|metric| metric_less(metric, delta.branches)),
    }
}

/// One metric less the gated items' share, its percent recomputed.
fn metric_less(metric: LlvmCovMetric, delta: Tally) -> LlvmCovMetric {
    let count = metric.count.saturating_sub(delta.count);
    as_metric(
        count,
        metric.covered.saturating_sub(delta.covered).min(count),
    )
}

/// A metric from its pair. An empty denominator reads 100%: with nothing left to measure there
/// is nothing left to miss.
fn as_metric(count: u64, covered: u64) -> LlvmCovMetric {
    let percent = if count == 0 {
        100.0
    } else {
        covered as f64 * 100.0 / count as f64
    };
    LlvmCovMetric {
        count,
        covered,
        percent,
    }
}

/// The gated items' contribution to one export entry. llvm-cov groups function records by their
/// first region's start location, so the `--bins` half's second copy of an ungated function
/// merges with the first; a gated item has no such twin and stands alone as 0-hit.
fn hidden_totals(
    data: &LlvmCovExportData,
    hidden: &BTreeMap<String, BTreeSet<u32>>,
) -> HiddenTotals {
    let measured: BTreeSet<&str> = data.files.iter().map(|f| f.filename.as_str()).collect();
    let mut groups: BTreeMap<(String, i64, i64), HiddenTotals> = BTreeMap::new();
    for function in &data.functions {
        let Some((file, line, column)) = function_start(function) else {
            continue;
        };
        if !measured.contains(file.as_str()) {
            continue;
        }
        let Some(lines) = hidden.get(&file) else {
            continue;
        };
        if !lines.contains(&(line.max(0) as u32)) {
            continue;
        }
        groups
            .entry((file, line, column))
            .or_default()
            .merge(function_totals(function, lines));
    }
    groups.values().fold(HiddenTotals::default(), |mut acc, g| {
        acc.add(*g);
        acc
    })
}

/// The `(file, line, column)` llvm-cov groups a function record under — its first region's
/// start. A record with no region, or one naming a file outside its own list, has no group.
fn function_start(function: &LlvmCovFunction) -> Option<(String, i64, i64)> {
    let region = function.regions.first()?;
    if region.len() < 8 {
        return None;
    }
    let file = function.filenames.get(usize::try_from(region[5]).ok()?)?;
    Some((file.clone(), region[0], region[1]))
}

/// One record's share: its code regions, the gated source lines they map, its own execution,
/// and the two outcomes llvm-cov counts per branch region.
fn function_totals(function: &LlvmCovFunction, hidden: &BTreeSet<u32>) -> HiddenTotals {
    let code: Vec<&Vec<i64>> = function
        .regions
        .iter()
        .filter(|region| region.len() >= 8 && region[7] == 0)
        .collect();
    let mut lines: BTreeMap<u32, bool> = BTreeMap::new();
    for region in &code {
        for line in region[0].max(0) as u32..=region[2].max(0) as u32 {
            if hidden.contains(&line) {
                *lines.entry(line).or_default() |= region[4] > 0;
            }
        }
    }
    HiddenTotals {
        regions: Tally {
            count: code.len() as u64,
            covered: code.iter().filter(|region| region[4] > 0).count() as u64,
        },
        lines: Tally {
            count: lines.len() as u64,
            covered: lines.values().filter(|covered| **covered).count() as u64,
        },
        functions: Tally {
            count: 1,
            covered: u64::from(function.count > 0),
        },
        branches: branch_tally(&function.branches),
    }
}

/// Two outcomes per branch region: llvm-cov counts the true and false arms separately.
fn branch_tally(branches: &[Vec<i64>]) -> Tally {
    let mut tally = Tally::default();
    for branch in branches.iter().filter(|branch| branch.len() >= 9) {
        tally.count += 2;
        tally.covered += u64::from(branch[4] > 0) + u64::from(branch[5] > 0);
    }
    tally
}

/// Run `cargo llvm-cov --lib` over the unit suite in `root` with the given coverage
/// `format` args and return its stdout. Shared by the whole-tree floor and the
/// diff-scoped floor, so both measure the same unit-only slice.
fn run_cargo_llvm_cov(
    root: &Path,
    ignore: &[String],
    format: &[&str],
    features: &[String],
    branch: bool,
) -> Result<String> {
    run_in(&TargetDir::new(), root, ignore, format, features, branch)
}

/// Both exports of a single run: `--json` for the per-function detail, then a `report --lcov`
/// pass over the profile that run left in the target dir. The second pass re-reads the profile
/// rather than running the suite again.
fn run_cargo_llvm_cov_json_and_lcov(
    root: &Path,
    ignore: &[String],
    features: &[String],
    branch: bool,
) -> Result<(String, String)> {
    let target = TargetDir::new();
    let json = run_in(&target, root, ignore, &["--json"], features, branch)?;
    let lcov = report_in(&target, root, ignore, &["--lcov"])?;
    Ok((json, lcov))
}

/// Re-export the profile already in `target`. `report` runs no tests, so the two views a caller
/// compares come from one execution of the suite.
fn report_in(
    target: &TargetDir,
    root: &Path,
    ignore: &[String],
    format: &[&str],
) -> Result<String> {
    let mut command = Command::new("cargo");
    command
        .current_dir(root)
        .args(report_argv(format, ignore_filename_regex(root, ignore)))
        .env("CARGO_TARGET_DIR", &target.0);
    scrub_outer_llvm_cov(&mut command);
    let output = command
        .output()
        .context("running `cargo llvm-cov report` (is cargo-llvm-cov installed?)")?;
    llvm_cov_stdout(
        output.status.success(),
        &output.stdout,
        &output.stderr,
        &format!(
            "cargo llvm-cov could not re-export the profile it just wrote in `{}`:",
            root.display()
        ),
    )
}

fn report_argv(format: &[&str], ignore_regex: Option<String>) -> Vec<String> {
    let mut argv = vec!["llvm-cov".to_string(), "report".to_string()];
    argv.extend(format.iter().map(|arg| (*arg).to_string()));
    if let Some(regex) = ignore_regex {
        argv.extend(["--ignore-filename-regex".to_string(), regex]);
    }
    argv
}

/// An invocation's stdout, or `failure` carrying both of its streams when it exited non-zero.
fn llvm_cov_stdout(success: bool, stdout: &[u8], stderr: &[u8], failure: &str) -> Result<String> {
    if !success {
        bail!(
            "{failure}\n{}{}",
            String::from_utf8_lossy(stdout),
            String::from_utf8_lossy(stderr)
        );
    }
    Ok(String::from_utf8_lossy(stdout).into_owned())
}

fn run_in(
    target: &TargetDir,
    root: &Path,
    ignore: &[String],
    format: &[&str],
    features: &[String],
    branch: bool,
) -> Result<String> {
    let mut command = Command::new("cargo");
    command
        .current_dir(root)
        .args(run_argv(
            format,
            features,
            branch,
            ignore_filename_regex(root, ignore),
        ))
        .env("CARGO_TARGET_DIR", &target.0);
    scrub_outer_llvm_cov(&mut command);
    let output = command
        .output()
        .context("running `cargo llvm-cov` (is cargo-llvm-cov installed?)")?;
    llvm_cov_stdout(
        output.status.success(),
        &output.stdout,
        &output.stderr,
        &format!(
            "the unit suite did not run cleanly under cargo llvm-cov in `{}`:{}",
            root.display(),
            branch_hint(branch)
        ),
    )
}

fn run_argv(
    format: &[&str],
    features: &[String],
    branch: bool,
    ignore_regex: Option<String>,
) -> Vec<String> {
    let mut argv = vec![
        "llvm-cov".to_string(),
        "--lib".to_string(),
        "--bins".to_string(),
    ];
    argv.extend(format.iter().map(|arg| (*arg).to_string()));
    if !features.is_empty() {
        argv.extend(["--features".to_string(), features.join(",")]);
    }
    if branch {
        argv.push("--branch".to_string());
    }
    if let Some(regex) = ignore_regex {
        argv.extend(["--ignore-filename-regex".to_string(), regex]);
    }
    argv
}

fn branch_hint(branch: bool) -> &'static str {
    if branch {
        "\n(the [rust].coverage `branch` floor runs with --branch, which requires a \
         nightly toolchain — pin one in the crate's rust-toolchain.toml with \
         llvm-tools-preview, or set a rustup directory override)"
    } else {
        ""
    }
}

/// Strip the outer run's instrumentation state from `command`.
///
/// When this check runs under an outer `cargo llvm-cov`, an inherited `RUSTC_WRAPPER` makes the
/// inner run re-enter cargo-llvm-cov on every rustc invocation and hang until the runner is
/// OOM-killed.
fn scrub_outer_llvm_cov(command: &mut Command) {
    for var in [
        "RUSTFLAGS",
        "CARGO_ENCODED_RUSTFLAGS",
        "RUSTDOCFLAGS",
        "CARGO_ENCODED_RUSTDOCFLAGS",
        "LLVM_PROFILE_FILE",
        "CARGO_LLVM_COV",
        "CARGO_LLVM_COV_SHOW_ENV",
        "CARGO_LLVM_COV_TARGET_DIR",
        "CARGO_LLVM_COV_BUILD_DIR",
        "RUSTC_WRAPPER",
        "RUSTC_WORKSPACE_WRAPPER",
        "__CARGO_LLVM_COV_RUSTC_WRAPPER",
        "__CARGO_LLVM_COV_RUSTC_WRAPPER_RUSTFLAGS",
        "__CARGO_LLVM_COV_RUSTC_WRAPPER_CRATE_NAMES",
        // rustup gives an inherited toolchain selection precedence over the scanned
        // crate's own `rust-toolchain.toml`, so a spawning cargo would override the
        // nightly a branch-floor crate pins there.
        "RUSTUP_TOOLCHAIN",
        "CARGO",
        "RUSTC",
    ] {
        command.env_remove(var);
    }
}

/// Per-file region detail from a `cargo llvm-cov --json` export — what
/// [`crate::patch_coverage::evaluate_patch_rust`] restricts to the changed lines.
#[derive(Debug, Clone, Default)]
pub struct RustPatchCoverage {
    /// One per `kind == 0` code region: `(start_line, end_line, covered)`. A region
    /// counts toward the diff when any line it spans is changed.
    pub regions: Vec<(u64, u64, bool)>,
}

/// A full `cargo llvm-cov --json` export, modeling the per-function region detail the
/// diff-scoped floor needs — separate from [`LlvmCovReport`], which keeps the totals.
#[derive(Debug, Clone, Deserialize)]
struct LlvmCovExport {
    data: Vec<LlvmCovExportData>,
}

/// One export entry. `--ignore-filename-regex` drops an exempt file from `files` but
/// *not* from `functions` (the regions array is unfiltered), so `files` is the
/// allowlist [`llvm_cov_patch_detail`] restricts the regions to.
#[derive(Debug, Clone, Deserialize)]
struct LlvmCovExportData {
    files: Vec<LlvmCovExportFile>,
    functions: Vec<LlvmCovFunction>,
    /// The same block [`LlvmCovReport`] reads. Defaulted so a fixture that models only the
    /// region detail still parses.
    #[serde(default)]
    totals: LlvmCovTotals,
}

/// One measured file in the export's `files` block — only its absolute `filename` is
/// needed, to build the not-ignored allowlist.
#[derive(Debug, Clone, Deserialize)]
struct LlvmCovExportFile {
    filename: String,
}

/// One function's coverage: the files it spans (`filenames`, indexed by a region's
/// `fileID`) and its regions. Each region is a flat array `[lineStart, colStart,
/// lineEnd, colEnd, executionCount, fileID, expandedFileID, kind]`, read positionally.
/// A branch region sits in `branches` instead, with `falseExecutionCount` inserted at index 5.
#[derive(Debug, Clone, Deserialize)]
struct LlvmCovFunction {
    filenames: Vec<String>,
    regions: Vec<Vec<i64>>,
    /// How many times the function itself ran.
    #[serde(default)]
    count: u64,
    #[serde(default)]
    branches: Vec<Vec<i64>>,
}

/// Run the Rust unit suite under `cargo llvm-cov` and return the per-file region
/// detail, keyed by the absolute path llvm-cov reports. `ignore` is the
/// `coverage`-rule exemptions, dropped so an exempt file's changed lines are lifted.
pub fn measure_patch_rust_detail(
    root: &Path,
    ignore: &[String],
    features: &[String],
) -> Result<BTreeMap<String, RustPatchCoverage>> {
    // The diff-scoped floor judges regions + lines, so its run never adds `--branch`.
    let json = run_cargo_llvm_cov(root, ignore, &["--json"], features, false)?;
    let hidden = hidden_lines_by_file(&json)?;
    llvm_cov_patch_detail(&json, &hidden)
}

/// Parse a full `cargo llvm-cov --json` export.
fn parse_llvm_cov_export(json: &str) -> Result<LlvmCovExport> {
    serde_json::from_str(json).context("parsing cargo llvm-cov JSON export")
}

/// Pure: per-file [`RustPatchCoverage`] from a `cargo llvm-cov --json` export, keyed
/// by the absolute path llvm-cov reports.
fn llvm_cov_patch_detail(
    json: &str,
    hidden: &BTreeMap<String, BTreeSet<u32>>,
) -> Result<BTreeMap<String, RustPatchCoverage>> {
    let export = parse_llvm_cov_export(json)?;
    let mut out: BTreeMap<String, RustPatchCoverage> = BTreeMap::new();
    for data in &export.data {
        let measured: BTreeSet<&str> = data.files.iter().map(|f| f.filename.as_str()).collect();
        for function in &data.functions {
            for region in &function.regions {
                if let Some((file, start, end, covered)) =
                    patch_region(region, &function.filenames, &measured, hidden)
                {
                    out.entry(file)
                        .or_default()
                        .regions
                        .push((start, end, covered));
                }
            }
        }
    }
    Ok(out)
}

/// One llvm-cov region's contribution as `(file, start line, end line, covered)`, or `None`
/// when it carries no line-coverage signal: only `kind == 0` code regions in the `measured`
/// allowlist count, a malformed short region is skipped rather than indexed, and a region
/// starting on a line `hidden` names is dropped — no test can execute it.
fn patch_region(
    region: &[i64],
    filenames: &[String],
    measured: &BTreeSet<&str>,
    hidden: &BTreeMap<String, BTreeSet<u32>>,
) -> Option<(String, u64, u64, bool)> {
    if region.len() < 8 {
        return None;
    }
    // gap (1) / expansion (2) / branch regions carry no line-coverage signal.
    if region[7] != 0 {
        return None;
    }
    let file = filenames.get(usize::try_from(region[5]).ok()?)?;
    // A `coverage` exemption drops the file's regions, lifting its lines.
    if !measured.contains(file.as_str()) {
        return None;
    }
    let start = region[0].max(0) as u64;
    // A gated item is instrumented in the bin target's test harness, where `cfg(test)`
    // is unset, and no test can reach it.
    if hidden
        .get(file)
        .is_some_and(|lines| lines.contains(&(start as u32)))
    {
        return None;
    }
    Some((file.clone(), start, region[2].max(0) as u64, region[4] > 0))
}

/// The single `--ignore-filename-regex` for the run, or `None` when nothing is exempt.
/// It is a substring search over absolute filenames, so each exempt path is escaped,
/// joined under `root`, and `$`-anchored — else it over-matches `member/src/a.rs`.
fn ignore_filename_regex(root: &Path, ignore: &[String]) -> Option<String> {
    if ignore.is_empty() {
        return None;
    }
    Some(
        ignore
            .iter()
            .map(|rel| {
                // The fallback keeps the anchor deterministic when the path can't be
                // resolved (e.g. in tests).
                let full = root.join(rel);
                let full = full.canonicalize().unwrap_or(full);
                format!("{}$", regex_escape(&full.to_string_lossy()))
            })
            .collect::<Vec<_>>()
            .join("|"),
    )
}

/// Escape `s`'s regex metacharacters so an exempt path matches literally.
fn regex_escape(s: &str) -> String {
    const META: &str = r"\.+*?()|[]{}^$";
    let mut out = String::with_capacity(s.len());
    for c in s.chars() {
        if META.contains(c) {
            out.push('\\');
        }
        out.push(c);
    }
    out
}

#[cfg(test)]
mod tests {
    use super::*;

    fn report(percent_covered: f64, num_branches: u64) -> CoverageReport {
        CoverageReport {
            totals: Totals {
                percent_covered,
                num_branches,
            },
            files: BTreeMap::new(),
        }
    }

    #[test]
    fn passes_when_total_meets_the_floor() {
        assert_eq!(
            evaluate(
                &report(100.0, 12),
                Thresholds {
                    fail_under: 100,
                    branch: true
                }
            ),
            Outcome::Pass
        );
    }

    #[test]
    fn fails_when_total_is_below_the_floor() {
        assert!(matches!(
            evaluate(
                &report(80.0, 12),
                Thresholds {
                    fail_under: 100,
                    branch: true
                }
            ),
            Outcome::Fail(_)
        ));
    }

    #[test]
    fn passes_when_branch_required_and_none_are_measured() {
        assert_eq!(
            evaluate(
                &report(100.0, 0),
                Thresholds {
                    fail_under: 100,
                    branch: true
                }
            ),
            Outcome::Pass
        );
    }

    #[test]
    fn parses_a_coverage_py_report() {
        let json = r#"{"totals":{"percent_covered":91.5,"num_branches":8,"covered_lines":91}}"#;
        let report = parse_report(json).expect("valid coverage.py json");
        assert_eq!(report.totals.percent_covered, 91.5);
        assert_eq!(report.totals.num_branches, 8);
    }

    #[test]
    fn parses_the_per_file_block_for_patch_coverage() {
        let json = r#"{
            "files": {
                "widget.py": {
                    "executed_lines": [1, 2, 3, 4, 6],
                    "summary": {"percent_covered": 85.0},
                    "missing_lines": [5],
                    "excluded_lines": [],
                    "missing_branches": [[4, 5]]
                }
            },
            "totals": {"percent_covered": 85.0, "num_branches": 4}
        }"#;
        let report = parse_report(json).expect("valid coverage.py json with files");
        let widget = report.files.get("widget.py").expect("widget.py is present");
        assert_eq!(widget.missing_lines, vec![5]);
        assert_eq!(widget.missing_branches, vec![vec![4, 5]]);
        assert_eq!(report.totals.percent_covered, 85.0);
    }

    #[test]
    fn a_report_without_a_files_block_parses_with_an_empty_map() {
        let report = parse_report(r#"{"totals":{"percent_covered":100.0,"num_branches":2}}"#)
            .expect("valid coverage.py json");
        assert!(report.files.is_empty());
    }

    #[test]
    fn omit_is_the_test_and_support_globs_when_nothing_is_exempt() {
        assert_eq!(build_omit(&[]), "*_test.py,*conftest.py");
    }

    #[test]
    fn omit_folds_in_the_exempt_paths_after_the_test_glob() {
        let exempt = vec!["pkg/gen.py".to_string(), "shim.py".to_string()];
        assert_eq!(
            build_omit(&exempt),
            "*_test.py,*conftest.py,pkg/gen.py,shim.py"
        );
    }

    fn metric(pct: f64) -> VitestMetric {
        VitestMetric {
            pct: Some(pct),
            total: 10,
        }
    }

    fn ts_report(lines: f64, branches: f64, functions: f64, statements: f64) -> VitestReport {
        VitestReport {
            total: VitestTotals {
                lines: metric(lines),
                branches: metric(branches),
                functions: metric(functions),
                statements: metric(statements),
            },
        }
    }

    const TS_FULL: TypeScriptThresholds = TypeScriptThresholds {
        lines: 100,
        branches: 100,
        functions: 100,
        statements: 100,
    };
    const TS_MID: TypeScriptThresholds = TypeScriptThresholds {
        lines: 80,
        branches: 75,
        functions: 80,
        statements: 80,
    };

    #[test]
    fn typescript_passes_when_every_metric_meets_its_floor() {
        assert_eq!(
            evaluate_typescript(&ts_report(100.0, 100.0, 100.0, 100.0), TS_FULL),
            Outcome::Pass
        );
    }

    #[test]
    fn typescript_fails_on_the_one_metric_below_its_floor() {
        let outcome = evaluate_typescript(&ts_report(100.0, 66.66, 100.0, 100.0), TS_MID);
        assert!(
            matches!(&outcome, Outcome::Fail(message) if message.contains("branches") && !message.contains("lines")),
            "got: {outcome:?}"
        );
    }

    #[test]
    fn typescript_fail_message_names_every_metric_below() {
        let outcome = evaluate_typescript(&ts_report(70.0, 70.0, 70.0, 70.0), TS_MID);
        assert!(
            matches!(&outcome, Outcome::Fail(message)
                if message.contains("lines")
                    && message.contains("branches")
                    && message.contains("functions")
                    && message.contains("statements")),
            "got: {outcome:?}"
        );
    }

    #[test]
    fn typescript_tolerates_float_noise_at_the_floor() {
        assert_eq!(
            evaluate_typescript(&ts_report(99.999_999_999, 100.0, 100.0, 100.0), TS_FULL),
            Outcome::Pass
        );
    }

    #[test]
    fn typescript_empty_denominator_metric_is_vacuously_satisfied() {
        let report = VitestReport {
            total: VitestTotals {
                lines: metric(100.0),
                branches: VitestMetric {
                    pct: None,
                    total: 0,
                },
                functions: metric(100.0),
                statements: metric(100.0),
            },
        };
        assert_eq!(evaluate_typescript(&report, TS_FULL), Outcome::Pass);
    }

    #[test]
    fn typescript_fails_a_vacuous_run_that_measured_no_code() {
        let nothing = VitestMetric {
            pct: None,
            total: 0,
        };
        let report = VitestReport {
            total: VitestTotals {
                lines: nothing,
                branches: nothing,
                functions: nothing,
                statements: nothing,
            },
        };
        let outcome = evaluate_typescript(&report, TS_MID);
        assert!(
            matches!(&outcome, Outcome::Fail(message) if message.contains("measured no code")),
            "got: {outcome:?}"
        );
    }

    #[test]
    fn parses_a_vitest_summary_report() {
        let json = r#"{
            "total": {
                "lines": {"total": 5, "covered": 4, "skipped": 0, "pct": 80},
                "statements": {"total": 5, "covered": 4, "skipped": 0, "pct": 80},
                "functions": {"total": 2, "covered": 2, "skipped": 0, "pct": 100},
                "branches": {"total": 3, "covered": 2, "skipped": 0, "pct": 66.66},
                "branchesTrue": {"total": 0, "covered": 0, "skipped": 0, "pct": "Unknown"}
            },
            "/abs/widget.ts": {
                "lines": {"total": 5, "covered": 4, "skipped": 0, "pct": 80}
            }
        }"#;
        let report = parse_vitest_report(json).expect("valid vitest json-summary");
        // A whole-number percent (`visit_u64`) and a fractional one (`visit_f64`).
        assert_eq!(report.total.lines.pct, Some(80.0));
        assert_eq!(report.total.branches.pct, Some(66.66));
        assert_eq!(report.total.functions.total, 2);
    }

    #[test]
    fn parses_an_unknown_pct_as_unmeasured() {
        let json = r#"{"total": {
            "lines": {"total": 0, "covered": 0, "skipped": 0, "pct": "Unknown"},
            "statements": {"total": 0, "covered": 0, "skipped": 0, "pct": "Unknown"},
            "functions": {"total": 0, "covered": 0, "skipped": 0, "pct": "Unknown"},
            "branches": {"total": 0, "covered": 0, "skipped": 0, "pct": "Unknown"}
        }}"#;
        let report = parse_vitest_report(json).expect("valid vitest json-summary");
        assert_eq!(report.total.lines.pct, None);
        assert_eq!(report.total.lines.total, 0);
    }

    #[test]
    fn a_pct_that_is_neither_number_nor_string_is_a_parse_error() {
        let json = r#"{"total":{
            "lines": {"total": 1, "covered": 1, "skipped": 0, "pct": true},
            "statements": {"total": 1, "covered": 1, "skipped": 0, "pct": 100},
            "functions": {"total": 1, "covered": 1, "skipped": 0, "pct": 100},
            "branches": {"total": 1, "covered": 1, "skipped": 0, "pct": 100}
        }}"#;
        assert!(parse_vitest_report(json).is_err());
    }

    fn rust_metric(percent: f64) -> LlvmCovMetric {
        LlvmCovMetric {
            count: 10,
            covered: 10,
            percent,
        }
    }

    fn rust_report(regions: f64, lines: f64) -> LlvmCovReport {
        LlvmCovReport {
            data: vec![LlvmCovData {
                totals: LlvmCovTotals {
                    regions: rust_metric(regions),
                    lines: rust_metric(lines),
                    functions: rust_metric(lines),
                    branches: None,
                },
            }],
        }
    }

    /// Like [`rust_report`] with explicit functions/branches; `branches: (count,
    /// percent)` so the vacuous zero-denominator case is constructible.
    fn rust_report_full(
        regions: f64,
        lines: f64,
        functions: f64,
        branches: (u64, f64),
    ) -> LlvmCovReport {
        let (count, percent) = branches;
        LlvmCovReport {
            data: vec![LlvmCovData {
                totals: LlvmCovTotals {
                    regions: rust_metric(regions),
                    lines: rust_metric(lines),
                    functions: rust_metric(functions),
                    branches: Some(LlvmCovMetric {
                        count,
                        covered: count,
                        percent,
                    }),
                },
            }],
        }
    }

    const RUST_FULL: RustThresholds = RustThresholds {
        regions: Some(100),
        lines: 100,
        functions: None,
        branch: None,
    };
    const RUST_MID: RustThresholds = RustThresholds {
        regions: Some(80),
        lines: 85,
        functions: None,
        branch: None,
    };

    #[test]
    fn rust_functions_floor_fails_below_and_passes_at_its_bar() {
        let report = rust_report_full(100.0, 100.0, 66.67, (0, 0.0));
        let floor = |functions| RustThresholds {
            regions: None,
            lines: 50,
            functions: Some(functions),
            branch: None,
        };
        assert!(matches!(
            evaluate_rust(&report, floor(100)),
            Outcome::Fail(message) if message.contains("functions")
        ));
        assert_eq!(evaluate_rust(&report, floor(60)), Outcome::Pass);
    }

    #[test]
    fn rust_branch_floor_fails_below_and_passes_at_its_bar() {
        let report = rust_report_full(100.0, 100.0, 100.0, (2, 50.0));
        let floor = |branch| RustThresholds {
            regions: None,
            lines: 50,
            functions: None,
            branch: Some(branch),
        };
        assert!(matches!(
            evaluate_rust(&report, floor(100)),
            Outcome::Fail(message) if message.contains("branches")
        ));
        assert_eq!(evaluate_rust(&report, floor(50)), Outcome::Pass);
    }

    #[test]
    fn rust_a_branchless_crate_clears_any_branch_floor_vacuously() {
        let report = rust_report_full(100.0, 100.0, 100.0, (0, 0.0));
        let floor = RustThresholds {
            regions: None,
            lines: 50,
            functions: None,
            branch: Some(100),
        };
        assert_eq!(evaluate_rust(&report, floor), Outcome::Pass);
    }

    #[test]
    fn rust_passes_when_both_metrics_meet_their_floor() {
        assert_eq!(
            evaluate_rust(&rust_report(100.0, 100.0), RUST_FULL),
            Outcome::Pass
        );
    }

    #[test]
    fn rust_fails_on_the_one_metric_below_its_floor() {
        let outcome = evaluate_rust(&rust_report(70.0, 100.0), RUST_MID);
        assert!(
            matches!(&outcome, Outcome::Fail(message) if message.contains("regions") && !message.contains("lines")),
            "got: {outcome:?}"
        );
    }

    #[test]
    fn rust_fail_message_names_every_metric_below() {
        let outcome = evaluate_rust(&rust_report(50.0, 50.0), RUST_MID);
        assert!(
            matches!(&outcome, Outcome::Fail(message)
                if message.contains("regions") && message.contains("lines")),
            "got: {outcome:?}"
        );
    }

    #[test]
    fn rust_skips_the_region_check_when_regions_is_opt_out() {
        let thresholds = RustThresholds {
            regions: None,
            lines: 100,
            functions: None,
            branch: None,
        };
        assert_eq!(
            evaluate_rust(&rust_report(40.0, 100.0), thresholds),
            Outcome::Pass
        );
    }

    #[test]
    fn rust_still_fails_lines_with_regions_opt_out() {
        let thresholds = RustThresholds {
            regions: None,
            lines: 100,
            functions: None,
            branch: None,
        };
        let outcome = evaluate_rust(&rust_report(100.0, 80.0), thresholds);
        assert!(
            matches!(&outcome, Outcome::Fail(message)
                if message.contains("lines") && !message.contains("regions")),
            "got: {outcome:?}"
        );
    }

    #[test]
    fn rust_tolerates_float_noise_at_the_floor() {
        assert_eq!(
            evaluate_rust(&rust_report(99.999_999_999, 100.0), RUST_FULL),
            Outcome::Pass
        );
    }

    #[test]
    fn rust_fails_a_vacuous_run_that_measured_no_code() {
        let nothing = LlvmCovMetric {
            count: 0,
            covered: 0,
            percent: 0.0,
        };
        let report = LlvmCovReport {
            data: vec![LlvmCovData {
                totals: LlvmCovTotals {
                    regions: nothing,
                    lines: nothing,
                    functions: nothing,
                    branches: None,
                },
            }],
        };
        let outcome = evaluate_rust(&report, RUST_MID);
        assert!(
            matches!(&outcome, Outcome::Fail(message) if message.contains("measured no code")),
            "got: {outcome:?}"
        );
    }

    #[test]
    fn rust_fails_an_export_with_no_data() {
        let report = LlvmCovReport { data: vec![] };
        assert!(matches!(evaluate_rust(&report, RUST_MID), Outcome::Fail(_)));
    }

    #[test]
    fn parses_a_cargo_llvm_cov_report() {
        let json = r#"{
            "data": [{"totals": {
                "regions": {"count": 12, "covered": 9, "notcovered": 3, "percent": 75.0},
                "lines": {"count": 20, "covered": 18, "percent": 90.0},
                "functions": {"count": 3, "covered": 3, "percent": 100.0}
            }}],
            "type": "llvm.coverage.json.export",
            "version": "2.0.1"
        }"#;
        let report = parse_llvm_cov_report(json).expect("valid llvm-cov json");
        assert_eq!(report.data[0].totals.regions.percent, 75.0);
        assert_eq!(report.data[0].totals.lines.count, 20);
    }

    /// [`llvm_cov_patch_detail`] over an export with nothing gated.
    fn patch_detail(json: &str) -> BTreeMap<String, RustPatchCoverage> {
        llvm_cov_patch_detail(json, &BTreeMap::new()).expect("valid llvm-cov export")
    }

    #[test]
    fn llvm_cov_patch_detail_reads_code_regions_per_file() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/grade.rs"}],
                "functions": [{
                    "filenames": ["/abs/grade.rs"],
                    "regions": [
                        [6, 5, 6, 26, 1, 0, 0, 0],
                        [10, 9, 10, 17, 0, 0, 0, 0]
                    ]
                }]
            }],
            "type": "llvm.coverage.json.export",
            "version": "3.0.1"
        }"#;
        let out = patch_detail(json);
        assert_eq!(
            out["/abs/grade.rs"].regions,
            vec![(6, 6, true), (10, 10, false)]
        );
    }

    #[test]
    fn llvm_cov_patch_detail_skips_non_code_regions() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/a.rs"}],
                "functions": [{
                    "filenames": ["/abs/a.rs"],
                    "regions": [
                        [1, 1, 1, 10, 2, 0, 0, 0],
                        [2, 1, 2, 10, 0, 0, 0, 1],
                        [3, 1, 3, 10, 0, 0, 0, 2]
                    ]
                }]
            }]
        }"#;
        let out = patch_detail(json);
        assert_eq!(out["/abs/a.rs"].regions, vec![(1, 1, true)]);
    }

    #[test]
    fn llvm_cov_patch_detail_groups_regions_by_filename_id() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/a.rs"}, {"filename": "/abs/b.rs"}],
                "functions": [{
                    "filenames": ["/abs/a.rs", "/abs/b.rs"],
                    "regions": [
                        [1, 1, 1, 5, 1, 0, 0, 0],
                        [9, 1, 9, 5, 0, 1, 1, 0]
                    ]
                }]
            }]
        }"#;
        let out = patch_detail(json);
        assert_eq!(out["/abs/a.rs"].regions, vec![(1, 1, true)]);
        assert_eq!(out["/abs/b.rs"].regions, vec![(9, 9, false)]);
    }

    #[test]
    fn llvm_cov_patch_detail_skips_a_malformed_short_region() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/a.rs"}],
                "functions": [{
                    "filenames": ["/abs/a.rs"],
                    "regions": [
                        [4, 1, 4],
                        [5, 1, 5, 9, 1, 0, 0, 0]
                    ]
                }]
            }]
        }"#;
        let out = patch_detail(json);
        assert_eq!(out["/abs/a.rs"].regions, vec![(5, 5, true)]);
    }

    #[test]
    fn llvm_cov_patch_detail_spans_a_multiline_region() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/a.rs"}],
                "functions": [{
                    "filenames": ["/abs/a.rs"],
                    "regions": [[3, 5, 5, 6, 0, 0, 0, 0]]
                }]
            }]
        }"#;
        let out = patch_detail(json);
        assert_eq!(out["/abs/a.rs"].regions, vec![(3, 5, false)]);
    }

    #[test]
    fn llvm_cov_patch_detail_drops_a_file_absent_from_the_files_allowlist() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/kept.rs"}],
                "functions": [{
                    "filenames": ["/abs/kept.rs", "/abs/ignored.rs"],
                    "regions": [
                        [1, 1, 1, 9, 1, 0, 0, 0],
                        [2, 1, 2, 9, 0, 1, 0, 0]
                    ]
                }]
            }]
        }"#;
        let out = patch_detail(json);
        assert_eq!(out["/abs/kept.rs"].regions, vec![(1, 1, true)]);
        assert!(!out.contains_key("/abs/ignored.rs"));
    }

    #[test]
    fn llvm_cov_patch_detail_malformed_json_is_an_error() {
        assert!(llvm_cov_patch_detail("{ not json", &BTreeMap::new()).is_err());
    }

    #[test]
    fn llvm_cov_patch_detail_skips_a_negative_file_id() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/a.rs"}],
                "functions": [{
                    "filenames": ["/abs/a.rs"],
                    "regions": [[1, 1, 1, 5, 1, -1, 0, 0]]
                }]
            }]
        }"#;
        let out = patch_detail(json);
        assert!(out.is_empty(), "got: {out:?}");
    }

    #[test]
    fn llvm_cov_patch_detail_skips_an_out_of_range_file_id() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/a.rs"}],
                "functions": [{
                    "filenames": ["/abs/a.rs"],
                    "regions": [[1, 1, 1, 5, 1, 7, 0, 0]]
                }]
            }]
        }"#;
        let out = patch_detail(json);
        assert!(out.is_empty(), "got: {out:?}");
    }

    #[test]
    fn istanbul_patch_detail_reads_statements_arms_and_functions() {
        let json = r#"{
            "/abs/a.ts": {
                "statementMap": {"0": {"start": {"line": 1}, "end": {"line": 2}}},
                "s": {"0": 1},
                "branchMap": {"0": {"loc": {"start": {"line": 3}, "end": {"line": 3}}}},
                "b": {"0": [1, 0]},
                "fnMap": {"0": {"decl": {"start": {"line": 7}, "end": {"line": 7}}}},
                "f": {"0": 0}
            }
        }"#;
        let out = istanbul_patch_detail(json).expect("valid Istanbul report");
        let detail = &out["/abs/a.ts"];
        assert_eq!(detail.statements, vec![(1, 2, true)]);
        assert_eq!(detail.branch_arms, vec![(3, true), (3, false)]);
        assert_eq!(detail.functions, vec![(7, false)]);
    }

    #[test]
    fn istanbul_patch_detail_keeps_a_branch_without_counts() {
        let json = r#"{
            "/abs/a.ts": {
                "statementMap": {},
                "s": {},
                "branchMap": {"0": {"loc": {"start": {"line": 3}, "end": {"line": 3}}}},
                "b": {},
                "fnMap": {},
                "f": {}
            }
        }"#;
        let out = istanbul_patch_detail(json).expect("valid Istanbul report");
        assert!(out["/abs/a.ts"].branch_arms.is_empty(), "got: {out:?}");
    }

    #[test]
    fn default_excludes_that_are_not_json_name_the_output() {
        let err = parse_default_excludes(b"vitest warmed up first").unwrap_err();
        let msg = format!("{err:#}");
        assert!(msg.contains("not a JSON string array"), "got: {msg}");
        assert!(msg.contains("vitest warmed up first"), "got: {msg}");
    }

    #[test]
    fn default_excludes_drop_a_nul_bearing_pattern() {
        let parsed = parse_default_excludes(br#"["**/dist/**", "**/\u0000*"]"#).unwrap();
        assert_eq!(parsed, vec!["**/dist/**".to_string()]);
    }

    #[test]
    fn a_missing_vitest_report_names_the_reporter() {
        let path = std::env::temp_dir().join("tc-no-such-report/coverage-final.json");
        let err = read_vitest_report(&path, "json").unwrap_err();
        assert!(format!("{err:#}").contains("json report"), "got: {err:#}");
    }

    #[test]
    fn rust_ignore_regex_is_none_when_nothing_is_exempt() {
        assert_eq!(ignore_filename_regex(Path::new("/repo"), &[]), None);
    }

    #[test]
    fn rust_run_argv_carries_format_features_branch_and_ignore_regex() {
        assert_eq!(
            run_argv(
                &["--json"],
                &["alpha".to_string(), "beta".to_string()],
                true,
                Some("src/ignored\\.rs$".to_string()),
            ),
            [
                "llvm-cov",
                "--lib",
                "--bins",
                "--json",
                "--features",
                "alpha,beta",
                "--branch",
                "--ignore-filename-regex",
                "src/ignored\\.rs$",
            ]
        );
        assert_eq!(
            run_argv(&["--lcov"], &[], false, None),
            ["llvm-cov", "--lib", "--bins", "--lcov"]
        );
    }

    #[test]
    fn vitest_coverage_argv_names_the_reporter_the_report_dir_and_every_exclude() {
        let excludes = ["dist/**".to_string(), "src/generated/**".to_string()];
        let argv = vitest_coverage_argv("json-summary", Path::new("/tmp/reports"), excludes.iter());

        assert_eq!(argv[0], "--no-install");
        assert_eq!(argv[1], "vitest");
        assert!(argv.contains(&"--coverage.all=true".to_string()));
        assert!(argv.contains(&"--coverage.thresholds.autoUpdate=false".to_string()));
        assert!(argv.contains(&"--coverage.reporter=json-summary".to_string()));
        assert!(argv.contains(&"--coverage.reportsDirectory=/tmp/reports".to_string()));
        assert!(argv.contains(&format!("--coverage.include={TS_INCLUDE}")));
        assert_eq!(
            argv.iter()
                .filter(|arg| arg.starts_with("--coverage.exclude="))
                .collect::<Vec<_>>(),
            [
                "--coverage.exclude=dist/**",
                "--coverage.exclude=src/generated/**"
            ]
        );
    }

    #[test]
    fn vitest_coverage_argv_never_passes_yes_so_a_missing_vitest_fails_clean() {
        let argv = vitest_coverage_argv("json", Path::new("/tmp/r"), [].iter());

        assert!(!argv.iter().any(|arg| arg == "--yes"));
    }

    #[test]
    fn a_metric_at_or_above_its_floor_names_no_shortfall() {
        assert_eq!(shortfall("lines", 100.0, 100), None);
        assert_eq!(shortfall("lines", 90.0, 90), None);
        // A percent that rounds to the floor is not failed by float noise.
        assert_eq!(shortfall("lines", 89.999999999, 90), None);
    }

    #[test]
    fn a_metric_below_its_floor_names_the_gap() {
        assert_eq!(
            shortfall("branches", 72.5, 80),
            Some("branches 72.50% < 80%".to_string())
        );
    }

    #[test]
    fn a_verdict_passes_on_no_shortfalls_and_names_every_one_otherwise() {
        assert_eq!(verdict(Vec::new()), Outcome::Pass);
        assert_eq!(
            verdict(vec![
                "lines 1.00% < 2%".to_string(),
                "b 3.00% < 4%".to_string()
            ]),
            Outcome::Fail("coverage below thresholds: lines 1.00% < 2%, b 3.00% < 4%".to_string())
        );
    }

    #[test]
    fn rust_checks_floor_lines_always_and_the_rest_only_when_configured() {
        let totals = rust_report_full(10.0, 20.0, 30.0, (4, 50.0)).data[0].totals;

        assert_eq!(
            rust_checks(
                &totals,
                RustThresholds {
                    lines: 90,
                    regions: None,
                    functions: None,
                    branch: None,
                }
            ),
            [("lines", 20.0, 90)]
        );
        assert_eq!(
            rust_checks(
                &totals,
                RustThresholds {
                    lines: 90,
                    regions: Some(80),
                    functions: Some(70),
                    branch: Some(60),
                }
            ),
            [
                ("regions", 10.0, 80),
                ("lines", 20.0, 90),
                ("functions", 30.0, 70),
                ("branches", 50.0, 60),
            ]
        );
    }

    #[test]
    fn a_branch_floor_over_a_branchless_crate_is_vacuously_satisfied() {
        let totals = rust_report_full(10.0, 20.0, 30.0, (0, 0.0)).data[0].totals;

        assert_eq!(
            rust_checks(
                &totals,
                RustThresholds {
                    lines: 90,
                    regions: None,
                    functions: None,
                    branch: Some(60),
                }
            ),
            [("lines", 20.0, 90)]
        );
    }

    #[test]
    fn a_code_region_in_a_measured_file_contributes_its_span_and_hit_state() {
        let names = ["src/a.rs".to_string()];

        assert_eq!(
            patch_region(
                &[7, 1, 9, 20, 3, 0, 0, 0],
                &names,
                &BTreeSet::from(["src/a.rs"]),
                &BTreeMap::new()
            ),
            Some(("src/a.rs".to_string(), 7, 9, true))
        );
        assert_eq!(
            patch_region(
                &[7, 1, 9, 20, 0, 0, 0, 0],
                &names,
                &BTreeSet::from(["src/a.rs"]),
                &BTreeMap::new()
            ),
            Some(("src/a.rs".to_string(), 7, 9, false))
        );
    }

    #[test]
    fn a_region_carrying_no_line_signal_contributes_nothing() {
        let names = ["src/a.rs".to_string()];
        let measured = BTreeSet::from(["src/a.rs"]);
        let nothing_hidden = BTreeMap::new();
        let reject = |region: &[i64]| patch_region(region, &names, &measured, &nothing_hidden);

        // Too short to index.
        assert_eq!(reject(&[7, 1, 9, 20, 3, 0, 0]), None);
        // A gap region.
        assert_eq!(reject(&[7, 1, 9, 20, 3, 0, 0, 1]), None);
        // A file id outside the function's filename table.
        assert_eq!(reject(&[7, 1, 9, 20, 3, 9, 0, 0]), None);
        // A negative file id.
        assert_eq!(reject(&[7, 1, 9, 20, 3, -1, 0, 0]), None);
        // A file the `coverage` exemptions dropped from the measured set.
        assert_eq!(
            patch_region(
                &[7, 1, 9, 20, 3, 0, 0, 0],
                &names,
                &BTreeSet::new(),
                &nothing_hidden
            ),
            None
        );
        // A region starting on a `cfg(not(test))`-gated line.
        assert_eq!(
            patch_region(
                &[7, 1, 9, 20, 3, 0, 0, 0],
                &names,
                &measured,
                &BTreeMap::from([("src/a.rs".to_string(), BTreeSet::from([7u32]))])
            ),
            None
        );
    }

    #[test]
    fn rust_report_argv_carries_format_and_optional_ignore_regex() {
        assert_eq!(
            report_argv(&["--lcov"], Some("src/ignored\\.rs$".to_string())),
            [
                "llvm-cov",
                "report",
                "--lcov",
                "--ignore-filename-regex",
                "src/ignored\\.rs$"
            ]
        );
        assert_eq!(
            report_argv(&["--json"], None),
            ["llvm-cov", "report", "--json"]
        );
    }

    #[test]
    fn branch_hint_names_the_nightly_requirement_only_for_branch_coverage() {
        assert_eq!(branch_hint(false), "");
        assert!(branch_hint(true).contains("requires a nightly toolchain"));
    }

    #[test]
    fn scrub_removes_outer_llvm_cov_state_from_a_command() {
        let mut command = Command::new("cargo");
        for name in [
            "RUSTFLAGS",
            "CARGO_ENCODED_RUSTFLAGS",
            "RUSTDOCFLAGS",
            "CARGO_ENCODED_RUSTDOCFLAGS",
            "LLVM_PROFILE_FILE",
            "CARGO_LLVM_COV",
            "CARGO_LLVM_COV_SHOW_ENV",
            "CARGO_LLVM_COV_TARGET_DIR",
            "CARGO_LLVM_COV_BUILD_DIR",
            "RUSTC_WRAPPER",
            "RUSTC_WORKSPACE_WRAPPER",
            "__CARGO_LLVM_COV_RUSTC_WRAPPER",
            "__CARGO_LLVM_COV_RUSTC_WRAPPER_RUSTFLAGS",
            "__CARGO_LLVM_COV_RUSTC_WRAPPER_CRATE_NAMES",
            "RUSTUP_TOOLCHAIN",
            "CARGO",
            "RUSTC",
        ] {
            command.env(name, "outer");
        }
        command.env("KEEP", "value");
        scrub_outer_llvm_cov(&mut command);
        let envs: Vec<_> = command.get_envs().collect();
        assert_eq!(envs.len(), 18);
        assert!(envs
            .iter()
            .all(|(name, value)| { name == &"KEEP" || value.is_none() }));
        assert_eq!(
            envs.iter().find(|(name, _)| *name == "KEEP").unwrap().1,
            Some("value".as_ref())
        );
    }

    #[test]
    fn rust_ignore_regex_anchors_each_exempt_path_to_its_full_path() {
        // `/repo` doesn't exist, so `canonicalize` falls back to the plain join.
        let exempt = vec!["src/shim.rs".to_string(), "src/gen.rs".to_string()];
        assert_eq!(
            ignore_filename_regex(Path::new("/repo"), &exempt).as_deref(),
            Some(r"/repo/src/shim\.rs$|/repo/src/gen\.rs$")
        );
    }

    /// Model llvm-cov's substring `--ignore-filename-regex` for the escaped, optionally
    /// `$`-anchored literals this tool emits. One matching alternative ignores the file.
    fn llvm_would_ignore(regex: &str, filename: &str) -> bool {
        regex.split('|').any(|alt| {
            let (lit, anchored) = match alt.strip_suffix('$') {
                Some(head) => (head, true),
                None => (alt, false),
            };
            let lit = lit.replace('\\', "");
            if anchored {
                filename.ends_with(&lit)
            } else {
                filename.contains(&lit)
            }
        })
    }

    #[test]
    fn llvm_would_ignore_matches_an_unanchored_literal_anywhere() {
        assert!(llvm_would_ignore("/repo/src", "/repo/src/a.rs"));
        assert!(!llvm_would_ignore("/elsewhere", "/repo/src/a.rs"));
    }

    #[test]
    fn rust_ignore_regex_does_not_over_match_a_member_with_the_same_suffix() {
        let regex = ignore_filename_regex(Path::new("/repo"), &["src/a.rs".to_string()]).unwrap();
        assert!(
            llvm_would_ignore(&regex, "/repo/src/a.rs"),
            "the exempted file must still be ignored: {regex}"
        );
        assert!(
            !llvm_would_ignore(&regex, "/repo/member/src/a.rs"),
            "`src/a.rs` over-matched `member/src/a.rs`: {regex}"
        );
        assert!(
            !llvm_would_ignore(&regex, "/repo/src/xsrc/a.rs"),
            "`src/a.rs` over-matched `src/xsrc/a.rs`: {regex}"
        );
    }

    /// A `cargo llvm-cov --json` export of one file holding a gated `main` on lines 6-8 and a
    /// tested `report` on lines 11-13, with the `--bins` half's second, 0-hit copy of both.
    const GATED_EXPORT: &str = r#"{
        "data": [{
            "files": [{"filename": "/abs/entrypoint.rs"}],
            "functions": [
                {"name": "report", "count": 1, "filenames": ["/abs/entrypoint.rs"], "branches": [],
                 "regions": [[11, 1, 11, 37, 1, 0, 0, 0], [12, 5, 12, 19, 1, 0, 0, 0],
                             [12, 20, 12, 30, 1, 0, 0, 0], [13, 1, 13, 2, 1, 0, 0, 0]]},
                {"name": "main", "count": 0, "filenames": ["/abs/entrypoint.rs"], "branches": [],
                 "regions": [[6, 1, 6, 26, 0, 0, 0, 0], [7, 5, 7, 11, 0, 0, 0, 0],
                             [7, 12, 7, 46, 0, 0, 0, 0], [8, 1, 8, 2, 0, 0, 0, 0]]},
                {"name": "report", "count": 0, "filenames": ["/abs/entrypoint.rs"], "branches": [],
                 "regions": [[11, 1, 11, 37, 0, 0, 0, 0], [12, 5, 12, 19, 0, 0, 0, 0],
                             [12, 20, 12, 30, 0, 0, 0, 0], [13, 1, 13, 2, 0, 0, 0, 0]]}
            ],
            "totals": {
                "regions": {"count": 13, "covered": 9, "percent": 69.23},
                "lines": {"count": 9, "covered": 6, "percent": 66.67},
                "functions": {"count": 3, "covered": 2, "percent": 66.67}
            }
        }]
    }"#;

    /// The lines `#[cfg(not(test))] fn main` spans in [`GATED_EXPORT`]'s source.
    fn gated_main() -> BTreeMap<String, BTreeSet<u32>> {
        BTreeMap::from([(
            "/abs/entrypoint.rs".to_string(),
            BTreeSet::from([5, 6, 7, 8]),
        )])
    }

    /// [`llvm_cov_totals_less_hidden`] over an export string.
    fn totals_less(json: &str, hidden: &BTreeMap<String, BTreeSet<u32>>) -> LlvmCovTotals {
        let export = parse_llvm_cov_export(json).expect("valid llvm-cov export");
        llvm_cov_totals_less_hidden(&export, hidden).data[0].totals
    }

    #[test]
    fn a_gated_entry_point_leaves_every_ratio_full() {
        let totals = totals_less(GATED_EXPORT, &gated_main());
        assert_eq!((totals.regions.count, totals.regions.covered), (9, 9));
        assert_eq!((totals.lines.count, totals.lines.covered), (6, 6));
        assert_eq!((totals.functions.count, totals.functions.covered), (2, 2));
        assert_eq!(totals.regions.percent, 100.0);
    }

    #[test]
    fn an_export_with_nothing_gated_keeps_its_totals() {
        let totals = totals_less(GATED_EXPORT, &BTreeMap::new());
        assert_eq!((totals.regions.count, totals.regions.covered), (13, 9));
        assert_eq!((totals.lines.count, totals.lines.covered), (9, 6));
        assert_eq!((totals.functions.count, totals.functions.covered), (3, 2));
    }

    #[test]
    fn two_copies_of_one_gated_item_subtract_once() {
        let json = GATED_EXPORT.replace(
            r#"{"name": "report", "count": 1"#,
            r#"{"name": "main", "count": 0, "filenames": ["/abs/entrypoint.rs"], "branches": [],
                 "regions": [[6, 1, 6, 26, 0, 0, 0, 0], [7, 5, 7, 11, 0, 0, 0, 0],
                             [7, 12, 7, 46, 0, 0, 0, 0], [8, 1, 8, 2, 0, 0, 0, 0]]},
                {"name": "report", "count": 1"#,
        );
        let totals = totals_less(&json, &gated_main());
        assert_eq!((totals.regions.count, totals.regions.covered), (9, 9));
        assert_eq!(totals.functions.count, 2);
    }

    #[test]
    fn a_record_with_no_region_to_place_it_is_not_subtracted() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/a.rs"}],
                "functions": [{"name": "empty", "count": 0, "filenames": ["/abs/a.rs"],
                    "regions": [], "branches": []}],
                "totals": {
                    "regions": {"count": 2, "covered": 2, "percent": 100.0},
                    "lines": {"count": 2, "covered": 2, "percent": 100.0},
                    "functions": {"count": 1, "covered": 1, "percent": 100.0}
                }
            }]
        }"#;
        let hidden = BTreeMap::from([("/abs/a.rs".to_string(), BTreeSet::from([1]))]);
        assert_eq!(totals_less(json, &hidden).regions.count, 2);
    }

    #[test]
    fn a_record_outside_the_files_allowlist_is_not_subtracted() {
        let hidden = BTreeMap::from([("/abs/other.rs".to_string(), BTreeSet::from([6]))]);
        let json = GATED_EXPORT.replace("\"/abs/entrypoint.rs\"],", "\"/abs/other.rs\"],");
        assert_eq!(totals_less(&json, &hidden).regions.count, 13);
    }

    #[test]
    fn a_gated_branch_drops_both_of_its_arms() {
        let json = r#"{
            "data": [{
                "files": [{"filename": "/abs/a.rs"}],
                "functions": [{"name": "main", "count": 0, "filenames": ["/abs/a.rs"],
                    "regions": [[1, 1, 3, 2, 0, 0, 0, 0]],
                    "branches": [[2, 9, 2, 14, 0, 0, 0, 0, 4], [2, 9, 2, 14, 0, 0, 0, 0]]}],
                "totals": {
                    "regions": {"count": 5, "covered": 4, "percent": 80.0},
                    "lines": {"count": 9, "covered": 6, "percent": 66.67},
                    "functions": {"count": 3, "covered": 2, "percent": 66.67},
                    "branches": {"count": 6, "covered": 4, "percent": 66.67}
                }
            }]
        }"#;
        let hidden = BTreeMap::from([("/abs/a.rs".to_string(), BTreeSet::from([1, 2, 3]))]);
        let branches = totals_less(json, &hidden).branches.expect("branch totals");
        // The second entry is a region array, not a branch one; a short array carries no arms.
        assert_eq!((branches.count, branches.covered), (4, 4));
    }

    #[test]
    fn a_metric_the_subtraction_empties_reads_full() {
        let metric = LlvmCovMetric {
            count: 4,
            covered: 0,
            percent: 0.0,
        };
        let emptied = metric_less(
            metric,
            Tally {
                count: 9,
                covered: 9,
            },
        );
        assert_eq!((emptied.count, emptied.covered), (0, 0));
        assert_eq!(emptied.percent, 100.0);
    }

    /// Two instantiation groups of one file, the second never run. The `--json` totals sum the
    /// two — nine lines, one short — while lcov merges them into three, all covered.
    const TWO_GROUPS_LCOV: &str = "SF:/abs/a.rs\nDA:1,4\nDA:2,4\nDA:3,0\n\
                                   SF:/abs/a.rs\nDA:1,0\nDA:2,0\nDA:3,7\nend_of_record\n";

    #[test]
    fn a_line_one_instantiation_ran_counts_once_covered() {
        let lines = lcov_lines_metric(TWO_GROUPS_LCOV, &BTreeMap::new());
        assert_eq!((lines.count, lines.covered), (3, 3));
        assert_eq!(lines.percent, 100.0);
    }

    #[test]
    fn a_gated_line_leaves_the_lcov_denominator() {
        let hidden = BTreeMap::from([("/abs/a.rs".to_string(), BTreeSet::from([3]))]);
        let lines = lcov_lines_metric(TWO_GROUPS_LCOV, &hidden);
        assert_eq!((lines.count, lines.covered), (2, 2));
    }

    #[test]
    fn a_line_no_instantiation_ran_is_still_missing() {
        let lcov = "SF:/abs/a.rs\nDA:1,4\nDA:2,0\nend_of_record\n";
        let lines = lcov_lines_metric(lcov, &BTreeMap::new());
        assert_eq!((lines.count, lines.covered), (2, 1));
    }

    #[test]
    fn records_outside_a_source_file_are_not_lines() {
        let lcov = "DA:1,4\nSF:/abs/a.rs\nFN:1,main\nDA:x,4\nDA:2\nDA:3,y\nDA:4,1\nLF:4\n";
        assert_eq!(
            lcov_lines(lcov),
            BTreeMap::from([("/abs/a.rs".to_string(), BTreeMap::from([(4, true)]))]),
            "a `DA:` before any `SF:`, and a malformed one after, name no line"
        );
    }

    #[test]
    fn a_failed_export_carries_both_streams() {
        let err = llvm_cov_stdout(false, b"out\n", b"err\n", "could not re-export:")
            .expect_err("a non-zero exit is an error");
        assert_eq!(format!("{err}"), "could not re-export:\nout\nerr\n");
    }

    #[test]
    fn an_export_measuring_nothing_reads_full() {
        let lines = lcov_lines_metric("", &BTreeMap::new());
        assert_eq!((lines.count, lines.covered), (0, 0));
        assert_eq!(lines.percent, 100.0);
    }

    #[test]
    fn a_function_record_without_a_usable_first_region_has_no_group() {
        let short = LlvmCovFunction {
            filenames: vec!["/abs/a.rs".to_string()],
            regions: vec![vec![1, 1, 1, 2]],
            count: 0,
            branches: Vec::new(),
        };
        let unnamed = LlvmCovFunction {
            filenames: Vec::new(),
            regions: vec![vec![1, 1, 1, 2, 0, 7, 0, 0]],
            count: 0,
            branches: Vec::new(),
        };
        let empty = LlvmCovFunction {
            filenames: vec!["/abs/a.rs".to_string()],
            regions: Vec::new(),
            count: 0,
            branches: Vec::new(),
        };
        assert_eq!(function_start(&short), None);
        assert_eq!(function_start(&unnamed), None);
        assert_eq!(function_start(&empty), None);
    }

    #[test]
    fn a_gated_region_drops_out_of_the_changed_line_detail() {
        let hidden =
            BTreeMap::from([("/abs/entrypoint.rs".to_string(), BTreeSet::from([6, 7, 8]))]);
        let detail = llvm_cov_patch_detail(GATED_EXPORT, &hidden).expect("valid export");
        assert_eq!(
            detail["/abs/entrypoint.rs"]
                .regions
                .iter()
                .map(|(start, _, _)| *start)
                .collect::<BTreeSet<_>>(),
            BTreeSet::from([11, 12, 13])
        );
    }

    #[test]
    fn hidden_lines_come_from_the_sources_the_export_measured() {
        let dir = std::env::temp_dir().join(format!("tc-cov-hidden-{}", std::process::id()));
        std::fs::create_dir_all(&dir).unwrap();
        let gated = dir.join("gated.rs");
        std::fs::write(&gated, "#[cfg(not(test))]\nfn main() {}\n").unwrap();
        let json = format!(
            r#"{{"data": [{{"files": [{{"filename": "{}"}}, {{"filename": "{}"}}],
                 "functions": []}}]}}"#,
            gated.display(),
            dir.join("absent.rs").display(),
        );
        let hidden = hidden_lines_by_file(&json).expect("valid export");
        std::fs::remove_dir_all(&dir).ok();
        assert_eq!(
            hidden,
            BTreeMap::from([(gated.display().to_string(), BTreeSet::from([1, 2]))]),
            "an unreadable source hides nothing"
        );
    }

    #[test]
    fn a_clean_vitest_exit_raises_nothing() {
        assert!(vitest_exit(true, Path::new("/tmp/project"), b"ignored", b"ignored").is_ok());
    }

    #[test]
    fn a_failed_vitest_exit_names_the_project_both_streams_and_the_no_install_rule() {
        let err = vitest_exit(
            false,
            Path::new("/tmp/project"),
            b"out detail",
            b"err detail",
        )
        .unwrap_err()
        .to_string();

        assert!(err.contains("/tmp/project"), "got: {err}");
        assert!(err.contains("out detail"), "got: {err}");
        assert!(err.contains("err detail"), "got: {err}");
        assert!(err.contains("npx --no-install"), "got: {err}");
        assert!(err.contains("@vitest/coverage-v8"), "got: {err}");
    }
}