shiplog 0.9.0

CLI evidence compiler for review-cycle packets with receipts, coverage, gaps, and safe share profiles.
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

//! Cross-platform path handling tests for the shiplog CLI.
//!
//! Ensures the CLI correctly handles path arguments with spaces, unicode,
//! and special characters on all platforms.

use assert_cmd::Command;
use std::path::{Path, PathBuf};
use tempfile::TempDir;

fn shiplog_cmd() -> Command {
    Command::from_std(std::process::Command::new(env!("CARGO_BIN_EXE_shiplog")))
}

fn fixture_dir() -> PathBuf {
    Path::new(env!("CARGO_MANIFEST_DIR"))
        .join("../..")
        .join("examples/fixture")
}

// ---------------------------------------------------------------------------
// collect json with spaces in --out path
// ---------------------------------------------------------------------------

#[test]
fn collect_json_with_spaces_in_out_path() {
    let tmp = TempDir::new().unwrap();
    let out = tmp.path().join("output with spaces");
    let fixtures = fixture_dir();

    shiplog_cmd()
        .args([
            "collect",
            "--out",
            out.to_str().unwrap(),
            "json",
            "--events",
            fixtures.join("ledger.events.jsonl").to_str().unwrap(),
            "--coverage",
            fixtures.join("coverage.manifest.json").to_str().unwrap(),
        ])
        .assert()
        .success();

    let run_dir = out.join("run_fixture");
    assert!(
        run_dir.join("packet.md").exists(),
        "packet.md missing with spaces in --out path"
    );
    assert!(run_dir.join("ledger.events.jsonl").exists());
    assert!(run_dir.join("coverage.manifest.json").exists());
    assert!(run_dir.join("bundle.manifest.json").exists());
}

// ---------------------------------------------------------------------------
// collect json with unicode in --out path
// ---------------------------------------------------------------------------

#[test]
fn collect_json_with_unicode_in_out_path() {
    let tmp = TempDir::new().unwrap();
    let out = tmp.path().join("données_出力");
    let fixtures = fixture_dir();

    shiplog_cmd()
        .args([
            "collect",
            "--out",
            out.to_str().unwrap(),
            "json",
            "--events",
            fixtures.join("ledger.events.jsonl").to_str().unwrap(),
            "--coverage",
            fixtures.join("coverage.manifest.json").to_str().unwrap(),
        ])
        .assert()
        .success();

    let run_dir = out.join("run_fixture");
    assert!(
        run_dir.join("packet.md").exists(),
        "packet.md missing with unicode in --out path"
    );
}

// ---------------------------------------------------------------------------
// collect json with special characters in --out path
// ---------------------------------------------------------------------------

#[test]
fn collect_json_with_special_chars_in_out_path() {
    let tmp = TempDir::new().unwrap();
    let out = tmp.path().join("project (v2.0-beta)");
    let fixtures = fixture_dir();

    shiplog_cmd()
        .args([
            "collect",
            "--out",
            out.to_str().unwrap(),
            "json",
            "--events",
            fixtures.join("ledger.events.jsonl").to_str().unwrap(),
            "--coverage",
            fixtures.join("coverage.manifest.json").to_str().unwrap(),
        ])
        .assert()
        .success();

    let run_dir = out.join("run_fixture");
    assert!(run_dir.join("packet.md").exists());
}

// ---------------------------------------------------------------------------
// render with spaces in --out path (after collect)
// ---------------------------------------------------------------------------

#[test]
fn render_with_spaces_in_out_path() {
    let tmp = TempDir::new().unwrap();
    let out = tmp.path().join("render output dir");
    let fixtures = fixture_dir();

    // First, collect
    shiplog_cmd()
        .args([
            "collect",
            "--out",
            out.to_str().unwrap(),
            "json",
            "--events",
            fixtures.join("ledger.events.jsonl").to_str().unwrap(),
            "--coverage",
            fixtures.join("coverage.manifest.json").to_str().unwrap(),
        ])
        .assert()
        .success();

    let run_dir = out.join("run_fixture");
    assert!(run_dir.join("packet.md").exists());

    // Then, render with the same spaced path
    shiplog_cmd()
        .args([
            "render",
            "--out",
            out.to_str().unwrap(),
            "--run",
            "run_fixture",
            "--user",
            "tester",
        ])
        .assert()
        .success();

    assert!(
        run_dir.join("packet.md").exists(),
        "packet.md should exist after re-render with spaces in path"
    );
}

// ---------------------------------------------------------------------------
// import with spaces in path
// ---------------------------------------------------------------------------

#[test]
fn import_with_spaces_in_paths() {
    let tmp = TempDir::new().unwrap();
    let out = tmp.path().join("import output dir");
    let fixtures = fixture_dir();

    // First collect to create a run directory with ledger artifacts
    shiplog_cmd()
        .args([
            "collect",
            "--out",
            out.to_str().unwrap(),
            "json",
            "--events",
            fixtures.join("ledger.events.jsonl").to_str().unwrap(),
            "--coverage",
            fixtures.join("coverage.manifest.json").to_str().unwrap(),
        ])
        .assert()
        .success();

    let run_dir = out.join("run_fixture");

    // Import from that run directory using --dir (the correct flag)
    let import_out = tmp.path().join("import dest dir");
    shiplog_cmd()
        .args([
            "import",
            "--dir",
            run_dir.to_str().unwrap(),
            "--out",
            import_out.to_str().unwrap(),
        ])
        .assert()
        .success();
}

// ---------------------------------------------------------------------------
// Deeply nested --out path
// ---------------------------------------------------------------------------

#[test]
fn collect_json_with_deeply_nested_out_path() {
    let tmp = TempDir::new().unwrap();
    let out = tmp
        .path()
        .join("level1")
        .join("level2")
        .join("level3")
        .join("output");
    let fixtures = fixture_dir();

    shiplog_cmd()
        .args([
            "collect",
            "--out",
            out.to_str().unwrap(),
            "json",
            "--events",
            fixtures.join("ledger.events.jsonl").to_str().unwrap(),
            "--coverage",
            fixtures.join("coverage.manifest.json").to_str().unwrap(),
        ])
        .assert()
        .success();

    let run_dir = out.join("run_fixture");
    assert!(run_dir.join("packet.md").exists());
}