rvtest 0.3.0

A Next Level Testing Library for Rust — BDD specs, property-based testing, parametrized tests, rich reporting, and code coverage. Just a library, not a framework.
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

use std::fmt::Write;

use crate::core::{TestKind, TestRun, TestStatus};
use super::json::escape_json;
use super::TestReporter;

// ---------------------------------------------------------------------------
// AgentReporter — LLM-optimised structured JSON output
// ---------------------------------------------------------------------------

/// Reporter that emits structured JSON optimised for LLM consumption.
///
/// Includes full test metadata, source code snippets at failure locations,
/// structured failure analysis, and machine-parseable metadata.
pub struct AgentReporter;

impl TestReporter for AgentReporter {
    fn report(&self, run: &TestRun) -> String {
        let mut out = String::new();

        let _ = writeln!(out, "{{");
        let _ = writeln!(out, r#"  "format": "rvtest-agent-v1","#);
        let _ = writeln!(out, r#"  "success": {},"#, if run.success() { "true" } else { "false" });
        let _ = writeln!(out, r#"  "total": {},"#, run.total());
        let _ = writeln!(out, r#"  "passed": {},"#, run.total_passed());
        let _ = writeln!(out, r#"  "failed": {},"#, run.total_failed());
        let _ = writeln!(out, r#"  "skipped": {},"#, run.total_skipped());
        let _ = writeln!(out, r#"  "duration_secs": {:.3},"#, run.duration.as_secs_f64());
        let _ = writeln!(out, r#"  "suites": ["#);

        for (si, suite) in run.suites.iter().enumerate() {
            if si > 0 {
                out.push(',');
            }
            let _ = writeln!(out);
            let _ = writeln!(out, r#"    {{"#);
            let _ = writeln!(out, r#"      "name": "{}", "#, escape_json(&suite.name));
            let _ = writeln!(out, r#"      "kind": "{}", "#, match suite.kind {
                TestKind::Unit => "unit",
                TestKind::Integration => "integration",
                TestKind::Doc => "doc",
            });
            let _ = writeln!(out, r#"      "source_path": "{}", "#, escape_json(&suite.source_path));
            let _ = writeln!(out, r#"      "duration_secs": {:.3},"#, suite.duration.as_secs_f64());
            let _ = writeln!(out, r#"      "tests": ["#);

            for (ti, test) in suite.tests.iter().enumerate() {
                if ti > 0 {
                    out.push(',');
                }
                let _ = writeln!(out);
                let _ = writeln!(out, r#"        {{"#);
                let _ = writeln!(out, r#"          "name": "{}", "#, escape_json(&test.name));
                let (status_str, reason) = match &test.status {
                    TestStatus::Passed => ("passed", None),
                    TestStatus::Failed { reason: r, .. } => ("failed", Some(r.as_str())),
                    TestStatus::Skipped { reason: r } => ("skipped", r.as_deref()),
                    TestStatus::TimedOut { .. } => ("timed_out", None),
                };
                let _ = writeln!(out, r#"          "status": "{}", "#, status_str);
                let _ = writeln!(out, r#"          "duration_secs": {:.3},"#, test.duration.as_secs_f64());

                if let Some(r) = reason {
                    let _ = writeln!(out, r#"          "failure": "{}", "#, escape_json(r));
                }

                // Source location
                if let Some(ref loc) = test.location {
                    let _ = writeln!(out, r#"          "location": {{"#);
                    let _ = writeln!(out, r#"            "file": "{}", "#, escape_json(&loc.file));
                    let _ = writeln!(out, r#"            "line": {}"#, loc.line);
                    if let Some(col) = loc.column {
                        let _ = write!(out, r#","column":{col}"#);
                    }
                    let _ = writeln!(out);
                    let _ = writeln!(out, r#"          }}, "#);

                    // Source code snippet around the failure
                    if let Some(snippet) = read_source_snippet(&loc.file, loc.line, 3) {
                        let _ = writeln!(out, r#"          "source_snippet": "{}", "#, escape_json(&snippet));
                    }
                }

                if let Some(ref output) = test.captured_output {
                    let _ = writeln!(out, r#"          "captured_output": "{}", "#, escape_json(output));
                }

                if !test.tags.is_empty() {
                    let tags: String = test.tags.iter().map(|t| format!(r#""{}""#, escape_json(t))).collect::<Vec<_>>().join(",");
                    let _ = writeln!(out, r#"          "tags": [{}], "#, tags);
                }

                if !test.parameters.is_empty() {
                    let _ = writeln!(out, r#"          "parameters": {{"#);
                    for (pi, (k, v)) in test.parameters.iter().enumerate() {
                        if pi > 0 { out.push(','); }
                        let _ = writeln!(out, r#"            "{}": "{}""#, escape_json(k), escape_json(v));
                    }
                    let _ = writeln!(out);
                    let _ = writeln!(out, r#"          }}, "#);
                }

                let _ = writeln!(out, r#"          "analysis": {{"#);
                let _ = writeln!(out, r#"            "is_failure": {},"#, if status_str == "failed" || status_str == "timed_out" { "true" } else { "false" });
                let _ = writeln!(out, r#"            "is_flaky_candidate": false"#);
                let _ = writeln!(out, r#"          }}"#);
                let _ = write!(out, r#"        }}"#);
            }

            let _ = writeln!(out);
            let _ = writeln!(out, r#"      ]"#);
            let _ = write!(out, r#"    }}"#);
        }

        let _ = writeln!(out);
        let _ = writeln!(out, r#"  ]"#);
        let _ = writeln!(out, r#"}}"#);
        out
    }
}

/// Read a snippet of source code around a given line.
fn read_source_snippet(file: &str, line: u32, context: usize) -> Option<String> {
    let content = std::fs::read_to_string(file).ok()?;
    let lines: Vec<&str> = content.lines().collect();
    let line_idx = (line as usize).saturating_sub(1);
    let start = line_idx.saturating_sub(context);
    let end = (line_idx + context + 1).min(lines.len());
    if start >= end {
        return None;
    }
    let mut snippet = String::new();
    for i in start..end {
        let prefix = if i == line_idx { "→" } else { " " };
        snippet.push_str(&format!("{}{:>4}: {}\n", prefix, i + 1, lines[i]));
    }
    Some(snippet)
}