Files
faunosteo/crates/core/tests/curation_review.rs
T

361 lines
13 KiB
Rust

//! The Rust review files against the TypeScript (R5.4): CHANGELOG.md and REVIEW-REPORT.md of the
//! committed draft byte for byte, their raw texts against the ledger's pre-Prettier digests, the
//! four review drawings byte for byte or, for the application's main drawing, as trees under
//! the declared R3 rule; the synthetic cases of `oracles/r5/review-synthetic.json`; two runs
//! byte-equal; an undeclared difference refused.
#![allow(clippy::disallowed_methods, clippy::unwrap_used, clippy::expect_used)]
mod common;
use faunosteo_core::curation::PipelineError;
use faunosteo_core::curation::draft::app_review::render_app_review_drawing;
use faunosteo_core::curation::draft::changelog::render_changelog;
use faunosteo_core::curation::draft::drawing::read_cleaned_drawing;
use faunosteo_core::curation::draft::migration_map::{
MigrationMapInput, SheetRef, build_report_migration_map,
};
use faunosteo_core::curation::draft::overlay::{OverlayInput, render_review_overlay};
use faunosteo_core::curation::draft::review_report::{ReviewReportInput, render_review_report};
use faunosteo_core::curation::draft::stats::document_stats;
use faunosteo_core::curation::draft::svg_compare::{Match, TriggerNames, compare_drawing};
use faunosteo_core::curation::draft::{
DraftInput, DraftResult, apply_changeset, build_equine_draft, parse_changeset,
parse_references, parse_view_box, render_draft_artifacts,
};
use faunosteo_core::curation::ids::sha256_hex;
use faunosteo_core::curation::legacy::types::Anomaly;
use faunosteo_core::curation::legacy::{
EquineLegacyInput, HEAD_VIEW_ID, ImportResult, SvgSource, import_equine_legacy,
};
use faunosteo_core::curation::markdown::format_markdown;
use faunosteo_core::curation::prettier_json::format_json;
use faunosteo_core::domain::sheet::AnatomicalSheetDocument;
use faunosteo_core::json::to_js_compact;
use serde_json::{Map, Value};
const SOURCES: &str = "supabase/seed/anatomical-sheets/equine/legacy-sources";
const CURATION: &str = "supabase/seed/anatomical-sheets/equine/curation";
const DRAFT: &str = "supabase/seed/anatomical-sheets/equine/draft";
fn bytes(relative: &str) -> Vec<u8> {
std::fs::read(common::repo_path(relative)).unwrap()
}
fn equine() -> (ImportResult, DraftResult) {
let svg = |name: &str| SvgSource {
file_name: name.to_owned(),
bytes: bytes(&format!("{SOURCES}/{name}")),
};
let result = import_equine_legacy(&EquineLegacyInput {
main_svg: svg("Horse.svg"),
head_svg: svg("Horse_head.svg"),
catalog: bytes(&format!("{SOURCES}/pathologies.json")),
vertebrae: bytes(&format!("{SOURCES}/vertebrae.ts")),
})
.unwrap();
let references =
parse_references(&common::repo_file(&format!("{CURATION}/references.json"))).unwrap();
let changeset =
parse_changeset(&common::repo_file(&format!("{CURATION}/changes.json"))).unwrap();
let head = result.view_boxes.get(HEAD_VIEW_ID).and_then(Value::as_str);
let draft = build_equine_draft(&DraftInput {
import_result: &result,
cleaned_svg: &bytes(&format!("{DRAFT}/assets/horse.svg")),
head_view_box: parse_view_box(head).unwrap(),
references: &references,
changes: &changeset.changes,
})
.unwrap();
(result, draft)
}
fn oracle(name: &str) -> Value {
serde_json::from_str(&common::repo_file(&format!(
"crates/core/tests/oracles/r5/{name}"
)))
.unwrap()
}
fn typed(document: &Value) -> AnatomicalSheetDocument {
serde_json::from_value(document.clone()).unwrap()
}
const REVIEW_FILES: [&str; 6] = [
"review/annotations-main.svg",
"review/annotations-head.svg",
"review/app-main.svg",
"review/app-head.svg",
"CHANGELOG.md",
"REVIEW-REPORT.md",
];
#[test]
fn the_review_files_of_the_committed_draft_are_reproduced() {
let (result, draft) = equine();
let files = render_draft_artifacts(&draft, &result.anomalies).unwrap();
let rule = TriggerNames::of(&typed(&draft.document));
for name in REVIEW_FILES {
let produced = &files.iter().find(|(file, _)| file == name).unwrap().1;
let committed = common::repo_file(&format!("{DRAFT}/{name}"));
let outcome = compare_drawing(produced, &committed, Some(&rule));
let expected = if name == "review/app-main.svg" {
Match::TreeAfterRule
} else {
Match::Bytes
};
assert_eq!(outcome, Ok(expected), "{name}");
}
}
/// The one declared difference of the drawings, measured: `app-main.svg` differs from the
/// xmldom file in the trigger's English name and its title only, byte for byte elsewhere.
#[test]
fn app_main_differs_only_by_the_r3_trigger_names() {
let (result, draft) = equine();
let files = render_draft_artifacts(&draft, &result.anomalies).unwrap();
let produced = &files
.iter()
.find(|(file, _)| file == "review/app-main.svg")
.unwrap()
.1;
let committed = common::repo_file(&format!("{DRAFT}/review/app-main.svg"));
let fr = "Tête (vue latérale gauche)";
let en = "Head (left lateral view)";
let expected = committed
.replace(
&format!("data-anno-name-en=\"{fr}\""),
&format!("data-anno-name-en=\"{en}\""),
)
.replace(
&format!("<title>{fr} / {fr}</title>"),
&format!("<title>{fr} / {en}</title>"),
);
assert_ne!(expected, committed);
assert_eq!(*produced, expected);
}
#[test]
fn the_raw_reports_are_the_texts_prettier_received() {
let (result, draft) = equine();
let document_json = format_json(&draft.document).unwrap();
let reference = SheetRef {
sheet_id: draft.sheet_id.clone(),
version_id: None,
document_sha256: sha256_hex(document_json.as_bytes()),
};
let (_, stats) =
faunosteo_core::curation::draft::pipeline::draft_migration_map(&draft, &reference).unwrap();
let changelog = render_changelog(
&draft.records,
&draft.stats_before,
&draft.stats_after,
&stats,
)
.unwrap();
let review = render_review_report(&ReviewReportInput {
changes: &draft.changes,
records: &draft.records,
document: &draft.document,
stats_before: &draft.stats_before,
legacy_anomalies: &result.anomalies,
})
.unwrap();
let ledger = oracle("pipeline.json")["artifacts"]
.as_array()
.unwrap()
.clone();
for (file, raw) in [("CHANGELOG.md", changelog), ("REVIEW-REPORT.md", review)] {
let row = ledger
.iter()
.find(|row| row["folder"] == DRAFT && row["file"] == file)
.unwrap();
assert_eq!(
sha256_hex(raw.as_bytes()),
row["before_prettier_sha256"],
"{file} raw"
);
let formatted = format_markdown(&raw).unwrap();
assert_eq!(
sha256_hex(formatted.as_bytes()),
row["sha256"],
"{file} formatted"
);
}
}
#[test]
fn two_runs_emit_the_same_review_files() {
let (result, draft) = equine();
let first = render_draft_artifacts(&draft, &result.anomalies).unwrap();
let second = render_draft_artifacts(&draft, &result.anomalies).unwrap();
assert_eq!(first, second);
}
#[test]
fn an_undeclared_drawing_difference_is_refused() {
let committed = common::repo_file(&format!("{DRAFT}/review/annotations-main.svg"));
let changed = committed.replacen("#1d4ed8", "#1d4ed9", 1);
let (_, draft) = equine();
let rule = TriggerNames::of(&typed(&draft.document));
assert!(compare_drawing(&changed, &committed, None).is_err());
assert!(compare_drawing(&changed, &committed, Some(&rule)).is_err());
let app = common::repo_file(&format!("{DRAFT}/review/app-head.svg"));
let moved = app.replacen("cx=\"", "cx=\"1", 1);
assert!(compare_drawing(&moved, &app, Some(&rule)).is_err());
}
// ---------------------------------------------------------------------------------------------
// Synthetic cases written by the TypeScript (`oracles/r5/review-synthetic.json`).
/// Cases the port refuses where the TypeScript wrote a file (declared in RUST.md §11.12).
const DECLARED_REFUSALS: [&str; 1] = ["declared-emoji-in-a-cell"];
struct Rendered {
changelog_raw: String,
changelog: Result<String, PipelineError>,
review_raw: String,
review: Result<String, PipelineError>,
drawings: Map<String, Value>,
}
fn render_case(frozen: &Value, case: &Value) -> Rendered {
let baseline = &frozen["baseline"];
let references = parse_references(
&to_js_compact(&serde_json::json!({ "references": frozen["references"] })).unwrap(),
)
.unwrap();
let changeset = parse_changeset(&to_js_compact(&case["changes_file"]).unwrap()).unwrap();
let result = apply_changeset(baseline, &references, &changeset.changes).unwrap();
let before = document_stats(baseline).unwrap();
let after = document_stats(&result.document).unwrap();
let sheet = SheetRef {
sheet_id: "11111111-1111-5111-8111-111111111111".to_owned(),
version_id: None,
document_sha256: "0".repeat(64),
};
let (_, stats) = build_report_migration_map(&MigrationMapInput {
baseline,
final_document: &result.document,
legacy_id_map: frozen["legacy_id_map"].as_object().unwrap(),
records: &result.records,
sheet: &sheet,
main_view_id: "main",
})
.unwrap();
let anomalies: Vec<Anomaly> = frozen["anomalies"]
.as_array()
.unwrap()
.iter()
.map(|a| {
let text = |key: &str| a[key].as_str().unwrap().to_owned();
let level = if a["level"] == "a_valider" {
"a_valider"
} else {
"informatif"
};
Anomaly {
code: text("code"),
level,
subject: text("subject"),
message: text("message"),
}
})
.collect();
let changes: Vec<_> = changeset.changes.iter().map(|c| c.summary()).collect();
let changelog_raw = render_changelog(&result.records, &before, &after, &stats).unwrap();
let review_raw = render_review_report(&ReviewReportInput {
changes: &changes,
records: &result.records,
document: &result.document,
stats_before: &before,
legacy_anomalies: &anomalies,
})
.unwrap();
let drawing = read_cleaned_drawing(frozen["drawing"].as_str().unwrap().as_bytes()).unwrap();
let document = typed(&result.document);
let mut drawings = Map::new();
for view in &document.views {
let id = view.id();
let overlay = render_review_overlay(&OverlayInput {
drawing: &drawing,
before: baseline,
after: &result.document,
view_id: id,
})
.unwrap();
drawings.insert(format!("annotations-{id}"), Value::from(overlay));
}
for view in &document.views {
let app = render_app_review_drawing(&drawing, &document, view.id()).unwrap();
drawings.insert(format!("app-{}", view.id()), Value::from(app));
}
Rendered {
changelog: format_markdown(&changelog_raw),
review: format_markdown(&review_raw),
changelog_raw,
review_raw,
drawings,
}
}
#[test]
fn the_synthetic_review_cases_match_the_typescript_or_are_refused_as_declared() {
let frozen = oracle("review-synthetic.json");
let cases = frozen["cases"].as_array().unwrap();
assert_eq!(cases.len(), 4);
for case in cases {
let name = case["name"].as_str().unwrap();
let rendered = render_case(&frozen, case);
assert_eq!(
rendered.changelog_raw,
case["changelog_raw"].as_str().unwrap(),
"{name}"
);
assert_eq!(
rendered.review_raw,
case["review_raw"].as_str().unwrap(),
"{name}"
);
if DECLARED_REFUSALS.contains(&name) {
let refused = rendered.changelog.unwrap_err();
assert!(
matches!(refused, PipelineError::UnsupportedWidth(_)),
"{name}"
);
continue;
}
assert_eq!(
rendered.changelog.unwrap(),
case["changelog"].as_str().unwrap(),
"{name}"
);
assert_eq!(
rendered.review.unwrap(),
case["review"].as_str().unwrap(),
"{name}"
);
let views = typed(&case_document(&frozen, case)).views.len();
assert_eq!(rendered.drawings.len(), 2 * views, "{name}");
let rule = TriggerNames::of(&typed(&case_document(&frozen, case)));
for (key, produced) in &rendered.drawings {
let committed = case["drawings"][key].as_str().unwrap();
let outcome = compare_drawing(produced.as_str().unwrap(), committed, Some(&rule));
assert!(outcome.is_ok(), "{name} {key}: {outcome:?}");
if key.starts_with("annotations-") {
assert_eq!(outcome, Ok(Match::Bytes), "{name} {key}");
}
}
}
}
fn case_document(frozen: &Value, case: &Value) -> Value {
let references = parse_references(
&to_js_compact(&serde_json::json!({ "references": frozen["references"] })).unwrap(),
)
.unwrap();
let changeset = parse_changeset(&to_js_compact(&case["changes_file"]).unwrap()).unwrap();
apply_changeset(&frozen["baseline"], &references, &changeset.changes)
.unwrap()
.document
}