poexam 0.0.9

Blazingly fast PO linter.
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
139
140
141
142
143
144
145

// SPDX-FileCopyrightText: 2026 Sébastien Helleu <flashcode@flashtux.org>
//
// SPDX-License-Identifier: GPL-3.0-or-later

//! Implementation of the `compilation` rule: check compilation of PO file with msgfmt command.

use crate::checker::Checker;
use crate::diagnostic::{Diagnostic, Severity};
use crate::rules::rule::RuleChecker;

pub struct CompilationRule;

impl RuleChecker for CompilationRule {
    fn name(&self) -> &'static str {
        "compilation"
    }

    fn is_default(&self) -> bool {
        false
    }

    fn is_check(&self) -> bool {
        true
    }

    fn severity(&self) -> Severity {
        Severity::Error
    }

    /// Check for compilation errors using the `msgfmt` command.
    ///
    /// This rule is not enabled by default.
    ///
    /// Diagnostics reported with severity [`error`](Severity::Error):
    /// - `command '/usr/bin/msgfmt' reported errors`
    /// - `failed to run command '/usr/bin/msgfmt'`
    fn check_file(&self, checker: &Checker) -> Vec<Diagnostic> {
        match std::process::Command::new(&checker.config.check.path_msgfmt)
            .arg("--check-format")
            .arg("-o")
            .arg("/dev/null")
            .arg(checker.path.as_path())
            .output()
        {
            Ok(output) => {
                if output.status.success() {
                    vec![]
                } else {
                    vec![
                        self.new_diag(
                            checker,
                            format!(
                                "command `{}` reported errors",
                                checker.config.check.path_msgfmt.display()
                            ),
                        )
                        .with_multiline(&String::from_utf8_lossy(&output.stderr)),
                    ]
                }
            }
            Err(err) => {
                vec![
                    self.new_diag(
                        checker,
                        format!(
                            "failed to run command `{}`",
                            checker.config.check.path_msgfmt.display()
                        ),
                    )
                    .with_multiline(&err.to_string()),
                ]
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use std::{
        fs::File,
        io::Read,
        path::{Path, PathBuf},
    };

    use super::*;
    use crate::{
        config::Config, config::DEFAULT_PATH_MSGFMT, diagnostic::Diagnostic, rules::rule::Rules,
    };

    fn check_compilation(filename: &str, path_msgfmt: &Path) -> Vec<Diagnostic> {
        let mut po_file = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
        po_file.push("resources");
        po_file.push("test");
        po_file.push(filename);
        let mut data: Vec<u8> = Vec::new();
        File::open(&po_file)
            .unwrap()
            .read_to_end(&mut data)
            .unwrap();
        let mut config = Config::default();
        config.check.path_msgfmt = path_msgfmt.to_path_buf();
        let mut checker = Checker::new(&data)
            .with_path(po_file.as_path())
            .with_config(config);
        let rules = Rules::new(vec![Box::new(CompilationRule {})]);
        checker.do_all_checks(&rules);
        checker.diagnostics
    }

    #[test]
    fn test_compilation_ok() {
        // Skip this test if the msgfmt command is not available.
        if !Path::new(DEFAULT_PATH_MSGFMT).exists() {
            return;
        }
        let diags = check_compilation("fr_compilation_ok.po", Path::new(DEFAULT_PATH_MSGFMT));
        assert!(diags.is_empty());
    }

    #[test]
    fn test_compilation_error() {
        // Skip this test if the msgfmt command is not available.
        if !Path::new(DEFAULT_PATH_MSGFMT).exists() {
            return;
        }
        let diags = check_compilation("fr_compilation_error.po", Path::new(DEFAULT_PATH_MSGFMT));
        assert_eq!(diags.len(), 1);
        let diag = &diags[0];
        assert_eq!(diag.severity, Severity::Error);
        assert_eq!(
            diag.message,
            format!("command `{DEFAULT_PATH_MSGFMT}` reported errors")
        );
    }

    #[test]
    fn test_compilation_command_not_fount() {
        let path = "this_path_does_not_exist";
        let diags = check_compilation("fr_compilation_error.po", Path::new(path));
        assert_eq!(diags.len(), 1);
        let diag = &diags[0];
        assert_eq!(diag.severity, Severity::Error);
        assert_eq!(diag.message, format!("failed to run command `{path}`"));
    }
}