daml-lint 0.2.0

use crate::detector::{Finding, Severity};
use serde::Serialize;
use serde_json::json;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OutputFormat {
    Sarif,
    Markdown,
    Json,
}

impl std::str::FromStr for OutputFormat {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "sarif" => Ok(Self::Sarif),
            "markdown" | "md" => Ok(Self::Markdown),
            "json" => Ok(Self::Json),
            _ => Err(()),
        }
    }
}

/// A parse/lex diagnostic surfaced to the caller alongside findings. A file
/// with parse errors is NOT clean, even when no findings were produced.
pub struct ParseError {
    pub file: String,
    pub line: usize,
    pub column: usize,
    /// End column when the diagnostic span sits on one line; `None` otherwise.
    pub end_column: Option<usize>,
    pub message: String,
    /// Recovery category tag (e.g. `skipped-declaration`, `unsupported-syntax`).
    pub category: &'static str,
}

pub fn format_findings(
    findings: &[Finding],
    parse_errors: &[ParseError],
    format: OutputFormat,
) -> String {
    match format {
        OutputFormat::Sarif => format_sarif(findings, parse_errors),
        OutputFormat::Markdown => format_markdown(findings, parse_errors),
        OutputFormat::Json => format_json(findings, parse_errors),
    }
}

fn format_sarif(findings: &[Finding], parse_errors: &[ParseError]) -> String {
    let results: Vec<serde_json::Value> = findings
        .iter()
        .map(|f| {
            json!({
                "ruleId": f.detector,
                "level": sarif_level(&f.severity),
                "message": {
                    "text": f.message,
                },
                "locations": [{
                    "physicalLocation": {
                        "artifactLocation": {
                            "uri": f.file.display().to_string(),
                        },
                        "region": {
                            "startLine": f.line,
                            "startColumn": f.column,
                        }
                    }
                }],
                "properties": {
                    "evidence": f.evidence,
                }
            })
        })
        .collect();

    let rules: Vec<serde_json::Value> = {
        let mut seen = std::collections::HashSet::new();
        findings
            .iter()
            .filter(|f| seen.insert(f.detector.clone()))
            .map(|f| {
                json!({
                    "id": f.detector,
                    "shortDescription": {
                        "text": f.detector.replace('-', " "),
                    },
                    "defaultConfiguration": {
                        "level": sarif_level(&f.severity),
                    }
                })
            })
            .collect()
    };

    // Parse failures are reported as tool execution notifications, not as
    // findings, and they mark the run as unsuccessful so callers can detect
    // that the scan over invalid input is not authoritative.
    let notifications: Vec<serde_json::Value> = parse_errors
        .iter()
        .map(|e| {
            let mut region = json!({ "startLine": e.line, "startColumn": e.column });
            if let Some(end) = e.end_column {
                region["endColumn"] = json!(end);
            }
            json!({
                "level": "error",
                "message": { "text": e.message },
                "properties": { "category": e.category },
                "locations": [{
                    "physicalLocation": {
                        "artifactLocation": { "uri": e.file },
                        "region": region
                    }
                }]
            })
        })
        .collect();

    let sarif = 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": "daml-lint",
                    "version": env!("CARGO_PKG_VERSION"),
                    "informationUri": "https://github.com/example/daml-lint",
                    "rules": rules,
                }
            },
            "invocations": [{
                "executionSuccessful": parse_errors.is_empty(),
                "toolExecutionNotifications": notifications,
            }],
            "results": results,
        }]
    });

    serde_json::to_string_pretty(&sarif).unwrap()
}

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

fn format_markdown(findings: &[Finding], parse_errors: &[ParseError]) -> String {
    let mut out = String::new();
    out.push_str("# daml-lint Report\n\n");

    if !parse_errors.is_empty() {
        out.push_str(&format!("## Parse Errors ({})\n\n", parse_errors.len()));
        for e in parse_errors {
            out.push_str(&format!(
                "- `{}:{}:{}` [{}] {}\n",
                e.file, e.line, e.column, e.category, e.message
            ));
        }
        out.push('\n');
    }

    if findings.is_empty() {
        if parse_errors.is_empty() {
            out.push_str("No findings.\n");
        } else {
            out.push_str("No findings, but parse errors were reported above.\n");
        }
        return out;
    }

    let (critical, high, medium, low, info) = count_by_severity(findings);
    out.push_str(&format!(
        "**Summary:** {} finding(s) — {} Critical, {} High, {} Medium, {} Low, {} Info\n\n",
        findings.len(),
        critical,
        high,
        medium,
        low,
        info
    ));

    // Group by severity
    for severity in &[
        Severity::Critical,
        Severity::High,
        Severity::Medium,
        Severity::Low,
        Severity::Info,
    ] {
        let group: Vec<_> = findings
            .iter()
            .filter(|f| f.severity == *severity)
            .collect();
        if group.is_empty() {
            continue;
        }

        out.push_str(&format!("## {} ({})\n\n", severity, group.len()));

        for f in &group {
            out.push_str(&format!("### {} `{}`\n\n", f.severity, f.detector));
            out.push_str(&format!("**{}**\n\n", f.message));
            out.push_str(&format!("- **File:** `{}:{}`\n", f.file.display(), f.line));
            out.push_str(&format!(
                "- **Evidence:**\n  ```\n  {}\n  ```\n\n",
                f.evidence
            ));
        }
    }

    out
}

fn format_json(findings: &[Finding], parse_errors: &[ParseError]) -> String {
    #[derive(Serialize)]
    struct Report {
        tool: &'static str,
        version: &'static str,
        findings: Vec<FindingJson>,
        #[serde(rename = "parseErrors")]
        parse_errors: Vec<ParseErrorJson>,
        summary: Summary,
    }

    #[derive(Serialize)]
    struct ParseErrorJson {
        file: String,
        line: usize,
        column: usize,
        #[serde(rename = "endColumn", skip_serializing_if = "Option::is_none")]
        end_column: Option<usize>,
        message: String,
        category: &'static str,
    }

    #[derive(Serialize)]
    struct FindingJson {
        detector: String,
        severity: String,
        file: String,
        line: usize,
        column: usize,
        message: String,
        evidence: String,
    }

    #[derive(Serialize)]
    struct Summary {
        total: usize,
        critical: usize,
        high: usize,
        medium: usize,
        low: usize,
        info: usize,
        #[serde(rename = "parseErrors")]
        parse_errors: usize,
    }

    let (critical, high, medium, low, info) = count_by_severity(findings);

    let report = Report {
        tool: "daml-lint",
        version: env!("CARGO_PKG_VERSION"),
        findings: findings
            .iter()
            .map(|f| FindingJson {
                detector: f.detector.clone(),
                severity: f.severity.to_string(),
                file: f.file.display().to_string(),
                line: f.line,
                column: f.column,
                message: f.message.clone(),
                evidence: f.evidence.clone(),
            })
            .collect(),
        parse_errors: parse_errors
            .iter()
            .map(|e| ParseErrorJson {
                file: e.file.clone(),
                line: e.line,
                column: e.column,
                end_column: e.end_column,
                message: e.message.clone(),
                category: e.category,
            })
            .collect(),
        summary: Summary {
            total: findings.len(),
            critical,
            high,
            medium,
            low,
            info,
            parse_errors: parse_errors.len(),
        },
    };

    serde_json::to_string_pretty(&report).unwrap()
}

fn count_by_severity(findings: &[Finding]) -> (usize, usize, usize, usize, usize) {
    let critical = findings
        .iter()
        .filter(|f| f.severity == Severity::Critical)
        .count();
    let high = findings
        .iter()
        .filter(|f| f.severity == Severity::High)
        .count();
    let medium = findings
        .iter()
        .filter(|f| f.severity == Severity::Medium)
        .count();
    let low = findings
        .iter()
        .filter(|f| f.severity == Severity::Low)
        .count();
    let info = findings
        .iter()
        .filter(|f| f.severity == Severity::Info)
        .count();
    (critical, high, medium, low, info)
}

/// Returns exit code: 0 if no findings at or above the threshold, 1 otherwise.
pub fn exit_code(findings: &[Finding], fail_on: Severity) -> i32 {
    if findings.iter().any(|f| f.severity <= fail_on) {
        1
    } else {
        0
    }
}

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

    fn parse_err() -> ParseError {
        ParseError {
            file: "Bad.daml".to_string(),
            line: 3,
            column: 5,
            end_column: Some(11),
            message: "unterminated string literal".to_string(),
            category: "lexical-error",
        }
    }

    // A valid file (no findings, no parse errors) must still read as clean.
    #[test]
    fn clean_file_says_no_findings() {
        assert!(format_markdown(&[], &[]).contains("No findings."));
        let json: serde_json::Value = serde_json::from_str(&format_json(&[], &[])).unwrap();
        assert_eq!(json["parseErrors"].as_array().unwrap().len(), 0);
        assert_eq!(json["summary"]["parseErrors"], 0);
        let sarif: serde_json::Value = serde_json::from_str(&format_sarif(&[], &[])).unwrap();
        assert_eq!(
            sarif["runs"][0]["invocations"][0]["executionSuccessful"],
            true
        );
    }

    // Parse errors on a finding-free file must be visible in every format —
    // never reported as "No findings." with no other signal.
    #[test]
    fn markdown_exposes_parse_errors() {
        let out = format_markdown(&[], &[parse_err()]);
        assert!(out.contains("Parse Errors (1)"));
        assert!(out.contains("unterminated string literal"));
        assert!(!out.contains("\nNo findings.\n"));
    }

    #[test]
    fn json_exposes_parse_errors() {
        let json: serde_json::Value =
            serde_json::from_str(&format_json(&[], &[parse_err()])).unwrap();
        assert_eq!(json["parseErrors"].as_array().unwrap().len(), 1);
        assert_eq!(json["parseErrors"][0]["line"], 3);
        assert_eq!(json["summary"]["parseErrors"], 1);
    }

    // The recovery category and end column must reach machine-readable output
    // so consumers can distinguish unsupported syntax from a real malformation
    // and highlight the offending range.
    #[test]
    fn json_carries_category_and_end_column() {
        let json: serde_json::Value =
            serde_json::from_str(&format_json(&[], &[parse_err()])).unwrap();
        assert_eq!(json["parseErrors"][0]["category"], "lexical-error");
        assert_eq!(json["parseErrors"][0]["endColumn"], 11);
    }

    #[test]
    fn sarif_notification_carries_category_and_end_column() {
        let sarif: serde_json::Value =
            serde_json::from_str(&format_sarif(&[], &[parse_err()])).unwrap();
        let note = &sarif["runs"][0]["invocations"][0]["toolExecutionNotifications"][0];
        assert_eq!(note["properties"]["category"], "lexical-error");
        assert_eq!(
            note["locations"][0]["physicalLocation"]["region"]["endColumn"],
            11
        );
    }

    #[test]
    fn sarif_marks_run_unsuccessful_on_parse_errors() {
        let sarif: serde_json::Value =
            serde_json::from_str(&format_sarif(&[], &[parse_err()])).unwrap();
        let inv = &sarif["runs"][0]["invocations"][0];
        assert_eq!(inv["executionSuccessful"], false);
        assert_eq!(
            inv["toolExecutionNotifications"].as_array().unwrap().len(),
            1
        );
        // Parse errors are notifications, not findings.
        assert_eq!(sarif["runs"][0]["results"].as_array().unwrap().len(), 0);
    }
}