rightkit-qa 0.7.0

//! A QA run: select scenarios by tier, take the run lock, create the isolated
//! workspace, run scenarios sequentially, sweep orphans, and write hashed evidence.
use crate::audio::SystemMute;
use crate::config::{validate_tier_list, QaConfig};
use crate::engine::{build_engine, EngineTarget};
use crate::evidence::{Bundle, CheckStatus, RunStatus};
use crate::lock::{self, LockOptions};
use crate::process::{sweep_registries, Tracker};
use crate::scenario::{
    discover, platform_mismatch, resolve_run_kind, run_step, scenario_kind, tier_selected,
    unmet_requirement, Ctx, Scenario, StepHandlers, StepRecord,
};
use crate::storage::{self, RunKind, RunOutcome};
use crate::util::{err, now_iso, platform, Result};
use crate::workspace;
use serde_json::{json, Value};
use std::path::{Path, PathBuf};
use std::sync::Arc;
use std::time::{Duration, Instant};

/// Per-scenario callback: gets the scenario's [`Ctx`] (already built, run kind set) and the scenario.
pub type ScenarioHook = Arc<dyn for<'a> Fn(&mut Ctx<'a>, &Scenario) -> Result<()> + Send + Sync>;

/// App-defined behaviour for a suite run (rightkit#456). `SuiteHooks::default()` changes nothing.
#[derive(Clone, Default)]
pub struct SuiteHooks {
    /// App-defined step kinds, see [`StepHandlers`].
    pub steps: StepHandlers,
    /// Runs once per scenario, after its [`Ctx`] exists and before its first step: start the app's
    /// mock, set `ctx.vars` entries (`mock_url`, ...), register cleanup. An `Err` fails the scenario
    /// without running its steps; [`SuiteHooks::teardown`] still runs.
    pub setup: Option<ScenarioHook>,
    /// Runs once per scenario that reached setup, after its steps (pass or fail) and before the
    /// built-in teardown (UI, sidecars, mocks) and the run's orphan sweep, while `ctx` is still
    /// live. An `Err` is a teardown problem and fails an otherwise passing scenario.
    pub teardown: Option<ScenarioHook>,
}

impl SuiteHooks {
    /// Register a custom step kind (builder style).
    pub fn step(
        mut self,
        kind: &str,
        handler: impl for<'a> Fn(&mut Ctx<'a>, &serde_json::Map<String, Value>) -> Result<Value>
            + Send
            + Sync
            + 'static,
    ) -> Self {
        self.steps.register(kind, handler);
        self
    }
    pub fn setup(
        mut self,
        f: impl for<'a> Fn(&mut Ctx<'a>, &Scenario) -> Result<()> + Send + Sync + 'static,
    ) -> Self {
        self.setup = Some(Arc::new(f));
        self
    }
    pub fn teardown(
        mut self,
        f: impl for<'a> Fn(&mut Ctx<'a>, &Scenario) -> Result<()> + Send + Sync + 'static,
    ) -> Self {
        self.teardown = Some(Arc::new(f));
        self
    }
}

impl std::fmt::Debug for SuiteHooks {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("SuiteHooks")
            .field("steps", &self.steps)
            .field("setup", &self.setup.is_some())
            .field("teardown", &self.teardown.is_some())
            .finish()
    }
}

#[derive(Debug, Clone, Default)]
pub struct SuiteOptions {
    pub tier: Option<String>,
    pub only: Option<String>,
    pub engine: Option<PathBuf>,
    /// An explicit UI executable. Skips the resolver's validation; still refused when it is an
    /// installed app (see [`explicit_ui_binary`]).
    pub ui_binary: Option<PathBuf>,
    pub build_engine: bool,
    pub build_ui: bool,
    pub keep_data: bool,
    /// Run kind: `functional` (clicks, state, text; no screenshots or recordings) or `visual`.
    /// `None` lets the scenarios decide ([`resolve_run_kind`]); with none declaring `visual` the
    /// run is functional.
    pub kind: Option<RunKind>,
    /// Explicit scenario files (override discovery).
    pub files: Vec<PathBuf>,
    /// App-defined step kinds and per-scenario setup/teardown.
    pub hooks: SuiteHooks,
    /// Kill tracked processes still alive after each scenario's teardown, without failing the
    /// scenario, so one scenario's stray process cannot fail the ones after it. A scenario can
    /// also set `kill_orphans = true`. Off by default: survivors fail the scenario.
    pub kill_orphans: bool,
}

#[derive(Debug, Clone)]
pub struct Outcome {
    pub name: String,
    pub file: PathBuf,
    pub tier: String,
    pub status: CheckStatus,
    pub reason: Option<String>,
    pub ms: u128,
    pub steps: Vec<StepRecord>,
}

impl Outcome {
    fn to_value(&self) -> Value {
        json!({
            "name": self.name, "file": self.file.to_string_lossy(), "tier": self.tier,
            "status": format!("{:?}", self.status).to_lowercase(), "reason": self.reason, "ms": self.ms,
            "steps": self.steps.iter().map(|s| json!({"index": s.index, "kind": s.kind, "name": s.name, "ok": s.ok, "ms": s.ms, "error": s.error})).collect::<Vec<_>>(),
        })
    }
}

#[derive(Debug)]
pub struct SuiteReport {
    pub exit_code: i32,
    pub run_id: String,
    pub run_dir: PathBuf,
    pub evidence_path: PathBuf,
    pub results_path: PathBuf,
    pub outcomes: Vec<Outcome>,
}

/// Whether `only` selects the scenario: `only` is one name or a comma-separated list; a name
/// matches when it is a substring of the scenario name or file path, or equals the file stem (the
/// file name without `.scenario.toml`) exactly.
pub fn only_matches(only: &str, name: &str, file: &Path) -> bool {
    let fname = file
        .file_name()
        .map(|n| n.to_string_lossy().to_string())
        .unwrap_or_default();
    let stem = fname
        .strip_suffix(".scenario.toml")
        .map(str::to_string)
        .unwrap_or_else(|| {
            file.file_stem()
                .map(|s| s.to_string_lossy().to_string())
                .unwrap_or_default()
        });
    let path = file.to_string_lossy();
    only.split(',')
        .map(str::trim)
        .filter(|o| !o.is_empty())
        .any(|o| name.contains(o) || path.contains(o) || stem == o)
}

pub fn select(cfg: &QaConfig, opts: &SuiteOptions) -> Result<Vec<Scenario>> {
    let tier = opts
        .tier
        .clone()
        .unwrap_or_else(|| cfg.default_tier.clone());
    validate_tier_list(&tier)?;
    let files = if opts.files.is_empty() {
        discover(&cfg.scenario_dirs)?
    } else {
        opts.files.clone()
    };
    let mut out = vec![];
    for f in files {
        let s = Scenario::load(&f)?;
        let matches_only = opts
            .only
            .as_ref()
            .map(|o| only_matches(o, &s.name, &f))
            .unwrap_or(true);
        if matches_only && (!opts.files.is_empty() || tier_selected(&s.tier, &tier)) {
            out.push(s);
        }
    }
    Ok(out)
}

fn engine_target(
    cfg: &QaConfig,
    opts: &SuiteOptions,
    tracker: &Tracker,
    tier: &str,
) -> Result<Option<EngineTarget>> {
    let mut env: Vec<(String, String)> = cfg
        .env
        .iter()
        .chain(cfg.engine.env.iter())
        .map(|(k, v)| (k.clone(), v.clone()))
        .collect();
    env.push(("RIGHTKIT_QA_TIER".into(), tier.into()));
    env.push(("RIGHTKIT_QA_MUTE".into(), "1".into()));
    let binary = if let Some(p) = &opts.engine {
        Some(p.clone())
    } else if let Ok(p) = std::env::var("RIGHTKIT_QA_ENGINE") {
        Some(PathBuf::from(p))
    } else if opts.build_engine {
        if cfg.engine.build.is_empty() {
            return err("--build needs [engine].build in the config");
        }
        let pkg = cfg.engine.package.clone().ok_or_else(|| {
            crate::util::Error("--build needs [engine].package (the cargo target name)".into())
        })?;
        let build_env: Vec<(String, String)> = cfg
            .env
            .iter()
            .map(|(k, v)| (k.clone(), v.clone()))
            .collect();
        Some(build_engine(
            &cfg.app_root,
            &cfg.engine.build,
            &pkg,
            &build_env,
            tracker,
        )?)
    } else {
        cfg.engine_binary()?
    };
    Ok(binary.map(|binary| EngineTarget {
        env,
        data_dir_env: cfg.engine.data_dir_env.clone(),
        data_dir_arg: cfg.engine.data_dir_arg.clone(),
        forbidden_args: cfg.engine.forbidden_args.clone(),
        ..EngineTarget::new(binary)
    }))
}

/// A UI binary the caller named (`SuiteOptions::ui_binary`, `--ui-binary`, `RIGHTKIT_QA_UI_BINARY`).
/// It skips the resolver's checks (name, release directory, QA marker: the caller said which file),
/// but the installed-app refusal stays in force (Orthic-Labs/rightkit#235), so the suite fails before
/// any scenario starts instead of at the first `ui_launch`.
pub fn explicit_ui_binary(path: &Path) -> Result<PathBuf> {
    crate::installed::refuse_installed(path, "UI app binary")?;
    Ok(path.to_path_buf())
}

/// An explicitly named UI binary, launched from the fixed stash like every other source (macOS keys privacy
/// grants to the launch path, so the path must not follow the file the caller happened to name). The
/// control-marker check stays skipped for it, and an app bundle (`.app`) is staged at its fixed path by
/// `control::launch`.
fn stashed_explicit_ui_binary(cfg: &QaConfig, path: &Path) -> Result<PathBuf> {
    let named = explicit_ui_binary(path)?;
    if named.is_dir() || crate::binary::is_stashed(&named, &cfg.app_root) {
        return Ok(named);
    }
    crate::binary::stash_binary(&named, &cfg.app_root, None, false)
}

fn ui_binary(cfg: &QaConfig, opts: &SuiteOptions, tracker: &Tracker) -> Result<Option<PathBuf>> {
    if let Some(p) = &opts.ui_binary {
        return stashed_explicit_ui_binary(cfg, p).map(Some);
    }
    if let Ok(p) = std::env::var("RIGHTKIT_QA_UI_BINARY") {
        return stashed_explicit_ui_binary(cfg, Path::new(&p)).map(Some);
    }
    if opts.build_ui {
        if cfg.ui.build.is_empty() {
            return err("--build-ui needs [ui].build in the config");
        }
        let pkg = cfg.ui.package.clone().ok_or_else(|| {
            crate::util::Error("--build-ui needs [ui].package (the cargo target name)".into())
        })?;
        let env: Vec<(String, String)> = cfg
            .env
            .iter()
            .map(|(k, v)| (k.clone(), v.clone()))
            .collect();
        let built = build_engine(&cfg.app_root, &cfg.ui.build, &pkg, &env, tracker)?;
        // Keep a stable QA-only copy so a later plain dev build cannot displace it.
        let kept =
            crate::binary::stash_qa_build(&built, &cfg.app_root, cfg.ui.pointer_file.as_deref())?;
        return Ok(Some(kept));
    }
    // No override and no build requested: the dev-build resolver (pointer file, broker target root,
    // then `ui.binaries`). A config that names no executable keeps the old "none configured" answer.
    match cfg.resolve_ui_binary() {
        Ok(found) => {
            eprintln!(
                "[qa] ui binary ({:?}): {}",
                found.source,
                found.path.display()
            );
            Ok(Some(found.path))
        }
        // A found-but-not-QA build fails closed with its instructive message.
        Err(err) if err.0.contains("test-mode/control build") => Err(err),
        Err(err) => {
            eprintln!("[qa] dev-build resolver: {err}; falling back to ui.binaries");
            // Same rule as every other source: launch from the fixed stash, not from `target/`.
            match cfg.ui_binary()? {
                Some(p) => stashed_explicit_ui_binary(cfg, &p).map(Some),
                None => Ok(None),
            }
        }
    }
}

pub fn run_suite(cfg: &QaConfig, opts: &SuiteOptions) -> Result<SuiteReport> {
    run_suite_at(cfg, opts, None)
}

/// Test/embedding entry point with an explicit managed root.
pub fn run_suite_in_managed_root(
    cfg: &QaConfig,
    opts: &SuiteOptions,
    managed_root: &Path,
) -> Result<SuiteReport> {
    run_suite_at(cfg, opts, Some(managed_root))
}

fn run_suite_at(
    cfg: &QaConfig,
    opts: &SuiteOptions,
    managed_override: Option<&Path>,
) -> Result<SuiteReport> {
    let platform = platform()?;
    let tier = opts
        .tier
        .clone()
        .unwrap_or_else(|| cfg.default_tier.clone());
    let scenarios = select(cfg, opts)?;
    if scenarios.is_empty() {
        return err(format!(
            "no scenarios matched tier '{tier}'{}",
            opts.only
                .as_ref()
                .map(|o| format!(" --only {o}"))
                .unwrap_or_default()
        ));
    }
    let run_kind = resolve_run_kind(opts.kind, &scenarios);
    let managed_root = managed_override
        .map(Path::to_path_buf)
        .unwrap_or_else(|| crate::storage::managed_root(None));
    let managed_app_root = crate::storage::prepare_app_root(&managed_root, &cfg.app)?;
    let lock_opts = LockOptions {
        timeout: Duration::from_secs(cfg.lock.timeout_s.unwrap_or(120)),
        stale: Duration::from_secs(cfg.lock.stale_s.unwrap_or(60)),
        ..Default::default()
    };
    let mut ownership = lock::acquire(
        &managed_app_root.join("native.lock"),
        &format!("{}:{tier}", cfg.app),
        &lock_opts,
    )?;
    let run_id = crate::util::new_id();
    // Earlier crashed runs: kill survivors by recorded pid + command line, then drop their dirs.
    let swept = sweep_registries(&managed_app_root, &run_id);
    let ws = workspace::create(&managed_root, Some(&run_id), &cfg.app)?;
    if let Err(e) = ws.set_kind(run_kind) {
        ownership.release();
        return Err(e);
    }
    let tracker = Tracker::with_registry(ws.root.join("pids.json"));
    let mut bundle = Bundle::new(&cfg.app, platform, &run_id)?;
    let _mute = cfg.audio.system_mute.then(SystemMute::engage);

    let needs_engine = scenarios
        .iter()
        .any(|s| s.target == "engine" && unmet_requirement(&s.requires, &cfg.app_root).is_none());
    let needs_ui = scenarios.iter().any(|s| s.target == "ui");
    // A `ui` scenario that seeds engine state before launch (`engine_seed`) needs the engine too.
    let needs_engine = needs_engine
        || scenarios.iter().any(|s| {
            s.target == "ui"
                && s.steps.iter().any(|st| st.kind == "engine_seed")
                && unmet_requirement(&s.requires, &cfg.app_root).is_none()
        });
    let engine = engine_target(cfg, opts, &tracker, &tier)?;
    let ui = if needs_ui {
        ui_binary(cfg, opts, &tracker)?
    } else {
        None
    };
    if needs_engine && engine.is_none() {
        ownership.release();
        return err("selected scenarios need the engine but no binary is configured (use --engine, RIGHTKIT_QA_ENGINE, [engine].binary, or --build)");
    }

    let identity = match run_identity(
        cfg,
        &scenarios,
        engine.as_ref().map(|e| e.binary.as_path()),
        ui.as_deref(),
        needs_engine,
        false,
    ) {
        Ok(mut i) => {
            if let Some(o) = i.as_object_mut() {
                o.insert("runKind".into(), json!(run_kind.as_str()));
            }
            i
        }
        Err(e) => {
            ownership.release();
            return Err(e);
        }
    };
    bundle.set_identity(identity)?;
    println!(
        "[qa] app={} platform={platform} tier={tier} kind={run_kind} scenarios={} run={run_id}",
        cfg.app,
        scenarios.len()
    );
    if let Some(e) = &engine {
        println!("[qa] engine={}", e.binary.display());
    }
    if !swept.is_empty() {
        println!("[qa] swept orphan pids from earlier runs: {swept:?}");
    }

    let mut outcomes = vec![];
    for sc in &scenarios {
        let started = Instant::now();
        let name = sc.name.clone();
        let unmet = platform_mismatch(&sc.requires)
            .map(|r| (r, true))
            .or_else(|| unmet_requirement(&sc.requires, &cfg.app_root).map(|r| (r, false)));
        if let Some((reason, other_os)) = unmet {
            if sc.optional || other_os {
                println!(
                    "[qa] SKIP  {name}: {reason} ({})",
                    if sc.optional {
                        "optional"
                    } else {
                        "other platform"
                    }
                );
                bundle.add_check(
                    &name,
                    CheckStatus::Skipped,
                    json!({"reason": reason, "optional": sc.optional, "platform": other_os}),
                    &[],
                )?;
                outcomes.push(Outcome {
                    name,
                    file: sc.file.clone(),
                    tier: sc.tier.clone(),
                    status: CheckStatus::Skipped,
                    reason: Some(reason),
                    ms: 0,
                    steps: vec![],
                });
            } else {
                let reason = format!("mandatory scenario could not run: {reason} (mark it `optional = true` only if skipping is acceptable)");
                println!("[qa] FAIL  {name}: {reason}");
                bundle.add_check(
                    &name,
                    CheckStatus::Failed,
                    json!({"error": reason, "mandatory": true}),
                    &[],
                )?;
                outcomes.push(Outcome {
                    name,
                    file: sc.file.clone(),
                    tier: sc.tier.clone(),
                    status: CheckStatus::Failed,
                    reason: Some(reason),
                    ms: 0,
                    steps: vec![],
                });
            }
            continue;
        }
        if sc.target == "ui" && ui.is_none() {
            let reason =
                "no UI binary for this platform ([ui].binaries / --ui-binary / --build-ui)"
                    .to_string();
            println!("[qa] FAIL  {name}: {reason}");
            bundle.add_check(&name, CheckStatus::Failed, json!({"error": reason}), &[])?;
            outcomes.push(Outcome {
                name,
                file: sc.file.clone(),
                tier: sc.tier.clone(),
                status: CheckStatus::Failed,
                reason: Some(reason),
                ms: 0,
                steps: vec![],
            });
            continue;
        }
        let kind = match scenario_kind(run_kind, sc.kind, &name) {
            Ok(k) => k,
            Err(e) => {
                println!("[qa] FAIL  {name}: {e}");
                bundle.add_check(&name, CheckStatus::Failed, json!({"error": e.0}), &[])?;
                outcomes.push(Outcome {
                    name,
                    file: sc.file.clone(),
                    tier: sc.tier.clone(),
                    status: CheckStatus::Failed,
                    reason: Some(e.0),
                    ms: 0,
                    steps: vec![],
                });
                continue;
            }
        };
        let mut ctx = Ctx::new(cfg, engine.clone(), ui.clone(), &ws, &tracker, &name)?;
        ctx.kind = kind;
        ctx.handlers = opts.hooks.steps.clone();
        ctx.kill_orphans = opts.kill_orphans || sc.kill_orphans;
        let mut steps = vec![];
        let mut failure: Option<String> = None;
        let limit = Duration::from_secs(sc.timeout_s.unwrap_or(600));
        let mut run_steps = true;
        if let Some(setup) = &opts.hooks.setup {
            if let Err(e) = setup(&mut ctx, sc) {
                failure = Some(format!("scenario setup: {}", e.0));
                run_steps = false;
            }
        }
        for (i, step) in sc.steps.iter().enumerate() {
            if !run_steps {
                break;
            }
            let t = Instant::now();
            if started.elapsed() > limit {
                failure = Some(format!(
                    "scenario exceeded its {}s budget before step {}",
                    limit.as_secs(),
                    i + 1
                ));
                break;
            }
            let label = step.label.clone().unwrap_or_else(|| step.kind.clone());
            match run_step(&mut ctx, step) {
                Ok(_) => steps.push(StepRecord {
                    index: i + 1,
                    kind: step.kind.clone(),
                    name: label,
                    ok: true,
                    ms: t.elapsed().as_millis(),
                    error: None,
                }),
                Err(e) => {
                    steps.push(StepRecord {
                        index: i + 1,
                        kind: step.kind.clone(),
                        name: label,
                        ok: false,
                        ms: t.elapsed().as_millis(),
                        error: Some(e.0.clone()),
                    });
                    failure = Some(e.0);
                    break;
                }
            }
        }
        // The failure capture is a screenshot: only a visual scenario takes one.
        if failure.is_some() && ctx.kind == RunKind::Visual {
            if let Some((c, _)) = &ctx.ui {
                let p = ctx.log_dir.join("failure.png");
                if c.screenshot_to(&p).is_ok() {
                    ctx.artifacts.push((format!("{name}/failure.png"), p));
                }
            }
        }
        let mut problems = vec![];
        if let Some(td) = &opts.hooks.teardown {
            if let Err(e) = td(&mut ctx, sc) {
                problems.push(format!("scenario teardown: {}", e.0));
            }
        }
        problems.extend(ctx.teardown());
        if failure.is_none() && !problems.is_empty() {
            failure = Some(problems.join("; "));
        }
        // Hash every artifact the scenario produced, then bind the check to them.
        let mut names = vec![];
        let mut artifact_errors = vec![];
        for (n, path) in &ctx.artifacts {
            if names.contains(n) {
                continue;
            }
            match ws
                .preserve_artifact(path)
                .and_then(|kept| bundle.add_artifact(n, &kept))
            {
                Ok(_) => names.push(n.clone()),
                Err(e) => artifact_errors.push(e.0),
            }
        }
        if !artifact_errors.is_empty() {
            let msg = format!(
                "required evidence could not be recorded: {}",
                artifact_errors.join("; ")
            );
            failure = Some(match failure.take() {
                Some(f) => format!("{f}; {msg}"),
                None => msg,
            });
        }
        let status = if failure.is_none() {
            CheckStatus::Passed
        } else {
            CheckStatus::Failed
        };
        let details = json!({"file": sc.file.to_string_lossy(), "tier": sc.tier, "steps": steps.len(), "error": failure});
        bundle.add_check(&name, status, details, &names)?;
        println!(
            "[qa] {}  {name} ({} ms){}",
            if failure.is_none() { "PASS" } else { "FAIL" },
            started.elapsed().as_millis(),
            failure
                .as_ref()
                .map(|f| format!("\n       {f}"))
                .unwrap_or_default()
        );
        outcomes.push(Outcome {
            name,
            file: sc.file.clone(),
            tier: sc.tier.clone(),
            status,
            reason: failure,
            ms: started.elapsed().as_millis(),
            steps,
        });
    }

    tracker.kill_all();
    let failed = outcomes
        .iter()
        .filter(|o| o.status == CheckStatus::Failed)
        .count();
    let passed = outcomes
        .iter()
        .filter(|o| o.status == CheckStatus::Passed)
        .count();
    // Skips are only ever optional scenarios; a run whose scenarios were all skipped proves nothing.
    bundle.finish(if failed == 0 && passed > 0 {
        RunStatus::Passed
    } else {
        RunStatus::Failed
    });
    let evidence_path = ws.evidence_dir.join("evidence.json");
    let results_path = ws.evidence_dir.join("results.json");
    std::fs::write(
        &results_path,
        serde_json::to_vec_pretty(&json!({
            "app": cfg.app, "platform": platform, "runId": run_id, "tier": tier, "kind": run_kind.as_str(), "finishedAt": now_iso(),
            "passed": passed, "failed": failed, "skipped": outcomes.len() - passed - failed,
            "scenarios": outcomes.iter().map(Outcome::to_value).collect::<Vec<_>>(),
        }))?,
    )?;
    bundle.write(&evidence_path)?;
    let _ = std::fs::write(
        ws.root.parent().unwrap_or(&ws.root).join("latest.json"),
        serde_json::to_vec_pretty(
            &json!({"runId": run_id, "evidence": evidence_path.to_string_lossy(), "results": results_path.to_string_lossy()}),
        )?,
    );
    // Record pass or fail in the run marker before it is completed: retention reads only this.
    let _ = ws.set_outcome(if failed == 0 && passed > 0 {
        RunOutcome::Passed
    } else {
        RunOutcome::Failed
    });
    ws.finish()?;
    if !opts.keep_data && failed > 0 && storage::keep_failed_home_requested() {
        println!(
            "[qa] kept QA home of the failed run: {}",
            storage::describe_kept_home(&ws.home)
        );
    } else if !opts.keep_data {
        let report = workspace::dispose(&ws, true, 5, 200);
        for (p, why) in report.retained {
            println!("[qa] WARN could not remove {}: {why}", p.display());
        }
    }
    println!(
        "[qa] {passed} passed, {failed} failed, {} skipped; evidence {}",
        outcomes.len() - passed - failed,
        evidence_path.display()
    );
    ownership.release();
    // Retention right after the job: failed runs and the newest pass per kind stay, the rest of
    // the passing runs of this app go. It never fails the job.
    let pruned = crate::retention::prune_runs_after_job(&managed_root, &cfg.app);
    println!("[qa] run retention: {}", pruned.summary());
    for (path, why) in pruned
        .kept
        .iter()
        .filter(|(_, why)| why.starts_with("not removed"))
    {
        println!("[qa] WARN {}: {why}", path.display());
    }
    Ok(SuiteReport {
        exit_code: if failed == 0 && passed > 0 { 0 } else { 1 },
        run_id,
        run_dir: ws.root.clone(),
        evidence_path,
        results_path,
        outcomes,
    })
}

fn file_sha(path: &std::path::Path) -> Result<String> {
    let bytes = std::fs::read(path).map_err(|e| {
        crate::util::Error(format!(
            "cannot hash {} for the evidence identity: {e}",
            path.display()
        ))
    })?;
    Ok(crate::util::sha256_hex(&bytes))
}

fn git_revision(root: &std::path::Path) -> Value {
    let git = |args: &[&str]| {
        let mut git = std::process::Command::new("git");
        git.arg("-C").arg(root).args(args);
        #[cfg(windows)]
        {
            use std::os::windows::process::CommandExt;
            git.creation_flags(0x0800_0000); // CREATE_NO_WINDOW: never flash a console from a GUI host
        }
        crate::process::output_bounded(&mut git, Duration::from_secs(30))
            .ok()
            .flatten()
            .filter(|o| o.status.success())
            .map(|o| String::from_utf8_lossy(&o.stdout).trim().to_string())
    };
    match git(&["rev-parse", "HEAD"]) {
        Some(head) => {
            json!({"head": head, "dirty": git(&["status", "--porcelain"]).map(|s| !s.is_empty())})
        }
        None => Value::Null,
    }
}

/// What this run exercises: config, scenario files, engine/UI binaries and the source revision,
/// all by digest, so a receipt cannot be reused for different bytes.
fn run_identity(
    cfg: &QaConfig,
    scenarios: &[Scenario],
    engine: Option<&std::path::Path>,
    ui: Option<&std::path::Path>,
    needs_engine: bool,
    needs_ui: bool,
) -> Result<Value> {
    let mut scenario_ids = vec![];
    for sc in scenarios {
        scenario_ids.push(json!({"name": sc.name, "file": sc.file.to_string_lossy(), "sha256": file_sha(&sc.file)?}));
    }
    let binary = |p: Option<&std::path::Path>, what: &str, needed: bool| -> Result<Value> {
        match p {
            Some(p) => {
                let target = if p.is_dir() { None } else { Some(p) };
                match target {
                    Some(t) => Ok(json!({"path": t.to_string_lossy(), "sha256": file_sha(t)?})),
                    None => {
                        // A `.app` bundle: bind to every executable inside Contents/MacOS.
                        let mut exes = vec![];
                        if let Ok(rd) = std::fs::read_dir(p.join("Contents").join("MacOS")) {
                            for e in rd.flatten() {
                                exes.push(json!({"path": e.path().to_string_lossy(), "sha256": file_sha(&e.path())?}));
                            }
                        }
                        if exes.is_empty() {
                            return err(format!(
                                "{} has no executable to bind into the evidence identity",
                                p.display()
                            ));
                        }
                        Ok(json!({"path": p.to_string_lossy(), "executables": exes}))
                    }
                }
            }
            None if needed => err(format!(
                "evidence identity needs the {what} binary but none resolved"
            )),
            None => Ok(Value::Null),
        }
    };
    Ok(json!({
        "config": {"path": cfg.config_path.to_string_lossy(), "sha256": file_sha(&cfg.config_path)?},
        "scenarios": scenario_ids,
        "engine": binary(engine, "engine", needs_engine)?,
        "ui": binary(ui, "UI", needs_ui)?,
        "source": git_revision(&cfg.app_root),
    }))
}

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

    #[test]
    fn only_matches_substring_exact_stem_and_comma_lists() {
        let f = Path::new("/x/scenarios/login-flow.scenario.toml");
        assert!(only_matches("login-flow", "Some Name", f));
        assert!(only_matches("login", "Some Name", f));
        assert!(only_matches("Some", "Some Name", f));
        assert!(only_matches("nope, login-flow", "Some Name", f));
        assert!(only_matches("nope,Some Name", "Some Name", f));
        assert!(!only_matches("nope,other", "Some Name", f));
        assert!(!only_matches(" , ", "Some Name", f));
        // Stem equality, even when the stem is not a substring of anything else matched.
        let g = Path::new("/x/a/b.scenario.toml");
        assert!(only_matches("b", "zzz", g));
    }

    #[test]
    fn an_explicit_ui_binary_skips_the_resolver_checks() {
        // Not named after the app, not a file, not a QA build: the caller named it, so it stands.
        let p = std::env::temp_dir()
            .join("rkqa-explicit")
            .join("release")
            .join("anything.bin");
        assert_eq!(explicit_ui_binary(&p).unwrap(), p);
        assert!(
            crate::binary::validate(&p, "app").is_err(),
            "the resolver path would have refused it"
        );
    }

    #[cfg(any(target_os = "macos", windows))]
    #[test]
    fn an_explicit_ui_binary_in_an_installed_location_is_still_refused() {
        if crate::installed::installed_mode() {
            return;
        }
        #[cfg(target_os = "macos")]
        let p = PathBuf::from("/Applications/CutRight.app/Contents/MacOS/CutRight");
        #[cfg(windows)]
        let Some(p) = std::env::var_os("ProgramFiles")
            .map(|d| PathBuf::from(d).join("CutRight").join("cutright.exe"))
        else {
            return;
        };
        let e = explicit_ui_binary(&p).unwrap_err();
        assert!(e.0.contains("RIGHT_RELEASE_QA_STAGE=installed"), "{e}");
    }
}