Skip to content

SolidCraft: an open-source parametric 3D CAD application built in pure Rust. Desktop, web, and automation through MCP.

16.1 KB
Raw Blame
//! STEP files written by other CAD systems: Y up (`up`) and the names of the bodies (`names`)
//! on `file.insert_step` and `doc.open`.

use serde_json::{Value, json};
use solidcore_record::Vec3;
use solidcraft_kernel::{ExportBody, ExportProduct, StepHeader, box_solid, step_export_products};

use super::run;
use crate::*;

/// A frame as a Y-up file has it, in a STEP file in a fresh temp directory: a plate 40 wide,
/// 4 high (Y) and 20 deep, with two posts 4 wide and 30 high standing on it. The solids are
/// named after the last feature that made them (`Cut-Extrude3`), and the posts are two
/// occurrences of one part. As written the frame spans x 0..40, y 0..34, z 0..20.
fn frame_file(tag: &str) -> String {
    let dir = std::env::temp_dir().join(format!("solidcraft-step-options-{tag}-{}", std::process::id()));
    std::fs::create_dir_all(&dir).unwrap();
    let plate = box_solid(Vec3::ZERO, Vec3::new(40.0, 4.0, 20.0)).unwrap();
    let post = box_solid(Vec3::ZERO, Vec3::new(4.0, 30.0, 4.0)).unwrap();
    let at = |x: f64, y: f64, z: f64| [[1.0, 0.0, 0.0, 0.0], [0.0, 1.0, 0.0, 0.0], [0.0, 0.0, 1.0, 0.0], [x, y, z, 1.0]];
    let part = |name: &str, label: &str, body| ExportProduct {
        name: name.into(),
        bodies: vec![ExportBody { name: label.into(), body, color: None }],
        children: Vec::new(),
    };
    let products = vec![
        ExportProduct {
            name: "Frame".into(),
            bodies: Vec::new(),
            children: vec![
                (1, at(0.0, 0.0, 0.0), "Plate-1".into()),
                (2, at(10.0, 4.0, 8.0), "Post-1".into()),
                (2, at(26.0, 4.0, 8.0), "Post-2".into()),
            ],
        },
        part("Plate", "Cut-Extrude3", &plate),
        part("Post", "Boss-Extrude1", &post),
    ];
    let text = step_export_products(&products, 0, &StepHeader::default()).unwrap();
    let path = dir.join("frame.step");
    std::fs::write(&path, text).unwrap();
    path.to_string_lossy().to_string()
}

/// The lowest and highest corner of everything the design shows.
fn extent(s: &Session) -> ([f64; 3], [f64; 3]) {
    let b = crate::view::bounds(s).unwrap();
    ([b.min.x, b.min.y, b.min.z], [b.max.x, b.max.y, b.max.z])
}

fn near(a: [f64; 3], b: [f64; 3]) -> bool {
    a.iter().zip(&b).all(|(x, y)| (x - y).abs() < 1e-6)
}

fn body_names(s: &Session) -> Vec<String> {
    s.model.state().bodies.iter().map(|b| b.name.clone()).collect()
}

fn kinds(s: &Session) -> Vec<&'static str> {
    s.doc.features.iter().map(|f| f.kind.type_name()).collect()
}

fn total_volume(s: &mut Session) -> f64 {
    run(s, "inspect.measure", json!({}))["total"]["volume_mm3"].as_f64().unwrap()
}

#[test]
fn imported_joints_do_not_reuse_deleted_ids() {
    let path = frame_file("joint-ids");
    let mut s = Session::default();
    run(&mut s, "file.insert_step", json!({"path": path}));
    let first: Vec<_> = s.doc.assembly.joints.iter().map(|j| j.id).collect();
    assert!(!first.is_empty());
    for id in &first {
        run(&mut s, "joint.delete", json!({"joint": id}));
    }
    run(&mut s, "component.activate", json!({"component": "root"}));
    run(&mut s, "file.insert_step", json!({"path": path}));
    assert!(!s.doc.assembly.joints.is_empty());
    for joint in &s.doc.assembly.joints {
        assert!(!first.contains(&joint.id), "import reused deleted joint {}", joint.id);
        assert!(joint.id < s.doc.next_id, "import did not reserve joint {}", joint.id);
    }
}

/// `up: "y"` turns the file's bodies a quarter turn about X, Y becoming Z: the frame's height
/// lies along Z, and what was its depth now runs towards -Y.
#[test]
fn a_y_up_step_file_comes_in_standing_up() {
    let path = frame_file("up");
    let mut s = Session::default();
    run(&mut s, "file.insert_step", json!({"path": path}));
    let (lo, hi) = extent(&s);
    assert!(near(lo, [0.0, 0.0, 0.0]) && near(hi, [40.0, 34.0, 20.0]), "as written: {lo:?} {hi:?}");
    assert_eq!(kinds(&s), ["BaseFeature"]);

    // An explicit z keeps the file's axes, in any case.
    for up in ["z", "Z"] {
        let mut d = Session::default();
        let r = run(&mut d, "file.insert_step", json!({"path": path, "up": up}));
        assert_eq!(kinds(&d), ["BaseFeature"], "{r}");
        assert!(r.get("stand_up").is_none(), "{r}");
        assert!(near(extent(&d).1, [40.0, 34.0, 20.0]));
    }

    // y: (x, y, z) goes to (x, -z, y), so the frame, 34 high in Y, stands 34 high in Z.
    let mut d = Session::default();
    let undo = d.undo.len();
    let r = run(&mut d, "file.insert_step", json!({"path": path, "up": "y"}));
    let (lo, hi) = extent(&d);
    assert!(near(lo, [0.0, -20.0, 0.0]) && near(hi, [40.0, 0.0, 34.0]), "stood up: {lo:?} {hi:?}");
    // The import's component is turned (#1386), so an assembly's instances turn with it.
    assert_eq!(kinds(&d), ["BaseFeature"]);
    assert_eq!(r["stand_up"], r["occurrence"], "{r}");
    assert_eq!(r["created_bodies"].as_array().unwrap().len(), 2, "the plate, and the post placed twice: {r}");
    assert!((total_volume(&mut d) - (40.0 * 4.0 * 20.0 + 2.0 * 4.0 * 30.0 * 4.0)).abs() < 1e-6);
    // The Import and the turn are one undo step.
    assert_eq!(d.undo.len(), undo + 1);
    run(&mut d, "edit.undo", json!({}));
    assert!(d.doc.features.is_empty());

    // Only the file's bodies turn, not the ones already in the design.
    let mut d = Session::default();
    run(&mut d, "solid.box", json!({"length": 5, "width": 6, "height": 7, "corner": [100, 100, 100]}));
    run(&mut d, "file.insert_step", json!({"path": path, "up": "Y"}));
    let (lo, hi) = extent(&d);
    assert!(near(lo, [0.0, -20.0, 0.0]) && near(hi, [105.0, 106.0, 107.0]), "{lo:?} {hi:?}");

    // The turn is the component's placement: the saved design has it.
    let design = std::path::Path::new(&path).with_file_name("frame.solidcraft");
    run(&mut s, "edit.undo", json!({}));
    run(&mut s, "file.insert_step", json!({"path": path, "up": "y"}));
    run(&mut s, "file.save_as", json!({"path": design.to_string_lossy()}));
    let mut again = Session::default();
    run(&mut again, "doc.open", json!({"path": design.to_string_lossy()}));
    assert!(near(extent(&again).1, [40.0, 0.0, 34.0]));
}

/// `doc.open` takes the same options and starts a new design that has the turn in it.
#[test]
fn opening_a_y_up_step_file_can_stand_it_up() {
    let path = frame_file("open");
    let mut s = Session::default();
    let r = run(&mut s, "doc.open", json!({"path": path, "up": "y"}));
    assert_eq!(r["features"], 1, "{r}");
    assert!(near(extent(&s).1, [40.0, 0.0, 34.0]));
    assert!(s.undo.is_empty(), "a freshly opened design has no history");
    run(&mut s, "doc.open", json!({"path": path}));
    assert_eq!(kinds(&s), ["BaseFeature"]);

    // The options belong to STEP files: a design file does not take them.
    let design = std::path::Path::new(&path).with_file_name("kept.solidcraft");
    run(&mut s, "file.save_as", json!({"path": design.to_string_lossy()}));
    let before = s.doc.clone();
    for p in [json!({"up": "y"}), json!({"names": "product"})] {
        let mut params = p.clone();
        params["path"] = json!(design.to_string_lossy());
        assert!(s.execute("doc.open", &params).is_err(), "{params}");
    }
    assert!(std::sync::Arc::ptr_eq(&s.doc, &before));
}

/// A value that is not one of the choices is refused, and the design stays as it was.
#[test]
fn wrong_up_and_names_are_refused() {
    let path = frame_file("refused");
    let mut s = Session::default();
    run(&mut s, "solid.box", json!({"length": 5, "width": 5, "height": 5}));
    let before = s.doc.clone();
    for p in [
        json!({"up": "x"}),
        json!({"up": "-y"}),
        json!({"up": 5}),
        json!({"up": ["y"]}),
        json!({"names": "label"}),
        json!({"names": 7}),
        json!({"up": "y", "names": "nope"}),
    ] {
        let mut params = p.clone();
        params["path"] = json!(path);
        for command in ["file.insert_step", "doc.open"] {
            let e = s.execute(command, &params).unwrap_err().to_string();
            assert!(e.contains("`up`") || e.contains("`names`"), "{command} {params}: {e}");
            assert!(std::sync::Arc::ptr_eq(&s.doc, &before), "{command} {params} changed the design");
        }
    }
    // Null means not given.
    run(&mut s, "file.insert_step", json!({"path": path, "up": null, "names": null}));
    assert_eq!(kinds(&s), ["BoxFeature", "BaseFeature"]);
}

/// Explicit naming choices select the solid, part or occurrence; automatic naming keeps
/// meaningful solid names.
#[test]
fn the_bodies_are_named_after_the_solid_the_product_or_the_instance() {
    let path = frame_file("names");
    let named = |params: Value| {
        let mut s = Session::default();
        let r = run(&mut s, "file.insert_step", params);
        assert_eq!(r["bodies"], json!(body_names(&s)), "{r}");
        assert_eq!(r["name"], "Frame", "the timeline entry is the root product's");
        body_names(&s)
    };
    // The post is placed twice: one component, two occurrences, its body built once (#1386).
    let solids = ["Cut-Extrude3", "Boss-Extrude1"];
    assert_eq!(named(json!({"path": path})), solids);
    assert_eq!(named(json!({"path": path, "names": "auto"})), solids);
    assert_eq!(named(json!({"path": path, "names": "solid"})), solids);
    assert_eq!(named(json!({"path": path, "names": "product"})), ["Plate", "Post"]);
    assert_eq!(named(json!({"path": path, "names": "Instance"})), ["Plate-1", "Post-1"]);

    // The names are stored with the import: a saved design keeps them, and `up` does not change them.
    let mut s = Session::default();
    run(&mut s, "doc.open", json!({"path": path, "names": "instance", "up": "y"}));
    assert_eq!(body_names(&s), ["Plate-1", "Post-1"]);
    let design = std::path::Path::new(&path).with_file_name("frame-named.solidcraft");
    run(&mut s, "file.save_as", json!({"path": design.to_string_lossy()}));
    let mut again = Session::default();
    run(&mut again, "doc.open", json!({"path": design.to_string_lossy()}));
    assert_eq!(body_names(&again), ["Plate-1", "Post-1"]);
    // A feature finds them by those names.
    run(&mut again, "solid.move", json!({"bodies": ["Post-1"], "translate": [0, 0, 5]}));
    assert_eq!(body_names(&again), ["Plate-1", "Post-1"]);
}

/// `matrix` places the inserted file's component, after `up`, in the same command (one undo
/// step); a matrix that is not rigid is refused before anything is added.
#[test]
fn a_step_file_can_be_inserted_at_a_matrix() {
    let path = frame_file("matrix");
    let quarter = json!([0, -1, 0, 100, 1, 0, 0, 0, 0, 0, 1, 0]);
    let mut s = Session::default();
    let r = run(&mut s, "file.insert_step", json!({"path": path, "matrix": quarter}));
    // (x, y, z) goes to (100 - y, x, z): the frame (0..40, 0..34, 0..20) spans x 66..100, y 0..40.
    let (lo, hi) = extent(&s);
    assert!(near(lo, [66.0, 0.0, 0.0]) && near(hi, [100.0, 40.0, 20.0]), "{lo:?} {hi:?} {r}");
    assert_eq!(r["transform"][3][0], json!(100.0), "{r}");
    assert_eq!(s.undo.len(), 1);

    // Stood up first ((0..40, -20..0, 0..34)), then turned and moved.
    let mut d = Session::default();
    run(&mut d, "file.insert_step", json!({"path": path, "up": "y", "matrix": quarter}));
    let (lo, hi) = extent(&d);
    assert!(near(lo, [100.0, 0.0, 0.0]) && near(hi, [120.0, 40.0, 34.0]), "{lo:?} {hi:?}");

    let mut d = Session::default();
    let e = d.execute("file.insert_step", &json!({"path": path, "matrix": [2, 0, 0, 0, 0, 2, 0, 0, 0, 0, 2, 0]})).unwrap_err().to_string();
    assert!(e.contains("not rigid"), "{e}");
    assert!(d.doc.features.is_empty() && d.doc.occurrences.is_empty());
}

/// Generated body labels become part names, and the saved assembly retains its components
/// and repeated placements without needing the source file.
#[test]
fn automatic_part_names_and_assembly_survive_reopening() {
    let path = frame_file("automatic");
    let text = std::fs::read_to_string(&path).unwrap().replace("'Cut-Extrude3'", "'Body1'").replace("'Boss-Extrude1'", "'Body 2 (3)'");
    std::fs::write(&path, text).unwrap();
    let mut s = Session::default();
    let r = run(&mut s, "file.insert_step", json!({"path": path}));
    assert_eq!(body_names(&s), ["Plate", "Post"]);
    let top = r["component"].as_u64().unwrap();
    let parts: Vec<_> = s.doc.components.iter().filter(|c| c.parent == top).collect();
    assert_eq!(parts.iter().map(|c| c.name.as_str()).collect::<Vec<_>>(), ["Plate", "Post"]);
    assert_eq!(s.doc.occurrences.iter().filter(|o| o.component == parts[1].id && o.parent == top).count(), 2);
    let design = std::path::Path::new(&path).with_file_name("automatic.solidcraft");
    run(&mut s, "file.save_as", json!({"path": design.to_string_lossy()}));
    std::fs::remove_file(&path).unwrap();
    let mut again = Session::default();
    run(&mut again, "doc.open", json!({"path": design.to_string_lossy()}));
    assert_eq!(body_names(&again), ["Plate", "Post"]);
    assert_eq!(again.doc.components, s.doc.components);
    assert_eq!(again.doc.occurrences, s.doc.occurrences);
    assert!(near(extent(&again).0, [0.0, 0.0, 0.0]) && near(extent(&again).1, [40.0, 34.0, 20.0]));
    assert!((total_volume(&mut again) - (40.0 * 4.0 * 20.0 + 2.0 * 4.0 * 30.0 * 4.0)).abs() < 1e-6);
}

#[test]
fn step_replies_include_originating_system() -> std::result::Result<(), Box<dyn std::error::Error>> {
    let dir = std::env::temp_dir().join(format!("solidcraft-step-system-{}", std::process::id()));
    std::fs::create_dir_all(&dir)?;
    let path = dir.join("box.step");
    let mut source = Session::default();
    source.execute("solid.box", &json!({"length": 10, "width": 40, "height": 5}))?;
    source.execute("file.export", &json!({"path": path.to_string_lossy()}))?;
    let text = std::fs::read_to_string(&path)?;
    assert!(text.contains("'SolidCraft','SolidCraft'"));
    for system in ["SolidCraft", "Example CAD"] {
        std::fs::write(&path, text.replace("'SolidCraft','SolidCraft'", &format!("'SolidCraft','{system}'")))?;
        for command in ["file.insert_step", "doc.open"] {
            let reply = Session::default().execute(command, &json!({"path": path.to_string_lossy()}))?;
            assert_eq!(reply.get("system").and_then(Value::as_str), Some(system), "{command}: {reply}");
        }
    }
    std::fs::remove_dir_all(dir)?;
    Ok(())
}

/// A header naming SolidWorks says the file has Y up; SolidCraft's own says Z; anything else
/// says nothing (synthetic headers only).
#[test]
fn step_replies_name_a_y_up_exporter() -> std::result::Result<(), Box<dyn std::error::Error>> {
    let dir = std::env::temp_dir().join(format!("solidcraft-step-exporter-{}", std::process::id()));
    std::fs::create_dir_all(&dir)?;
    let path = dir.join("box.step");
    let mut source = Session::default();
    source.execute("solid.box", &json!({"length": 10, "width": 40, "height": 5}))?;
    source.execute("file.export", &json!({"path": path.to_string_lossy()}))?;
    let text = std::fs::read_to_string(&path)?;
    let header = "'SolidCraft','SolidCraft'";
    assert!(text.contains(header));
    for (preprocessor, system, want) in [
        ("SolidCraft", "SolidCraft", Some(("z", "SolidCraft"))),
        ("SolidWorks 2021", "SolidWorks 2021", Some(("y", "SolidWorks"))),
        ("Example CAD", "SOLIDWORKS 2019", Some(("y", "SolidWorks"))),
        ("Example CAD", "Example CAD", None),
    ] {
        std::fs::write(&path, text.replace(header, &format!("'{preprocessor}','{system}'")))?;
        for command in ["file.insert_step", "doc.open"] {
            let reply = Session::default().execute(command, &json!({"path": path.to_string_lossy()}))?;
            let got = reply.get("exporter_up").and_then(Value::as_str).zip(reply.get("exporter").and_then(Value::as_str));
            assert_eq!(got, want, "{command} {system}: {reply}");
        }
    }
    // The program may be named only in FILE_DESCRIPTION.
    std::fs::write(
        &path,
        text.replace("FILE_DESCRIPTION((", "FILE_DESCRIPTION(('SolidWorks export',").replace(header, "'Example CAD','Example CAD'"),
    )?;
    let reply = Session::default().execute("file.insert_step", &json!({"path": path.to_string_lossy()}))?;
    assert_eq!(reply.get("exporter_up").and_then(Value::as_str), Some("y"), "{reply}");
    std::fs::remove_dir_all(dir)?;
    Ok(())
}