devops-models 0.1.0

Typed serde models for DevOps configuration formats: Kubernetes, Docker Compose, GitLab CI, GitHub Actions, Prometheus, Alertmanager, Helm, Ansible, and OpenAPI.
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
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314

use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use crate::models::validation::{ConfigValidator, Diagnostic, Severity, YamlType};

// ═══════════════════════════════════════════════════════════════════════════
// Docker Compose
// ═══════════════════════════════════════════════════════════════════════════

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ComposeHealthcheck {
    #[serde(default)]
    pub test: Option<serde_json::Value>,
    #[serde(default)]
    pub interval: Option<String>,
    #[serde(default)]
    pub timeout: Option<String>,
    #[serde(default)]
    pub retries: Option<u32>,
    #[serde(default)]
    pub start_period: Option<String>,
    #[serde(default)]
    pub start_interval: Option<String>,
    #[serde(default)]
    pub disable: Option<bool>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ComposeBuild {
    #[serde(default)]
    pub context: Option<String>,
    #[serde(default)]
    pub dockerfile: Option<String>,
    #[serde(default)]
    pub args: Option<serde_json::Value>,
    #[serde(default)]
    pub target: Option<String>,
    #[serde(default)]
    pub cache_from: Option<Vec<String>>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ComposeDeploy {
    #[serde(default)]
    pub replicas: Option<u32>,
    #[serde(default)]
    pub resources: Option<serde_json::Value>,
    #[serde(default)]
    pub restart_policy: Option<serde_json::Value>,
    #[serde(default)]
    pub update_config: Option<serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ComposeService {
    #[serde(default)]
    pub image: Option<String>,
    #[serde(default)]
    pub build: Option<serde_json::Value>,
    #[serde(default)]
    pub ports: Vec<serde_json::Value>,
    #[serde(default)]
    pub volumes: Vec<serde_json::Value>,
    #[serde(default)]
    pub environment: Option<serde_json::Value>,
    #[serde(default)]
    pub env_file: Option<serde_json::Value>,
    #[serde(default)]
    pub depends_on: Option<serde_json::Value>,
    #[serde(default)]
    pub networks: Option<serde_json::Value>,
    #[serde(default)]
    pub command: Option<serde_json::Value>,
    #[serde(default)]
    pub entrypoint: Option<serde_json::Value>,
    #[serde(default)]
    pub restart: Option<String>,
    #[serde(default)]
    pub deploy: Option<ComposeDeploy>,
    #[serde(default)]
    pub healthcheck: Option<ComposeHealthcheck>,
    #[serde(default)]
    pub container_name: Option<String>,
    #[serde(default)]
    pub hostname: Option<String>,
    #[serde(default)]
    pub labels: Option<serde_json::Value>,
    #[serde(default)]
    pub logging: Option<serde_json::Value>,
    #[serde(default)]
    pub expose: Vec<serde_json::Value>,
    #[serde(default)]
    pub extra_hosts: Option<serde_json::Value>,
    #[serde(default)]
    pub working_dir: Option<String>,
    #[serde(default)]
    pub user: Option<String>,
    #[serde(default)]
    pub privileged: Option<bool>,
    #[serde(default)]
    pub cap_add: Vec<String>,
    #[serde(default)]
    pub cap_drop: Vec<String>,
    #[serde(default)]
    pub security_opt: Vec<String>,
    #[serde(default)]
    pub tmpfs: Option<serde_json::Value>,
    #[serde(default)]
    pub stdin_open: Option<bool>,
    #[serde(default)]
    pub tty: Option<bool>,
    #[serde(default)]
    pub secrets: Option<serde_json::Value>,
    #[serde(default)]
    pub configs: Option<serde_json::Value>,
    #[serde(default)]
    pub profiles: Vec<String>,
    #[serde(default)]
    pub platform: Option<String>,
    #[serde(default)]
    pub init: Option<bool>,
    #[serde(default)]
    pub stop_grace_period: Option<String>,
    #[serde(default)]
    pub sysctls: Option<serde_json::Value>,
    #[serde(default)]
    pub ulimits: Option<serde_json::Value>,
    #[serde(default)]
    pub pull_policy: Option<String>,
    #[serde(default)]
    pub mem_limit: Option<String>,
    #[serde(default)]
    pub cpus: Option<serde_json::Value>,
    #[serde(default)]
    pub shm_size: Option<serde_json::Value>,
    #[serde(default)]
    pub pid: Option<String>,
    #[serde(default)]
    pub network_mode: Option<String>,
    #[serde(default)]
    pub links: Vec<String>,
    #[serde(default)]
    pub external_links: Vec<String>,
    #[serde(default)]
    pub dns: Option<serde_json::Value>,
    #[serde(default)]
    pub dns_search: Option<serde_json::Value>,
    #[serde(default)]
    pub domainname: Option<String>,
    #[serde(default)]
    pub ipc: Option<String>,
    #[serde(default)]
    pub mac_address: Option<String>,
    #[serde(default)]
    pub extends: Option<serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DockerCompose {
    #[serde(default)]
    pub version: Option<String>,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub services: HashMap<String, ComposeService>,
    #[serde(default)]
    pub volumes: Option<serde_json::Value>,
    #[serde(default)]
    pub networks: Option<serde_json::Value>,
    #[serde(default)]
    pub secrets: Option<serde_json::Value>,
    #[serde(default)]
    pub configs: Option<serde_json::Value>,
    #[serde(default, rename = "x-common")]
    pub x_common: Option<serde_json::Value>,
}

impl DockerCompose {
    pub fn from_value(data: serde_json::Value) -> Result<Self, String> {
        serde_json::from_value(data)
            .map_err(|e| format!("Failed to parse Docker Compose: {e}"))
    }
}

impl ConfigValidator for DockerCompose {
    fn yaml_type(&self) -> YamlType { YamlType::DockerCompose }

    fn validate_structure(&self) -> Vec<Diagnostic> {
        let mut diags = Vec::new();
        if self.services.is_empty() {
            diags.push(Diagnostic {
                severity: Severity::Error,
                message: "No services defined".into(),
                path: Some("services".into()),
            });
        }
        for (name, svc) in &self.services {
            if svc.image.is_none() && svc.build.is_none() {
                diags.push(Diagnostic {
                    severity: Severity::Error,
                    message: format!("Service '{}': must specify either 'image' or 'build'", name),
                    path: Some(format!("services > {}", name)),
                });
            }
        }
        diags
    }

    fn validate_semantics(&self) -> Vec<Diagnostic> {
        let mut diags = Vec::new();
        // Deprecated version field
        if let Some(ver) = &self.version {
            diags.push(Diagnostic {
                severity: Severity::Info,
                message: format!("'version: \"{}\"' is deprecated in modern Docker Compose — it can be removed", ver),
                path: Some("version".into()),
            });
        }

        // Collect host ports for duplicate detection
        let mut host_ports: HashMap<String, Vec<String>> = HashMap::new();

        for (name, svc) in &self.services {
            // Image tag analysis
            if let Some(img) = &svc.image
                && (img.ends_with(":latest") || !img.contains(':')) {
                    diags.push(Diagnostic {
                        severity: Severity::Warning,
                        message: format!("Service '{}': using ':latest' or untagged image '{}' — pin a specific version", name, img),
                        path: Some(format!("services > {} > image", name)),
                    });
                }

            // No restart policy
            match svc.restart.as_deref() {
                Some("no") | None => {
                    diags.push(Diagnostic {
                        severity: Severity::Info,
                        message: format!("Service '{}': no restart policy — container won't restart automatically", name),
                        path: Some(format!("services > {} > restart", name)),
                    });
                }
                _ => {}
            }

            // No healthcheck
            if svc.healthcheck.is_none() {
                diags.push(Diagnostic {
                    severity: Severity::Info,
                    message: format!("Service '{}': no healthcheck defined", name),
                    path: Some(format!("services > {} > healthcheck", name)),
                });
            }

            // Privileged mode
            if svc.privileged == Some(true) {
                diags.push(Diagnostic {
                    severity: Severity::Warning,
                    message: format!("Service '{}': running in privileged mode — security risk", name),
                    path: Some(format!("services > {} > privileged", name)),
                });
            }

            // Port duplicate detection
            for port_val in &svc.ports {
                if let Some(port_str) = port_val.as_str() {
                    // Extract host port (before the last :)
                    if let Some(host_port) = extract_host_port(port_str) {
                        host_ports
                            .entry(host_port.clone())
                            .or_default()
                            .push(name.clone());
                    }
                }
            }

            // Sensitive bind mounts
            for vol in &svc.volumes {
                if let Some(vol_str) = vol.as_str() {
                    let path = vol_str.split(':').next().unwrap_or("");
                    if path == "/" || path == "/etc" || path == "/var/run/docker.sock" {
                        diags.push(Diagnostic {
                            severity: Severity::Warning,
                            message: format!("Service '{}': bind mounting '{}' is a security risk", name, path),
                            path: Some(format!("services > {} > volumes", name)),
                        });
                    }
                }
            }
        }

        // Check for duplicate host ports
        for (port, services) in &host_ports {
            if services.len() > 1 {
                diags.push(Diagnostic {
                    severity: Severity::Error,
                    message: format!("Host port {} is mapped by multiple services: {}", port, services.join(", ")),
                    path: Some("services > ports".into()),
                });
            }
        }

        diags
    }
}

fn extract_host_port(port_mapping: &str) -> Option<String> {
    // Handle formats: "8080:80", "127.0.0.1:8080:80", "8080:80/tcp"
    let parts: Vec<&str> = port_mapping.split(':').collect();
    match parts.len() {
        2 => Some(parts[0].to_string()),
        3 => Some(format!("{}:{}", parts[0], parts[1])),
        _ => None,
    }
}