photocraft/crates/engine/tests/precheck.rs

//! `Session::precheck` accepts exactly what `execute` accepts for the commands it covers
//! (`PRECHECKED`): Free Transform applies its box before them only when they will run (#5859).

use photocraft_engine::{PRECHECKED, Session};
use serde_json::{Value, json};

/// Documents in different states: a Background only, a pixel layer active, a group active, a
/// selection, no document.
fn states() -> Vec<(&'static str, Session)> {
    let mut out = Vec::new();
    out.push(("no document", Session::new()));
    let mut s = Session::new();
    s.execute("file.new", json!({"width": 40, "height": 30, "background": "white"})).unwrap();
    out.push(("background only", s));
    let mut s = Session::new();
    s.execute("file.new", json!({"width": 40, "height": 30, "background": "white"})).unwrap();
    s.execute("layer.new.layer", json!({})).unwrap();
    s.execute("edit.fill", json!({"color": "#ff0000"})).unwrap();
    out.push(("pixel layer", s));
    let mut s = Session::new();
    s.execute("file.new", json!({"width": 40, "height": 30, "background": "transparent"})).unwrap();
    s.execute("layer.new.group", json!({})).unwrap();
    out.push(("group, no background", s));
    let mut s = Session::new();
    s.execute("file.new", json!({"width": 40, "height": 30, "background": "white"})).unwrap();
    s.execute("layer.new.layer", json!({})).unwrap();
    s.execute("edit.fill", json!({"color": "#00ff00"})).unwrap();
    s.execute("select.rect", json!({"x": 2, "y": 2, "width": 10, "height": 10})).unwrap();
    out.push(("selection", s));
    out
}

fn params() -> Vec<Value> {
    vec![
        Value::Null,
        json!({}),
        json!([1]),
        json!("x"),
        json!({"mode": "Bogus"}),
        json!({"mode": "Multiply"}),
        json!({"fillNeutral": true}),
        json!({"mode": "Overlay", "fillNeutral": true}),
        json!({"position": "x"}),
        json!({"position": "below"}),
        json!({"opacity": "half"}),
        json!({"name": 5}),
        json!({"name": "ok"}),
        json!({"color": "chartreuse"}),
        json!({"layer": 999_999}),
        json!({"layer": "Layer 1"}),
        json!({"layer": "no such layer"}),
        json!({"layer": true}),
        json!({"ifPresent": true}),
    ]
}

#[test]
fn precheck_agrees_with_execute() {
    let mut disagreements = Vec::new();
    for id in PRECHECKED {
        for p in params() {
            for (state, _) in states() {
                // A fresh copy of the state for each call: execute changes it.
                let mut s = states().into_iter().find(|(n, _)| *n == state).map(|(_, s)| s).unwrap();
                let pre = s.precheck(id, &p).is_ok();
                let ran = s.execute(id, p.clone()).is_ok();
                if pre != ran {
                    disagreements.push(format!("{id} {p} on {state}: precheck {pre}, execute {ran}"));
                }
            }
        }
    }
    assert!(disagreements.is_empty(), "{disagreements:#?}");
}