bzr 0.4.1

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
#![expect(clippy::unwrap_used)]

use std::collections::HashMap;

use super::*;
use crate::config::{Config, ServerConfig};

fn make_server_config(server_url: &str) -> ServerConfig {
    ServerConfig {
        url: server_url.into(),
        api_key: None,
        api_key_env: None,
        api_key_keyring: None,
        email: None,
        auth_method: None,
        api_mode: None,
        server_version: None,
        tls_insecure: false,
        tls_ca_cert: None,
        tls_pin_sha256: None,
        tls_pin_issuer: None,
        tls_pin_issuer_der: None,
    }
}

fn make_config(server_url: &str) -> Config {
    let mut servers = HashMap::new();
    servers.insert("test".to_string(), make_server_config(server_url));
    Config {
        default_server: Some("test".to_string()),
        servers,
        templates: HashMap::new(),
        queries: HashMap::new(),
    }
}

#[test]
fn classify_param_kinds() {
    assert!(matches!(classify_param("columnlist"), ParamKind::Ignored));
    assert!(matches!(classify_param("known_name"), ParamKind::KnownName));
    assert!(matches!(
        classify_param("query_based_on"),
        ParamKind::QueryBasedOn
    ));
    assert!(matches!(classify_param("limit"), ParamKind::Limit));
    assert!(matches!(classify_param("product"), ParamKind::Mapped(_)));
    assert!(matches!(
        classify_param("Bugzilla_api_key"),
        ParamKind::Credential
    ));
    assert!(matches!(classify_param("token"), ParamKind::Credential));
    assert!(matches!(
        classify_param("nonexistent_field"),
        ParamKind::Raw
    ));
}

/// Parse a buglist.cgi URL with the standard test config (bugzilla.example.com).
fn parse_test_url(query: &str) -> ParsedUrl {
    let config = make_config("https://bugzilla.example.com");
    let url = format!("https://bugzilla.example.com/buglist.cgi?{query}");
    parse_bugzilla_url(&url, &config).unwrap()
}

/// Extract `raw_params` keys as a vec for assertions.
fn raw_keys(parsed: &ParsedUrl) -> Vec<&str> {
    parsed
        .query
        .raw_params
        .iter()
        .map(|(k, _)| k.as_str())
        .collect()
}

/// Find a raw param value by key.
fn raw_value<'a>(parsed: &'a ParsedUrl, key: &str) -> &'a str {
    parsed
        .query
        .raw_params
        .iter()
        .find(|(k, _)| k == key)
        .map(|(_, v)| v.as_str())
        .unwrap()
}

#[test]
fn parse_simple_url_with_recognized_params() {
    let parsed = parse_test_url("product=Firefox&product=Thunderbird&bug_status=NEW&limit=50");
    assert_eq!(parsed.query.product, vec!["Firefox", "Thunderbird"]);
    assert_eq!(parsed.query.status, vec!["NEW"]);
    assert_eq!(parsed.query.limit, Some(50));
    assert!(parsed.query.raw_params.is_empty());
    assert_eq!(parsed.query.server.as_deref(), Some("test"));
}

#[test]
fn parse_complex_boolean_chart_url() {
    let parsed = parse_test_url(
        "known_name=My+Query\
        &query_format=advanced\
        &list_id=12345\
        &columnlist=bug_id%2Csummary\
        &chfield=%5BBug+creation%5D\
        &chfieldfrom=-7d\
        &classification=Client+Software\
        &f1=component\
        &o1=equals\
        &v1=PDF+Viewer",
    );

    // Ignored params must not appear in raw_params
    let keys = raw_keys(&parsed);
    assert!(!keys.contains(&"query_format"));
    assert!(!keys.contains(&"list_id"));
    assert!(!keys.contains(&"columnlist"));
    assert!(!keys.contains(&"known_name"));

    // Boolean chart params must be in raw_params
    assert!(keys.contains(&"f1"));
    assert!(keys.contains(&"o1"));
    assert!(keys.contains(&"v1"));
    assert!(keys.contains(&"chfield"));
    assert!(keys.contains(&"chfieldfrom"));
    assert!(keys.contains(&"classification"));

    // URL-decoded values
    assert_eq!(raw_value(&parsed, "v1"), "PDF Viewer");
    assert_eq!(raw_value(&parsed, "chfield"), "[Bug creation]");
}

#[test]
fn parse_url_without_buglist_cgi_errors() {
    let config = make_config("https://bugzilla.example.com");
    let err = parse_bugzilla_url(
        "https://bugzilla.example.com/show_bug.cgi?id=12345",
        &config,
    )
    .unwrap_err();
    assert!(
        err.to_string().contains("buglist.cgi"),
        "error should mention buglist.cgi: {err}"
    );
}

#[test]
fn parse_malformed_url_errors() {
    let config = make_config("https://bugzilla.example.com");
    let err = parse_bugzilla_url("not a url", &config).unwrap_err();
    assert!(
        err.to_string().contains("invalid URL"),
        "error should mention invalid URL: {err}"
    );
}

#[test]
fn parse_url_hostname_matches_configured_server() {
    let parsed = parse_test_url("product=Firefox&bug_status=NEW");
    assert_eq!(parsed.query.server.as_deref(), Some("test"));
}

#[test]
fn parse_url_hostname_no_match_uses_default() {
    let config = make_config("https://other.example.com");
    // Config has "test" server at other.example.com, with default_server = "test"
    // URL hostname (bugzilla.example.com) won't match
    let parsed = parse_bugzilla_url(
        "https://bugzilla.example.com/buglist.cgi?product=Firefox",
        &config,
    )
    .unwrap();
    // No hostname match → server field is None (will use default at query time)
    assert!(parsed.query.server.is_none());
}

#[test]
fn parse_url_hostname_no_match_no_default_errors() {
    let config = Config {
        default_server: None,
        servers: HashMap::new(),
        templates: HashMap::new(),
        queries: HashMap::new(),
    };
    let err = parse_bugzilla_url(
        "https://bugzilla.example.com/buglist.cgi?product=Firefox",
        &config,
    )
    .unwrap_err();
    assert!(
        err.to_string().contains("does not match"),
        "error should mention does not match: {err}"
    );
}

#[test]
fn parse_url_repeated_product_params_accumulate() {
    let parsed = parse_test_url("product=Firefox&product=Thunderbird&product=SeaMonkey");
    assert_eq!(
        parsed.query.product,
        vec!["Firefox", "Thunderbird", "SeaMonkey"]
    );
}

#[test]
fn parse_url_decodes_percent_encoded_values() {
    let parsed = parse_test_url("product=PPC64%20Development&assigned_to=user%40example.com");
    assert_eq!(parsed.query.product, vec!["PPC64 Development"]);
    assert_eq!(parsed.query.assignee, vec!["user@example.com"]);
}

#[test]
fn parse_url_all_recognized_fields() {
    let parsed = parse_test_url(
        "product=Firefox\
        &component=General\
        &bug_status=NEW\
        &assigned_to=dev@example.com\
        &reporter=reporter@example.com\
        &priority=P1\
        &bug_severity=major\
        &limit=100",
    );
    assert_eq!(parsed.query.product, vec!["Firefox"]);
    assert_eq!(parsed.query.component, vec!["General"]);
    assert_eq!(parsed.query.status, vec!["NEW"]);
    assert_eq!(parsed.query.assignee, vec!["dev@example.com"]);
    assert_eq!(parsed.query.creator, vec!["reporter@example.com"]);
    assert_eq!(parsed.query.priority, vec!["P1"]);
    assert_eq!(parsed.query.severity, vec!["major"]);
    assert_eq!(parsed.query.limit, Some(100));
    assert!(parsed.query.raw_params.is_empty());
}

#[test]
fn parse_url_only_raw_params() {
    let parsed = parse_test_url("f1=component&o1=equals&v1=PDF+Viewer");
    assert!(parsed.query.product.is_empty());
    assert_eq!(parsed.query.raw_params.len(), 3);
    assert!(parsed.query.has_filters());
}

#[test]
fn find_server_by_hostname_matches() {
    let config = make_config("https://bugzilla.example.com");
    let result = find_server_by_hostname(&config, "bugzilla.example.com");
    assert_eq!(result, Some("test"));
}

#[test]
fn find_server_by_hostname_no_match() {
    let config = make_config("https://bugzilla.example.com");
    let result = find_server_by_hostname(&config, "other.example.com");
    assert!(result.is_none());
}

#[test]
fn parse_url_strips_api_key_from_raw_params() {
    let parsed = parse_test_url(
        "product=Firefox&Bugzilla_api_key=secret123&f1=component&o1=equals&v1=General",
    );

    // API key must not appear in raw_params
    let keys = raw_keys(&parsed);
    assert!(!keys.contains(&"Bugzilla_api_key"));
    assert!(!keys.contains(&"bugzilla_api_key"));

    // Other raw params should still be present
    assert!(keys.contains(&"f1"));
    assert!(keys.contains(&"o1"));
    assert!(keys.contains(&"v1"));

    // Product should be recognized normally
    assert_eq!(parsed.query.product, vec!["Firefox"]);
}

#[test]
fn parse_url_strips_credentials_from_source_url() {
    let parsed = parse_test_url("product=Firefox&Bugzilla_api_key=secret123&token=abc");

    let source = parsed.query.source_url.as_deref().unwrap();
    assert!(
        !source.contains("secret123"),
        "API key leaked into source_url: {source}"
    );
    assert!(
        !source.contains("abc"),
        "token leaked into source_url: {source}"
    );
    assert!(
        source.contains("product=Firefox"),
        "non-credential params should remain: {source}"
    );
}

#[test]
fn parses_known_name_into_suggested_name() {
    let parsed = parse_test_url("product=Firefox&known_name=my%20saved%20search");
    assert_eq!(parsed.suggested_name, Some("my saved search".into()));
}

#[test]
fn prefers_known_name_over_query_based_on() {
    let parsed = parse_test_url("product=Firefox&known_name=preferred&query_based_on=ancestor");
    assert_eq!(parsed.suggested_name, Some("preferred".into()));
}

#[test]
fn falls_back_to_query_based_on() {
    let parsed = parse_test_url("product=Firefox&query_based_on=ancestor%20query");
    assert_eq!(parsed.suggested_name, Some("ancestor query".into()));
}

#[test]
fn no_suggested_name_when_absent() {
    let parsed = parse_test_url("product=Firefox");
    assert!(parsed.suggested_name.is_none());
}

#[test]
fn empty_known_name_ignored() {
    let parsed = parse_test_url("product=Firefox&known_name=");
    assert!(parsed.suggested_name.is_none());
}

#[test]
fn parse_url_strips_credentials_case_insensitive() {
    let parsed = parse_test_url("product=Firefox&BUGZILLA_API_KEY=secret&Token=abc&api_key=def");

    let source = parsed.query.source_url.as_deref().unwrap();
    assert!(!source.contains("secret"));
    assert!(!source.contains("abc"));
    assert!(!source.contains("def"));

    let keys = raw_keys(&parsed);
    assert!(
        keys.is_empty()
            || !keys
                .iter()
                .any(|k| k.to_ascii_lowercase().contains("key") || k.eq_ignore_ascii_case("token"))
    );
}

#[test]
fn strip_shell_backslashes_cleans_escaped_url() {
    let escaped = r"https://bugzilla.example.com/buglist.cgi\?product\=Firefox\&bug_status\=NEW";
    let cleaned = strip_shell_backslashes(escaped);
    assert_eq!(
        cleaned,
        "https://bugzilla.example.com/buglist.cgi?product=Firefox&bug_status=NEW"
    );
}

#[test]
fn strip_shell_backslashes_preserves_clean_url() {
    let clean = "https://bugzilla.example.com/buglist.cgi?product=Firefox";
    let result = strip_shell_backslashes(clean);
    assert_eq!(result, clean);
}

#[test]
fn strip_shell_backslashes_preserves_percent_encoding() {
    // Backslash before % should be stripped; the %20 must survive intact
    let escaped = r"https://bugzilla.example.com/buglist.cgi\?product\=PPC64\%20Development";
    let cleaned = strip_shell_backslashes(escaped);
    assert_eq!(
        cleaned,
        "https://bugzilla.example.com/buglist.cgi?product=PPC64%20Development"
    );
}

#[test]
fn strip_shell_backslashes_ignores_non_special() {
    // Backslash before a non-URL-significant character is kept
    let input = r"https://bugzilla.example.com/buglist.cgi?summary=foo\bar";
    let result = strip_shell_backslashes(input);
    assert_eq!(result, input);
}

#[test]
fn strip_shell_backslashes_trailing_backslash() {
    // Trailing backslash with no following char is preserved
    let input = r"https://bugzilla.example.com/buglist.cgi?product=Firefox\";
    let result = strip_shell_backslashes(input);
    assert_eq!(result, input);
}

#[test]
fn parse_url_with_shell_backslashes_succeeds() {
    let config = make_config("https://bugzilla.example.com");
    let escaped = r"https://bugzilla.example.com/buglist.cgi\?product\=Firefox\&bug_status\=NEW";
    let parsed = parse_bugzilla_url(escaped, &config).unwrap();
    assert_eq!(parsed.query.product, vec!["Firefox"]);
    assert_eq!(parsed.query.status, vec!["NEW"]);
}

#[test]
fn parse_url_with_shell_backslashes_boolean_chart() {
    let config = make_config("https://bugzilla.example.com");
    let escaped = r"https://bugzilla.example.com/buglist.cgi\?f1\=qa_contact\&o1\=changedfrom\&v1\=user\%40example.com\&classification\=Community";
    let parsed = parse_bugzilla_url(escaped, &config).unwrap();

    let keys = raw_keys(&parsed);
    assert!(keys.contains(&"f1"), "boolean chart f1 missing: {keys:?}");
    assert!(keys.contains(&"o1"), "boolean chart o1 missing: {keys:?}");
    assert_eq!(raw_value(&parsed, "v1"), "user@example.com");
    assert_eq!(raw_value(&parsed, "classification"), "Community");
}

#[test]
fn parse_url_with_new_158_field_params() {
    let parsed = parse_test_url(
        "status_whiteboard=needs-review\
        &target_milestone=5.0\
        &version=9.4\
        &op_sys=Linux\
        &rep_platform=x86_64\
        &resolution=FIXED\
        &qa_contact=qa%40example.com\
        &bug_file_loc=github.com%2Ffoo",
    );
    assert_eq!(parsed.query.whiteboard, vec!["needs-review"]);
    assert_eq!(parsed.query.target_milestone, vec!["5.0"]);
    assert_eq!(parsed.query.version, vec!["9.4"]);
    assert_eq!(parsed.query.op_sys, vec!["Linux"]);
    assert_eq!(parsed.query.platform, vec!["x86_64"]);
    assert_eq!(parsed.query.resolution, vec!["FIXED"]);
    assert_eq!(parsed.query.qa_contact, vec!["qa@example.com"]);
    assert_eq!(parsed.query.url, vec!["github.com/foo"]);
    // Nothing falls through to raw_params.
    assert!(parsed.query.raw_params.is_empty());
}

#[test]
fn parse_url_repeated_whiteboard_accumulates() {
    let parsed = parse_test_url("status_whiteboard=wip&status_whiteboard=review");
    assert_eq!(parsed.query.whiteboard, vec!["wip", "review"]);
}