carte 0.5.0

Runs your apps' processes on demand behind *.localhost hostnames, one stack per git worktree
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

//! The daemon's LaunchAgent property list.

use std::fmt::Write;
use std::path::{Path, PathBuf};

pub const LABEL: &str = "no.elektronaut.carte";
/// The label earlier installs used.
pub const OLD_LABEL: &str = "carte.daemon";

/// Everything the LaunchAgent needs to know.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Agent {
    pub exe: PathBuf,
    pub home: PathBuf,
    pub config_dir: PathBuf,
    pub state_dir: PathBuf,
    pub http_port: u16,
    pub https_port: u16,
}

impl Agent {
    pub fn log_path(&self) -> PathBuf {
        self.state_dir.join("carte.log")
    }

    /// Homebrew, the user's own bin directories, then the system's.
    pub fn path_var(&self) -> String {
        let home = |rel: &str| self.home.join(rel).to_string_lossy().into_owned();
        [
            "/opt/homebrew/bin".to_string(),
            "/opt/homebrew/sbin".to_string(),
            "/usr/local/bin".to_string(),
            home(".local/bin"),
            home(".cargo/bin"),
            "/usr/bin".to_string(),
            "/bin".to_string(),
            "/usr/sbin".to_string(),
            "/sbin".to_string(),
        ]
        .join(":")
    }

    pub fn to_plist(&self) -> String {
        let path = |p: &Path| p.to_string_lossy().into_owned();
        let log = path(&self.log_path());
        let mut out = String::from(
            "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
             <!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \
             \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n\
             <plist version=\"1.0\">\n<dict>\n",
        );
        key_string(&mut out, 1, "Label", LABEL);
        key(&mut out, 1, "ProgramArguments");
        line(&mut out, 1, "<array>");
        string(&mut out, 2, &path(&self.exe));
        string(&mut out, 2, "daemon");
        line(&mut out, 1, "</array>");
        key(&mut out, 1, "EnvironmentVariables");
        line(&mut out, 1, "<dict>");
        key_string(&mut out, 2, "PATH", &self.path_var());
        key_string(&mut out, 2, "CARTE_CONFIG_DIR", &path(&self.config_dir));
        key_string(&mut out, 2, "CARTE_STATE_HOME", &path(&self.state_dir));
        line(&mut out, 1, "</dict>");
        key(&mut out, 1, "KeepAlive");
        line(&mut out, 1, "<true/>");
        key(&mut out, 1, "RunAtLoad");
        line(&mut out, 1, "<true/>");
        key(&mut out, 1, "ProcessType");
        string(&mut out, 1, "Interactive");
        key(&mut out, 1, "ExitTimeOut");
        line(&mut out, 1, "<integer>40</integer>");
        key(&mut out, 1, "SoftResourceLimits");
        line(&mut out, 1, "<dict>");
        key(&mut out, 2, "NumberOfFiles");
        line(&mut out, 2, "<integer>8192</integer>");
        line(&mut out, 1, "</dict>");
        key_string(&mut out, 1, "StandardOutPath", &log);
        key_string(&mut out, 1, "StandardErrorPath", &log);
        key(&mut out, 1, "Sockets");
        line(&mut out, 1, "<dict>");
        socket(&mut out, "http", self.http_port);
        socket(&mut out, "https", self.https_port);
        line(&mut out, 1, "</dict>");
        out.push_str("</dict>\n</plist>\n");
        out
    }
}

fn socket(out: &mut String, name: &str, port: u16) {
    key(out, 2, name);
    line(out, 2, "<array>");
    for (node, family) in [("127.0.0.1", "IPv4"), ("::1", "IPv6")] {
        line(out, 3, "<dict>");
        key_string(out, 4, "SockNodeName", node);
        key_string(out, 4, "SockServiceName", &port.to_string());
        key_string(out, 4, "SockType", "stream");
        key_string(out, 4, "SockFamily", family);
        line(out, 3, "</dict>");
    }
    line(out, 2, "</array>");
}

fn line(out: &mut String, depth: usize, text: &str) {
    let _ = writeln!(out, "{}{text}", "  ".repeat(depth));
}

fn key(out: &mut String, depth: usize, name: &str) {
    line(out, depth, &format!("<key>{}</key>", escape(name)));
}

fn string(out: &mut String, depth: usize, value: &str) {
    line(out, depth, &format!("<string>{}</string>", escape(value)));
}

fn key_string(out: &mut String, depth: usize, name: &str, value: &str) {
    key(out, depth, name);
    string(out, depth, value);
}

/// Whether an installed LaunchAgent runs the daemon with `state_dir` as its state
/// directory, and so answers on that directory's socket.
pub fn runs_with_state(plist: &str, state_dir: &Path) -> bool {
    let value = format!(
        "<key>CARTE_STATE_HOME</key>\n    <string>{}</string>",
        escape(&state_dir.to_string_lossy())
    );
    plist.contains(&value)
}

fn escape(text: &str) -> String {
    text.replace('&', "&amp;")
        .replace('<', "&lt;")
        .replace('>', "&gt;")
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn tells_which_state_directory_the_agent_serves() {
        let plist = agent().to_plist();
        assert!(runs_with_state(&plist, &agent().state_dir));
        assert!(!runs_with_state(&plist, Path::new("/tmp/trial/state")));
    }

    fn agent() -> Agent {
        Agent {
            exe: "/opt/homebrew/bin/carte".into(),
            home: "/Users/me".into(),
            config_dir: "/Users/me/.config/carte".into(),
            state_dir: "/Users/me/.local/state/R&D <carte>".into(),
            http_port: 80,
            https_port: 443,
        }
    }

    #[test]
    fn runs_the_daemon_with_launchd_sockets() {
        let plist = agent().to_plist();
        for expected in [
            "  <key>Label</key>\n  <string>no.elektronaut.carte</string>\n",
            "  <array>\n    <string>/opt/homebrew/bin/carte</string>\n    <string>daemon</string>\n  </array>\n",
            "<key>KeepAlive</key>\n  <true/>",
            "<key>RunAtLoad</key>\n  <true/>",
            "<key>ExitTimeOut</key>\n  <integer>40</integer>",
            "<string>/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/Users/me/.local/bin:/Users/me/.cargo/bin:/usr/bin:/bin:/usr/sbin:/sbin</string>",
            "<key>CARTE_STATE_HOME</key>\n    <string>/Users/me/.local/state/R&amp;D &lt;carte&gt;</string>",
            "<key>StandardErrorPath</key>\n  <string>/Users/me/.local/state/R&amp;D &lt;carte&gt;/carte.log</string>",
            "    <key>http</key>\n    <array>\n      <dict>\n        <key>SockNodeName</key>\n        \
             <string>127.0.0.1</string>\n        <key>SockServiceName</key>\n        <string>80</string>\n        \
             <key>SockType</key>\n        <string>stream</string>\n        <key>SockFamily</key>\n        \
             <string>IPv4</string>\n      </dict>\n      <dict>\n        <key>SockNodeName</key>\n        \
             <string>::1</string>\n        <key>SockServiceName</key>\n        <string>80</string>\n        \
             <key>SockType</key>\n        <string>stream</string>\n        <key>SockFamily</key>\n        \
             <string>IPv6</string>\n      </dict>\n    </array>\n",
            "<key>https</key>\n    <array>\n      <dict>\n        <key>SockNodeName</key>\n        \
             <string>127.0.0.1</string>\n        <key>SockServiceName</key>\n        <string>443</string>",
        ] {
            assert!(plist.contains(expected), "missing {expected:?} in\n{plist}");
        }
        assert!(plist.starts_with("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist"));
        assert!(plist.ends_with("</dict>\n</plist>\n"));
    }

    #[test]
    #[cfg(target_os = "macos")]
    fn is_a_valid_property_list() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join("no.elektronaut.carte.plist");
        std::fs::write(&path, agent().to_plist()).unwrap();
        let output = std::process::Command::new("plutil")
            .arg("-lint")
            .arg(&path)
            .output()
            .unwrap();
        assert!(output.status.success(), "{output:?}");
    }
}