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
133
134
135
136
137
138

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

pub fn detect(
    ws: &dyn Workspace,
    _preferences: &FixerPreferences,
) -> Result<Vec<Diagnostic>, FixerError> {
    let old_rel = PathBuf::from("debian/source.lintian-overrides");
    let new_rel = PathBuf::from("debian/source/lintian-overrides");

    let Some(old_bytes) = ws.read_file(&old_rel)? else {
        return Ok(Vec::new());
    };
    let old_content =
        String::from_utf8(old_bytes.into_owned()).map_err(|e| FixerError::Other(e.to_string()))?;

    let merged_content = if let Some(existing_bytes) = ws.read_file(&new_rel)? {
        let mut existing = String::from_utf8(existing_bytes.into_owned())
            .map_err(|e| FixerError::Other(e.to_string()))?;
        existing.push_str(&old_content);
        existing
    } else {
        old_content
    };

    let issue = LintianIssue::source_with_info(
        "old-source-override-location",
        Visibility::Pedantic,
        vec!["debian/source.lintian-overrides".to_string()],
    );

    Ok(vec![Diagnostic::with_actions(
        issue,
        "Source overrides live at deprecated location.",
        "Move source package lintian overrides to debian/source.",
        vec![
            Action::Filesystem(FilesystemAction::Write {
                file: new_rel,
                content: merged_content.into_bytes(),
            }),
            Action::Filesystem(FilesystemAction::Delete { file: old_rel }),
        ],
    )
    .with_certainty(Certainty::Certain)])
}

declare_detector! {
    name: "package-uses-deprecated-source-override-location",
    tags: ["old-source-override-location"],
    triggers: [
        debian_workspace::Trigger::File("debian/source.lintian-overrides"),
        debian_workspace::Trigger::File("debian/source/lintian-overrides"),
    ],
    detect: |ws, prefs| detect(ws, prefs),
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::detector::Detector;
    use crate::{FixerPreferences, Version};
    use std::fs;
    use std::path::Path;
    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.clone()),
            );
            adapter.apply(&ws, &FixerPreferences::default())
        }
    }

    #[test]
    fn test_simple_move() {
        let temp_dir = TempDir::new().unwrap();
        let base_path = temp_dir.path();
        let debian_dir = base_path.join("debian");
        fs::create_dir(&debian_dir).unwrap();

        let old_path = debian_dir.join("source.lintian-overrides");
        fs::write(&old_path, "foo source: some-tag exact match\n").unwrap();

        let result = run_apply(base_path).unwrap();
        assert_eq!(
            result.description,
            "Move source package lintian overrides to debian/source."
        );
        assert_eq!(result.certainty, Some(Certainty::Certain));

        assert!(!old_path.exists());
        let new_path = debian_dir.join("source/lintian-overrides");
        assert_eq!(
            fs::read_to_string(&new_path).unwrap(),
            "foo source: some-tag exact match\n"
        );
    }

    #[test]
    fn test_append_to_existing() {
        let temp_dir = TempDir::new().unwrap();
        let base_path = temp_dir.path();
        let debian_dir = base_path.join("debian");
        let source_dir = debian_dir.join("source");
        fs::create_dir_all(&source_dir).unwrap();

        let old_path = debian_dir.join("source.lintian-overrides");
        let new_path = source_dir.join("lintian-overrides");
        fs::write(&old_path, "foo source: tag-a\n").unwrap();
        fs::write(&new_path, "foo source: tag-b\n").unwrap();

        run_apply(base_path).unwrap();

        assert!(!old_path.exists());
        assert_eq!(
            fs::read_to_string(&new_path).unwrap(),
            "foo source: tag-b\nfoo source: tag-a\n"
        );
    }

    #[test]
    fn test_no_change_when_no_old_file() {
        let temp_dir = TempDir::new().unwrap();
        let base_path = temp_dir.path();
        let debian_dir = base_path.join("debian");
        fs::create_dir(&debian_dir).unwrap();

        assert!(matches!(run_apply(base_path), Err(FixerError::NoChanges)));
    }
}