vade-cli 0.1.1

A command-line tool to deploy applications on Linux servers
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

use crate::config::{AppConfig, SystemdUnitConfig};
use miette::{LabeledSpan, Report, SourceCode, miette};
use std::collections::HashMap;
use toml_span::{Span, Spanned};

const ALL_SYSTEMD_UNIT_EXTENSIONS: [&str; 11] = [
    "service",
    "socket",
    "device",
    "mount",
    "automount",
    "swap",
    "target",
    "path",
    "timer",
    "slice",
    "scope",
];

pub struct ValidationError {
    span: Span,
    message: String,
}

pub struct ValidationErrors {
    errors: Vec<ValidationError>,
}

impl ValidationErrors {
    pub fn into_report<S: SourceCode + 'static>(self, source: S) -> Report {
        let labels = self
            .errors
            .into_iter()
            .map(|e| LabeledSpan::new_primary_with_span(Some(e.message), e.span.start..e.span.end))
            .collect::<Vec<_>>();
        miette!(labels = labels, "invalid vade config file").with_source_code(source)
    }
}

/// Runs all semantic checks on a structurally-valid [`AppConfig`]
pub fn validate(app_name: &str, config: &AppConfig) -> Result<(), ValidationErrors> {
    let mut errors = Vec::new();

    check_unit_filenames(app_name, &config.systemd_units, &mut errors);
    check_duplicate_unit_filenames(app_name, &config.systemd_units, &mut errors);

    if errors.is_empty() {
        Ok(())
    } else {
        // Report in source order
        errors.sort_by_key(|e| e.span.start);
        Err(ValidationErrors { errors })
    }
}

fn check_unit_filenames(
    app_name: &str,
    systemd_units: &[Spanned<SystemdUnitConfig>],
    errors: &mut Vec<ValidationError>,
) {
    for unit in systemd_units {
        if let Some(filename_suffix) = &unit.value.filename_suffix {
            let invalid_chars = filename_suffix
                .value
                .chars()
                .filter(|c| !c.is_ascii_alphanumeric() && ![':', '-', '_', '.', '\\'].contains(c))
                .map(|c| c.to_string())
                .collect::<Vec<_>>();

            if !invalid_chars.is_empty() {
                errors.push(ValidationError {
                    span: filename_suffix.span,
                    message: format!(
                        "the following characters are not allowed in a systemd unit filename: {}",
                        invalid_chars.join(", ")
                    ),
                })
            }
        }

        if let Some(file_extension) = &unit.value.file_extension
            && !ALL_SYSTEMD_UNIT_EXTENSIONS.contains(&file_extension.value.as_str())
        {
            let valid_extensions = ALL_SYSTEMD_UNIT_EXTENSIONS.join(", ");
            errors.push(ValidationError {
                    span: file_extension.span,
                    message: format!("`{}` is not a valid systemd unit extension (valid extensions are: {valid_extensions})", file_extension.value),
                })
        }

        let name = unit.value.filename(app_name);
        if name.len() > 255 {
            errors.push(ValidationError {
                span: unit.span,
                message: format!("The total length of the unit name must not exceed 255 characters, but it is currently {} characters", name.len())
            })
        }
    }
}

fn check_duplicate_unit_filenames(
    app_name: &str,
    systemd_units: &[Spanned<SystemdUnitConfig>],
    errors: &mut Vec<ValidationError>,
) {
    let mut spans_by_filename: HashMap<_, Vec<_>> = HashMap::new();
    for unit in systemd_units {
        let key = unit.value.filename(app_name);
        spans_by_filename.entry(key).or_default().push(unit.span);
    }

    for (filename, spans) in spans_by_filename {
        if spans.len() < 2 {
            continue;
        }

        for span in spans {
            errors.push(ValidationError {
                    message: format!("systemd unit filename `{filename}` is declared multiple times, you can use the `filename-suffix` and `file-extension` properties to differentiate between them"),
                span,
            });
        }
    }
}