deedar-cli 0.7.0

Operator path: deedar create/get/list/trail/evidence/delete/leave/timestamp/current/migrate
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
//! Refusals name the input and the next command.
//!
//! An unknown accession, a prefix of several accessions, an unset
//! `DEEDAR_URL`, and a path that is not a store used to end in a short
//! line. Each of these is one stderr line and exit 1.

use std::path::Path;
use std::process::{Command, Output};

fn deedar(home: &Path, args: &[&str]) -> Output {
    deedar_xdg(home, &home.join(".local/share"), args)
}

/// `XDG_DATA_HOME` is its own directory, so a test can tell the seat store
/// from the home-directory fallback.
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")
        .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)
        ),
    );
}

/// Nine deeds share a prefix. The line names eight, in byte order, and the
/// count says the ninth is there.
#[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");
}

/// The first create on a fresh machine stores the deed and names the seat path.
///
/// `$XDG_DATA_HOME/deedar/store` is one fixed directory, so making it cannot
/// split citations the way a store in the working directory would. A second
/// create finds the directory and stays quiet.
#[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)
    );
}

/// The first import makes the same seat store, and says so once.
#[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), "");
}

/// A store the seat named is created with no seat-store line.
#[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()
        ),
    );
}

#[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",
    );
}