doiget-cli 0.5.0

doiget CLI binary
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
// allow: outbound-network
//! End-to-end tests for `doiget version [--check]`.
//!
//! The `--check` tests spin up a wiremock server and pass
//! `DOIGET_GITHUB_BASE=<mock-uri>` to the subprocess so no real GitHub
//! network calls are made.

#![allow(clippy::expect_used, clippy::unwrap_used, clippy::panic)]

use assert_cmd::Command;
use predicates::str::contains;
use tempfile::TempDir;
use wiremock::matchers::{method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

fn doiget(dir: &TempDir) -> Command {
    let mut cmd = Command::cargo_bin("doiget").expect("locate doiget binary");
    let p = dir.path().to_str().expect("tempdir path utf-8");
    cmd.env("HOME", p)
        .env("USERPROFILE", p)
        // Non-TTY implicit-quiet override — without this the ADR-0017
        // resolver falls back to Quiet in captured-stdout contexts.
        .env("DOIGET_MODE", "human");
    cmd
}

fn releases_body(tag: &str, draft: bool, prerelease: bool) -> serde_json::Value {
    serde_json::json!([{
        "tag_name":  tag,
        "html_url":  format!("https://github.com/sotashimozono/doiget/releases/tag/{tag}"),
        "draft":     draft,
        "prerelease": prerelease,
    }])
}

// ---------------------------------------------------------------------------
// doiget version (no --check)
// ---------------------------------------------------------------------------

#[test]
fn version_no_flag_prints_human_line() {
    let dir = TempDir::new().expect("tempdir");
    doiget(&dir)
        .arg("version")
        .assert()
        .success()
        .stdout(contains("doiget "));
}

#[test]
fn version_json_mode_emits_version_key() {
    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--mode", "json"])
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let v: serde_json::Value = serde_json::from_slice(&out).expect("stdout is valid JSON");
    assert!(
        v.get("version").and_then(|v| v.as_str()).is_some(),
        "json output must have a `version` string field; got: {v}"
    );
}

#[test]
fn version_quiet_mode_produces_no_stdout() {
    let dir = TempDir::new().expect("tempdir");
    doiget(&dir)
        .args(["version", "--quiet"])
        .assert()
        .success()
        .stdout("");
}

// ---------------------------------------------------------------------------
// doiget version --check  (wiremock-driven)
// ---------------------------------------------------------------------------

#[tokio::test]
async fn version_check_newer_available_human_output() {
    let server = MockServer::start().await;
    // v1.0.0 is numerically greater than any 0.x.y build.
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(releases_body("v1.0.0", false, false)),
        )
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let s = String::from_utf8(out).unwrap();
    assert!(
        s.contains("update available") || s.contains("1.0.0"),
        "expected update-available message; got: {s:?}"
    );
}

#[tokio::test]
async fn version_check_up_to_date_human_output() {
    let server = MockServer::start().await;
    // v0.1.0 is older than any current build (>= 0.4.x).
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(releases_body("v0.1.0", false, false)),
        )
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let s = String::from_utf8(out).unwrap();
    assert!(
        s.contains("up to date") || s.contains("0.1.0"),
        "expected up-to-date message; got: {s:?}"
    );
}

#[tokio::test]
async fn version_check_json_mode_emits_structured_object() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(releases_body("v1.0.0", false, false)),
        )
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check", "--mode", "json"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let v: serde_json::Value =
        serde_json::from_slice(&out).expect("--check --mode json stdout is valid JSON");
    assert!(v.get("current").is_some(), "must have `current`; got: {v}");
    assert!(v.get("latest").is_some(), "must have `latest`; got: {v}");
    assert!(
        v.get("newer_available").is_some(),
        "must have `newer_available`; got: {v}"
    );
    assert!(
        v.get("html_url").is_some(),
        "must have `html_url`; got: {v}"
    );
    assert_eq!(
        v["newer_available"],
        serde_json::json!(true),
        "v1.0.0 must be newer than current build; got: {v}"
    );
}

#[tokio::test]
async fn version_check_skips_draft_releases() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(releases_body("v9.0.0", true, false)),
        )
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check", "--mode", "json"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let v: serde_json::Value = serde_json::from_slice(&out).unwrap();
    assert!(
        v["latest"].is_null(),
        "draft releases must not surface as latest; got: {v}"
    );
    assert!(v.get("error").is_some(), "must report an error; got: {v}");
}

#[tokio::test]
async fn version_check_skips_prerelease_flag_releases() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(releases_body("v9.0.0", false, true)),
        )
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check", "--mode", "json"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let v: serde_json::Value = serde_json::from_slice(&out).unwrap();
    assert!(
        v["latest"].is_null(),
        "prerelease=true releases must not surface; got: {v}"
    );
}

#[tokio::test]
async fn version_check_skips_tags_with_beta_suffix() {
    let server = MockServer::start().await;
    // draft=false, prerelease=false, but tag has -beta — must be filtered.
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(serde_json::json!([{
                "tag_name":   "v9.0.0-beta.1",
                "html_url":   "https://github.com/sotashimozono/doiget/releases/tag/v9.0.0-beta.1",
                "draft":      false,
                "prerelease": false,
            }])),
        )
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check", "--mode", "json"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let v: serde_json::Value = serde_json::from_slice(&out).unwrap();
    assert!(
        v["latest"].is_null(),
        "-beta tag must be filtered even when prerelease=false; got: {v}"
    );
}

#[tokio::test]
async fn version_check_picks_first_stable_skipping_unstable() {
    let server = MockServer::start().await;
    // First entry is a draft; second is the stable release to pick.
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!([
            {
                "tag_name":   "v10.0.0",
                "html_url":   "https://github.com/example/releases/tag/v10.0.0",
                "draft":      true,
                "prerelease": false,
            },
            {
                "tag_name":   "v0.9.0",
                "html_url":   "https://github.com/sotashimozono/doiget/releases/tag/v0.9.0",
                "draft":      false,
                "prerelease": false,
            }
        ])))
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check", "--mode", "json"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let v: serde_json::Value = serde_json::from_slice(&out).unwrap();
    assert_eq!(
        v["latest"].as_str(),
        Some("0.9.0"),
        "must pick v0.9.0, skipping draft v10.0.0; got: {v}"
    );
}

#[tokio::test]
async fn version_check_rate_limited_json_reports_error() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(ResponseTemplate::new(403))
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check", "--mode", "json"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success() // must never hard-fail on a network error
        .get_output()
        .stdout
        .clone();
    let v: serde_json::Value = serde_json::from_slice(&out).unwrap();
    assert!(
        v["latest"].is_null(),
        "rate-limited must return null latest; got: {v}"
    );
    assert_eq!(
        v["error"].as_str(),
        Some("rate_limited"),
        "must report rate_limited; got: {v}"
    );
}

#[tokio::test]
async fn version_check_rate_limited_human_exits_zero() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(ResponseTemplate::new(403))
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    doiget(&dir)
        .args(["version", "--check"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .stdout(contains("version check failed"));
}

#[tokio::test]
async fn version_check_empty_releases_reports_error() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!([])))
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check", "--mode", "json"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let v: serde_json::Value = serde_json::from_slice(&out).unwrap();
    assert!(
        v.get("error").is_some(),
        "empty releases must report error; got: {v}"
    );
    assert!(v["latest"].is_null(), "latest must be null; got: {v}");
}

#[tokio::test]
async fn version_check_quiet_suppresses_network_call() {
    // With --quiet the command must exit 0 and produce no stdout,
    // even when --check is also passed. The mock is intentionally not
    // mounted: if the subprocess made a network call it would fail or
    // produce output, both of which would cause the assertion to fail.
    let dir = TempDir::new().expect("tempdir");
    doiget(&dir)
        .args(["version", "--check", "--quiet"])
        // Point at localhost on a port with no listener; any actual
        // network attempt would surface as an error, not silence.
        .env("DOIGET_GITHUB_BASE", "http://127.0.0.1:1")
        .assert()
        .success()
        .stdout("");
}

#[tokio::test]
async fn version_check_newer_available_human_prints_release_url() {
    let server = MockServer::start().await;
    let tag = "v1.0.0";
    let expected_url = format!("https://github.com/sotashimozono/doiget/releases/tag/{tag}");
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(ResponseTemplate::new(200).set_body_json(releases_body(tag, false, false)))
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    doiget(&dir)
        .args(["version", "--check"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .stdout(contains(&expected_url));
}

#[tokio::test]
async fn version_check_json_up_to_date_newer_available_false() {
    let server = MockServer::start().await;
    // v0.1.0 is older than any current build — newer_available must be false.
    Mock::given(method("GET"))
        .and(path("/repos/sotashimozono/doiget/releases"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(releases_body("v0.1.0", false, false)),
        )
        .mount(&server)
        .await;

    let dir = TempDir::new().expect("tempdir");
    let out = doiget(&dir)
        .args(["version", "--check", "--mode", "json"])
        .env("DOIGET_GITHUB_BASE", server.uri())
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let v: serde_json::Value = serde_json::from_slice(&out).unwrap();
    assert_eq!(
        v["newer_available"],
        serde_json::json!(false),
        "v0.1.0 must not be reported as newer; got: {v}"
    );
    assert!(v.get("error").is_none(), "no error on success; got: {v}");
}