bpflint 0.3.0

Linting functionality for BPF C programs.
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

use std::env;
use std::fs::read_dir;
use std::path::Path;
use std::path::PathBuf;

use bpflint::Lint;
use bpflint::builtin_lints;


/// Check that `builtin_lints()` reports all lints we expect it to.
// Note that there is some overlap with logic from `build.rs` here, but
// we don't really have a good way to share it.
#[test]
fn validate_builtin_lints() {
    let manifest_dir = PathBuf::from(env::var("CARGO_MANIFEST_DIR").unwrap());
    let lint_dir = Path::new(&manifest_dir).join("lints");

    let mut lints = Vec::new();
    for result in read_dir(&lint_dir).unwrap() {
        let entry = result.unwrap();
        if let Some(lint_name) = entry.file_name().to_str().unwrap().strip_suffix(".scm") {
            let () = lints.push(lint_name.to_string());
        }
    }
    let () = lints.sort();

    let mut expected = builtin_lints()
        .map(|Lint { name, .. }| name)
        .collect::<Vec<_>>();
    let () = expected.sort();

    assert_eq!(lints, expected)
}

fn is_lower_ascii_slug(s: &str) -> bool {
    // Must be non‑empty and neither start nor end with a hyphen
    if s.is_empty() || s.starts_with('-') || s.ends_with('-') {
        return false;
    }

    // Validate every character
    s.chars().all(|c| c.is_ascii_lowercase() || c == '-')
}

mod slug {
    use super::*;

    #[test]
    fn valid() {
        assert!(is_lower_ascii_slug("hello"));
        assert!(is_lower_ascii_slug("hello-world"));
        assert!(is_lower_ascii_slug("a-b-c"));
    }

    #[test]
    fn invalid_chars() {
        assert!(!is_lower_ascii_slug("Hello"));
        assert!(!is_lower_ascii_slug("abc_def"));
        assert!(!is_lower_ascii_slug("naïve"));
    }

    #[test]
    fn hyphen_rules() {
        assert!(!is_lower_ascii_slug("-hello"));
        assert!(!is_lower_ascii_slug("hello-"));
        assert!(!is_lower_ascii_slug("-"));
    }

    #[test]
    fn empty() {
        assert!(!is_lower_ascii_slug(""));
    }
}


/// Check that our lint names comply with repository policy.
#[test]
fn builtin_lint_names() {
    for Lint { name, .. } in builtin_lints() {
        assert!(
            is_lower_ascii_slug(&name),
            "lint `{name}` contains invalid characters (allowed: [a-z] and `-`)"
        );
    }
}


/// Make sure that each lint has a test module associated with it.
#[test]
fn lint_test_assurance() {
    let manifest_dir = PathBuf::from(env::var("CARGO_MANIFEST_DIR").unwrap());
    let lint_test_dir = manifest_dir.join("tests").join("lints");

    for Lint { name, .. } in builtin_lints() {
        // Check that a test exists. It could still not be wired up, but
        // it's better than nothing.
        assert!(
            lint_test_dir
                .join(format!("{name}.rs"))
                .try_exists()
                .unwrap(),
            "tests for lint {name} are missing; please add to tests/lints/"
        )
    }
}