bzr 0.4.0

A CLI for Bugzilla, inspired by gh
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
#![expect(clippy::unwrap_used)]

use wiremock::matchers::{body_json, method, path, query_param};
use wiremock::{Mock, MockServer, ResponseTemplate};

use crate::client::test_helpers::{test_client, test_client_hybrid, test_client_xmlrpc};

#[tokio::test]
async fn update_comment_tags_sends_put() {
    let mock = MockServer::start().await;
    Mock::given(method("PUT"))
        .and(path("/rest/bug/comment/42/tags"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(serde_json::json!(["needinfo", "reviewed"])),
        )
        .expect(1)
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let params = crate::types::UpdateCommentTagsParams {
        add: vec!["needinfo".into()],
        ..Default::default()
    };
    let tags = client.update_comment_tags(42, &params).await.unwrap();
    assert_eq!(tags, vec!["needinfo", "reviewed"]);
}

#[tokio::test]
async fn search_comment_tags_returns_matches() {
    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/comment/tags/need"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(serde_json::json!(["needinfo", "needreview"])),
        )
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let tags = client.search_comment_tags("need").await.unwrap();
    assert_eq!(tags, vec!["needinfo", "needreview"]);
}

#[tokio::test]
async fn get_comments_since_filters_by_date() {
    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/1/comment"))
        .and(query_param("new_since", "2025-01-01T00:00:00Z"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "bugs": {
                "1": {
                    "comments": [
                        {"id": 5, "bug_id": 1, "text": "new comment", "count": 3}
                    ]
                }
            }
        })))
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let comments = client
        .get_comments_since(1, Some("2025-01-01T00:00:00Z"))
        .await
        .unwrap();
    assert_eq!(comments.len(), 1);
    assert_eq!(comments[0].text, "new comment");
}

fn comments_response_json(counts: &[u64]) -> serde_json::Value {
    let comments: Vec<serde_json::Value> = counts
        .iter()
        .map(|&c| {
            serde_json::json!({
                "id": 1000 + c,
                "bug_id": 42,
                "count": c,
                "text": format!("comment {c}"),
                "creator": "alice@test",
                "creation_time": "2026-01-01T00:00:00Z",
                "is_private": c % 2 == 1
            })
        })
        .collect();
    serde_json::json!({"bugs": {"42": {"comments": comments}}})
}

fn xmlrpc_comments_response(counts: &[u64]) -> String {
    use std::fmt::Write;
    let mut entries = String::new();
    for &c in counts {
        write!(
            entries,
            "<value><struct>\
                <member><name>id</name><value><int>{id}</int></value></member>\
                <member><name>bug_id</name><value><int>42</int></value></member>\
                <member><name>count</name><value><int>{c}</int></value></member>\
                <member><name>text</name><value><string>xmlrpc {c}</string></value></member>\
                <member><name>is_private</name><value><boolean>{p}</boolean></value></member>\
            </struct></value>",
            id = 2000 + c,
            p = u8::from(c % 2 == 1),
        )
        .unwrap();
    }
    format!(
        "<?xml version=\"1.0\"?><methodResponse><params><param><value><struct>\
            <member><name>bugs</name><value><struct>\
                <member><name>42</name><value><struct>\
                    <member><name>comments</name><value><array>\
<data>{entries}</data></array></value></member>\
                </struct></value></member>\
            </struct></value></member>\
        </struct></value></param></params></methodResponse>"
    )
}

#[tokio::test]
async fn hybrid_uses_xmlrpc_directly() {
    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(500))
        .expect(0)
        .mount(&mock)
        .await;
    Mock::given(method("POST"))
        .and(path("/xmlrpc.cgi"))
        .respond_with(
            ResponseTemplate::new(200).set_body_string(xmlrpc_comments_response(&[0, 1, 2])),
        )
        .expect(1)
        .mount(&mock)
        .await;

    let client = test_client_hybrid(&mock.uri());
    let comments = client.get_comments_since(42, None).await.unwrap();
    assert_eq!(comments.len(), 3);
    assert_eq!(comments[0].text, "xmlrpc 0");
}

#[tokio::test]
async fn hybrid_xmlrpc_transport_error_falls_back_to_rest() {
    let mock = MockServer::start().await;
    Mock::given(method("POST"))
        .and(path("/xmlrpc.cgi"))
        .respond_with(ResponseTemplate::new(502))
        .mount(&mock)
        .await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(200).set_body_json(comments_response_json(&[0, 1, 2])))
        .expect(1)
        .mount(&mock)
        .await;

    let client = test_client_hybrid(&mock.uri());
    let comments = client.get_comments_since(42, None).await.unwrap();
    assert_eq!(comments.len(), 3);
    assert_eq!(comments[0].text, "comment 0");
}

#[tokio::test]
async fn rest_mode_uses_rest_only() {
    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(200).set_body_json(comments_response_json(&[4])))
        .mount(&mock)
        .await;
    Mock::given(method("POST"))
        .and(path("/xmlrpc.cgi"))
        .respond_with(ResponseTemplate::new(500))
        .expect(0)
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let comments = client.get_comments_since(42, None).await.unwrap();
    assert_eq!(comments.len(), 1);
    assert_eq!(comments[0].count, 4);
}

#[tokio::test]
async fn xmlrpc_mode_skips_rest() {
    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(500))
        .expect(0)
        .mount(&mock)
        .await;
    Mock::given(method("POST"))
        .and(path("/xmlrpc.cgi"))
        .respond_with(
            ResponseTemplate::new(200).set_body_string(xmlrpc_comments_response(&[0, 1, 2])),
        )
        .expect(1)
        .mount(&mock)
        .await;

    let client = test_client_xmlrpc(&mock.uri());
    let comments = client.get_comments_since(42, None).await.unwrap();
    assert_eq!(comments.len(), 3);
}

#[tokio::test]
async fn add_comment_private_sets_is_private_in_body() {
    let mock = MockServer::start().await;
    Mock::given(method("POST"))
        .and(path("/rest/bug/42/comment"))
        .and(body_json(
            serde_json::json!({"comment": "secret", "is_private": true}),
        ))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({"id": 999})))
        .expect(1)
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let id = client.add_comment(42, "secret", true).await.unwrap();
    assert_eq!(id, 999);
}

#[tokio::test]
async fn add_comment_public_sets_is_private_false() {
    let mock = MockServer::start().await;
    Mock::given(method("POST"))
        .and(path("/rest/bug/42/comment"))
        .and(body_json(
            serde_json::json!({"comment": "public", "is_private": false}),
        ))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({"id": 1000})))
        .expect(1)
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let id = client.add_comment(42, "public", false).await.unwrap();
    assert_eq!(id, 1000);
}

#[tokio::test]
async fn get_comments_since_rest_accepts_flat_comments_envelope() {
    // Some Bugzilla 5.0.x deployments return {"comments": [...]} at the
    // root instead of the stock {"bugs": {<id>: {"comments": [...]}}}.
    // Issue #135.
    use crate::client::test_helpers::test_client;
    use wiremock::matchers::{method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "comments": [
                {
                    "id": 1,
                    "bug_id": 42,
                    "creator": "alice@example.com",
                    "time": "2026-01-01T00:00:00Z",
                    "creation_time": "2026-01-01T00:00:00Z",
                    "text": "hello from alt envelope",
                    "is_private": false,
                    "count": 0
                }
            ]
        })))
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let comments = client
        .get_comments_since_rest_for_test(42, None)
        .await
        .unwrap();
    assert_eq!(comments.len(), 1);
    assert_eq!(comments[0].id, 1);
    assert_eq!(comments[0].text, "hello from alt envelope");
}

#[tokio::test]
async fn get_comments_since_rest_accepts_bugs_envelope() {
    use crate::client::test_helpers::test_client;
    use wiremock::matchers::{method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "bugs": {
                "42": {
                    "comments": [
                        {
                            "id": 1,
                            "bug_id": 42,
                            "creator": "alice@example.com",
                            "time": "2026-01-01T00:00:00Z",
                            "creation_time": "2026-01-01T00:00:00Z",
                            "text": "from bugs envelope",
                            "is_private": false,
                            "count": 0
                        }
                    ]
                }
            }
        })))
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let comments = client
        .get_comments_since_rest_for_test(42, None)
        .await
        .unwrap();
    assert_eq!(comments.len(), 1);
    assert_eq!(comments[0].id, 1);
    assert_eq!(comments[0].text, "from bugs envelope");
}

#[tokio::test]
async fn get_comments_since_rest_prefers_bugs_when_both_envelopes_populated() {
    use crate::client::test_helpers::test_client;
    use wiremock::matchers::{method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "bugs": {
                "42": {
                    "comments": [
                        {
                            "id": 1,
                            "bug_id": 42,
                            "creator": "alice@example.com",
                            "time": "2026-01-01T00:00:00Z",
                            "creation_time": "2026-01-01T00:00:00Z",
                            "text": "from bugs envelope",
                            "is_private": false,
                            "count": 0
                        }
                    ]
                }
            },
            "comments": [
                {
                    "id": 2,
                    "bug_id": 42,
                    "creator": "bob@example.com",
                    "time": "2026-01-01T00:00:00Z",
                    "creation_time": "2026-01-01T00:00:00Z",
                    "text": "from flat envelope",
                    "is_private": false,
                    "count": 0
                }
            ]
        })))
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let comments = client
        .get_comments_since_rest_for_test(42, None)
        .await
        .unwrap();
    assert_eq!(comments.len(), 1);
    assert_eq!(
        comments[0].text, "from bugs envelope",
        "should prefer bugs-keyed envelope when both present"
    );
}

#[tokio::test]
async fn get_comments_since_rest_falls_through_when_bugs_map_empty_and_flat_populated() {
    // Regression: an empty top-level `bugs` map (no bug ID acknowledged)
    // alongside a populated flat `comments` array used to silently return
    // [] because the bugs extractor swallowed the empty case. The bugs
    // extractor now returns Err on an empty top-level map so try_envelopes
    // falls through to the flat extractor.
    use crate::client::test_helpers::test_client;
    use wiremock::matchers::{method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "bugs": {},
            "comments": [
                {
                    "id": 99,
                    "bug_id": 42,
                    "creator": "alice@example.com",
                    "time": "2026-01-01T00:00:00Z",
                    "creation_time": "2026-01-01T00:00:00Z",
                    "text": "from flat envelope",
                    "is_private": false,
                    "count": 0
                }
            ]
        })))
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let comments = client
        .get_comments_since_rest_for_test(42, None)
        .await
        .unwrap();
    assert_eq!(
        comments.len(),
        1,
        "should fall through to flat envelope, not return empty"
    );
    assert_eq!(comments[0].text, "from flat envelope");
}

#[tokio::test]
async fn get_comments_since_rest_returns_empty_when_bug_acknowledged_with_no_comments() {
    // Legitimate empty case: server acknowledges bug 42 but reports no
    // comments. Must return Ok([]) — NOT fall through to flat and NOT error.
    use crate::client::test_helpers::test_client;
    use wiremock::matchers::{method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "bugs": {"42": {"comments": []}}
        })))
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let comments = client
        .get_comments_since_rest_for_test(42, None)
        .await
        .unwrap();
    assert!(comments.is_empty(), "no comments expected: {comments:?}");
}

#[tokio::test]
async fn get_comments_since_rest_propagates_attachment_id() {
    // Regression guard for issue #170: the REST envelope path must preserve
    // `Comment.attachment_id` end-to-end so `flip_new_comment_private` can
    // identify the auto-generated upload comment. A wrapper that strips
    // unknown fields before deserialization would pass the type-level unit
    // test in `src/types/comment_tests.rs` while breaking this round trip.
    use crate::client::test_helpers::test_client;
    use wiremock::matchers::{method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/rest/bug/42/comment"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "bugs": {
                "42": {
                    "comments": [
                        {
                            "id": 7,
                            "bug_id": 42,
                            "creator": "alice@example.com",
                            "time": "2026-01-01T00:00:00Z",
                            "creation_time": "2026-01-01T00:00:00Z",
                            "text": "Created attachment 99",
                            "is_private": false,
                            "count": 1,
                            "attachment_id": 99
                        }
                    ]
                }
            }
        })))
        .mount(&mock)
        .await;

    let client = test_client(&mock.uri());
    let comments = client
        .get_comments_since_rest_for_test(42, None)
        .await
        .unwrap();
    assert_eq!(comments.len(), 1);
    assert_eq!(comments[0].attachment_id, Some(99));
}