sqc 0.4.13

Software Code Quality - CERT C compliance checker
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

use crate::analyze::SuppressedViolation;
use crate::manifest::Severity;
use crate::rules::RuleViolation;

use anyhow::Result;
use std::collections::BTreeMap;
use std::fs::File;
use std::io::BufWriter;

fn severity_to_sarif_level(severity: &Severity) -> &'static str {
    match severity {
        Severity::Critical | Severity::High => "error",
        Severity::Medium => "warning",
        Severity::Low => "note",
    }
}

fn violation_to_sarif_result(
    v: &RuleViolation,
    rule_index: &BTreeMap<&str, usize>,
) -> serde_json::Value {
    let idx = rule_index.get(v.rule_id.as_str()).copied().unwrap_or(0);
    let mut result = serde_json::json!({
        "ruleId": v.rule_id,
        "ruleIndex": idx,
        "level": severity_to_sarif_level(&v.severity),
        "message": {
            "text": v.message
        },
        "locations": [{
            "physicalLocation": {
                "artifactLocation": {
                    "uri": v.file_path
                },
                "region": {
                    "startLine": v.line,
                    "startColumn": v.column
                }
            }
        }]
    });
    if let Some(suggestion) = &v.suggestion {
        result["fixes"] = serde_json::json!([{
            "description": {
                "text": suggestion
            }
        }]);
    }
    result
}

pub fn export_all_violations_to_sarif(
    violations: &[RuleViolation],
    suppressed: &[SuppressedViolation],
    sarif_path: &str,
) -> Result<()> {
    // Collect unique rules from both active and suppressed violations
    let mut rules_map: BTreeMap<String, &RuleViolation> = BTreeMap::new();
    for v in violations {
        rules_map.entry(v.rule_id.clone()).or_insert(v);
    }
    for s in suppressed {
        rules_map
            .entry(s.violation.rule_id.clone())
            .or_insert(&s.violation);
    }

    // Build rule index for result references
    let rule_index: BTreeMap<&str, usize> = rules_map
        .keys()
        .enumerate()
        .map(|(i, k)| (k.as_str(), i))
        .collect();

    let rules_array: Vec<serde_json::Value> = rules_map
        .iter()
        .map(|(rule_id, v)| {
            serde_json::json!({
                "id": rule_id,
                "shortDescription": {
                    "text": v.message
                },
                "defaultConfiguration": {
                    "level": severity_to_sarif_level(&v.severity)
                },
                "helpUri": format!("https://wiki.sei.cmu.edu/confluence/display/c/{}", rule_id)
            })
        })
        .collect();

    // Build results: active violations
    let mut results_array: Vec<serde_json::Value> = violations
        .iter()
        .map(|v| violation_to_sarif_result(v, &rule_index))
        .collect();

    // Append suppressed violations with SARIF suppressions array
    for s in suppressed {
        let mut result = violation_to_sarif_result(&s.violation, &rule_index);
        result["suppressions"] = serde_json::json!([{
            "kind": "inSource",
            "justification": s.justification
        }]);
        results_array.push(result);
    }

    let sarif = serde_json::json!({
        "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/main/sarif-2.1/schema/sarif-schema-2.1.0.json",
        "version": "2.1.0",
        "runs": [{
            "tool": {
                "driver": {
                    "name": "SqC",
                    "version": env!("CARGO_PKG_VERSION"),
                    "informationUri": "https://github.com/your-org/sqc",
                    "rules": rules_array
                }
            },
            "results": results_array
        }]
    });

    let file = File::create(sarif_path)?;
    let writer = BufWriter::new(file);
    serde_json::to_writer_pretty(writer, &sarif)?;

    Ok(())
}