rustqual 1.2.2

Comprehensive Rust code quality analyzer — seven dimensions: IOSP, Complexity, DRY, SRP, Coupling, Test Quality, Architecture
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

use crate::adapters::analyzers::iosp::{
    compute_severity, CallOccurrence, Classification, ComplexityMetrics, FunctionAnalysis,
    LogicOccurrence, MagicNumberOccurrence,
};
use crate::ports::Reporter;
use crate::report::html::*;
use crate::report::Summary;

/// Test-local helper: instantiate the reporter and render. Replaces
/// the production `build_html_string` shim (whose only consumer was
/// these tests).
fn build_html_string(analysis: &AnalysisResult) -> String {
    HtmlReporter {
        summary: &analysis.summary,
    }
    .render(&analysis.findings, &analysis.data)
}

fn make_result(name: &str, classification: Classification) -> FunctionAnalysis {
    let severity = compute_severity(&classification);
    FunctionAnalysis {
        name: name.to_string(),
        file: "test.rs".to_string(),
        line: 1,
        classification,
        parent_type: None,
        suppressed: false,
        complexity: None,
        qualified_name: name.to_string(),
        severity,
        cognitive_warning: false,
        cyclomatic_warning: false,
        nesting_depth_warning: false,
        function_length_warning: false,
        unsafe_warning: false,
        error_handling_warning: false,
        complexity_suppressed: false,
        own_calls: vec![],
        parameter_count: 0,
        is_trait_impl: false,
        is_test: false,
        effort_score: None,
    }
}

fn make_analysis(results: Vec<FunctionAnalysis>) -> AnalysisResult {
    let mut summary = Summary::from_results(&results);
    summary.compute_quality_score(&crate::config::sections::DEFAULT_QUALITY_WEIGHTS);
    let config = crate::config::Config::default();
    let data = crate::app::projection::project_data(&results, None);
    let findings = crate::domain::AnalysisFindings {
        iosp: crate::app::projection::project_iosp(&results),
        complexity: crate::app::projection::project_complexity(&results, &config),
        ..Default::default()
    };
    AnalysisResult {
        results,
        summary,
        findings,
        data,
    }
}

#[test]
fn test_html_contains_doctype() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    assert!(html.starts_with("<!DOCTYPE html>"));
}

#[test]
fn test_html_contains_style() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    assert!(html.contains("<style>"));
    assert!(html.contains("</style>"));
}

#[test]
fn test_html_contains_dashboard() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    assert!(html.contains("class=\"dashboard\""));
    assert!(html.contains("Quality Score:"));
}

#[test]
fn test_html_quality_score_displayed() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    assert!(html.contains("100.0%"));
}

#[test]
fn test_html_iosp_section_present() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    assert!(html.contains("IOSP"));
    assert!(html.contains("No IOSP violations."));
}

#[test]
fn test_html_no_violations_message() {
    let analysis = make_analysis(vec![make_result("f", Classification::Integration)]);
    let html = build_html_string(&analysis);
    assert!(html.contains("No IOSP violations."));
}

#[test]
fn test_html_with_violations_table() {
    let analysis = make_analysis(vec![make_result(
        "bad_fn",
        Classification::Violation {
            has_logic: true,
            has_own_calls: true,
            logic_locations: vec![LogicOccurrence {
                kind: "if".into(),
                line: 5,
            }],
            call_locations: vec![CallOccurrence {
                name: "helper".into(),
                line: 6,
            }],
        },
    )]);
    let html = build_html_string(&analysis);
    assert!(html.contains("bad_fn"));
    assert!(html.contains("<table>"));
    assert!(html.contains("helper"));
}

#[test]
fn test_html_complexity_section() {
    let mut func = make_result("complex_fn", Classification::Operation);
    func.complexity = Some(ComplexityMetrics {
        logic_count: 5,
        call_count: 0,
        max_nesting: 3,
        cognitive_complexity: 20,
        cyclomatic_complexity: 12,
        magic_numbers: vec![MagicNumberOccurrence {
            line: 10,
            value: "42".to_string(),
        }],
        ..Default::default()
    });
    func.cognitive_warning = true;
    let analysis = make_analysis(vec![func]);
    let html = build_html_string(&analysis);
    assert!(html.contains("complex_fn"));
    assert!(html.contains("42"));
}

#[test]
fn test_html_dry_section_empty() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    assert!(html.contains("No DRY issues found."));
}

#[test]
fn test_html_srp_section_empty() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    assert!(html.contains("No SRP warnings."));
}

#[test]
fn test_html_coupling_section_empty() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    assert!(html.contains("No coupling data."));
}

#[test]
fn test_html_self_contained_no_external() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    // No external resource references
    assert!(!html.contains("http://"));
    assert!(!html.contains("https://"));
    assert!(!html.contains("<link"));
    assert!(!html.contains("<script src"));
}

#[test]
fn test_html_empty_results() {
    let analysis = make_analysis(vec![]);
    let html = build_html_string(&analysis);
    assert!(html.contains("<!DOCTYPE html>"));
    assert!(html.contains("</html>"));
}

#[test]
fn test_html_footer_closes_tags() {
    let analysis = make_analysis(vec![make_result("f", Classification::Operation)]);
    let html = build_html_string(&analysis);
    assert!(html.contains("</body>"));
    assert!(html.contains("</html>"));
    assert!(html.contains("rustqual"));
}

#[test]
fn test_html_escapes_special_chars() {
    let escaped = html_escape("<script>alert('xss')</script>");
    assert!(escaped.contains("&lt;"));
    assert!(escaped.contains("&gt;"));
    assert!(!escaped.contains("<script>"));
}

#[test]
fn test_html_renders_architecture_findings() {
    let mut analysis = make_analysis(vec![]);
    analysis.findings.architecture = vec![crate::domain::findings::ArchitectureFinding {
        common: crate::domain::Finding {
            file: "src/cli/handlers.rs".into(),
            line: 17,
            column: 0,
            dimension: crate::findings::Dimension::Architecture,
            rule_id: "architecture/call_parity/no_delegation".into(),
            message: "cli pub fn delegates to no application function".into(),
            severity: crate::domain::Severity::Medium,
            suppressed: false,
        },
    }];
    let html = build_html_string(&analysis);
    assert!(
        html.contains("architecture/call_parity/no_delegation"),
        "HTML must contain the architecture rule_id; got:\n{html}"
    );
    assert!(
        html.contains("src/cli/handlers.rs"),
        "HTML must contain the architecture finding file path"
    );
}

#[test]
fn html_reporter_renders_orphans_via_snapshot_view() {
    // Construct the reporter with NO orphan_suppressions struct-field
    // bypass and populate `findings.orphan_suppressions`. Output must
    // include the orphan section — proving render flows through
    // `build_orphans` → `Snapshot::orphans` → `publish`.
    use crate::domain::findings::OrphanSuppression;
    let mut analysis = make_analysis(vec![]);
    analysis.findings.orphan_suppressions = vec![OrphanSuppression {
        file: "src/foo.rs".into(),
        line: 42,
        dimensions: vec![crate::findings::Dimension::Iosp],
        reason: Some("legacy".into()),
    }];
    // Reporter struct WITHOUT the orphan_suppressions field — the
    // bypass path is gone; only the trait-driven snapshot view is left.
    let html = HtmlReporter {
        summary: &analysis.summary,
    }
    .render(&analysis.findings, &analysis.data);
    assert!(
        html.contains("src/foo.rs"),
        "HTML must include orphan file path from snapshot.orphans, got:\n{html}"
    );
    assert!(
        html.contains("Orphan") || html.contains("ORPHAN"),
        "HTML must include orphan section heading from snapshot.orphans, got:\n{html}"
    );
}