diagprint 0.8.1

A Rust diagnostics lifecycle framework for structured diagnostics, rendering, remediation, CI, editors, and telemetry.
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

use diagprint::{
    DeltaPolicy, DiagnosticReport, ExportPolicy, GithubActionsDeltaRenderer, Reporter,
};

fn reporter() -> Reporter {
    Reporter::builder()
        .application("github-delta-test")
        .build()
        .unwrap()
}

fn report(diagnostics: impl IntoIterator<Item = diagprint::Diagnostic>) -> DiagnosticReport {
    diagnostics.into_iter().collect()
}

#[test]
fn default_renderer_emits_summary_new_and_changed_only() {
    let reporter = reporter();

    let baseline = report([
        reporter.warning("changed").code("G100"),
        reporter.error("resolved").code("G101"),
        reporter.info("persisting").code("G102"),
    ]);

    let candidate = report([
        reporter.error("changed").code("G100"),
        reporter.info("persisting").code("G102"),
        reporter.error("brand new").code("G103"),
    ]);

    let delta = candidate.delta_from(&baseline).unwrap();

    let artifact = delta.evaluated_artifact(&DeltaPolicy::ci(), &ExportPolicy::default());

    let rendered = GithubActionsDeltaRenderer::new().render(&artifact);

    assert!(rendered.contains("title=diagprint delta"));
    assert!(rendered.contains("[changed] G100"));
    assert!(rendered.contains("[new] G103"));

    assert!(!rendered.contains("[resolved] G101"));
    assert!(!rendered.contains("[persisting] G102"));
}

#[test]
fn resolved_and_persisting_are_opt_in() {
    let reporter = reporter();

    let baseline = report([
        reporter.warning("resolved").code("G200"),
        reporter.info("persisting").code("G201"),
    ]);

    let candidate = report([reporter.info("persisting").code("G201")]);

    let delta = candidate.delta_from(&baseline).unwrap();
    let artifact = delta.artifact(&ExportPolicy::default());

    let rendered = GithubActionsDeltaRenderer::new()
        .with_resolved(true)
        .with_persisting(true)
        .render(&artifact);

    assert!(rendered.contains("[resolved] G200"));
    assert!(rendered.contains("[persisting] G201"));
}

#[test]
fn changed_annotation_shows_severity_transition() {
    let reporter = reporter();

    let baseline = report([reporter.warning("same logical diagnostic").code("G300")]);

    let candidate = report([reporter.error("same logical diagnostic").code("G300")]);

    let delta = candidate.delta_from(&baseline).unwrap();

    let rendered = GithubActionsDeltaRenderer::new()
        .with_summary(false)
        .render(&delta.artifact(&ExportPolicy::default()));

    assert!(rendered.starts_with("::error"));
    assert!(rendered.contains("[changed] G300"));

    assert!(
        rendered.contains("severity%3A WARNING -> ERROR")
            || rendered.contains("severity: WARNING -> ERROR")
    );
}

#[test]
fn default_export_boundary_prevents_absolute_path_leak() {
    let reporter = reporter();

    let baseline = DiagnosticReport::new();

    let candidate = report([reporter.error("private path").code("G400").label(
        "/home/alice/private/project/src/main.rs",
        42,
        Some(3),
        Some(4),
        Some("bad value"),
    )]);

    let delta = candidate.delta_from(&baseline).unwrap();

    let rendered =
        GithubActionsDeltaRenderer::new().render(&delta.artifact(&ExportPolicy::default()));

    assert!(rendered.contains("file=main.rs"));
    assert!(rendered.contains("line=42"));
    assert!(rendered.contains("col=3"));

    assert!(!rendered.contains("/home/alice/private/project/src/main.rs"));
}

#[test]
fn failing_ci_evaluation_is_presented_as_errors() {
    let reporter = reporter();

    let baseline = report([reporter.warning("promoted").code("G500")]);

    let candidate = report([
        reporter.error("promoted").code("G500"),
        reporter.error("new").code("G501"),
    ]);

    let delta = candidate.delta_from(&baseline).unwrap();

    let artifact = delta.evaluated_artifact(&DeltaPolicy::ci(), &ExportPolicy::default());

    let rendered = GithubActionsDeltaRenderer::new().render(&artifact);

    assert!(rendered.contains("::error title=diagprint CI policy violation::"));

    assert!(rendered.contains("new_at_or_above"));
    assert!(rendered.contains("severity_increase_at_or_above"));
}

#[test]
fn github_command_payloads_are_escaped() {
    let reporter = reporter();

    let baseline = DiagnosticReport::new();

    let candidate = report([reporter
        .warning("value is 100%\nsecond line")
        .code("G:600,test")]);

    let delta = candidate.delta_from(&baseline).unwrap();

    let rendered = GithubActionsDeltaRenderer::new()
        .with_summary(false)
        .render(&delta.artifact(&ExportPolicy::default()));

    assert!(rendered.contains("G%3A600%2Ctest"));
    assert!(rendered.contains("100%25"));
    assert!(rendered.contains("%0Asecond line"));
}