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
use super::schema::AppConfig;
use core::fmt;
use std::collections::BTreeMap;
// use schemars::generate
use crate::values::UpDuration;
/// Redacts `env`: only its length is printed.
impl fmt::Debug for AppConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("AppConfig")
.field("name", &self.name)
.field("script", &self.script)
.field("env", &format_args!("<{} vars>", self.env.len()))
.finish_non_exhaustive()
}
}
impl Default for AppConfig {
fn default() -> Self {
Self {
name: String::new(),
script: String::new(),
args: Vec::new(),
cwd: None,
interpreter: None,
env: BTreeMap::new(),
environment: None,
instances: 1,
autorestart: true,
autostart: true,
stop_exit_codes: Vec::new(),
min_uptime: UpDuration::from_millis(1000),
max_restarts: 16,
restart_delay: None,
// Not None: see the field's doc comment. An unstable exit with
// no restart policy configured must not restart instantly.
exp_backoff_restart_delay: Some(UpDuration::from_millis(100)),
kill_signal: None,
kill_timeout: UpDuration::from_millis(1600),
shutdown_with_message: false,
listen_timeout: UpDuration::from_millis(3000),
graceful_timeout: UpDuration::from_millis(8000),
action_timeout: UpDuration::from_millis(3000),
max_memory: None,
watch: false,
ignore_watch: Vec::new(),
watch_delay: None,
cron_restart: None,
fold: None,
depends_on: Vec::new(),
user: None,
group: None,
out_file: None,
err_file: None,
merge_logs: false,
log_timestamps: true,
level_rules: Vec::new(),
dogs: BTreeMap::new(),
channel: false,
stdin: false,
wait_ready: false,
reuse_port: false,
readiness_probe: None,
liveness_probe: None,
watch_options: Vec::new(),
cron_timezone: None,
}
}
}
impl AppConfig {
/// A minimal config with spec defaults, the programmatic entry point.
#[must_use]
pub fn minimal(name: &str, script: &str) -> Self {
Self {
name: name.to_string(),
script: script.to_string(),
..Self::default()
}
}
/// The names of the fields whose values differ between `self` and
/// `other`, in field-name order.
///
/// Names only, never values. The one caller sends this list across the
/// wire to be printed at an operator, and [`AppConfig::env`] carries
/// secrets, so a differing `env` reports `"env"` and stops there.
///
/// Compare configs that have both been through
/// [`normalize`](fn@crate::config::normalize). Two configs differing only
/// in what normalization would have filled in are not a difference an
/// operator can act on, and reporting them would make the caller noisy
/// about nothing.
///
/// # Example
///
/// ```
/// use shep_core::config::AppConfig;
///
/// let stored = AppConfig::minimal("web", "./srv");
/// let mut edited = stored.clone();
/// edited.cwd = Some("/srv".to_string());
///
/// assert_eq!(stored.drifted_fields(&edited), vec!["cwd".to_string()]);
/// assert!(stored.drifted_fields(&stored).is_empty());
/// ```
#[must_use]
pub fn drifted_fields(&self, other: &Self) -> Vec<String> {
if self == other {
return Vec::new();
}
// Serde-compared, not field by field: a new field needs no edit here.
// Sorted since `serde_json::Map` is a `BTreeMap` only while
// `preserve_order` is off crate-wide. An empty result means no
// drift, or none could be computed.
let (Ok(serde_json::Value::Object(mine)), Ok(serde_json::Value::Object(theirs))) =
(serde_json::to_value(self), serde_json::to_value(other))
else {
return Vec::new();
};
let mut fields: Vec<String> = mine
.iter()
.filter(|(key, value)| theirs.get(key.as_str()) != Some(value))
.map(|(key, _)| key.clone())
.collect();
fields.sort_unstable();
fields
}
}
#[cfg(test)]
mod tests {
use super::super::schema::AppConfig;
use crate::config::{FlockFormat, Flockfile};
// use schemars::generate
#[test]
fn log_lines_are_stamped_unless_a_flockfile_says_false() {
let parse = |extra: &str| {
let src = format!("[[app]]\nname = \"web\"\nscript = \"./srv\"\n{extra}");
Flockfile::parse(&src, FlockFormat::Toml)
.expect("parses")
.apps[0]
.log_timestamps
};
assert!(AppConfig::minimal("web", "./srv").log_timestamps);
assert!(parse(""));
assert!(parse("log_timestamps = true"));
assert!(!parse("log_timestamps = false"));
}
#[test]
fn an_unedited_config_has_drifted_in_no_field() {
let app = AppConfig::minimal("web", "./srv");
assert!(app.drifted_fields(&app.clone()).is_empty());
}
#[test]
fn drift_names_every_edited_field_and_no_other() {
// Two fields, not one, so a comparator that stopped at the first
// difference fails here.
let stored = AppConfig::minimal("proto-api", "./proto-enum-api");
let mut edited = stored.clone();
edited.cwd = Some("/srv/pogo-proto-api".to_string());
edited.args = vec!["-config".to_string(), "config.toml".to_string()];
assert_eq!(
stored.drifted_fields(&edited),
vec!["args".to_string(), "cwd".to_string()]
);
}
#[test]
fn drift_reports_env_by_name_and_never_by_value() {
let stored = AppConfig::minimal("web", "./srv");
let mut edited = stored.clone();
edited
.env
.insert("DATABASE_URL".to_string(), "postgres://hunter2".to_string());
let fields = edited.drifted_fields(&stored);
assert_eq!(fields, vec!["env".to_string()]);
// Names go to an operator; a value never should.
assert!(!fields.concat().contains("hunter2"));
}
#[test]
fn drift_is_symmetric() {
let stored = AppConfig::minimal("web", "./srv");
let mut edited = stored.clone();
edited.instances = 4;
assert_eq!(
stored.drifted_fields(&edited),
edited.drifted_fields(&stored)
);
assert_eq!(
stored.drifted_fields(&edited),
vec!["instances".to_string()]
);
}
}