use std::path::Path;
use std::process::{Command, Output};
fn deedar(home: &Path, args: &[&str]) -> Output {
deedar_xdg(home, &home.join(".local/share"), args)
}
fn deedar_xdg(home: &Path, xdg: &Path, args: &[&str]) -> Output {
Command::new(env!("CARGO_BIN_EXE_deedar"))
.args(args)
.env("HOME", home)
.env("XDG_CONFIG_HOME", home.join(".config"))
.env("XDG_DATA_HOME", xdg)
.env("DEEDAR_HOST_SIGNING_KEY", "off")
.env_remove("DEEDAR_HOST_KEY")
.env_remove("DEEDAR_URL")
.env_remove("DEEDAR_TSA")
.current_dir(home)
.output()
.expect("deedar runs")
}
fn ok(home: &Path, args: &[&str]) -> String {
let out = deedar(home, args);
assert!(
out.status.success(),
"deedar {args:?}: {}",
String::from_utf8_lossy(&out.stderr)
);
String::from_utf8(out.stdout).expect("stdout is utf8")
}
fn refused(out: &Output, stderr: &str) {
assert_eq!(out.status.code(), Some(1), "{:?}", out.status);
assert_eq!(String::from_utf8_lossy(&out.stdout).as_ref(), "");
assert_eq!(String::from_utf8_lossy(&out.stderr).as_ref(), stderr);
}
fn store_url(home: &Path) -> String {
format!("file://{}", home.join("store").display())
}
fn quote(home: &Path, url: &str, id: &str) {
ok(
home,
&[
"--url",
url,
"create",
"quote",
"--id",
id,
"--excerpt",
"a range in a frozen edition",
"--src-url",
"https://example.invalid/edition",
"--agent",
"seat",
],
);
}
fn next_list(url: &str) -> String {
format!("`deedar --url {url} list`")
}
fn next_get(url: &str, id: &str) -> String {
format!("`deedar --url {url} get {id}`")
}
#[test]
fn an_unknown_accession_names_the_input_and_exits_1() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
quote(home, &url, "deed-quote-survey");
let out = deedar(home, &["--url", &url, "get", "deed-quote-missing"]);
refused(
&out,
&format!(
"deedar: unknown accession deed-quote-missing; {}\n",
next_list(&url)
),
);
}
#[test]
fn a_prefix_of_one_accession_names_that_accession_and_exits_1() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
quote(home, &url, "deed-quote-survey");
let out = deedar(home, &["--url", &url, "get", "deed-quote-sur"]);
refused(
&out,
&format!(
"deedar: prefix deed-quote-sur matches deed-quote-survey; {}\n",
next_get(&url, "deed-quote-survey")
),
);
}
#[test]
fn an_ambiguous_prefix_lists_matches_in_byte_order_and_exits_1() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
quote(home, &url, "deed-quote-survey");
quote(home, &url, "deed-quote-survey-v2");
let got = ok(home, &["--url", &url, "get", "deed-quote-survey"]);
assert!(got.starts_with("id=deed-quote-survey "), "{got}");
let out = deedar(home, &["--url", &url, "get", "deed-quote-sur"]);
refused(
&out,
&format!(
"deedar: ambiguous prefix deed-quote-sur matches 2 deeds, at most 8 in byte order: \
deed-quote-survey, deed-quote-survey-v2; {}\n",
next_list(&url)
),
);
}
#[test]
fn an_ambiguous_prefix_lists_at_most_eight_and_exits_1() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
for n in 1..=9 {
quote(home, &url, &format!("deed-quote-p{n:02}"));
}
let listed = (1..=8)
.map(|n| format!("deed-quote-p{n:02}"))
.collect::<Vec<_>>()
.join(", ");
let out = deedar(home, &["--url", &url, "get", "deed-quote-p"]);
refused(
&out,
&format!(
"deedar: ambiguous prefix deed-quote-p matches 9 deeds, at most 8 in byte order: \
{listed}; {}\n",
next_list(&url)
),
);
}
#[test]
fn a_shared_product_path_lists_both_accessions_and_exits_1() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
for (id, name) in [("deed-file-first", "a.txt"), ("deed-file-second", "b.txt")] {
std::fs::write(home.join(name), b"same bytes\n").unwrap();
ok(
home,
&[
"--url", &url, "create", "file", "--id", id, "--path", name, "--agent", "seat",
],
);
}
let got = ok(home, &["--url", &url, "get", "deed-file-first"]);
let path = got
.lines()
.find_map(|line| line.strip_prefix("paths="))
.expect("paths line");
let out = deedar(home, &["--url", &url, "get", path]);
refused(
&out,
&format!(
"deedar: ambiguous {path} matches 2 deeds, at most 8 in byte order: \
deed-file-first, deed-file-second; {}\n",
next_list(&url)
),
);
}
#[test]
fn an_unset_deedar_url_names_the_seat_path_and_exits_1() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let seat = home.join(".local/share/deedar/store");
let out = Command::new(env!("CARGO_BIN_EXE_deedar"))
.arg("list")
.env("HOME", home)
.env("XDG_CONFIG_HOME", home.join(".config"))
.env_remove("XDG_DATA_HOME")
.env("DEEDAR_HOST_SIGNING_KEY", "off")
.env_remove("DEEDAR_HOST_KEY")
.env_remove("DEEDAR_URL")
.current_dir(home)
.output()
.expect("deedar runs");
let path = seat.display();
refused(
&out,
&format!(
"deedar: DEEDAR_URL is unset and there is no store at {path}; \
`export DEEDAR_URL=file://{path}` or `deedar --url file://{path}`\n"
),
);
assert!(!seat.exists(), "list must not make the seat store");
}
#[test]
fn the_first_create_makes_the_seat_store() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let xdg = home.join("xdg");
let seat = xdg.join("deedar/store");
let create = [
"create",
"quote",
"--excerpt",
"x",
"--src-url",
"https://e.invalid",
"--agent",
"me",
];
let out = deedar_xdg(home, &xdg, &create);
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
let stdout = String::from_utf8(out.stdout).expect("stdout is utf8");
let accession = stdout
.lines()
.find_map(|line| line.strip_prefix("accession="))
.expect("accession line");
assert_eq!(
String::from_utf8_lossy(&out.stderr),
format!("deedar: created the store at {}\n", seat.display())
);
assert!(seat.is_dir());
assert!(
!home.join(".local/share/deedar").exists(),
"a second store was made under HOME"
);
let listed = deedar_xdg(home, &xdg, &["list"]);
assert!(
listed.status.success(),
"{}",
String::from_utf8_lossy(&listed.stderr)
);
assert!(
String::from_utf8_lossy(&listed.stdout).contains(&format!("id={accession}")),
"{}",
String::from_utf8_lossy(&listed.stdout)
);
let again = deedar_xdg(home, &xdg, &create);
assert!(
again.status.success(),
"{}",
String::from_utf8_lossy(&again.stderr)
);
assert_eq!(String::from_utf8_lossy(&again.stderr), "");
assert!(
String::from_utf8_lossy(&again.stdout).contains(&format!("accession={accession}")),
"{}",
String::from_utf8_lossy(&again.stdout)
);
}
#[test]
fn the_first_import_makes_the_seat_store() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
quote(home, &url, "deed-quote-carried");
ok(
home,
&[
"--url",
&url,
"export",
"--into",
"bag/data/deeds",
"deed-quote-carried",
],
);
let xdg = home.join("xdg");
let seat = xdg.join("deedar/store");
let out = deedar_xdg(home, &xdg, &["import", "bag", "--allow-unsigned-head"]);
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
assert_eq!(
String::from_utf8_lossy(&out.stderr),
format!("deedar: created the store at {}\n", seat.display())
);
let listed = deedar_xdg(home, &xdg, &["list"]);
assert!(
listed.status.success(),
"{}",
String::from_utf8_lossy(&listed.stderr)
);
assert!(
String::from_utf8_lossy(&listed.stdout).contains("id=deed-quote-carried"),
"{}",
String::from_utf8_lossy(&listed.stdout)
);
let again = deedar_xdg(home, &xdg, &["import", "bag", "--allow-unsigned-head"]);
assert!(
again.status.success(),
"{}",
String::from_utf8_lossy(&again.stderr)
);
assert_eq!(String::from_utf8_lossy(&again.stderr), "");
}
#[test]
fn a_named_new_store_does_not_say_the_seat_store_was_created() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let xdg = home.join("xdg");
let create = [
"create",
"quote",
"--excerpt",
"x",
"--src-url",
"https://e.invalid",
"--agent",
"me",
];
let url = store_url(home);
let mut args = vec!["--url", &url];
args.extend_from_slice(&create);
let out = deedar_xdg(home, &xdg, &args);
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
assert_eq!(String::from_utf8_lossy(&out.stderr), "");
assert!(!xdg.join("deedar/store").exists());
let other = home.join("other");
let named = format!("file://{}", other.display());
let out = Command::new(env!("CARGO_BIN_EXE_deedar"))
.args(create)
.env("HOME", home)
.env("XDG_CONFIG_HOME", home.join(".config"))
.env("XDG_DATA_HOME", &xdg)
.env("DEEDAR_URL", &named)
.env("DEEDAR_HOST_SIGNING_KEY", "off")
.env_remove("DEEDAR_HOST_KEY")
.current_dir(home)
.output()
.expect("deedar runs");
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
assert_eq!(String::from_utf8_lossy(&out.stderr), "");
assert!(other.is_dir());
assert!(!xdg.join("deedar/store").exists());
}
#[test]
fn a_file_path_is_not_a_store_and_exits_1() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let file = home.join("notes.txt");
std::fs::write(&file, b"not a store\n").unwrap();
let url = format!("file://{}", file.display());
let out = deedar(home, &["--url", &url, "list"]);
refused(
&out,
&format!(
"deedar: {} is not a store; `export DEEDAR_URL=file://PATH` or `deedar --url file://PATH`\n",
file.display()
),
);
}
#[cfg(unix)]
#[test]
fn a_bare_32_byte_value_with_a_separator_is_refused_and_names_the_seed_forms() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
let bare = "/tmp/a/b/c/d/e/f/g/h/i/j/k/l/m/n";
assert_eq!(bare.len(), 32);
let run = |value: &str| {
Command::new(env!("CARGO_BIN_EXE_deedar"))
.args([
"--url", &url, "create", "file", "--path", "x", "--agent", "you",
])
.env("HOME", home)
.env("XDG_CONFIG_HOME", home.join(".config"))
.env("XDG_DATA_HOME", home.join(".local/share"))
.env("DEEDAR_HOST_SIGNING_KEY", value)
.env_remove("DEEDAR_HOST_KEY")
.env_remove("DEEDAR_URL")
.current_dir(home)
.output()
.expect("deedar runs")
};
let out = run(bare);
assert_eq!(out.status.code(), Some(1));
let said = String::from_utf8(out.stderr).expect("stderr is utf8");
assert_eq!(said.lines().count(), 1, "{said}");
assert!(
said.contains(&format!("names {bare}, which is not a file")),
"{said}"
);
assert!(said.contains("`seed:` then the bytes"), "{said}");
assert!(said.contains("`hex:` then 64 hex digits"), "{said}");
let seed = run(&format!("seed:{bare}"));
assert!(
!String::from_utf8_lossy(&seed.stderr).contains("which is not a file"),
"{}",
String::from_utf8_lossy(&seed.stderr)
);
}
#[cfg(unix)]
#[test]
fn a_missing_signing_key_path_names_the_file_and_exits_1() {
use std::os::unix::ffi::OsStringExt;
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
let missing = home.join("absent.key");
let out = Command::new(env!("CARGO_BIN_EXE_deedar"))
.args([
"--url", &url, "create", "file", "--path", "x", "--agent", "you",
])
.env("HOME", home)
.env("XDG_CONFIG_HOME", home.join(".config"))
.env("XDG_DATA_HOME", home.join(".local/share"))
.env("DEEDAR_HOST_SIGNING_KEY", &missing)
.env_remove("DEEDAR_HOST_KEY")
.env_remove("DEEDAR_URL")
.current_dir(home)
.output()
.expect("deedar runs");
refused(
&out,
&format!(
"deedar: DEEDAR_HOST_SIGNING_KEY names {}, which is not a file; \
write 32 bytes there (`head -c 32 /dev/urandom > {}`) or set DEEDAR_HOST_SIGNING_KEY=off\n",
missing.display(),
missing.display()
),
);
let seed = std::ffi::OsString::from_vec(vec![0x11; 32]);
let out = Command::new(env!("CARGO_BIN_EXE_deedar"))
.args([
"--url",
&url,
"create",
"quote",
"--excerpt",
"seed",
"--src-url",
"https://example.invalid/edition",
"--agent",
"you",
])
.env("HOME", home)
.env("XDG_CONFIG_HOME", home.join(".config"))
.env("XDG_DATA_HOME", home.join(".local/share"))
.env("DEEDAR_HOST_SIGNING_KEY", seed)
.env_remove("DEEDAR_HOST_KEY")
.env_remove("DEEDAR_URL")
.current_dir(home)
.output()
.expect("deedar runs");
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
let host = Command::new(env!("CARGO_BIN_EXE_deedar"))
.args(["--url", &url, "host"])
.env("HOME", home)
.env("XDG_CONFIG_HOME", home.join(".config"))
.env("XDG_DATA_HOME", home.join(".local/share"))
.env(
"DEEDAR_HOST_SIGNING_KEY",
std::ffi::OsString::from_vec(vec![0x11; 32]),
)
.env_remove("DEEDAR_HOST_KEY")
.env_remove("DEEDAR_URL")
.current_dir(home)
.output()
.expect("deedar runs");
assert!(
host.status.success(),
"{}",
String::from_utf8_lossy(&host.stderr)
);
let said = String::from_utf8(host.stdout).expect("stdout is utf8");
let file = home.join("seed.key");
std::fs::write(&file, [0x11; 32]).unwrap();
let from_file = Command::new(env!("CARGO_BIN_EXE_deedar"))
.args(["--url", &url, "host"])
.env("HOME", home)
.env("XDG_CONFIG_HOME", home.join(".config"))
.env("XDG_DATA_HOME", home.join(".local/share"))
.env("DEEDAR_HOST_SIGNING_KEY", &file)
.env_remove("DEEDAR_HOST_KEY")
.env_remove("DEEDAR_URL")
.current_dir(home)
.output()
.expect("deedar runs");
assert!(
from_file.status.success(),
"{}",
String::from_utf8_lossy(&from_file.stderr)
);
let file_said = String::from_utf8(from_file.stdout).expect("stdout is utf8");
let key = file_said
.split_whitespace()
.find(|word| word.starts_with("ed25519:"))
.expect("public key")
.trim_end_matches(',');
assert!(said.contains(key), "{said}");
}
#[test]
fn create_names_the_flag_it_still_needs() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
let cases = [
(
vec!["--url", &url, "create", "file", "--path"],
"deedar: --path needs a value\n",
),
(
vec!["--url", &url, "create", "--agent", "you"],
"deedar: create needs a kind before the flags; `deedar create --help`\n",
),
(
vec!["--url", &url, "create", "quote", "--agent", "you"],
"deedar: create quote wants --excerpt TEXT and --src-url URL; `deedar create --help`\n",
),
(
vec!["--url", &url, "create", "mailDraft", "--agent", "you"],
"deedar: create mailDraft wants --message-id <local@domain>, --subject TEXT and --path FILE; `deedar create --help`\n",
),
];
for (args, stderr) in cases {
let out = deedar(home, &args);
refused(&out, stderr);
}
let missing = home.join("no-such-note.rs");
let out = deedar(
home,
&[
"--url",
&url,
"create",
"file",
"--path",
missing.to_str().unwrap(),
"--agent",
"you",
],
);
refused(
&out,
&format!(
"deedar: {} is not a file; --path needs a regular file\n",
missing.display()
),
);
}
#[test]
fn host_accept_with_no_key_names_how_to_write_one() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
let out = deedar(home, &["--url", &url, "host", "accept"]);
refused(
&out,
"deedar: host key: none; set DEEDAR_HOST_SIGNING_KEY to a 32-byte seed, \
or to a file of those bytes (`head -c 32 /dev/urandom > host.key`)\n",
);
assert!(
!String::from_utf8_lossy(&out.stderr).contains("ljos"),
"{}",
String::from_utf8_lossy(&out.stderr)
);
}
#[test]
fn timestamp_without_a_tsa_names_the_query_and_the_variable() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let url = store_url(home);
quote(home, &url, "deed-quote-survey");
let out = deedar(home, &["--url", &url, "timestamp", "deed-quote-survey"]);
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
assert_eq!(String::from_utf8_lossy(&out.stderr).as_ref(), "");
let tsq = home.join("store/deeds/deed-quote-survey.tsq");
assert!(tsq.is_file(), "{}", tsq.display());
assert_eq!(
String::from_utf8(out.stdout).expect("stdout is utf8"),
format!(
"timestamp {}; DEEDAR_TSA is unset, so this file is the query. \
Set DEEDAR_TSA to an RFC 3161 URL to write a .tsr\n",
tsq.display()
)
);
}
#[test]
fn a_url_that_is_not_a_path_names_the_input_and_exits_1() {
let home = tempfile::tempdir().unwrap();
let home = home.path();
let out = deedar(home, &["--url", "notapath", "list"]);
refused(
&out,
"deedar: notapath is not a store path; `export DEEDAR_URL=file://PATH` or `deedar --url file://PATH`\n",
);
}