gruff-rs 0.4.0

Rust static analyzer and quality linter for CI: dead-code, complexity, security, secrets, and architecture rules with deterministic SARIF/JSON output and baseline support.
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

use super::dead_code::has_dead_code_symbol;
use super::*;

#[test]
pub(crate) fn project_dead_code_honors_module_level_allow_dead_code() {
    let _guard = analysis_lock();
    let dir = tempdir().expect("tempdir");
    fs::create_dir_all(dir.path().join("src")).expect("src dir");
    fs::write(dir.path().join("README.md"), "# Fixture\n").expect("readme write");
    fs::write(
        dir.path().join("src/lib.rs"),
        "pub mod generated;\nfn ordinary_unused() {}\npub fn entry() {}\n",
    )
    .expect("lib write");
    // A module file with an inner `#![allow(dead_code)]` keeps its items on purpose.
    fs::write(
        dir.path().join("src/generated.rs"),
        "#![allow(dead_code)]\nfn intentionally_kept() {}\n",
    )
    .expect("generated write");

    let report = run_project_analysis(
        dir.path(),
        AnalysisOptions {
            paths: vec![PathBuf::from(".")],
            no_config: true,
            no_baseline: true,
            ..default_test_options()
        },
    )
    .expect("analysis succeeds");
    assert!(
        !has_dead_code_symbol(&report, "intentionally_kept"),
        "module-level #![allow(dead_code)] must suppress its private items"
    );
    assert!(
        has_dead_code_symbol(&report, "ordinary_unused"),
        "an unrelated unused private item must still flag"
    );
}

#[test]
pub(crate) fn project_dead_code_suppressed_when_a_sibling_fails_to_parse() {
    let _guard = analysis_lock();
    let dir = tempdir().expect("tempdir");
    fs::create_dir_all(dir.path().join("src")).expect("src dir");
    fs::write(dir.path().join("README.md"), "# Fixture\n").expect("readme write");
    // `helper_used_by_sibling` is referenced only by the sibling that fails to parse.
    fs::write(
        dir.path().join("src/lib.rs"),
        "mod broken;\nfn helper_used_by_sibling() {}\npub fn entry() {}\n",
    )
    .expect("lib write");
    fs::write(
        dir.path().join("src/broken.rs"),
        "pub fn call( { crate::helper_used_by_sibling() }\n",
    )
    .expect("broken write");

    let report = run_project_analysis(
        dir.path(),
        AnalysisOptions {
            paths: vec![PathBuf::from(".")],
            no_config: true,
            no_baseline: true,
            ..default_test_options()
        },
    )
    .expect("analysis succeeds");
    assert!(
        !has_dead_code_symbol(&report, "helper_used_by_sibling"),
        "a parse-failed sibling makes coverage partial, suppressing cross-file dead-code"
    );
    assert!(
        report
            .diagnostics
            .iter()
            .any(|diagnostic| diagnostic.diagnostic_type == "partial-context-rule-suppressed"),
        "partial coverage from the unparseable file must emit the suppression diagnostic"
    );
}