nils-api-testing-core 0.27.0

Library crate for nils-api-testing-core in the nils-cli workspace.
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

use std::path::Path;

use anyhow::Context;

use crate::Result;
use crate::suite::results::SuiteRunResults;

fn xml_escape(s: &str) -> String {
    s.replace('&', "&")
        .replace('<', "&lt;")
        .replace('>', "&gt;")
        .replace('"', "&quot;")
        .replace('\'', "&apos;")
}

pub fn render_junit_xml(results: &SuiteRunResults) -> String {
    let suite_name = if results.suite.trim().is_empty() {
        "suite".to_string()
    } else {
        results.suite.clone()
    };

    let mut out = String::new();
    out.push_str("<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
    out.push_str(&format!(
        "<testsuite name=\"{}\" tests=\"{}\" failures=\"{}\" skipped=\"{}\">\n",
        xml_escape(&suite_name),
        results.summary.total,
        results.summary.failed,
        results.summary.skipped
    ));

    for case in &results.cases {
        let seconds = (case.duration_ms as f64) / 1000.0;
        out.push_str(&format!(
            "  <testcase name=\"{}\" classname=\"{}\" time=\"{:.3}\">",
            xml_escape(&case.id),
            xml_escape(&case.case_type),
            seconds
        ));

        let message = case.message.clone().unwrap_or_default();
        let message_trim = message.trim();
        match case.status.as_str() {
            "skipped" => {
                out.push_str(&format!(
                    "<skipped message=\"{}\"/>",
                    xml_escape(message_trim)
                ));
            }
            "failed" => {
                let failure_message = if message_trim.is_empty() {
                    "failed"
                } else {
                    message_trim
                };
                out.push_str(&format!(
                    "<failure message=\"{}\">",
                    xml_escape(failure_message)
                ));
                let mut detail = String::new();
                if let Some(cmd) = &case.command {
                    detail.push_str(&format!("command: {cmd}\n"));
                }
                if let Some(p) = &case.stdout_file {
                    detail.push_str(&format!("stdoutFile: {p}\n"));
                }
                if let Some(p) = &case.stderr_file {
                    detail.push_str(&format!("stderrFile: {p}\n"));
                }
                out.push_str(&xml_escape(&detail));
                out.push_str("</failure>");
            }
            _ => {}
        }

        out.push_str("</testcase>\n");
    }

    out.push_str("</testsuite>\n");
    out
}

pub fn write_junit_file(results: &SuiteRunResults, path: &Path) -> Result<()> {
    let xml = render_junit_xml(results);
    let Some(parent) = path.parent() else {
        anyhow::bail!("invalid junit path: {}", path.display());
    };
    std::fs::create_dir_all(parent)
        .with_context(|| format!("create directory: {}", parent.display()))?;
    std::fs::write(path, xml).with_context(|| format!("write junit file: {}", path.display()))?;
    Ok(())
}

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

    #[test]
    fn junit_emits_basic_structure() {
        let results = SuiteRunResults {
            version: 1,
            suite: "smoke".to_string(),
            suite_file: "tests/api/suites/smoke.suite.json".to_string(),
            run_id: "20260131-000000Z".to_string(),
            started_at: "2026-01-31T00:00:00Z".to_string(),
            finished_at: "2026-01-31T00:00:01Z".to_string(),
            output_dir: "out/api-test-runner/20260131-000000Z".to_string(),
            summary: crate::suite::results::SuiteRunSummary {
                total: 1,
                passed: 0,
                failed: 1,
                skipped: 0,
            },
            cases: vec![crate::suite::results::SuiteCaseResult {
                id: "case".to_string(),
                case_type: "rest".to_string(),
                status: "failed".to_string(),
                duration_ms: 10,
                tags: vec![],
                command: Some("api-rest call".to_string()),
                message: Some("rest_runner_failed".to_string()),
                assertions: None,
                stdout_file: Some("out/x.response.json".to_string()),
                stderr_file: Some("out/x.stderr.log".to_string()),
            }],
        };

        let xml = render_junit_xml(&results);
        assert!(xml.contains("<testsuite"));
        assert!(xml.contains("<testcase"));
        assert!(xml.contains("<failure"));
    }
}