bzr 0.2.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
use serde::Serialize;

use super::formatting::print_json;
use crate::types::OutputFormat;

// ── Result output ───────────────────────────────────────────────────

pub fn print_result(value: &(impl Serialize + ?Sized), human_message: &str, format: OutputFormat) {
    match format {
        OutputFormat::Json => print_json(value),
        OutputFormat::Table => println!("{human_message}"),
    }
}

// ── Action result types ─────────────────────────────────────────────

/// Resource type for mutation result payloads.
#[derive(Debug, Serialize)]
pub enum ResourceKind {
    #[serde(rename = "bug")]
    Bug,
    #[serde(rename = "attachment")]
    Attachment,
    #[serde(rename = "comment")]
    Comment,
    #[serde(rename = "user")]
    User,
    #[serde(rename = "group")]
    Group,
    #[serde(rename = "product")]
    Product,
    #[serde(rename = "component")]
    Component,
    #[serde(rename = "server")]
    Server,
}

/// Action type for mutation result payloads.
#[derive(Debug, Serialize)]
pub enum ActionKind {
    #[serde(rename = "created")]
    Created,
    #[serde(rename = "updated")]
    Updated,
    #[serde(rename = "added")]
    Added,
    #[serde(rename = "removed")]
    Removed,
    #[serde(rename = "downloaded")]
    Downloaded,
}

/// Typed result payload for relationship mutations (e.g. group membership).
#[derive(Debug, Serialize)]
#[non_exhaustive]
pub struct MembershipResult {
    pub user: String,
    pub group: String,
    pub resource: ResourceKind,
    pub action: ActionKind,
}

impl MembershipResult {
    pub fn added(user: impl Into<String>, group: impl Into<String>) -> Self {
        Self {
            user: user.into(),
            group: group.into(),
            resource: ResourceKind::Group,
            action: ActionKind::Added,
        }
    }

    pub fn removed(user: impl Into<String>, group: impl Into<String>) -> Self {
        Self {
            user: user.into(),
            group: group.into(),
            resource: ResourceKind::Group,
            action: ActionKind::Removed,
        }
    }
}

/// Typed result payload for attachment download operations.
#[derive(Debug, Serialize)]
#[non_exhaustive]
pub struct DownloadResult {
    pub id: u64,
    pub file: String,
    pub size: usize,
    pub resource: ResourceKind,
    pub action: ActionKind,
}

impl DownloadResult {
    pub fn new(id: u64, file: impl Into<String>, size: usize) -> Self {
        Self {
            id,
            file: file.into(),
            size,
            resource: ResourceKind::Attachment,
            action: ActionKind::Downloaded,
        }
    }
}

/// Typed result payload for attachment upload operations.
#[derive(Debug, Serialize)]
#[non_exhaustive]
pub struct UploadResult {
    pub id: u64,
    pub bug_id: u64,
    pub size: usize,
    pub resource: ResourceKind,
    pub action: ActionKind,
}

impl UploadResult {
    pub fn new(id: u64, bug_id: u64, size: usize) -> Self {
        Self {
            id,
            bug_id,
            size,
            resource: ResourceKind::Attachment,
            action: ActionKind::Created,
        }
    }
}

/// Typed result payload for comment tag operations.
#[derive(Debug, Serialize)]
#[non_exhaustive]
pub struct TagResult {
    pub comment_id: u64,
    pub tags: Vec<String>,
    pub resource: ResourceKind,
    pub action: ActionKind,
}

impl TagResult {
    pub fn updated(comment_id: u64, tags: Vec<String>) -> Self {
        Self {
            comment_id,
            tags,
            resource: ResourceKind::Comment,
            action: ActionKind::Updated,
        }
    }
}

/// Typed result payload for config operations.
#[derive(Debug, Serialize)]
#[non_exhaustive]
pub struct ConfigResult {
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_default: Option<bool>,
    pub config_file: String,
    pub resource: ResourceKind,
    pub action: ActionKind,
}

impl ConfigResult {
    pub fn configured(
        name: impl Into<String>,
        url: impl Into<String>,
        is_default: bool,
        config_file: impl Into<String>,
        is_update: bool,
    ) -> Self {
        Self {
            name: name.into(),
            url: Some(url.into()),
            is_default: Some(is_default),
            config_file: config_file.into(),
            resource: ResourceKind::Server,
            action: if is_update {
                ActionKind::Updated
            } else {
                ActionKind::Created
            },
        }
    }

    pub fn default_set(name: impl Into<String>, config_file: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            url: None,
            is_default: None,
            config_file: config_file.into(),
            resource: ResourceKind::Server,
            action: ActionKind::Updated,
        }
    }
}

/// Typed result payload for list-shaped search results (e.g. tag search).
#[derive(Debug, Serialize)]
#[non_exhaustive]
pub struct SearchResult {
    pub items: Vec<String>,
}

impl SearchResult {
    pub fn new(items: Vec<String>) -> Self {
        Self { items }
    }
}

/// Typed result payload for batch update operations.
#[derive(Debug, Serialize)]
#[non_exhaustive]
pub struct BatchResult {
    pub resource: ResourceKind,
    pub action: ActionKind,
    pub succeeded: Vec<u64>,
    pub failed: Vec<BatchFailure>,
}

/// A single failure in a batch operation.
#[derive(Debug, Serialize)]
#[non_exhaustive]
pub struct BatchFailure {
    pub id: u64,
    pub error: String,
}

impl BatchResult {
    pub fn new(succeeded: Vec<u64>, failed: Vec<BatchFailure>) -> Self {
        Self {
            resource: ResourceKind::Bug,
            action: ActionKind::Updated,
            succeeded,
            failed,
        }
    }
}

/// Typed result payload for JSON output of mutation operations.
///
/// Covers standard CRUD results with an `id` and optional `name`.
/// Relationship mutations use [`MembershipResult`], attachment I/O uses
/// [`DownloadResult`]/[`UploadResult`], tag operations use [`TagResult`],
/// config operations use [`ConfigResult`], and search results use
/// [`SearchResult`].
#[derive(Debug, Serialize)]
#[non_exhaustive]
pub struct ActionResult {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    pub resource: ResourceKind,
    pub action: ActionKind,
}

impl ActionResult {
    pub fn created(id: u64, resource: ResourceKind) -> Self {
        Self {
            id: Some(id),
            name: None,
            resource,
            action: ActionKind::Created,
        }
    }

    pub fn created_named(id: u64, name: impl Into<String>, resource: ResourceKind) -> Self {
        Self {
            id: Some(id),
            name: Some(name.into()),
            resource,
            action: ActionKind::Created,
        }
    }

    pub fn updated(id: u64, resource: ResourceKind) -> Self {
        Self {
            id: Some(id),
            name: None,
            resource,
            action: ActionKind::Updated,
        }
    }

    pub fn updated_named(name: impl Into<String>, id: Option<u64>, resource: ResourceKind) -> Self {
        Self {
            id,
            name: Some(name.into()),
            resource,
            action: ActionKind::Updated,
        }
    }
}

#[cfg(test)]
#[expect(clippy::unwrap_used)]
mod tests {
    use super::*;

    #[test]
    fn action_result_created_json_shape() {
        let result = ActionResult::created(42, ResourceKind::Bug);
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["id"], 42);
        assert_eq!(json["resource"], "bug");
        assert_eq!(json["action"], "created");
        assert!(json.get("name").is_none());
    }

    #[test]
    fn action_result_created_named_includes_name() {
        let result = ActionResult::created_named(1, "widget", ResourceKind::Component);
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["name"], "widget");
        assert_eq!(json["resource"], "component");
    }

    #[test]
    fn upload_result_json_shape() {
        let result = UploadResult::new(10, 42, 1024);
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["id"], 10);
        assert_eq!(json["bug_id"], 42);
        assert_eq!(json["size"], 1024);
        assert_eq!(json["resource"], "attachment");
        assert_eq!(json["action"], "created");
    }

    #[test]
    fn download_result_json_shape() {
        let result = DownloadResult::new(5, "patch.diff", 512);
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["id"], 5);
        assert_eq!(json["file"], "patch.diff");
        assert_eq!(json["resource"], "attachment");
        assert_eq!(json["action"], "downloaded");
    }

    #[test]
    fn membership_result_added_json_shape() {
        let result = MembershipResult::added("alice", "admin");
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["user"], "alice");
        assert_eq!(json["group"], "admin");
        assert_eq!(json["action"], "added");
    }

    #[test]
    fn membership_result_removed_json_shape() {
        let result = MembershipResult::removed("alice", "admin");
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["user"], "alice");
        assert_eq!(json["group"], "admin");
        assert_eq!(json["action"], "removed");
    }

    #[test]
    fn tag_result_json_shape() {
        let result = TagResult::updated(7, vec!["important".into()]);
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["comment_id"], 7);
        assert_eq!(json["tags"][0], "important");
        assert_eq!(json["action"], "updated");
    }

    #[test]
    fn config_result_skip_none_fields() {
        let result = ConfigResult::default_set("prod", "/etc/bzr/config.toml");
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert!(json.get("url").is_none());
        assert!(json.get("is_default").is_none());
        assert_eq!(json["resource"], "server");
    }

    #[test]
    fn config_result_configured_created_json_shape() {
        let result = ConfigResult::configured(
            "prod",
            "https://bugzilla.example",
            true,
            "/etc/bzr/config.toml",
            false,
        );
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["name"], "prod");
        assert_eq!(json["url"], "https://bugzilla.example");
        assert_eq!(json["is_default"], true);
        assert_eq!(json["action"], "created");
    }

    #[test]
    fn config_result_configured_updated_json_shape() {
        let result = ConfigResult::configured(
            "prod",
            "https://bugzilla.example",
            false,
            "/etc/bzr/config.toml",
            true,
        );
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["is_default"], false);
        assert_eq!(json["action"], "updated");
    }

    #[test]
    fn search_result_json_shape() {
        let result = SearchResult::new(vec!["foo".into(), "bar".into()]);
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["items"][0], "foo");
        assert_eq!(json["items"][1], "bar");
    }

    #[test]
    fn batch_result_json_shape() {
        let result = BatchResult::new(
            vec![1, 2],
            vec![BatchFailure {
                id: 3,
                error: "permission denied".into(),
            }],
        );
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["resource"], "bug");
        assert_eq!(json["action"], "updated");
        assert_eq!(json["succeeded"][0], 1);
        assert_eq!(json["failed"][0]["id"], 3);
        assert_eq!(json["failed"][0]["error"], "permission denied");
    }

    #[test]
    fn action_result_updated_json_shape() {
        let result = ActionResult::updated(42, ResourceKind::User);
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["id"], 42);
        assert_eq!(json["resource"], "user");
        assert_eq!(json["action"], "updated");
        assert!(json.get("name").is_none());
    }

    #[test]
    fn action_result_updated_named_with_id_json_shape() {
        let result = ActionResult::updated_named("widget", Some(9), ResourceKind::Component);
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert_eq!(json["id"], 9);
        assert_eq!(json["name"], "widget");
        assert_eq!(json["resource"], "component");
        assert_eq!(json["action"], "updated");
    }

    #[test]
    fn action_result_updated_named_without_id_skips_id() {
        let result = ActionResult::updated_named("widget", None, ResourceKind::Component);
        let json: serde_json::Value = serde_json::to_value(&result).unwrap();
        assert!(json.get("id").is_none());
        assert_eq!(json["name"], "widget");
        assert_eq!(json["action"], "updated");
    }

    #[test]
    fn print_result_uses_pretty_json() {
        let result = ActionResult::created(1, ResourceKind::Bug);
        let json = serde_json::to_string_pretty(&result).unwrap();
        assert!(json.contains('\n'), "expected pretty-printed JSON");
    }
}