lintian-brush 0.182.0

Automatic lintian issue fixer
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

use crate::declare_detector;
use crate::diagnostic::{Action, ActionPlan, DebcargoAction, Diagnostic};
use crate::{Certainty, FixerError, FixerPreferences};
use debian_workspace::Workspace;
use std::path::PathBuf;

pub fn detect(
    ws: &dyn Workspace,
    _preferences: &FixerPreferences,
) -> Result<Vec<Diagnostic>, FixerError> {
    let debcargo_rel = PathBuf::from("debian/debcargo.toml");

    let Some(doc) = ws.parsed_debcargo()? else {
        return Ok(Vec::new());
    };

    // If collapse_features is already set to true, nothing to do.
    if doc
        .get("collapse_features")
        .and_then(|v| v.as_bool())
        .unwrap_or(false)
    {
        return Ok(Vec::new());
    }

    Ok(vec![Diagnostic {
        issue: None,
        message: "Set collapse_features = true in debian/debcargo.toml.".to_string(),
        certainty: Some(Certainty::Certain),
        patch_name: None,
        plans: vec![ActionPlan {
            label: "Set collapse_features = true in debian/debcargo.toml.".to_string(),
            opinionated: false,
            certainty: None,
            actions: vec![Action::Debcargo(DebcargoAction::SetTopLevelBool {
                file: debcargo_rel,
                field: "collapse_features".to_string(),
                value: true,
            })],
        }],
    }])
}

declare_detector! {
    name: "debcargo-collapse-features",
    tags: [],
    triggers: [
        debian_workspace::Trigger::DebcargoField("collapse_features"),
    ],
    detect: |ws, prefs| detect(ws, prefs),
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::detector::Detector;
    use crate::Version;
    use std::fs;
    use tempfile::TempDir;

    fn run_apply(base: &std::path::Path) -> Result<crate::FixerResult, FixerError> {
        let v: Version = "1.0".parse().unwrap();
        let adapter = DetectorImpl;
        {
            let ws = debian_workspace::fs_workspace::FsWorkspace::new(
                base,
                Some("test".into()),
                Some(v.clone()),
            );
            adapter.apply(&ws, &FixerPreferences::default())
        }
    }

    #[test]
    fn test_no_debcargo_toml() {
        let tmp = TempDir::new().unwrap();
        fs::create_dir(tmp.path().join("debian")).unwrap();
        assert!(matches!(run_apply(tmp.path()), Err(FixerError::NoChanges)));
    }

    #[test]
    fn test_collapse_features_already_true() {
        let tmp = TempDir::new().unwrap();
        let debian = tmp.path().join("debian");
        fs::create_dir(&debian).unwrap();
        fs::write(debian.join("debcargo.toml"), "collapse_features = true\n").unwrap();
        assert!(matches!(run_apply(tmp.path()), Err(FixerError::NoChanges)));
    }

    #[test]
    fn test_collapse_features_missing() {
        let tmp = TempDir::new().unwrap();
        let debian = tmp.path().join("debian");
        fs::create_dir(&debian).unwrap();
        let debcargo_path = debian.join("debcargo.toml");
        fs::write(
            &debcargo_path,
            "[source]\nhomepage = \"https://example.com\"\n",
        )
        .unwrap();

        let result = run_apply(tmp.path()).unwrap();
        assert_eq!(
            result.description,
            "Set collapse_features = true in debian/debcargo.toml."
        );
        assert_eq!(
            fs::read_to_string(&debcargo_path).unwrap(),
            "collapse_features = true\n[source]\nhomepage = \"https://example.com\"\n",
        );
    }

    #[test]
    fn test_collapse_features_false() {
        let tmp = TempDir::new().unwrap();
        let debian = tmp.path().join("debian");
        fs::create_dir(&debian).unwrap();
        let debcargo_path = debian.join("debcargo.toml");
        fs::write(&debcargo_path, "collapse_features = false\n").unwrap();

        let result = run_apply(tmp.path()).unwrap();
        assert_eq!(
            result.description,
            "Set collapse_features = true in debian/debcargo.toml."
        );
        assert_eq!(
            fs::read_to_string(&debcargo_path).unwrap(),
            "collapse_features = true\n",
        );
    }
}