//! The kernel regression rig: replay `tests/kernel-cases///recipe.json` (an oracle //! recipe or a command script) and grade the result against the case's own `expected.json`: //! closed-form numbers where the case has them, and always the invariants (the operation's //! outcome, one closed valid solid per body, the expected counts). One kernel per run; kernels //! are never compared with each other. See tests/kernel-cases/README.md. use serde_json::{Value, json}; use crate::oracle::{ABS_FRAC, Checks, REL_TOL, totals, v3}; use crate::{read_json, recipe}; /// The kernel the cases run on: SMLib, the only one. fn kernel() -> String { "smlib".into() } /// How many cases a chain of `base` recipes may go through (a ladder case builds on the one /// before it, which builds on the one before that). const MAX_BASE_DEPTH: usize = 32; /// The case's commands: a script as is, or an oracle recipe translated. In a string, `$CASE` is /// the case directory (input files such as `input.step`) and `$OUT` a scratch directory for files /// the case writes (an export), outside the repository. A script with `"base": ""` (relative to this case's directory) runs that case's commands first: a ladder /// case starts from the previous tier's finished part without copying its commands. fn script(dir: &str, out: &str, recipe: &Value) -> Result { script_at(dir, out, recipe, 0) } fn script_at(dir: &str, out: &str, recipe: &Value, depth: usize) -> Result { let s = if recipe.get("commands").is_some() || recipe.is_array() { recipe.clone() } else { recipe::to_script(recipe)? }; let text = serde_json::to_string(&s).map_err(|e| e.to_string())?; let inner = |p: &str| -> Result { let j = serde_json::to_string(p).map_err(|e| e.to_string())?; Ok(j.get(1..j.len().saturating_sub(1)).unwrap_or("").to_string()) }; let own: Value = serde_json::from_str(&text.replace("$CASE", &inner(dir)?).replace("$OUT", &inner(out)?)).map_err(|e| e.to_string())?; let Some(base) = recipe.get("base").and_then(Value::as_str) else { return Ok(own) }; if depth >= MAX_BASE_DEPTH { return Err(format!("`base` chain deeper than {MAX_BASE_DEPTH} cases")); } let base_dir = std::path::Path::new(dir).join(base).to_string_lossy().to_string(); let base_script = read_json(&format!("{base_dir}/recipe.json")) .and_then(|r| script_at(&base_dir, out, &r, depth + 1)) .map_err(|e| format!("base {base}: {e}"))?; let list = |v: &Value| v.get("commands").or(Some(v)).and_then(Value::as_array).cloned().unwrap_or_default(); let mut commands = list(&base_script); commands.extend(list(&own)); Ok(json!({"commands": commands})) } /// A scratch directory for one case's output files. fn scratch(area: &str, name: &str) -> Result { let d = std::env::temp_dir().join(format!("solidcraft-kernel-cases-{}", std::process::id())).join(format!("{area}-{name}")); std::fs::create_dir_all(&d).map_err(|e| format!("{}: {e}", d.display()))?; Ok(d.to_string_lossy().to_string()) } /// Chord tolerance of the mesh a `watertight` case is checked on (mm). const MESH_TOL: f64 = 0.01; /// A mesh's edges used by one triangle only (open) and by more than two (over-shared). Vertices /// closer than `weld` (mm) are one vertex: a mesh repeats a vertex for each face, and faces /// meeting at an edge may place it a rounding error apart. fn open_edges(positions: &[solidcraft_engine::geom::Vec3], triangles: &[[u32; 3]], weld: f64) -> (usize, usize) { use std::collections::HashMap; let weld = if weld.is_finite() && weld > 0.0 { weld } else { 1e-4 }; let cell = |p: &solidcraft_engine::geom::Vec3| [p.x, p.y, p.z].map(|x| (x / weld).floor() as i64); // Union-find over positions, joining each vertex with any within `weld` in the 27 cells round it. let mut parent: Vec = (0..positions.len()).collect(); fn find(parent: &mut [usize], mut i: usize) -> usize { while let Some(&p) = parent.get(i) { if p == i { break; } let gp = parent.get(p).copied().unwrap_or(p); if let Some(slot) = parent.get_mut(i) { *slot = gp; } i = p; } i } let mut grid: HashMap<[i64; 3], Vec> = HashMap::new(); for (i, p) in positions.iter().enumerate() { let c = cell(p); for dx in -1..=1 { for dy in -1..=1 { for dz in -1..=1 { let Some(near) = grid.get(&[c[0] + dx, c[1] + dy, c[2] + dz]) else { continue }; for &j in near { if positions.get(j).is_some_and(|q| q.dist(*p) <= weld) { let (a, b) = (find(&mut parent, i), find(&mut parent, j)); if let Some(slot) = parent.get_mut(a) { *slot = b; } } } } } } grid.entry(c).or_default().push(i); } let mut uses: HashMap<(usize, usize), usize> = HashMap::new(); for t in triangles { for (a, b) in [(t[0], t[1]), (t[1], t[2]), (t[2], t[0])] { let (a, b) = (find(&mut parent, a as usize), find(&mut parent, b as usize)); if a != b { *uses.entry((a.min(b), a.max(b))).or_default() += 1; } } } (uses.values().filter(|&&n| n == 1).count(), uses.values().filter(|&&n| n > 2).count()) } /// An error that means "this kernel can't do it yet", not a wrong answer. fn unsupported(e: &str) -> bool { e.contains("not supported yet") } /// A panic caught by the engine or the kernel guard. fn crashed(e: &str) -> bool { e.contains("internal error") || e.contains("panicked") } fn case_name(dir: &str) -> (String, String) { let p = std::path::Path::new(dir); let name = |q: Option<&std::path::Path>| q.and_then(|q| q.file_name()).map(|x| x.to_string_lossy().to_string()).unwrap_or_default(); (name(p.parent()), name(Some(p))) } fn check_case(dir: &str, dumps: Option<&std::path::Path>) -> Value { let (area, name) = case_name(dir); let mut out = json!({"case": name, "area": area, "kernel": kernel()}); let want = match read_json(&format!("{dir}/expected.json")) { Ok(w) => w, Err(e) => { out["status"] = json!("fail"); out["error"] = json!(format!("expected.json: {e}")); return out; } }; out["sources"] = want["sources"].clone(); // A capability SolidCraft doesn't have yet (no command or parameter for it): recorded as a // case so the gap is visible, never run against a stand-in. if let Some(missing) = want["missing"].as_str() { out["status"] = json!("unsupported"); out["error"] = json!(missing); return out; } let commands = match scratch(&area, &name).and_then(|o| read_json(&format!("{dir}/recipe.json")).and_then(|r| script(dir, &o, &r))) { Ok(s) => s, Err(e) => { out["status"] = json!("fail"); out["error"] = json!(format!("recipe.json: {e}")); return out; } }; if !solidcraft_engine::kernel::smlib_built() { out["status"] = json!("unsupported"); out["error"] = json!("this build has no SMLib: build solidcraft-cli with --features smlib"); return out; } // `refused`: only a clean refusal is right; `solid_or_refused`: a clean refusal, or a result // graded as usual (where the geometry has no manifold answer, such as bodies touching along a // curve only). let outcome = want["outcome"].as_str().unwrap_or("solid"); let refused = outcome == "refused"; let may_refuse = refused || outcome == "solid_or_refused"; // The SMLib calls that fail in this case leave their inputs in its own folder. if let Some(root) = dumps { let folder = root.join(format!("{area}-{name}")); if let Err(e) = std::fs::create_dir_all(&folder) .map_err(|e| e.to_string()) .and_then(|()| solidcraft_engine::kernel::smlib_dump_dir(Some(&folder)).map_err(|e| e.to_string())) { out["status"] = json!("fail"); out["error"] = json!(format!("--dumps: {}: {e}", folder.display())); return out; } } let mut s = solidcraft_engine::Session::default(); let clock = std::time::Instant::now(); let ran = s.run_script(&commands); // The commands' own time, without process start or grading: the ladder's timing golden. out["seconds"] = json!(clock.elapsed().as_secs_f64()); match (ran, may_refuse) { (Err(e), _) if crashed(&e.to_string()) => { out["status"] = json!("crash"); out["error"] = json!(e.to_string()); return out; } (Err(e), true) => { // The right answer is a clean refusal. out["status"] = json!("pass"); out["refused_with"] = json!(e.to_string()); return out; } (Err(e), false) => { let e = e.to_string(); out["status"] = json!(if unsupported(&e) { "unsupported" } else { "fail" }); out["error"] = json!(e); return out; } (Ok(_), true) if refused => { out["status"] = json!("fail"); out["error"] = json!("succeeded where the case expects a refusal"); return out; } (Ok(_), _) => {} } // Every body in the world, imported components included. let world = s.world_state(); let mut bodies = Vec::new(); let mut c = Checks { list: Vec::new(), pass: true }; let want_valid = want["valid"].as_bool().unwrap_or(true); // Shells: the total where the case gives it (a body with a void, or several lumps in one // body), else one per body. let want_shells = want["shells"].as_u64(); let mut shells = 0u64; for b in &world.bodies { let m = match solidcraft_engine::kernel::measure(&b.body) { Ok(m) => m, Err(e) => { c.push("measure", json!(format!("{}: {e}", b.name)), json!("measurable"), false); continue; } }; bodies.push(json!({ "volume_mm3": m.volume, "area_mm2": m.area, "center_of_mass": m.centroid, "bbox": {"min": m.bbox.min, "max": m.bbox.max}, "faces": m.merged.faces, "edges": m.merged.edges, "vertices": m.merged.vertices, })); shells += m.shells as u64; if want["watertight"].as_bool() == Some(true) { let tol = want["tolerance"]["mesh_mm"].as_f64().unwrap_or(MESH_TOL); let (open, over) = match b.body.mesh(&solidcraft_engine::kernel::MeshTolerance::chord(tol)) { Ok(mesh) => open_edges(&mesh.positions, &mesh.triangles, want["tolerance"]["weld_mm"].as_f64().unwrap_or(1e-4)), Err(e) => { c.push("watertight", json!(format!("{}: {e}", b.name)), json!("no open edges"), false); continue; } }; c.push( "watertight", json!(format!("{}: {open} open, {over} over-shared mesh edges", b.name)), json!("no open edges"), open == 0 && over == 0, ); } if want_valid { // Closed shells, and every validity check this build has. if want_shells.is_none() { c.push("shells", json!(format!("{}: {}", b.name, m.shells)), json!(1), m.shells == 1); } let v = solidcraft_engine::kernel::validity(&b.body); c.push("record_valid", json!(v.record.clone().err().unwrap_or_else(|| "ok".into())), json!("ok"), v.record.is_ok()); match &v.smlib { Some(solidcraft_engine::kernel::SmlibCheck::Valid) => c.push("smlib_check", json!("ok"), json!("ok"), true), Some(solidcraft_engine::kernel::SmlibCheck::Invalid(e)) => c.push("smlib_check", json!(e), json!("ok"), false), // No verdict: the record can't be built in SMLib yet. Shown, not graded. Some(solidcraft_engine::kernel::SmlibCheck::NotSupported(e)) => { c.push("smlib_check", json!(format!("no verdict: {e}")), json!("ok"), true) } None => {} } } } let got = totals(&json!({"bodies": bodies})); let (edges, vertices): (u64, u64) = bodies.iter().fold((0, 0), |(e, v), b| (e + b["edges"].as_u64().unwrap_or(0), v + b["vertices"].as_u64().unwrap_or(0))); // What the kernel made, graded or not: the ladder's golden records it per kernel. out["measured"] = json!({ "body_count": got.body_count, "faces": got.faces, "edges": edges, "vertices": vertices, "volume_mm3": got.volume, "area_mm2": got.area, }); let has = |k: &str| want.get(k).is_some_and(|v| !v.is_null()); let rel = want["tolerance"]["rel"].as_f64().unwrap_or(REL_TOL); let diag = |b: ([f64; 3], [f64; 3])| ((b.1[0] - b.0[0]).powi(2) + (b.1[1] - b.0[1]).powi(2) + (b.1[2] - b.0[2]).powi(2)).sqrt(); let want_bbox = v3(&want["bbox"]["min"]).zip(v3(&want["bbox"]["max"])); let abs = want["tolerance"]["abs_mm"].as_f64().unwrap_or_else(|| ABS_FRAC * want_bbox.map(diag).unwrap_or_else(|| diag(got.bbox)).max(1.0)); // A count is exact, or an inclusive range `[min, max]` where the geometry only bounds it. let count = |c: &mut Checks, k: &str, g: u64| { if has(k) { let ok = match want[k].as_array() { Some(r) => r.first().and_then(Value::as_u64).is_some_and(|lo| g >= lo) && r.get(1).and_then(Value::as_u64).is_some_and(|hi| g <= hi), None => want[k].as_u64() == Some(g), }; c.push(k, json!(g), want[k].clone(), ok); } }; count(&mut c, "body_count", got.body_count as u64); count(&mut c, "shells", shells); count(&mut c, "faces", got.faces); count(&mut c, "edges", edges); count(&mut c, "vertices", vertices); if has("volume_mm3") { c.rel("volume_mm3", got.volume, want["volume_mm3"].as_f64(), rel); } if has("area_mm2") { c.rel("area_mm2", got.area, want["area_mm2"].as_f64(), rel); } if has("center_of_mass") { c.vec("center_of_mass", got.com, v3(&want["center_of_mass"]), abs); } if has("bbox") { c.vec("bbox.min", got.bbox.0, want_bbox.map(|b| b.0), abs); c.vec("bbox.max", got.bbox.1, want_bbox.map(|b| b.1), abs); } out["status"] = json!(if c.pass { "pass" } else { "fail" }); out["checks"] = json!(c.list); out } fn report(args: &[String], results: &[Value]) { if args.iter().any(|a| a == "--json") { println!("{}", serde_json::to_string_pretty(&Value::Array(results.to_vec())).unwrap_or_default()); return; } for r in results { let detail: Vec = r["checks"] .as_array() .into_iter() .flatten() .filter(|c| !c["ok"].as_bool().unwrap_or(false)) .map(|c| format!("{} got {} want {}", c["check"].as_str().unwrap_or(""), c["got"], c["want"])) .collect(); let err = r["error"].as_str().map(|e| format!(" ({e})")).unwrap_or_default(); println!( "{} {}/{} [{}]{err}{}", r["status"].as_str().unwrap_or("?").to_uppercase(), r["area"].as_str().unwrap_or(""), r["case"].as_str().unwrap_or(""), r["kernel"].as_str().unwrap_or(""), if detail.is_empty() { String::new() } else { format!(": {}", detail.join("; ")) } ); } } pub fn run(args: &[String]) -> Result<(), String> { let dirs: Vec<&String> = args.iter().filter(|a| !a.starts_with("--")).collect(); if dirs.is_empty() { return Err("kernel-cases: give one or more case directories (each with recipe.json and expected.json)".into()); } // `--dumps=DIR`: each case's failing SMLib calls leave their inputs in DIR/-. let dumps = args.iter().find_map(|a| a.strip_prefix("--dumps=")).map(std::path::PathBuf::from); if dumps.as_ref().is_some_and(|d| d.as_os_str().is_empty()) { return Err("kernel-cases: --dumps= needs a folder".into()); } let results: Vec = dirs.iter().map(|d| check_case(d, dumps.as_deref())).collect(); if dumps.is_some() { solidcraft_engine::kernel::smlib_dump_dir(None).map_err(|e| format!("kernel-cases: --dumps: {e}"))?; } report(args, &results); let bad = results.iter().filter(|r| matches!(r["status"].as_str(), Some("fail" | "crash"))).count(); if bad > 0 { Err(format!("{bad} kernel case(s) failed")) } else { Ok(()) } } #[cfg(test)] mod tests { use super::*; fn case_dir(root: &std::path::Path, name: &str, recipe: &Value) -> String { let d = root.join(name); std::fs::create_dir_all(&d).unwrap(); std::fs::write(d.join("recipe.json"), recipe.to_string()).unwrap(); d.to_string_lossy().to_string() } #[test] fn base_commands_run_first_through_the_chain() { let root = std::env::temp_dir().join(format!("kernel-cases-base-{}", std::process::id())); let _ = std::fs::remove_dir_all(&root); case_dir(&root, "a", &json!({"commands": [{"command": "a", "params": {"file": "$OUT/a.step"}}]})); case_dir(&root, "b", &json!({"base": "../a", "commands": [{"command": "b"}]})); let c = case_dir(&root, "c", &json!({"base": "../b", "commands": [{"command": "c", "params": {"file": "$CASE/x"}}]})); let r = read_json(&format!("{c}/recipe.json")).unwrap(); let s = script(&c, "/scratch", &r).unwrap(); let ids: Vec<&str> = s["commands"].as_array().unwrap().iter().map(|c| c["command"].as_str().unwrap()).collect(); assert_eq!(ids, ["a", "b", "c"]); assert_eq!(s["commands"][2]["params"]["file"], json!(format!("{c}/x"))); // `$OUT` is the running case's scratch directory, in its bases too. assert_eq!(s["commands"][0]["params"]["file"], json!("/scratch/a.step")); let _ = std::fs::remove_dir_all(&root); } #[test] fn a_base_cycle_is_an_error_not_a_hang() { let root = std::env::temp_dir().join(format!("kernel-cases-cycle-{}", std::process::id())); let _ = std::fs::remove_dir_all(&root); let a = case_dir(&root, "a", &json!({"base": "../a", "commands": []})); let r = read_json(&format!("{a}/recipe.json")).unwrap(); assert!(script(&a, "/scratch", &r).unwrap_err().contains("deeper than")); let _ = std::fs::remove_dir_all(&root); } }