obj-cli 1.0.0

Command-line tools (dump, check, stat, backup) for the obj embedded document database.
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

//! `obj dump` acceptance tests (issue #99).

use assert_cmd::Command;
use obj::{Db, Document};
use predicates::str::contains;
use serde::{Deserialize, Serialize};
use tempfile::TempDir;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
struct Note {
    title: String,
    body: String,
}

impl Document for Note {
    const COLLECTION: &'static str = "notes";
    const VERSION: u32 = 1;
}

#[test]
fn dump_default_header_format() {
    let dir = TempDir::new().expect("tmp");
    let path = dir.path().join("dump.obj");
    let db = Db::open(&path).expect("open");
    for i in 0..5u32 {
        db.insert(Note {
            title: format!("note-{i}"),
            body: format!("body-{i}"),
        })
        .expect("insert");
    }
    drop(db);

    Command::cargo_bin("obj")
        .expect("binary")
        .arg("dump")
        .arg(&path)
        .arg("--collection")
        .arg("notes")
        .assert()
        .success()
        .stdout(contains("## notes"))
        .stdout(contains("- id:"))
        .stdout(contains("collection_id:"))
        .stdout(contains("type_version:"))
        .stdout(contains("payload_len:"))
        .stdout(contains("payload_crc32c: 0x"))
        .stdout(contains("# emitted: 5"));
}

#[test]
fn dump_limit_truncates_output() {
    let dir = TempDir::new().expect("tmp");
    let path = dir.path().join("dump-limit.obj");
    let db = Db::open(&path).expect("open");
    for i in 0..10u32 {
        db.insert(Note {
            title: format!("note-{i}"),
            body: format!("body-{i}"),
        })
        .expect("insert");
    }
    drop(db);

    Command::cargo_bin("obj")
        .expect("binary")
        .arg("dump")
        .arg(&path)
        .arg("--collection")
        .arg("notes")
        .arg("--limit")
        .arg("3")
        .assert()
        .success()
        .stdout(contains("# emitted: 3"));
}

#[test]
fn dump_hex_format_includes_payload_bytes() {
    let dir = TempDir::new().expect("tmp");
    let path = dir.path().join("dump-hex.obj");
    let db = Db::open(&path).expect("open");
    db.insert(Note {
        title: "t".into(),
        body: "b".into(),
    })
    .expect("insert");
    drop(db);

    Command::cargo_bin("obj")
        .expect("binary")
        .arg("dump")
        .arg(&path)
        .arg("--collection")
        .arg("notes")
        .arg("--format")
        .arg("hex")
        .assert()
        .success()
        .stdout(contains("payload_hex:"));
}

#[test]
fn dump_missing_collection_exits_two() {
    let dir = TempDir::new().expect("tmp");
    let path = dir.path().join("dump-missing.obj");
    let db = Db::open(&path).expect("open");
    db.insert(Note {
        title: "t".into(),
        body: "b".into(),
    })
    .expect("insert");
    drop(db);

    Command::cargo_bin("obj")
        .expect("binary")
        .arg("dump")
        .arg(&path)
        .arg("--collection")
        .arg("does-not-exist")
        .assert()
        .code(2)
        .stderr(contains("error:"));
}