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
132

use crate::declare_detector;
use crate::diagnostic::{Action, Diagnostic, FilesystemAction};
use crate::{FixerError, FixerPreferences, LintianIssue, Visibility};
use debian_workspace::Workspace;
use std::path::{Path, PathBuf};

pub fn detect(
    ws: &dyn Workspace,
    _preferences: &FixerPreferences,
) -> Result<Vec<Diagnostic>, FixerError> {
    let rel = Path::new("debian/files");
    let contents = match ws.read_file(rel)? {
        Some(c) => c,
        None => return Ok(Vec::new()),
    };

    // lintian only emits the tag for a non-empty debian/files.
    if contents.is_empty() {
        return Ok(Vec::new());
    }

    let issue = LintianIssue::source_with_info(
        "debian-files-list-in-source",
        Visibility::Error,
        vec!["debian/files".to_string()],
    );

    Ok(vec![Diagnostic::with_actions(
        issue,
        "debian/files is present in the source tree.".to_string(),
        "Remove debian/files from the source tree.".to_string(),
        vec![Action::Filesystem(FilesystemAction::Delete {
            file: PathBuf::from("debian/files"),
        })],
    )])
}

declare_detector! {
    name: "debian-files-list-in-source",
    tags: ["debian-files-list-in-source"],
    triggers: [
        debian_workspace::Trigger::File("debian/files"),
    ],
    detect: |ws, prefs| detect(ws, prefs),
}

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

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

    fn detect_issues(base: &Path) -> Vec<Diagnostic> {
        let version: Version = "1.0".parse().unwrap();
        let ws = debian_workspace::fs_workspace::FsWorkspace::new(
            base,
            Some("test".into()),
            Some(version),
        );
        detect(&ws, &FixerPreferences::default()).unwrap()
    }

    #[test]
    fn test_removes_debian_files() {
        let tmp = TempDir::new().unwrap();
        let debian = tmp.path().join("debian");
        fs::create_dir_all(&debian).unwrap();
        let files = debian.join("files");
        fs::write(&files, "foo_1.0-1_amd64.deb misc optional\n").unwrap();

        let result = run_apply(tmp.path()).unwrap();
        assert!(!files.exists());
        assert_eq!(
            result.description,
            "Remove debian/files from the source tree."
        );
    }

    #[test]
    fn test_issue_info_matches_lintian() {
        let tmp = TempDir::new().unwrap();
        let debian = tmp.path().join("debian");
        fs::create_dir_all(&debian).unwrap();
        fs::write(debian.join("files"), "pkg_1_all.deb misc optional\n").unwrap();

        let diags = detect_issues(tmp.path());
        assert_eq!(diags.len(), 1);
        let issue = diags[0].issue.as_ref().unwrap();
        assert_eq!(issue.tag.as_deref(), Some("debian-files-list-in-source"));
        assert_eq!(issue.info.as_deref(), Some("debian/files"));
        assert_eq!(
            issue.to_string(),
            "source: debian-files-list-in-source debian/files"
        );
    }

    #[test]
    fn test_no_change_when_no_debian_files() {
        let tmp = TempDir::new().unwrap();
        let debian = tmp.path().join("debian");
        fs::create_dir_all(&debian).unwrap();
        fs::write(debian.join("control"), "").unwrap();

        assert!(matches!(run_apply(tmp.path()), Err(FixerError::NoChanges)));
    }

    #[test]
    fn test_no_change_when_empty_debian_files() {
        let tmp = TempDir::new().unwrap();
        let debian = tmp.path().join("debian");
        fs::create_dir_all(&debian).unwrap();
        let files = debian.join("files");
        fs::write(&files, "").unwrap();

        assert!(matches!(run_apply(tmp.path()), Err(FixerError::NoChanges)));
        // An empty debian/files does not trigger the tag, so it is left alone.
        assert!(files.exists());
    }
}