saccade 0.2.9

Visual-regression CLI for renderers and graphics code, built on NVIDIA FLIP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260

//! `saccade manifest`: find, link and re-check the outputs of a report directory.
use crate::agent::CliError;
use crate::local_cmd::{base_result, reference};
use saccade_core::manifest::{self, Anchors};
use serde_json::json;
use std::path::PathBuf;

#[derive(clap::Args)]
pub(crate) struct Args {
    #[command(subcommand)]
    operation: Operation,
}

#[derive(clap::Subcommand)]
enum Operation {
    /// Write saccade-manifest.json for a report directory: artifacts by hash, reports by
    /// report_id, duplicates listed once. Passing is never recorded as approval.
    Build {
        /// The output directory to describe.
        dir: PathBuf,
        /// Record a baseline a human approved (separate from last-good).
        #[arg(long)]
        approved_anchor: Option<PathBuf>,
        /// Record the last passing run (a different role; not approval).
        #[arg(long)]
        last_good: Option<PathBuf>,
        /// Explicit cases and axes (saccade-cases.v1); creates manifest v2.
        #[arg(long)]
        cases: Option<PathBuf>,
        /// Print a JSON result.
        #[arg(long)]
        json: bool,
    },
    /// Group declared variants, show missing cases and reference health in JSON and HTML.
    Views {
        /// A saccade-manifest.v2 file, or its report directory.
        target: PathBuf,
        /// Output directory for coverage.json and index.html.
        #[arg(long)]
        out: PathBuf,
        /// Declared axes to group by (default: all axes).
        #[arg(long, value_delimiter = ',')]
        group_by: Vec<String>,
        /// Observation time for reproducible health findings (default: current time).
        #[arg(long)]
        now_unix: Option<u64>,
        /// Age limit for recorded runs and known approval times.
        #[arg(long, default_value_t = 2_592_000)]
        max_age_seconds: u64,
        /// Print a bounded JSON result; full rows stay in coverage.json.
        #[arg(long)]
        json: bool,
    },
    /// Re-hash everything a manifest or link names; fails with `link_missing` or
    /// `stale_link` when a recorded file moved or changed.
    Verify {
        /// A report directory, a saccade-manifest.json or a saccade-link.json.
        target: PathBuf,
        /// Print a JSON result.
        #[arg(long)]
        json: bool,
    },
    /// Write a stable link to one report of a directory, by report_id.
    Link {
        /// A report directory that has a manifest.
        dir: PathBuf,
        /// The report_id to link (see `reports` in the manifest).
        #[arg(long)]
        report_id: String,
        /// Where to write the link document.
        #[arg(long)]
        out: PathBuf,
        /// Print a JSON result.
        #[arg(long)]
        json: bool,
    },
    /// Say whether a path is a report directory, a JSON document or an API response.
    Classify {
        /// Path to inspect.
        path: PathBuf,
        /// Print JSON (the default output is already one line of JSON).
        #[arg(long)]
        json: bool,
    },
}

pub(crate) fn run(args: Args) -> Result<u8, CliError> {
    match args.operation {
        Operation::Build {
            dir,
            approved_anchor,
            last_good,
            cases,
            json,
        } => {
            if crate::signed_approval::required()
                && let Some(anchor) = &approved_anchor
            {
                crate::signed_approval::check_anchor(anchor, None)?;
            }
            let anchors = Anchors {
                approved: approved_anchor.as_deref(),
                last_good: last_good.as_deref(),
            };
            let (path, value) = if let Some(cases) = cases {
                let declaration = saccade_core::coverage::read_declaration(&cases)?;
                if crate::signed_approval::required() {
                    crate::signed_approval::check_case_anchors(
                        &dir.join(manifest::MANIFEST_FILE),
                        &serde_json::to_value(&declaration.cases)?,
                    )?;
                }
                saccade_core::coverage::write_manifest(&dir, anchors, &declaration)?
            } else {
                manifest::write(&dir, anchors)?
            };
            let mut result = base_result("manifest.build");
            result["artifact"] = reference(&path)?;
            result["counts"] = value["counts"].clone();
            result["data"] = json!({"approval":value["approval"]["state"]});
            if json {
                crate::emit(&format!("{}\n", serde_json::to_string(&result)?))?;
            } else {
                crate::emit(&format!(
                    "wrote {} ({} artifacts, {} reports, {} duplicate files; approval: {})\n",
                    crate::escape_control(&path.display().to_string()),
                    value["counts"]["unique_artifacts"],
                    value["counts"]["reports"],
                    value["counts"]["duplicate_files"],
                    value["approval"]["state"].as_str().unwrap_or("none"),
                ))?;
            }
            Ok(0)
        }
        Operation::Views {
            target,
            out,
            group_by,
            now_unix,
            max_age_seconds,
            json,
        } => {
            let path = if target.is_dir() {
                target.join(manifest::MANIFEST_FILE)
            } else {
                target
            };
            let now = match now_unix {
                Some(now) => now,
                None => std::time::SystemTime::now()
                    .duration_since(std::time::UNIX_EPOCH)
                    .map_err(|e| CliError::new("config", e.to_string()))?
                    .as_secs(),
            };
            if crate::signed_approval::required() {
                crate::signed_approval::check_manifest(&path)?;
            }
            let report = saccade_core::coverage::analyze(&path, &group_by, now, max_age_seconds)?;
            saccade_core::run::guard_output_dir(&out, &[&path], &["coverage.json"])?;
            std::fs::create_dir_all(&out).map_err(|e| CliError::io(e.to_string()))?;
            let artifact = out.join("coverage.json");
            let linked = saccade_core::report_links::decorate(&serde_json::to_value(&report)?)?;
            manifest::write_owned(&artifact, saccade_core::coverage::REPORT_SCHEMA, &linked)?;
            saccade_core::report_links::index(&artifact, &linked)?;
            saccade_core::render::render_coverage_html(&report, &path, &out)?;
            let mut result = base_result("manifest.views");
            result["verdict"] = report.coverage.clone().into();
            result["artifact"] = reference(&artifact)?;
            result["counts"] = json!({"expected":report.counts.expected,"captured":report.counts.captured,"measured":report.counts.measured,"refused":report.counts.refused});
            result["data"] = json!({"outcomes":report.counts.outcomes,"health_cases":report.rows.iter().filter(|r| !r.health.is_empty()).count(), "groups":report.groups.len(), "html":saccade_core::paths::portable(&out.join("index.html"))});
            if json {
                crate::emit(&format!("{}\n", serde_json::to_string(&result)?))?;
            } else {
                crate::emit(&format!(
                    "coverage: {}; {} expected, {} captured, {} measured, {} refused; {} health cases; {}\n",
                    report.coverage,
                    report.counts.expected,
                    report.counts.captured,
                    report.counts.measured,
                    report.counts.refused,
                    result["data"]["health_cases"],
                    crate::escape_control(&out.join("index.html").display().to_string())
                ))?;
            }
            Ok(u8::from(report.coverage != "complete"))
        }
        Operation::Verify { target, json } => {
            if crate::signed_approval::required() {
                crate::signed_approval::check_manifest(&target)?;
            }
            let findings = manifest::verify(&target)?;
            if !findings.is_empty() {
                let code = if findings
                    .iter()
                    .any(|f| f["code"] == manifest::CODE_STALE_LINK)
                {
                    "stale_link"
                } else {
                    "link_missing"
                };
                let listed = findings
                    .iter()
                    .take(5)
                    .filter_map(|f| f["message"].as_str())
                    .collect::<Vec<_>>()
                    .join("; ");
                let mut error = CliError::new(
                    code,
                    format!("{} link failure(s): {listed}", findings.len()),
                );
                error.hint = "rebuild the manifest with `saccade manifest build` and re-link, or restore the recorded file".into();
                return Err(error);
            }
            let mut result = base_result("manifest.verify");
            result["data"] = json!({"verified":true});
            if json {
                crate::emit(&format!("{}\n", serde_json::to_string(&result)?))?;
            } else {
                crate::emit(
                    "verified: every recorded artifact is present with its recorded bytes\n",
                )?;
            }
            Ok(0)
        }
        Operation::Link {
            dir,
            report_id,
            out,
            json,
        } => {
            if crate::signed_approval::required() {
                crate::signed_approval::check_manifest(&dir)?;
            }
            manifest::link(&dir, &report_id, &out)?;
            let mut result = base_result("manifest.link");
            result["artifact"] = reference(&out)?;
            if json {
                crate::emit(&format!("{}\n", serde_json::to_string(&result)?))?;
            } else {
                crate::emit(&format!(
                    "wrote {}\n",
                    crate::escape_control(&out.display().to_string())
                ))?;
            }
            Ok(0)
        }
        Operation::Classify { path, json: _ } => {
            let value = manifest::classify(&path)?;
            if crate::signed_approval::required()
                && (value["manifest"] == true
                    || value["kind"] == "manifest"
                    || value["kind"] == "link")
            {
                crate::signed_approval::check_manifest(&path)?;
            }
            crate::emit(&format!("{}\n", serde_json::to_string(&value)?))?;
            Ok(0)
        }
    }
}