solcompat 0.1.0

Evidence-based compatibility checks for Solana programs and clients
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
use solcompat_core::{Outcome, Report, Severity};
use std::{ffi::OsString, fmt::Write};

const RESET: &str = "\x1b[0m";
const BOLD_GREEN: &str = "\x1b[1;32m";
const BOLD_RED: &str = "\x1b[1;31m";
const BOLD_YELLOW: &str = "\x1b[1;33m";
const BOLD_CYAN: &str = "\x1b[1;36m";
const BOLD_MAGENTA: &str = "\x1b[1;35m";
const DIM: &str = "\x1b[2m";

fn paint(value: &str, color: &str, enabled: bool) -> String {
    if enabled {
        format!("{color}{value}{RESET}")
    } else {
        value.into()
    }
}

pub fn error(message: &str, color: bool) -> String {
    format!("{} — {message}", paint("ERROR", BOLD_RED, color))
}

// Prevent untrusted manifest/config text from injecting terminal controls or fake rows.
fn one_line(value: &str) -> String {
    value
        .chars()
        .flat_map(|c| {
            if c.is_control() || matches!(c, '\u{202a}'..='\u{202e}' | '\u{2066}'..='\u{2069}') {
                c.escape_unicode().to_string().chars().collect::<Vec<_>>()
            } else {
                vec![c]
            }
        })
        .collect()
}

fn quote(value: &str) -> String {
    if !value.is_empty()
        && value
            .bytes()
            .all(|b| b.is_ascii_alphanumeric() || b"-_=./:".contains(&b))
    {
        value.into()
    } else {
        format!("'{}'", value.replace('\'', "'\"'\"'"))
    }
}

fn counted(count: usize, singular: &str, plural: &str) -> String {
    format!("{count} {}", if count == 1 { singular } else { plural })
}

pub fn detailed_hint(args: impl Iterator<Item = OsString>) -> String {
    let mut args: Vec<_> = args.map(|arg| quote(&arg.to_string_lossy())).collect();
    if args.len() == 1 {
        args.push("check".into());
    }
    if !args.iter().any(|arg| arg == "--detailed") {
        args.push("--detailed".into());
    }
    args.join(" ")
}

pub fn report(report: &Report, detailed: bool, hint: &str, color: bool) -> String {
    let mut out = String::new();
    let has_visible_results = report
        .results
        .iter()
        .any(|result| result.outcome != Outcome::NotApplicable);
    writeln!(
        out,
        "SolCompat — {} · {}",
        one_line(&report.project.name),
        match report.command.as_str() {
            "inspect" => "inventory",
            "upgrade" => "upgrade advisor",
            _ if report
                .results
                .iter()
                .any(|result| result.operation == "build") =>
            {
                "compatibility + build"
            }
            _ => "compatibility scan",
        }
    )
    .unwrap();
    writeln!(out, "Target: {}", report.target).unwrap();
    if report.command != "inspect" {
        let (verdict, verdict_color) = if report.command == "upgrade" && report.counts.errors > 0 {
            ("BREAKING CHANGES DETECTED", BOLD_RED)
        } else if report.command == "upgrade" && report.counts.warnings > 0 {
            ("UPGRADE REVIEW NEEDED", BOLD_YELLOW)
        } else if report.counts.errors > 0 {
            ("INCOMPATIBLE FOR CHECKED RULES", BOLD_RED)
        } else if (report.counts.unknown > 0 || report.counts.skipped > 0)
            && report.policy.deny_unknown
        {
            ("FAILED POLICY — INPUT REQUIRED", BOLD_RED)
        } else if report.counts.unknown > 0 || report.counts.skipped > 0 {
            ("INCOMPLETE", BOLD_YELLOW)
        } else if report.counts.warnings > 0 && report.policy.deny_warnings {
            ("FAILED POLICY — WARNINGS DENIED", BOLD_RED)
        } else if report.counts.warnings > 0 {
            ("PASSED WITH WARNINGS", BOLD_YELLOW)
        } else if report.counts.info > 0 {
            ("PASSED WITH NOTES", BOLD_CYAN)
        } else if report.counts.suppressed > 0 {
            ("REVIEW SUPPRESSIONS", BOLD_MAGENTA)
        } else if !has_visible_results && report.command == "upgrade" {
            ("NO APPLICABLE UPGRADE ADVICE", DIM)
        } else if !has_visible_results {
            ("NO APPLICABLE CHECKS", DIM)
        } else {
            ("COMPATIBLE FOR CHECKED RULES", BOLD_GREEN)
        };
        writeln!(out, "Verdict: {}", paint(verdict, verdict_color, color)).unwrap();
        writeln!(
            out,
            "Scope: {} · {} · {} · {}",
            counted(report.project.programs.len(), "program", "programs"),
            counted(report.project.clients.len(), "client", "clients"),
            counted(report.project.idls.len(), "IDL", "IDLs"),
            counted(report.project.artifacts.len(), "artifact", "artifacts")
        )
        .unwrap();
        if !has_visible_results {
            writeln!(
                out,
                "{}",
                if report.command == "upgrade" {
                    "No reviewed migration advice applies to the detected components and selected targets."
                } else {
                    "No configured checks apply to the detected components and selected target."
                }
            )
            .unwrap();
            if report
                .project
                .programs
                .iter()
                .any(|program| program.framework == "pinocchio")
            {
                writeln!(
                    out,
                    "Pinocchio checks require an explicit sBPFv3 build profile (SC103) or a supplied artifact with an applicable target (SC102). Builds and target/ outputs are not imported automatically in v0.1."
                )
                .unwrap();
            }
        }
        if report.counts.warnings > 0
            && report.counts.errors == 0
            && report.counts.unknown == 0
            && report.counts.skipped == 0
        {
            writeln!(
                out,
                "No incompatibility was detected; {} should be reviewed.",
                counted(
                    report.counts.warnings,
                    "advisory warning",
                    "advisory warnings"
                )
            )
            .unwrap();
        }
        if report.counts.unknown > 0 && report.counts.errors == 0 {
            writeln!(
                out,
                "No incompatibility was detected, but {} could not be completed.",
                counted(report.counts.unknown, "check", "checks")
            )
            .unwrap();
        }
    }
    if detailed {
        if let Some(digest) = &report.target_digest {
            writeln!(out, "Target data: {digest}").unwrap();
        }
    }
    if report.command == "inspect" {
        for client in &report.project.clients {
            writeln!(
                out,
                "\nCLIENT {} — {}",
                one_line(&client.id),
                one_line(&client.manifest)
            )
            .unwrap();
            for (package, requirement) in &client.dependencies {
                writeln!(
                    out,
                    "  {}: {} (declared)",
                    one_line(package),
                    one_line(requirement)
                )
                .unwrap();
            }
            for (package, version) in &client.resolved_dependencies {
                writeln!(
                    out,
                    "  {}: {} (resolved)",
                    one_line(package),
                    one_line(version)
                )
                .unwrap();
            }
            writeln!(out, "  RPC read contracts: {}", client.rpc_reads.len()).unwrap();
        }
        for program in &report.project.programs {
            writeln!(
                out,
                "\nPROGRAM CANDIDATE {} — {}",
                one_line(&program.id),
                one_line(&program.manifest)
            )
            .unwrap();
            writeln!(
                out,
                "  Framework: {} ({})",
                one_line(&program.framework),
                one_line(&program.candidate_reason)
            )
            .unwrap();
            for (package, version) in &program.resolved_dependencies {
                writeln!(
                    out,
                    "  {}: {} (resolved)",
                    one_line(package),
                    one_line(version)
                )
                .unwrap();
            }
        }
        for idl in &report.project.idls {
            writeln!(
                out,
                "\nIDL {} — {} ({})",
                one_line(&idl.id),
                one_line(&idl.path),
                one_line(&idl.schema)
            )
            .unwrap();
        }
        for artifact in &report.project.artifacts {
            writeln!(
                out,
                "\nARTIFACT {} — {} (sBPF{})",
                one_line(&artifact.id),
                one_line(&artifact.path),
                one_line(artifact.sbpf_version.as_deref().unwrap_or("unknown"))
            )
            .unwrap();
        }
        for tool in &report.project.tools {
            writeln!(
                out,
                "\nTOOL {} — {}",
                one_line(&tool.tool),
                one_line(tool.version.as_deref().unwrap_or(&tool.status))
            )
            .unwrap();
        }
        writeln!(
            out,
            "\n{} component(s) inspected; no compatibility checks executed.",
            report.project.clients.len() + report.project.programs.len()
        )
        .unwrap();
        return out.trim_end().into();
    }
    if detailed {
        writeln!(
            out,
            "Data: {} ({})",
            one_line(&report.dataset.revision),
            report.dataset.digest
        )
        .unwrap();
    }
    if detailed && has_visible_results {
        writeln!(
            out,
            "Status: {} verified · {} incompatible · {} review · {} insufficient evidence",
            paint("PASS", BOLD_GREEN, color),
            paint("ERROR", BOLD_RED, color),
            paint("WARNING", BOLD_YELLOW, color),
            paint("NEEDS INPUT", BOLD_YELLOW, color)
        )
        .unwrap();
    }
    if has_visible_results {
        out.push('\n');
    }
    for result in &report.results {
        // Not-applicable results remain in JSON for auditing, but do not help a
        // developer act on a terminal report—even in detailed mode.
        if result.outcome == Outcome::NotApplicable {
            continue;
        }
        let (status, status_color) = if result.suppression.is_some() {
            ("SUPPRESSED", BOLD_MAGENTA)
        } else {
            match result.outcome {
                Outcome::Pass => ("PASS", BOLD_GREEN),
                Outcome::Unknown => ("NEEDS INPUT", BOLD_YELLOW),
                Outcome::NotApplicable => ("N/A", DIM),
                Outcome::Skipped => ("SKIPPED", BOLD_CYAN),
                Outcome::Finding => match result.severity {
                    Some(Severity::Error) if report.command == "upgrade" => ("BREAKING", BOLD_RED),
                    Some(Severity::Error) => ("ERROR", BOLD_RED),
                    Some(Severity::Warning) => ("WARNING", BOLD_YELLOW),
                    _ => ("INFO", BOLD_CYAN),
                },
            }
        };
        let title = if detailed {
            &result.title
        } else {
            &result.rule_name
        };
        writeln!(
            out,
            "{}{} — {} ({}) · {}",
            paint(status, status_color, color),
            if result.conditional {
                " [CONDITIONAL]"
            } else {
                ""
            },
            one_line(title),
            result.rule_id,
            one_line(&result.subject)
        )
        .unwrap();
        writeln!(out, "  {}", one_line(&result.summary)).unwrap();
        if let Some(suppression) = &result.suppression {
            writeln!(out, "  Suppressed: {}", one_line(&suppression.reason)).unwrap();
        }
        if detailed {
            writeln!(out, "  Why: {}", one_line(&result.explanation)).unwrap();
            for evidence in &result.evidence {
                writeln!(
                    out,
                    "  Evidence: {} [{}; {}]",
                    one_line(&evidence.path),
                    one_line(&evidence.pointer),
                    one_line(&evidence.kind)
                )
                .unwrap();
            }
            if let Some(fix) = &result.remediation {
                writeln!(
                    out,
                    "  Next: {}\n  Where: {}",
                    one_line(&fix.summary),
                    one_line(&fix.location)
                )
                .unwrap();
                for (index, step) in fix.steps.iter().enumerate() {
                    writeln!(out, "  {}. {}", index + 1, one_line(step)).unwrap();
                }
                if let Some(example) = &fix.example {
                    writeln!(out, "  Example:").unwrap();
                    for line in example.lines() {
                        writeln!(out, "    {}", one_line(line)).unwrap();
                    }
                }
                for step in &fix.verification {
                    writeln!(out, "  Verify: {}", one_line(step)).unwrap();
                }
            }
            for source in &result.sources {
                writeln!(out, "  Reference: {}", one_line(source)).unwrap();
            }
        } else if let Some(fix) = &result.remediation {
            writeln!(out, "  Next: {}", one_line(&fix.summary)).unwrap();
        }
        out.push('\n');
    }
    let c = &report.counts;
    let counts = [
        (c.passed, "passed", "passed"),
        (c.errors, "error", "errors"),
        (c.warnings, "warning", "warnings"),
        (c.info, "info", "info"),
        (c.unknown, "check needs input", "checks need input"),
        (c.skipped, "skipped", "skipped"),
        (c.suppressed, "suppressed", "suppressed"),
    ]
    .into_iter()
    .filter(|(count, _, _)| *count > 0)
    .map(|(count, singular, plural)| {
        format!("{count} {}", if count == 1 { singular } else { plural })
    })
    .collect::<Vec<_>>()
    .join(" · ");
    if !counts.is_empty() {
        writeln!(out, "{counts}").unwrap();
    }
    writeln!(out, "Exit code: {}", report.exit_code).unwrap();
    if !detailed && has_visible_results {
        writeln!(out, "Details: {}", one_line(hint)).unwrap();
    }
    out.trim_end().into()
}