mkit-cli 0.4.2

The mkit command-line tool: a content-addressed VCS with native attestation support
Documentation
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
//! `--format=json` on the mutating commands unified by issue #710:
//! `commit`, `push`, `pull`, `fetch`, `merge`, `cherry-pick`, `revert`,
//! `rebase`, `stash`, `tag`, and `verify-attest`.
//!
//! One success-case test per command, plus the documented structured
//! failure shapes: CAS rejection for `push`, a conflict for
//! `merge`/`cherry-pick`/`revert`, and a bad signature for
//! `verify-attest`. Parsing is intentionally naive (`contains()` on the
//! known-deterministic key/value substrings) to match the existing
//! `tests/json_outputs.rs` / `tests/log_json.rs` convention, which
//! avoids pulling `serde_json` into the dev-dependency graph.
#![allow(clippy::unwrap_used)] // unwrap is the assertion in test helpers

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

fn mkit_bin() -> &'static str {
    env!("CARGO_BIN_EXE_mkit")
}

fn run_in(cwd: &Path, args: &[&str]) -> Output {
    let xdg = tempfile::tempdir().expect("xdg tempdir");
    let out = Command::new(mkit_bin())
        .args(args)
        .current_dir(cwd)
        .env("XDG_CONFIG_HOME", xdg.path())
        .output()
        .expect("spawn mkit");
    drop(xdg);
    out
}

fn stdout_of(out: &Output) -> String {
    String::from_utf8_lossy(&out.stdout).into_owned()
}

fn init_with_commit(content: &[u8]) -> tempfile::TempDir {
    let td = tempfile::tempdir().unwrap();
    assert!(run_in(td.path(), &["init"]).status.success());
    assert!(run_in(td.path(), &["keygen"]).status.success());
    fs::write(td.path().join("a.txt"), content).unwrap();
    assert!(run_in(td.path(), &["add", "a.txt"]).status.success());
    assert!(
        run_in(td.path(), &["commit", "-m", "initial"])
            .status
            .success()
    );
    td
}

fn file_url(dir: &Path) -> String {
    format!("mkit+file://{}", dir.display())
}

// -----------------------------------------------------------------------
// commit
// -----------------------------------------------------------------------

#[test]
fn commit_json_emits_hash_and_parents_on_success() {
    let td = tempfile::tempdir().unwrap();
    assert!(run_in(td.path(), &["init"]).status.success());
    assert!(run_in(td.path(), &["keygen"]).status.success());
    fs::write(td.path().join("a.txt"), b"hello").unwrap();
    assert!(run_in(td.path(), &["add", "a.txt"]).status.success());
    let out = run_in(td.path(), &["commit", "-m", "first", "--format=json"]);
    assert!(out.status.success(), "commit failed: {out:?}");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":true"), "{stdout}");
    assert!(stdout.contains("\"parents\":[]"), "root commit: {stdout}");
    assert!(stdout.contains("\"is_root\":true"), "{stdout}");
    assert!(stdout.contains("\"subject\":\"first\""), "{stdout}");
}

// -----------------------------------------------------------------------
// push
// -----------------------------------------------------------------------

#[test]
fn push_json_emits_ref_update_on_success() {
    let td = init_with_commit(b"hi");
    let remote = tempfile::tempdir().unwrap();
    let url = file_url(remote.path());
    assert!(
        run_in(td.path(), &["remote", "add", "origin", &url])
            .status
            .success()
    );
    let out = run_in(td.path(), &["push", "origin", "--format=json"]);
    assert!(out.status.success(), "push failed: {out:?}");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":true"), "{stdout}");
    assert!(stdout.contains("\"remote\":\"origin\""), "{stdout}");
    assert!(stdout.contains("\"up_to_date\":false"), "{stdout}");
}

#[test]
fn push_json_reports_non_fast_forward_rejection() {
    let td = init_with_commit(b"hi");
    let remote = tempfile::tempdir().unwrap();
    let url = file_url(remote.path());
    assert!(
        run_in(td.path(), &["remote", "add", "origin", &url])
            .status
            .success()
    );
    assert!(run_in(td.path(), &["push", "origin"]).status.success());

    // Simulate the remote moving forward independently so our cached
    // tracking ref no longer matches (same recipe as
    // push_named_remote.rs's non_fast_forward_push_is_rejected_without_force).
    let other = "0".repeat(64);
    fs::write(remote.path().join("refs/heads/main"), format!("{other}\n")).unwrap();

    fs::write(td.path().join("a.txt"), b"hi2").unwrap();
    assert!(run_in(td.path(), &["add", "a.txt"]).status.success());
    assert!(run_in(td.path(), &["commit", "-m", "c2"]).status.success());

    let out = run_in(td.path(), &["push", "--format=json"]);
    assert!(!out.status.success(), "non-ff push must be rejected");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":false"), "{stdout}");
    assert!(stdout.contains("\"rejected\":true"), "{stdout}");
}

// -----------------------------------------------------------------------
// pull / fetch
// -----------------------------------------------------------------------

#[test]
fn pull_json_reports_fast_forward() {
    let td = init_with_commit(b"hi");
    let remote = tempfile::tempdir().unwrap();
    let url = file_url(remote.path());
    assert!(run_in(td.path(), &["remote", "add", &url]).status.success());
    assert!(run_in(td.path(), &["push"]).status.success());

    let clone = tempfile::tempdir().unwrap();
    assert!(run_in(clone.path(), &["init"]).status.success());
    assert!(run_in(clone.path(), &["keygen"]).status.success());
    assert!(
        run_in(clone.path(), &["remote", "add", &url])
            .status
            .success()
    );
    assert!(run_in(clone.path(), &["pull"]).status.success());

    // Advance the origin repo and push again, then pull with --format=json
    // in the clone to observe a real (non-no-op) fast-forward.
    fs::write(td.path().join("a.txt"), b"hi2").unwrap();
    assert!(run_in(td.path(), &["add", "a.txt"]).status.success());
    assert!(run_in(td.path(), &["commit", "-m", "c2"]).status.success());
    assert!(run_in(td.path(), &["push"]).status.success());

    let out = run_in(clone.path(), &["pull", "--format=json"]);
    assert!(out.status.success(), "pull failed: {out:?}");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":true"), "{stdout}");
    assert!(stdout.contains("\"up_to_date\":false"), "{stdout}");
}

#[test]
fn fetch_json_lists_updated_tracking_refs() {
    let td = init_with_commit(b"hi");
    let remote = tempfile::tempdir().unwrap();
    let url = file_url(remote.path());
    assert!(run_in(td.path(), &["remote", "add", &url]).status.success());
    assert!(run_in(td.path(), &["push"]).status.success());

    let clone = tempfile::tempdir().unwrap();
    assert!(run_in(clone.path(), &["init"]).status.success());
    assert!(run_in(clone.path(), &["keygen"]).status.success());
    assert!(
        run_in(clone.path(), &["remote", "add", &url])
            .status
            .success()
    );
    let out = run_in(clone.path(), &["fetch", "--format=json"]);
    assert!(out.status.success(), "fetch failed: {out:?}");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":true"), "{stdout}");
    assert!(stdout.contains("\"updated\":["), "{stdout}");
}

// -----------------------------------------------------------------------
// merge
// -----------------------------------------------------------------------

fn init_two_branches_with_conflict(td: &Path) {
    assert!(run_in(td, &["init"]).status.success());
    assert!(run_in(td, &["keygen"]).status.success());
    fs::write(td.join("a.txt"), b"base\n").unwrap();
    assert!(run_in(td, &["add", "a.txt"]).status.success());
    assert!(run_in(td, &["commit", "-m", "base"]).status.success());
    assert!(run_in(td, &["branch", "feature"]).status.success());

    fs::write(td.join("a.txt"), b"main change\n").unwrap();
    assert!(run_in(td, &["add", "a.txt"]).status.success());
    assert!(
        run_in(td, &["commit", "-m", "main change"])
            .status
            .success()
    );

    assert!(run_in(td, &["checkout", "feature"]).status.success());
    fs::write(td.join("a.txt"), b"feature change\n").unwrap();
    assert!(run_in(td, &["add", "a.txt"]).status.success());
    assert!(
        run_in(td, &["commit", "-m", "feature change"])
            .status
            .success()
    );
    assert!(run_in(td, &["checkout", "main"]).status.success());
}

#[test]
fn merge_json_fast_forward_success() {
    let td = tempfile::tempdir().unwrap();
    assert!(run_in(td.path(), &["init"]).status.success());
    assert!(run_in(td.path(), &["keygen"]).status.success());
    fs::write(td.path().join("a.txt"), b"base").unwrap();
    assert!(run_in(td.path(), &["add", "a.txt"]).status.success());
    assert!(
        run_in(td.path(), &["commit", "-m", "base"])
            .status
            .success()
    );
    assert!(run_in(td.path(), &["branch", "feature"]).status.success());
    assert!(run_in(td.path(), &["checkout", "feature"]).status.success());
    fs::write(td.path().join("a.txt"), b"feature").unwrap();
    assert!(run_in(td.path(), &["add", "a.txt"]).status.success());
    assert!(
        run_in(td.path(), &["commit", "-m", "feature"])
            .status
            .success()
    );
    assert!(run_in(td.path(), &["checkout", "main"]).status.success());

    let out = run_in(td.path(), &["merge", "feature", "--format=json"]);
    assert!(out.status.success(), "merge failed: {out:?}");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":true"), "{stdout}");
    assert!(stdout.contains("\"kind\":\"fast-forward\""), "{stdout}");
}

#[test]
fn merge_json_reports_conflict() {
    let td = tempfile::tempdir().unwrap();
    init_two_branches_with_conflict(td.path());

    let out = run_in(td.path(), &["merge", "feature", "--format=json"]);
    assert!(!out.status.success(), "conflicting merge must fail");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":false"), "{stdout}");
    assert!(stdout.contains("\"kind\":\"conflict\""), "{stdout}");
    assert!(stdout.contains("\"conflicts\":[\"a.txt\"]"), "{stdout}");
}

// -----------------------------------------------------------------------
// cherry-pick
// -----------------------------------------------------------------------

#[test]
fn cherry_pick_json_success() {
    let td = tempfile::tempdir().unwrap();
    assert!(run_in(td.path(), &["init"]).status.success());
    assert!(run_in(td.path(), &["keygen"]).status.success());
    fs::write(td.path().join("a.txt"), b"base").unwrap();
    assert!(run_in(td.path(), &["add", "a.txt"]).status.success());
    assert!(
        run_in(td.path(), &["commit", "-m", "base"])
            .status
            .success()
    );
    assert!(run_in(td.path(), &["branch", "feature"]).status.success());
    assert!(run_in(td.path(), &["checkout", "feature"]).status.success());
    fs::write(td.path().join("b.txt"), b"new file").unwrap();
    assert!(run_in(td.path(), &["add", "b.txt"]).status.success());
    assert!(
        run_in(td.path(), &["commit", "-m", "add b"])
            .status
            .success()
    );
    let picked = fs::read_to_string(td.path().join(".mkit/refs/heads/feature"))
        .unwrap()
        .trim()
        .to_string();
    assert!(run_in(td.path(), &["checkout", "main"]).status.success());

    let out = run_in(td.path(), &["cherry-pick", &picked, "--format=json"]);
    assert!(out.status.success(), "cherry-pick failed: {out:?}");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":true"), "{stdout}");
    assert!(stdout.contains("\"kind\":\"commit\""), "{stdout}");
    assert!(
        stdout.contains(&format!("\"picked\":\"{picked}\"")),
        "{stdout}"
    );
}

#[test]
fn cherry_pick_json_reports_conflict() {
    let td = tempfile::tempdir().unwrap();
    init_two_branches_with_conflict(td.path());
    let picked = fs::read_to_string(td.path().join(".mkit/refs/heads/feature"))
        .unwrap()
        .trim()
        .to_string();

    let out = run_in(td.path(), &["cherry-pick", &picked, "--format=json"]);
    assert!(!out.status.success(), "conflicting pick must fail");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":false"), "{stdout}");
    assert!(stdout.contains("\"kind\":\"conflict\""), "{stdout}");
    assert!(stdout.contains("\"conflicts\":[\"a.txt\"]"), "{stdout}");
}

// -----------------------------------------------------------------------
// revert
// -----------------------------------------------------------------------

#[test]
fn revert_json_success() {
    let td = init_with_commit(b"hi");
    let head = fs::read_to_string(td.path().join(".mkit/refs/heads/main"))
        .unwrap()
        .trim()
        .to_string();
    let out = run_in(td.path(), &["revert", &head, "--format=json"]);
    assert!(out.status.success(), "revert failed: {out:?}");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":true"), "{stdout}");
    assert!(stdout.contains("\"kind\":\"commit\""), "{stdout}");
    assert!(
        stdout.contains(&format!("\"reverted\":\"{head}\"")),
        "{stdout}"
    );
}

// -----------------------------------------------------------------------
// stash
// -----------------------------------------------------------------------

#[test]
fn stash_json_save_list_pop_roundtrip() {
    let td = init_with_commit(b"hi");
    fs::write(td.path().join("a.txt"), b"dirty").unwrap();

    let save = run_in(td.path(), &["stash", "save", "-m", "wip", "--format=json"]);
    assert!(save.status.success(), "stash save failed: {save:?}");
    let save_out = stdout_of(&save);
    assert!(save_out.contains("\"ok\":true"), "{save_out}");
    assert!(save_out.contains("\"kind\":\"save\""), "{save_out}");

    let list = run_in(td.path(), &["stash", "list", "--format=json"]);
    assert!(list.status.success());
    let list_out = stdout_of(&list);
    assert!(list_out.contains("\"index\":0"), "{list_out}");
    assert!(
        list_out.contains("\"message\":\"On main: wip\""),
        "{list_out}"
    );

    let pop = run_in(td.path(), &["stash", "pop", "--format=json"]);
    assert!(pop.status.success(), "stash pop failed: {pop:?}");
    let pop_out = stdout_of(&pop);
    assert!(pop_out.contains("\"ok\":true"), "{pop_out}");
    assert!(pop_out.contains("\"kind\":\"pop\""), "{pop_out}");
}

// -----------------------------------------------------------------------
// tag
// -----------------------------------------------------------------------

#[test]
fn tag_json_lightweight_create_and_list() {
    let td = init_with_commit(b"hi");
    let create = run_in(td.path(), &["tag", "v1", "--format=json"]);
    assert!(create.status.success(), "tag create failed: {create:?}");
    let create_out = stdout_of(&create);
    assert!(create_out.contains("\"ok\":true"), "{create_out}");
    assert!(
        create_out.contains("\"kind\":\"lightweight\""),
        "{create_out}"
    );
    assert!(create_out.contains("\"name\":\"v1\""), "{create_out}");

    let list = run_in(td.path(), &["tag", "--format=json"]);
    assert!(list.status.success());
    let list_out = stdout_of(&list);
    assert!(list_out.contains("\"name\":\"v1\""), "{list_out}");
    assert!(list_out.contains("\"annotated\":false"), "{list_out}");
}

// -----------------------------------------------------------------------
// verify-attest
// -----------------------------------------------------------------------

fn hex_decode(s: &str) -> Vec<u8> {
    (0..s.len())
        .step_by(2)
        .map(|i| u8::from_str_radix(&s[i..i + 2], 16).unwrap())
        .collect()
}

#[test]
fn verify_attest_json_reports_verified_signature() {
    let td = init_with_commit(b"hi");
    let pubkey = run_in(td.path(), &["keygen", "--print-pubkey"]);
    // `keygen` already ran once via `init_with_commit`; re-running with
    // `--print-pubkey` on an existing key just prints it back out
    // (idempotent read path), so this does not rotate the key.
    assert!(pubkey.status.success(), "keygen --print-pubkey: {pubkey:?}");
    let printed = stdout_of(&pubkey).trim().to_string();
    let hex = printed.strip_prefix("ed25519:").unwrap().to_string();

    let attest = run_in(td.path(), &["attest", "--algorithm", "ed25519"]);
    assert!(attest.status.success(), "attest failed: {attest:?}");

    // The repo-key signer's DSSE signature carries a `blake3:<digest>`
    // keyid (digest of the raw pubkey bytes), not `ed25519:<hex>` — see
    // `keyid_matches_pubkey` in `commands/verify_attest.rs`.
    let pk_bytes = hex_decode(&hex);
    let digest = mkit_core::hash::hash(&pk_bytes);
    let keyid = format!("blake3:{}", mkit_core::hash::to_hex(&digest));

    let trust_roots = td.path().join("trust-roots.toml");
    fs::write(
        &trust_roots,
        format!(
            "[[trust_root]]\nkeyid = \"{keyid}\"\nkind = \"ed25519\"\npubkey_hex = \"{hex}\"\n"
        ),
    )
    .unwrap();

    let out = run_in(
        td.path(),
        &[
            "verify-attest",
            "--trust-roots",
            trust_roots.to_str().unwrap(),
            "--format=json",
        ],
    );
    assert!(out.status.success(), "verify-attest failed: {out:?}");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":true"), "{stdout}");
    assert!(stdout.contains("\"verified\":true"), "{stdout}");
}

#[test]
fn verify_attest_json_reports_unverified_signature_for_unknown_keyid() {
    let td = init_with_commit(b"hi");
    let attest = run_in(td.path(), &["attest", "--algorithm", "ed25519"]);
    assert!(attest.status.success(), "attest failed: {attest:?}");

    // Trust-roots naming a DIFFERENT (fabricated) key: the real
    // signature's keyid won't resolve, so it reports UnknownKeyid /
    // verified:false rather than "ok".
    let bogus_hex = "ab".repeat(32);
    let trust_roots = td.path().join("trust-roots.toml");
    fs::write(
        &trust_roots,
        format!(
            "[[trust_root]]\nkeyid = \"ed25519:{bogus_hex}\"\nkind = \"ed25519\"\npubkey_hex = \"{bogus_hex}\"\n"
        ),
    )
    .unwrap();

    let out = run_in(
        td.path(),
        &[
            "verify-attest",
            "--trust-roots",
            trust_roots.to_str().unwrap(),
            "--format=json",
        ],
    );
    assert!(
        !out.status.success(),
        "unverifiable attestation must not exit 0"
    );
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":false"), "{stdout}");
    assert!(stdout.contains("\"verified\":false"), "{stdout}");
}

// -----------------------------------------------------------------------
// rebase
// -----------------------------------------------------------------------

#[test]
fn rebase_json_reports_up_to_date() {
    let td = init_with_commit(b"hi");
    assert!(run_in(td.path(), &["branch", "feature"]).status.success());
    let out = run_in(td.path(), &["rebase", "feature", "--format=json"]);
    assert!(out.status.success(), "rebase failed: {out:?}");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":true"), "{stdout}");
    assert!(stdout.contains("\"kind\":\"up-to-date\""), "{stdout}");
}

#[test]
fn rebase_json_reports_conflict() {
    let td = tempfile::tempdir().unwrap();
    init_two_branches_with_conflict(td.path());
    // On `main`, rebase onto `feature` — replays main's own commit
    // (the divergent `a.txt` change) on top of feature's tip, conflicting.
    let out = run_in(td.path(), &["rebase", "feature", "--format=json"]);
    assert!(!out.status.success(), "conflicting rebase must fail");
    let stdout = stdout_of(&out);
    assert!(stdout.contains("\"ok\":false"), "{stdout}");
    assert!(stdout.contains("\"kind\":\"conflict\""), "{stdout}");
}