//! The agent-facing command line: scripts with references, describe, filtered command lists. use std::io::Write; use std::process::{Command, Stdio}; fn cli() -> Command { Command::new(env!("CARGO_BIN_EXE_designcraft-cli")) } #[test] fn script_from_stdin_with_references_saves_and_exports() { let dir = std::env::temp_dir().join(format!("dc-cli-{}", std::process::id())); std::fs::create_dir_all(&dir).unwrap(); let (doc, png) = (dir.join("a.designcraft"), dir.join("a.png")); let mut child = cli() .args(["script", "-", "--save", doc.to_str().unwrap(), "--export", png.to_str().unwrap()]) .stdin(Stdio::piped()) .stdout(Stdio::piped()) .spawn() .unwrap(); child .stdin .take() .unwrap() .write_all( b"# comment\nframe.create {\"rect\": [72, 72, 300, 200], \"content\": \"text\", \"text\": \"Hi\"}\nstory.get {\"story\": \"$0.story\"}\n", ) .unwrap(); let out = child.wait_with_output().unwrap(); assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr)); let v: serde_json::Value = serde_json::from_slice(&out.stdout).unwrap(); assert_eq!(v["completed"], 2); assert_eq!(v["results"][1]["text"], "Hi"); assert!(doc.exists() && png.exists()); let _ = std::fs::remove_dir_all(&dir); } #[test] fn failing_script_exits_nonzero_with_the_step() { let mut child = cli().args(["script", "-"]).stdin(Stdio::piped()).stdout(Stdio::piped()).stderr(Stdio::piped()).spawn().unwrap(); child.stdin.take().unwrap().write_all(b"document.inspect\nno.such.command\n").unwrap(); let out = child.wait_with_output().unwrap(); assert!(!out.status.success()); let v: serde_json::Value = serde_json::from_slice(&out.stdout).unwrap(); assert_eq!(v["failedIndex"], 1); } #[test] fn run_cmd_references_and_describe() { let out = cli() .args([ "run", "--cmd", r#"frame.create={"rect":[72,72,300,200],"content":"text","text":"Hello"}"#, "--cmd", r#"story.get={"story":"$0.story"}"#, ]) .output() .unwrap(); assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr)); assert!(String::from_utf8_lossy(&out.stdout).contains("\"text\":\"Hello\"")); let out = cli().args(["describe", "footnote.insert"]).output().unwrap(); let v: serde_json::Value = serde_json::from_slice(&out.stdout).unwrap(); assert_eq!(v["label"], "Insert Footnote"); let out = cli().args(["commands", "footnote."]).output().unwrap(); let v: serde_json::Value = serde_json::from_slice(&out.stdout).unwrap(); assert!(v.as_array().unwrap().iter().all(|c| c.to_string().contains("footnote"))); } /// `designcraft-cli --help` printed usage to stderr and exited 1; asking for help is not an /// error (#243). It now goes to stdout and succeeds, while an unknown command keeps the same /// usage on stderr and fails. #[test] fn help_goes_to_stdout_and_unknown_args_to_stderr() { for flag in ["--help", "-h", "help"] { let out = cli().arg(flag).output().unwrap(); let stdout = String::from_utf8_lossy(&out.stdout); assert!(out.status.success(), "{flag}: {:?}", out.status); assert!(stdout.starts_with("usage: designcraft-cli"), "{flag}: {stdout:?}"); assert!(stdout.contains("designcraft-cli --version"), "{flag}: {stdout:?}"); assert!(out.stderr.is_empty(), "{flag} wrote to stderr: {}", String::from_utf8_lossy(&out.stderr)); } // An unknown option is still an error: usage on stderr, nothing on stdout, non-zero exit. let out = cli().arg("--no-such-option").output().unwrap(); assert!(!out.status.success(), "{:?}", out.status); assert!(out.stdout.is_empty(), "unexpected stdout: {}", String::from_utf8_lossy(&out.stdout)); assert!(String::from_utf8_lossy(&out.stderr).starts_with("usage: designcraft-cli")); } /// `script --help` was "unknown script option `--help`"; the line syntax was only in /// `describe script.run` (#654). #[test] fn script_help_documents_the_syntax() { for flag in ["--help", "-h"] { let out = cli().args(["script", flag]).output().unwrap(); let stdout = String::from_utf8_lossy(&out.stdout); assert!(out.status.success(), "{flag}: {:?} {}", out.status, String::from_utf8_lossy(&out.stderr)); assert!(stdout.starts_with("usage: designcraft-cli script"), "{flag}: {stdout:?}"); for needle in ["0-based", "$1.story", "$3.ids.0", "\\u2028", "ignore"] { assert!(stdout.contains(needle), "{flag}: no {needle:?} in {stdout:?}"); } } } /// `designcraft-cli commands | head -1` panicked with "failed printing to /// stdout: Broken pipe (os error 32)" and exit status 101. #[test] fn closed_stdout_ends_quietly() { use std::io::Read; let mut child = cli().arg("commands").stdout(Stdio::piped()).stderr(Stdio::piped()).spawn().unwrap(); let mut first = [0u8; 16]; child.stdout.as_mut().unwrap().read_exact(&mut first).unwrap(); drop(child.stdout.take()); let out = child.wait_with_output().unwrap(); let err = String::from_utf8_lossy(&out.stderr); assert!(out.status.success() && !err.contains("panicked"), "{:?}: {err}", out.status); } /// `--scale`, `--page` and `--pdf-options` apply to the exports after them; one with no export /// after it was silently ignored. #[test] fn run_export_options_come_before_their_export() { let dir = std::env::temp_dir().join(format!("dc-cli-order-{}", std::process::id())); std::fs::create_dir_all(&dir).unwrap(); let (a, b) = (dir.join("a.png"), dir.join("b.png")); let (a, b) = (a.to_str().unwrap(), b.to_str().unwrap()); for (opt, val) in [("--scale", "0.5"), ("--page", "1"), ("--pdf-options", r#"{"pages":"1"}"#)] { let out = cli().args(["run", "--sample", "--export", a, opt, val]).output().unwrap(); let err = String::from_utf8_lossy(&out.stderr); assert!(!out.status.success(), "{opt} after the last --export: {err}"); assert!(err.contains(opt) && err.contains("before"), "{err}"); } assert!(!std::path::Path::new(a).exists(), "nothing is exported when the arguments are wrong"); let out = cli().args(["run", "--sample", "--scale", "0.5", "--export", a, "--scale", "0.25", "--export", b]).output().unwrap(); let err = String::from_utf8_lossy(&out.stderr); assert!(out.status.success(), "{err}"); assert!(err.contains("wrote") && std::path::Path::new(a).exists() && std::path::Path::new(b).exists(), "{err}"); let _ = std::fs::remove_dir_all(&dir); } #[cfg(unix)] #[test] fn raster_export_preserves_an_existing_reader_and_private_symlink_target() { use std::io::Read; use std::os::unix::fs::{PermissionsExt, symlink}; struct Fixture(std::path::PathBuf); impl Drop for Fixture { fn drop(&mut self) { let _ = std::fs::remove_dir_all(&self.0); } } let stamp = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap().as_nanos(); let dir = std::env::temp_dir().join(format!("designcraft-cli-atomic-{}-{stamp}", std::process::id())); std::fs::create_dir(&dir).unwrap(); let fixture = Fixture(dir); let target = fixture.0.join(format!("{}.png", "a".repeat(243))); let old = b"previous private export"; std::fs::write(&target, old).unwrap(); std::fs::set_permissions(&target, std::fs::Permissions::from_mode(0o600)).unwrap(); let alias = fixture.0.join("linked.png"); symlink(target.file_name().unwrap(), &alias).unwrap(); let mut reader = std::fs::File::open(&target).unwrap(); let out = cli().args(["run", "--sample", "--scale", "0.1", "--export", alias.to_str().unwrap()]).output().unwrap(); assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr)); let mut observed = Vec::new(); reader.read_to_end(&mut observed).unwrap(); assert!(observed == old, "CLI export changed bytes under an existing reader"); assert!(std::fs::read(&target).unwrap().starts_with(b"\x89PNG\r\n\x1a\n")); assert_eq!(std::fs::metadata(&target).unwrap().permissions().mode() & 0o777, 0o600); assert!(std::fs::symlink_metadata(alias).unwrap().file_type().is_symlink()); }