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
//! What the embedder passes to an operation: its params, secrets and choices.
use std::collections::BTreeMap;
use crate::secrets::Secrets;
/// What `up` does when the run already exists.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
#[non_exhaustive]
pub enum Occupied {
/// Fails with `already_running` when anything of the run is up or parked.
Refuse,
/// Resumes a parked run instead of starting it again (leftovers are still removed first).
#[default]
ResumeParked,
/// Removes whatever exists, then starts afresh.
Replace,
}
/// The options of one operation.
#[derive(Debug, Clone, Default)]
#[non_exhaustive]
pub struct RunOptions {
/// A Vagrant provider among the manifest's (`${run.provider}`).
pub provider: Option<String>,
/// Non-secret values, by param name.
pub params: BTreeMap<String, String>,
/// Secret and input values, by slot name. Never stored: pass them again to an operation that
/// creates something.
pub secrets: Secrets,
/// What the embedder calls the place the run is on (a server or account id): recorded, so a
/// later operation asked for elsewhere is refused (`running_elsewhere`).
pub host_label: Option<String>,
/// What `up` does when the run exists.
pub occupied: Occupied,
/// A login (`user@host`) every SSH of the run goes through first: a Proxmox node whose lab
/// bridge this host can't route to. Recorded at `up`, so later operations go the same way.
pub ssh_jump: Option<String>,
/// How long the run may live, for a manifest with an `expiry` (its default otherwise).
pub lifetime: Option<std::time::Duration>,
}
impl RunOptions {
/// No param, no secret, nothing recorded about the place; a parked run is resumed.
#[must_use]
pub fn new() -> RunOptions {
RunOptions::default()
}
/// Sets param `name` to `value`.
#[must_use]
pub fn with_param(mut self, name: impl Into<String>, value: impl Into<String>) -> RunOptions {
self.params.insert(name.into(), value.into());
self
}
/// Sets every param of `params`.
#[must_use]
pub fn with_params(mut self, params: impl IntoIterator<Item = (String, String)>) -> RunOptions {
self.params.extend(params);
self
}
/// Gives the secret and input slots `secrets`.
#[must_use]
pub fn with_secrets(mut self, secrets: Secrets) -> RunOptions {
self.secrets = secrets;
self
}
/// Records the place the run is on as `label`.
#[must_use]
pub fn with_host_label(mut self, label: impl Into<String>) -> RunOptions {
self.host_label = Some(label.into());
self
}
/// Runs with Vagrant provider `provider`.
#[must_use]
pub fn with_provider(mut self, provider: impl Into<String>) -> RunOptions {
self.provider = Some(provider.into());
self
}
/// Goes through `login` (`user@host`) for every SSH of the run.
#[must_use]
pub fn with_ssh_jump(mut self, login: impl Into<String>) -> RunOptions {
self.ssh_jump = Some(login.into());
self
}
/// Lets the run live `lifetime` (a manifest with an `expiry`).
#[must_use]
pub fn with_lifetime(mut self, lifetime: std::time::Duration) -> RunOptions {
self.lifetime = Some(lifetime);
self
}
/// What `up` does when the run exists.
#[must_use]
pub fn with_occupied(mut self, occupied: Occupied) -> RunOptions {
self.occupied = occupied;
self
}
}