koji-diff 0.12.1

Koji build log differ — compare buildroot and build logs between two Koji builds
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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Minimal XML-RPC client using reqwest + quick-xml.

use std::collections::HashMap;
use std::fmt;

use quick_xml::Reader;
use quick_xml::events::Event;

/// An XML-RPC value.
#[derive(Debug, Clone)]
pub enum Value {
    Int(i64),
    String(String),
    Boolean(bool),
    Double(f64),
    Array(Vec<Value>),
    Struct(HashMap<String, Value>),
    Nil,
}

impl Value {
    pub fn as_int(&self) -> Option<i64> {
        match self {
            Value::Int(i) => Some(*i),
            _ => None,
        }
    }

    pub fn as_str(&self) -> Option<&str> {
        match self {
            Value::String(s) => Some(s),
            _ => None,
        }
    }

    pub fn as_array(&self) -> Option<&[Value]> {
        match self {
            Value::Array(a) => Some(a),
            _ => None,
        }
    }

    pub fn as_struct(&self) -> Option<&HashMap<String, Value>> {
        match self {
            Value::Struct(s) => Some(s),
            _ => None,
        }
    }

    /// Look up a field in a struct value.
    pub fn get(&self, key: &str) -> Option<&Value> {
        self.as_struct()?.get(key)
    }
}

#[derive(Debug)]
pub enum Error {
    Http(reqwest::Error),
    Xml(String),
    Fault { code: i64, message: String },
    Parse(String),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Http(e) => write!(f, "HTTP error: {e}"),
            Error::Xml(e) => write!(f, "XML error: {e}"),
            Error::Fault { code, message } => {
                write!(f, "XML-RPC fault {code}: {message}")
            }
            Error::Parse(e) => write!(f, "parse error: {e}"),
        }
    }
}

impl std::error::Error for Error {}

impl Error {
    /// Return `true` if this error is likely transient and the
    /// operation should be retried (e.g. HTTP 502/503/504).
    pub fn is_retriable(&self) -> bool {
        match self {
            // Connection or transport failures are often transient.
            Error::Http(_) => true,
            // XML parse failures after a successful HTTP request
            // usually mean we got an HTML error page instead of XML
            // (e.g. a 502 gateway error page).
            Error::Xml(_) => true,
            // Koji CLI errors mentioning server errors.
            Error::Parse(msg) => {
                msg.contains("502")
                    || msg.contains("503")
                    || msg.contains("504")
                    || msg.contains("Bad Gateway")
                    || msg.contains("Service Unavailable")
                    || msg.contains("Gateway Timeout")
            }
            // XML-RPC faults are legitimate API errors.
            Error::Fault { .. } => false,
        }
    }
}

impl From<reqwest::Error> for Error {
    fn from(e: reqwest::Error) -> Self {
        Error::Http(e)
    }
}

impl From<quick_xml::Error> for Error {
    fn from(e: quick_xml::Error) -> Self {
        Error::Xml(e.to_string())
    }
}

/// XML-RPC client that communicates with a hub endpoint.
pub struct Client {
    http: reqwest::blocking::Client,
    hub_url: String,
}

impl Client {
    pub fn new(hub_url: &str) -> Self {
        Self {
            http: reqwest::blocking::Client::new(),
            hub_url: hub_url.to_string(),
        }
    }

    /// Call an XML-RPC method with the given parameters.
    pub fn call(&self, method: &str, params: &[Value]) -> Result<Value, Error> {
        let body = build_request(method, params);
        let resp = self
            .http
            .post(&self.hub_url)
            .header("Content-Type", "text/xml")
            .body(body)
            .send()?
            .text()?;
        parse_response(&resp)
    }
}

// --- Request building ---

fn build_request(method: &str, params: &[Value]) -> String {
    let mut xml = format!(
        "<?xml version=\"1.0\"?>\n\
         <methodCall>\n\
         <methodName>{method}</methodName>\n\
         <params>\n"
    );
    for param in params {
        xml.push_str("<param>");
        write_value(&mut xml, param);
        xml.push_str("</param>\n");
    }
    xml.push_str("</params>\n</methodCall>");
    xml
}

fn write_value(xml: &mut String, value: &Value) {
    xml.push_str("<value>");
    match value {
        Value::Int(i) => {
            xml.push_str(&format!("<int>{i}</int>"));
        }
        Value::String(s) => {
            xml.push_str("<string>");
            for ch in s.chars() {
                match ch {
                    '<' => xml.push_str("&lt;"),
                    '>' => xml.push_str("&gt;"),
                    '&' => xml.push_str("&amp;"),
                    _ => xml.push(ch),
                }
            }
            xml.push_str("</string>");
        }
        Value::Boolean(b) => {
            xml.push_str(&format!("<boolean>{}</boolean>", if *b { 1 } else { 0 }));
        }
        Value::Double(d) => {
            xml.push_str(&format!("<double>{d}</double>"));
        }
        Value::Array(items) => {
            xml.push_str("<array><data>");
            for item in items {
                write_value(xml, item);
            }
            xml.push_str("</data></array>");
        }
        Value::Struct(map) => {
            xml.push_str("<struct>");
            for (key, val) in map {
                xml.push_str(&format!("<member><name>{key}</name>"));
                write_value(xml, val);
                xml.push_str("</member>");
            }
            xml.push_str("</struct>");
        }
        Value::Nil => {
            xml.push_str("<nil/>");
        }
    }
    xml.push_str("</value>");
}

// --- Response parsing ---

pub fn parse_response(xml: &str) -> Result<Value, Error> {
    let mut reader = Reader::from_str(xml);
    reader.config_mut().trim_text(true);

    loop {
        match reader.read_event() {
            Ok(Event::Start(e)) => match e.name().as_ref() {
                b"params" => return parse_params(&mut reader),
                b"fault" => return parse_fault(&mut reader),
                _ => {}
            },
            Ok(Event::Eof) => {
                return Err(Error::Parse("unexpected EOF before params or fault".into()));
            }
            Err(e) => return Err(Error::Xml(e.to_string())),
            _ => {}
        }
    }
}

fn parse_params(reader: &mut Reader<&[u8]>) -> Result<Value, Error> {
    loop {
        match reader.read_event() {
            Ok(Event::Start(e)) if e.name().as_ref() == b"value" => {
                return parse_value_content(reader);
            }
            Ok(Event::End(e)) if e.name().as_ref() == b"params" => {
                return Ok(Value::Nil);
            }
            Ok(Event::Eof) => {
                return Err(Error::Parse("unexpected EOF in params".into()));
            }
            Err(e) => return Err(e.into()),
            _ => {}
        }
    }
}

fn parse_fault(reader: &mut Reader<&[u8]>) -> Result<Value, Error> {
    loop {
        match reader.read_event() {
            Ok(Event::Start(e)) if e.name().as_ref() == b"value" => {
                let value = parse_value_content(reader)?;
                let code = value
                    .get("faultCode")
                    .and_then(|v| v.as_int())
                    .unwrap_or(-1);
                let message = value
                    .get("faultString")
                    .and_then(|v| v.as_str())
                    .unwrap_or("unknown fault")
                    .to_string();
                return Err(Error::Fault { code, message });
            }
            Ok(Event::Eof) => {
                return Err(Error::Parse("unexpected EOF in fault".into()));
            }
            Err(e) => return Err(e.into()),
            _ => {}
        }
    }
}

/// Parse the content inside a `<value>` tag (opening `<value>` already consumed).
fn parse_value_content(reader: &mut Reader<&[u8]>) -> Result<Value, Error> {
    loop {
        match reader.read_event() {
            Ok(Event::Start(e)) => {
                let tag = e.name().as_ref().to_vec();
                match tag.as_slice() {
                    b"int" | b"i4" | b"i8" => {
                        let text = read_text_content(reader)?;
                        skip_to_end(reader, b"value")?;
                        return Ok(Value::Int(text.parse::<i64>().map_err(|e| {
                            Error::Parse(format!("invalid int '{text}': {e}"))
                        })?));
                    }
                    b"string" => {
                        let text = read_text_content(reader)?;
                        skip_to_end(reader, b"value")?;
                        return Ok(Value::String(text));
                    }
                    b"boolean" => {
                        let text = read_text_content(reader)?;
                        skip_to_end(reader, b"value")?;
                        return Ok(Value::Boolean(text == "1" || text == "true"));
                    }
                    b"double" => {
                        let text = read_text_content(reader)?;
                        skip_to_end(reader, b"value")?;
                        return Ok(Value::Double(text.parse::<f64>().map_err(|e| {
                            Error::Parse(format!("invalid double '{text}': {e}"))
                        })?));
                    }
                    b"struct" => {
                        let s = parse_struct_content(reader)?;
                        skip_to_end(reader, b"value")?;
                        return Ok(s);
                    }
                    b"array" => {
                        let a = parse_array_content(reader)?;
                        skip_to_end(reader, b"value")?;
                        return Ok(a);
                    }
                    _ => {
                        // Unknown type tag — treat content as string.
                        let text = read_text_content(reader)?;
                        skip_to_end(reader, b"value")?;
                        return Ok(Value::String(text));
                    }
                }
            }
            Ok(Event::Empty(e)) if e.name().as_ref() == b"nil" => {
                skip_to_end(reader, b"value")?;
                return Ok(Value::Nil);
            }
            Ok(Event::Text(t)) => {
                let text = t
                    .unescape()
                    .map_err(|e| Error::Xml(e.to_string()))?
                    .into_owned();
                if !text.trim().is_empty() {
                    // Bare text in <value> is implicitly a string.
                    skip_to_end(reader, b"value")?;
                    return Ok(Value::String(text));
                }
            }
            Ok(Event::End(e)) if e.name().as_ref() == b"value" => {
                return Ok(Value::String(String::new()));
            }
            Ok(Event::Eof) => {
                return Err(Error::Parse("unexpected EOF in value".into()));
            }
            Err(e) => return Err(e.into()),
            _ => {}
        }
    }
}

fn parse_struct_content(reader: &mut Reader<&[u8]>) -> Result<Value, Error> {
    let mut map = HashMap::new();
    loop {
        match reader.read_event() {
            Ok(Event::Start(e)) if e.name().as_ref() == b"member" => {
                let (name, value) = parse_member(reader)?;
                map.insert(name, value);
            }
            Ok(Event::End(e)) if e.name().as_ref() == b"struct" => {
                return Ok(Value::Struct(map));
            }
            Ok(Event::Eof) => {
                return Err(Error::Parse("unexpected EOF in struct".into()));
            }
            Err(e) => return Err(e.into()),
            _ => {}
        }
    }
}

fn parse_member(reader: &mut Reader<&[u8]>) -> Result<(String, Value), Error> {
    let mut name = String::new();
    let mut value = Value::Nil;
    loop {
        match reader.read_event() {
            Ok(Event::Start(e)) => match e.name().as_ref() {
                b"name" => {
                    name = read_text_content(reader)?;
                }
                b"value" => {
                    value = parse_value_content(reader)?;
                }
                _ => {}
            },
            Ok(Event::End(e)) if e.name().as_ref() == b"member" => {
                return Ok((name, value));
            }
            Ok(Event::Eof) => {
                return Err(Error::Parse("unexpected EOF in member".into()));
            }
            Err(e) => return Err(e.into()),
            _ => {}
        }
    }
}

fn parse_array_content(reader: &mut Reader<&[u8]>) -> Result<Value, Error> {
    let mut items = Vec::new();
    loop {
        match reader.read_event() {
            Ok(Event::Start(e)) => {
                if e.name().as_ref() == b"data" {
                    loop {
                        match reader.read_event() {
                            Ok(Event::Start(e2)) if e2.name().as_ref() == b"value" => {
                                items.push(parse_value_content(reader)?);
                            }
                            Ok(Event::End(e2)) if e2.name().as_ref() == b"data" => break,
                            Ok(Event::Eof) => {
                                return Err(Error::Parse("unexpected EOF in array data".into()));
                            }
                            Err(e) => return Err(e.into()),
                            _ => {}
                        }
                    }
                }
            }
            Ok(Event::End(e)) if e.name().as_ref() == b"array" => {
                return Ok(Value::Array(items));
            }
            Ok(Event::Eof) => {
                return Err(Error::Parse("unexpected EOF in array".into()));
            }
            Err(e) => return Err(e.into()),
            _ => {}
        }
    }
}

/// Read text content until the matching end tag.
fn read_text_content(reader: &mut Reader<&[u8]>) -> Result<String, Error> {
    let mut text = String::new();
    loop {
        match reader.read_event() {
            Ok(Event::Text(t)) => {
                text.push_str(&t.unescape().map_err(|e| Error::Xml(e.to_string()))?);
            }
            Ok(Event::End(_)) => return Ok(text),
            Ok(Event::Eof) => {
                return Err(Error::Parse("unexpected EOF reading text".into()));
            }
            Err(e) => return Err(e.into()),
            _ => {}
        }
    }
}

/// Skip events until we find an end tag matching the given name at depth 0.
fn skip_to_end(reader: &mut Reader<&[u8]>, end_tag: &[u8]) -> Result<(), Error> {
    let mut depth: u32 = 0;
    loop {
        match reader.read_event() {
            Ok(Event::Start(_)) => depth += 1,
            Ok(Event::End(e)) => {
                if depth == 0 && e.name().as_ref() == end_tag {
                    return Ok(());
                }
                depth = depth.saturating_sub(1);
            }
            Ok(Event::Eof) => return Ok(()),
            Err(e) => return Err(e.into()),
            _ => {}
        }
    }
}

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

    #[test]
    fn test_build_request_int() {
        let xml = build_request("getBuild", &[Value::Int(42)]);
        assert!(xml.contains("<methodName>getBuild</methodName>"));
        assert!(xml.contains("<int>42</int>"));
    }

    #[test]
    fn test_build_request_string_escaping() {
        let xml = build_request("test", &[Value::String("a<b&c".into())]);
        assert!(xml.contains("a&lt;b&amp;c"));
    }

    #[test]
    fn test_parse_int_response() {
        let xml = r#"<?xml version="1.0"?>
            <methodResponse><params><param>
            <value><int>42</int></value>
            </param></params></methodResponse>"#;
        let v = parse_response(xml).unwrap();
        assert_eq!(v.as_int(), Some(42));
    }

    #[test]
    fn test_parse_string_response() {
        let xml = r#"<?xml version="1.0"?>
            <methodResponse><params><param>
            <value><string>hello world</string></value>
            </param></params></methodResponse>"#;
        let v = parse_response(xml).unwrap();
        assert_eq!(v.as_str(), Some("hello world"));
    }

    #[test]
    fn test_parse_struct_response() {
        let xml = r#"<?xml version="1.0"?>
            <methodResponse><params><param>
            <value><struct>
                <member><name>task_id</name><value><int>12345</int></value></member>
                <member><name>nvr</name><value><string>foo-1.0-1.fc42</string></value></member>
            </struct></value>
            </param></params></methodResponse>"#;
        let v = parse_response(xml).unwrap();
        assert_eq!(v.get("task_id").unwrap().as_int(), Some(12345));
        assert_eq!(v.get("nvr").unwrap().as_str(), Some("foo-1.0-1.fc42"));
    }

    #[test]
    fn test_parse_array_response() {
        let xml = r#"<?xml version="1.0"?>
            <methodResponse><params><param>
            <value><array><data>
                <value><int>1</int></value>
                <value><int>2</int></value>
                <value><int>3</int></value>
            </data></array></value>
            </param></params></methodResponse>"#;
        let v = parse_response(xml).unwrap();
        let arr = v.as_array().unwrap();
        assert_eq!(arr.len(), 3);
        assert_eq!(arr[0].as_int(), Some(1));
        assert_eq!(arr[2].as_int(), Some(3));
    }

    #[test]
    fn test_parse_nested_struct_array() {
        let xml = r#"<?xml version="1.0"?>
            <methodResponse><params><param>
            <value><array><data>
                <value><struct>
                    <member><name>id</name><value><int>100</int></value></member>
                    <member><name>method</name><value><string>buildArch</string></value></member>
                    <member><name>arch</name><value><string>x86_64</string></value></member>
                </struct></value>
                <value><struct>
                    <member><name>id</name><value><int>101</int></value></member>
                    <member><name>method</name><value><string>buildArch</string></value></member>
                    <member><name>arch</name><value><string>aarch64</string></value></member>
                </struct></value>
            </data></array></value>
            </param></params></methodResponse>"#;
        let v = parse_response(xml).unwrap();
        let arr = v.as_array().unwrap();
        assert_eq!(arr.len(), 2);
        assert_eq!(arr[0].get("id").unwrap().as_int(), Some(100));
        assert_eq!(arr[0].get("arch").unwrap().as_str(), Some("x86_64"));
        assert_eq!(arr[1].get("id").unwrap().as_int(), Some(101));
    }

    #[test]
    fn test_parse_boolean_response() {
        let xml = r#"<?xml version="1.0"?>
            <methodResponse><params><param>
            <value><boolean>1</boolean></value>
            </param></params></methodResponse>"#;
        let v = parse_response(xml).unwrap();
        assert_eq!(v.as_int(), None);
        match v {
            Value::Boolean(b) => assert!(b),
            _ => panic!("expected boolean"),
        }
    }

    #[test]
    fn test_parse_nil_response() {
        let xml = r#"<?xml version="1.0"?>
            <methodResponse><params><param>
            <value><nil/></value>
            </param></params></methodResponse>"#;
        let v = parse_response(xml).unwrap();
        assert!(matches!(v, Value::Nil));
    }

    #[test]
    fn test_parse_fault_response() {
        let xml = r#"<?xml version="1.0"?>
            <methodResponse><fault><value><struct>
                <member><name>faultCode</name><value><int>1000</int></value></member>
                <member><name>faultString</name><value><string>No such build</string></value></member>
            </struct></value></fault></methodResponse>"#;
        let err = parse_response(xml).unwrap_err();
        match err {
            Error::Fault { code, message } => {
                assert_eq!(code, 1000);
                assert_eq!(message, "No such build");
            }
            _ => panic!("expected Fault error, got: {err}"),
        }
    }

    #[test]
    fn test_parse_bare_text_as_string() {
        let xml = r#"<?xml version="1.0"?>
            <methodResponse><params><param>
            <value>bare text</value>
            </param></params></methodResponse>"#;
        let v = parse_response(xml).unwrap();
        assert_eq!(v.as_str(), Some("bare text"));
    }

    #[test]
    fn test_is_retriable_http_error() {
        // reqwest errors are retriable (connection failures, etc.)
        let err = Error::Xml("unexpected token".into());
        assert!(err.is_retriable());
    }

    #[test]
    fn test_is_retriable_parse_502() {
        let err = Error::Parse("koji download-logs failed: 502 Bad Gateway".into());
        assert!(err.is_retriable());
    }

    #[test]
    fn test_is_retriable_parse_503() {
        let err = Error::Parse("503 Service Unavailable".into());
        assert!(err.is_retriable());
    }

    #[test]
    fn test_is_not_retriable_fault() {
        let err = Error::Fault {
            code: 1000,
            message: "No such build".into(),
        };
        assert!(!err.is_retriable());
    }

    #[test]
    fn test_is_not_retriable_parse_not_found() {
        let err = Error::Parse("root.log not found for task 123".into());
        assert!(!err.is_retriable());
    }
}