check-config 0.9.12

Check configuration files.
Documentation 
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

use core::fmt::Debug as DebugTrait;
use std::io;
use thiserror::Error;

use crate::{checkers::RelativeUrl, uri::PathError};

use super::GenericChecker;

#[derive(Clone, Debug, PartialEq)]
pub enum CheckResult {
    NoFixNeeded,
    FixNeeded(String),
    FixExecuted(String),
    Error(String),
}

#[derive(Error, Debug, PartialEq)]
pub(crate) enum CheckDefinitionError {
    #[error("invalid check definition ({0})")]
    InvalidDefinition(String),
    #[error("Unknown checktype ({0})")]
    UnknownCheckType(String),
}

#[derive(Error, Debug)]
pub(crate) enum CheckError {
    #[error("file can not be read")]
    FileCanNotBeRead(#[from] io::Error),
    #[error("unknown file type ({0}); do not know how to handle")]
    UnknownFileType(String),
    #[error("file can not be removed")]
    FileCanNotBeRemoved,
    #[error("file can not be written")]
    FileCanNotBeWritten,
    #[error("invalid file format ({0})")]
    InvalidFileFormat(String),
    #[error("invalid regex format ({0})")]
    InvalidRegex(String),
    #[error("permission not available on this system")]
    PermissionsNotAccessable,
    #[error("git error ({0})")]
    GitError(String),
    #[error("file can not be fetched")]
    FetchError(#[from] PathError),
    #[error("{0}")]
    String(String),
    #[error("executing command failed")]
    CommandFailed(String),
}

pub(crate) trait CheckConstructor {
    type Output;
    fn from_check_table(
        generic_check: GenericChecker,
        value: toml_edit::Table,
    ) -> Result<Self::Output, CheckDefinitionError>;
}
pub(crate) trait Checker: DebugTrait {
    fn checker_type(&self) -> String;
    fn generic_checker(&self) -> &GenericChecker;
    fn checker_object(&self) -> String;

    fn list_checker(&self, enabled: bool) {
        log::error!(
            "{} {} - {} - {} - {:?}",
            if enabled { "⬜" } else { " ✖️" },
            self.generic_checker().file_with_checks.short_url_str(),
            self.checker_type(),
            self.checker_object(),
            self.generic_checker().tags
        )
    }
    fn print(&self, check_result: &CheckResult) {
        let (check_result_str, action_message) = match check_result {
            CheckResult::NoFixNeeded => ("✅", "".to_string()),
            CheckResult::FixNeeded(action) => ("❌", format!(" - {action}")),
            CheckResult::FixExecuted(action) => ("🔧", format!(" - {action}")),
            CheckResult::Error(e) => ("🚨", format!(" - {e}")),
        };
        let msg = format!(
            "{} {} - {} - {}{}",
            check_result_str,
            self.generic_checker().file_with_checks().short_url_str(),
            self.checker_type(),
            self.checker_object(),
            action_message
        );
        match check_result {
            CheckResult::NoFixNeeded => log::info!("{msg}"),
            CheckResult::FixExecuted(_) => log::info!("{msg}"),
            CheckResult::FixNeeded(_) => log::warn!("{msg}"),
            CheckResult::Error(_) => log::error!("{msg}"),
        }
    }

    fn check_(&self, fix: bool) -> Result<CheckResult, CheckError>;

    fn check(&self, fix: bool) -> CheckResult {
        let check_result = match self.check_(fix) {
            Ok(check_result) => check_result,
            Err(e) => CheckResult::Error(e.to_string()),
        };

        self.print(&check_result);

        check_result
    }
}