esk 0.8.0

Encrypted Secrets Keeper with multi-target deploy
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
//! Render target — deploys env vars via the Render REST API using `curl`.
//!
//! Render.com is a cloud platform for hosting web services, databases, and
//! static sites. Unlike other targets, Render has no CLI — only a REST API.
//!
//! API: `https://api.render.com/v1`
//! Auth: `Authorization: Bearer {api_key}` header.
//! Set: `PUT /services/{serviceId}/env-vars/{envVarKey}` with JSON body.
//! Delete: `DELETE /services/{serviceId}/env-vars/{envVarKey}`.
//!
//! The API key and secret values are passed via curl's `--config -` stdin
//! to avoid exposing them in process argument lists.

use anyhow::{Context, Result};

use crate::config::{Config, RenderTargetConfig, ResolvedTarget};
use crate::targets::{
    check_command, resolve_env_flags, CommandOpts, CommandRunner, DeployMode, DeployTarget,
};

const BASE_URL: &str = "https://api.render.com/v1";

pub struct RenderTarget<'a> {
    pub config: &'a Config,
    pub target_config: &'a RenderTargetConfig,
    pub runner: &'a dyn CommandRunner,
}

impl RenderTarget<'_> {
    fn api_key(&self) -> Result<String> {
        std::env::var(&self.target_config.api_key_env).map_err(|_| {
            anyhow::anyhow!(
                "Render API key not found. Set the {} environment variable.",
                self.target_config.api_key_env
            )
        })
    }

    fn resolve_service_id(&self, target: &ResolvedTarget) -> Result<&str> {
        let app = target
            .app
            .as_deref()
            .context("render target requires an app")?;
        self.target_config
            .service_ids
            .get(app)
            .map(String::as_str)
            .with_context(|| format!("no render service_ids mapping for '{app}'"))
    }
}

/// Escape a string for use inside a curl config file value.
/// Backslashes and double quotes must be escaped.
fn curl_config_escape(s: &str) -> String {
    s.replace('\\', "\\\\").replace('"', "\\\"")
}

/// Build a curl config string for `--config -` stdin.
fn build_curl_config(method: &str, url: &str, api_key: &str, body: Option<&str>) -> String {
    use std::fmt::Write;
    let mut config = String::new();
    let _ = writeln!(
        config,
        "header = \"Authorization: Bearer {}\"",
        curl_config_escape(api_key)
    );
    if body.is_some() {
        config.push_str("header = \"Content-Type: application/json\"\n");
    }
    let _ = writeln!(config, "request = \"{method}\"");
    let _ = writeln!(config, "url = \"{}\"", curl_config_escape(url));
    if let Some(body) = body {
        let _ = writeln!(config, "data = \"{}\"", curl_config_escape(body));
    }
    config
}

/// Check curl output and return a descriptive error on failure.
fn check_curl_output(
    output: &crate::targets::CommandOutput,
    action: &str,
    key: &str,
) -> Result<()> {
    if !output.success {
        let stderr = String::from_utf8_lossy(&output.stderr);
        let stdout = String::from_utf8_lossy(&output.stdout);
        let detail = if stdout.is_empty() {
            stderr.to_string()
        } else {
            stdout.to_string()
        };
        anyhow::bail!("render {action} failed for {key}: {detail}");
    }
    Ok(())
}

impl DeployTarget for RenderTarget<'_> {
    fn name(&self) -> &'static str {
        "render"
    }

    fn deploy_mode(&self) -> DeployMode {
        DeployMode::Individual
    }

    fn preflight(&self) -> Result<()> {
        check_command(self.runner, "curl").map_err(|_| {
            anyhow::anyhow!("curl is not installed or not in PATH. Install it and try again.")
        })?;

        let api_key = self.api_key()?;

        // Use the first service ID to verify authentication
        let first_service_id = self
            .target_config
            .service_ids
            .values()
            .next()
            .context("render target has no service_ids configured")?;

        let url = format!("{BASE_URL}/services/{first_service_id}/env-vars");
        let config_str = build_curl_config("GET", &url, &api_key, None);

        let output = self
            .runner
            .run(
                "curl",
                &["--config", "-", "--silent", "--fail-with-body"],
                CommandOpts {
                    stdin: Some(config_str.into_bytes()),
                    ..Default::default()
                },
            )
            .context("failed to run curl for render preflight")?;

        if !output.success {
            let body = String::from_utf8_lossy(&output.stdout);
            if body.contains("401") || body.contains("Unauthorized") {
                anyhow::bail!(
                    "Render API key is invalid. Check your {} env var.",
                    self.target_config.api_key_env
                );
            }
            let stderr = String::from_utf8_lossy(&output.stderr);
            if stderr.contains("401") || stderr.contains("Unauthorized") {
                anyhow::bail!(
                    "Render API key is invalid. Check your {} env var.",
                    self.target_config.api_key_env
                );
            }
            anyhow::bail!(
                "render preflight failed: {}{}",
                body,
                if stderr.is_empty() {
                    String::new()
                } else {
                    format!(" (stderr: {stderr})")
                }
            );
        }

        Ok(())
    }

    fn deploy_secret(&self, key: &str, value: &str, target: &ResolvedTarget) -> Result<()> {
        let service_id = self.resolve_service_id(target)?;
        let api_key = self.api_key()?;

        let url = format!("{BASE_URL}/services/{service_id}/env-vars/{key}");
        let json_value = serde_json::to_string(value).expect("string is always valid JSON");
        let body = format!("{{\"value\":{json_value}}}");
        let config_str = build_curl_config("PUT", &url, &api_key, Some(&body));

        let flag_parts = resolve_env_flags(&self.target_config.env_flags, &target.environment);
        let mut args: Vec<&str> = vec!["--config", "-", "--silent", "--fail-with-body"];
        args.extend(flag_parts.iter().map(String::as_str));

        let output = self
            .runner
            .run(
                "curl",
                &args,
                CommandOpts {
                    stdin: Some(config_str.into_bytes()),
                    ..Default::default()
                },
            )
            .with_context(|| format!("failed to run curl for render deploy {key}"))?;

        check_curl_output(&output, "deploy", key)
    }

    fn delete_secret(&self, key: &str, target: &ResolvedTarget) -> Result<()> {
        let service_id = self.resolve_service_id(target)?;
        let api_key = self.api_key()?;

        let url = format!("{BASE_URL}/services/{service_id}/env-vars/{key}");
        let config_str = build_curl_config("DELETE", &url, &api_key, None);

        let flag_parts = resolve_env_flags(&self.target_config.env_flags, &target.environment);
        let mut args: Vec<&str> = vec!["--config", "-", "--silent", "--fail-with-body"];
        args.extend(flag_parts.iter().map(String::as_str));

        let output = self
            .runner
            .run(
                "curl",
                &args,
                CommandOpts {
                    stdin: Some(config_str.into_bytes()),
                    ..Default::default()
                },
            )
            .with_context(|| format!("failed to run curl for render delete {key}"))?;

        check_curl_output(&output, "delete", key)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::targets::CommandOutput;
    use crate::test_support::{ConfigFixture, ErrorCommandRunner, MockCommandRunner};

    fn make_config(api_key_env: &str) -> ConfigFixture {
        let yaml = format!(
            r#"
project: x
environments: [dev, prod]
apps:
  web:
    path: apps/web
targets:
  render:
    service_ids:
      web: srv-abc123def456
    api_key_env: {api_key_env}
    env_flags:
      prod: "--proxy http://proxy:8080"
"#
        );
        ConfigFixture::new(&yaml).unwrap()
    }

    fn make_target(app: Option<&str>, env: &str) -> ResolvedTarget {
        ResolvedTarget {
            service: "render".to_string(),
            app: app.map(String::from),
            environment: env.to_string(),
        }
    }

    /// Generate a unique env var name per test to avoid parallel test races.
    fn unique_api_key_env(test_name: &str) -> String {
        format!("RENDER_TEST_KEY_{}", test_name.to_uppercase())
    }

    #[test]
    fn render_preflight_success() {
        let env_name = unique_api_key_env("preflight_success");
        std::env::set_var(&env_name, "rnd_test_key_123");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![
            CommandOutput {
                success: true,
                stdout: b"curl 7.80.0".to_vec(),
                stderr: vec![],
            },
            CommandOutput {
                success: true,
                stdout: b"[{\"key\":\"TEST\",\"value\":\"val\"}]".to_vec(),
                stderr: vec![],
            },
        ]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        assert!(target.preflight().is_ok());
        let calls = runner.take_calls();
        assert_eq!(calls.len(), 2);
        assert_eq!(calls[0].args, vec!["--version"]);
        // Second call should be the auth check via curl --config
        assert_eq!(
            calls[1].args,
            vec!["--config", "-", "--silent", "--fail-with-body"]
        );
        let stdin = String::from_utf8(calls[1].stdin.clone().unwrap()).unwrap();
        assert!(stdin.contains("Authorization: Bearer rnd_test_key_123"));
        assert!(stdin.contains("srv-abc123def456"));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_preflight_missing_curl() {
        let env_name = unique_api_key_env("preflight_missing_curl");
        std::env::set_var(&env_name, "key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = ErrorCommandRunner::missing_command();
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        let err = target.preflight().unwrap_err();
        assert!(err.to_string().contains("curl is not installed"));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_preflight_auth_failure() {
        let env_name = unique_api_key_env("preflight_auth_failure");
        std::env::set_var(&env_name, "bad_key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![
            CommandOutput {
                success: true,
                stdout: b"curl 7.80.0".to_vec(),
                stderr: vec![],
            },
            CommandOutput {
                success: false,
                stdout: b"401 Unauthorized".to_vec(),
                stderr: vec![],
            },
        ]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        let err = target.preflight().unwrap_err();
        assert!(err.to_string().contains("API key is invalid"));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_deploy_builds_correct_curl_config() {
        let env_name = unique_api_key_env("deploy_correct");
        std::env::set_var(&env_name, "rnd_deploy_key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: vec![],
            stderr: vec![],
        }]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        target
            .deploy_secret("MY_KEY", "secret_val", &make_target(Some("web"), "dev"))
            .unwrap();
        let calls = runner.take_calls();
        assert_eq!(
            calls[0].args,
            vec!["--config", "-", "--silent", "--fail-with-body"]
        );
        let stdin = String::from_utf8(calls[0].stdin.clone().unwrap()).unwrap();
        assert!(stdin.contains("Authorization: Bearer rnd_deploy_key"));
        assert!(stdin.contains("Content-Type: application/json"));
        assert!(stdin.contains("request = \"PUT\""));
        assert!(stdin.contains("srv-abc123def456/env-vars/MY_KEY"));
        // JSON body is curl-config-escaped: quotes become \"
        assert!(stdin.contains(r#"data = "{\"value\":\"secret_val\"}"#));
        // Value NOT in args
        assert!(!calls[0].args.iter().any(|a| a.contains("secret_val")));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_deploy_with_env_flags() {
        let env_name = unique_api_key_env("deploy_env_flags");
        std::env::set_var(&env_name, "key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: vec![],
            stderr: vec![],
        }]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        target
            .deploy_secret("KEY", "val", &make_target(Some("web"), "prod"))
            .unwrap();
        let calls = runner.take_calls();
        assert_eq!(
            calls[0].args,
            vec![
                "--config",
                "-",
                "--silent",
                "--fail-with-body",
                "--proxy",
                "http://proxy:8080"
            ]
        );
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_deploy_escapes_special_chars() {
        let env_name = unique_api_key_env("deploy_escapes");
        std::env::set_var(&env_name, "key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: vec![],
            stderr: vec![],
        }]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        target
            .deploy_secret(
                "KEY",
                "val with \"quotes\" and \\backslash",
                &make_target(Some("web"), "dev"),
            )
            .unwrap();
        let calls = runner.take_calls();
        let stdin = String::from_utf8(calls[0].stdin.clone().unwrap()).unwrap();
        // The JSON value should have escaped quotes, then curl config escapes those
        assert!(stdin.contains("val with"));
        // Verify the config doesn't have unescaped quotes that would break curl config parsing
        // The data line should have the JSON-then-curl-config-escaped value
        assert!(stdin.contains("data = "));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_requires_app() {
        let env_name = unique_api_key_env("requires_app");
        std::env::set_var(&env_name, "key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        let err = target
            .deploy_secret("KEY", "val", &make_target(None, "dev"))
            .unwrap_err();
        assert!(err.to_string().contains("requires an app"));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_unknown_service_mapping() {
        let env_name = unique_api_key_env("unknown_service");
        std::env::set_var(&env_name, "key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        let err = target
            .deploy_secret("KEY", "val", &make_target(Some("api"), "dev"))
            .unwrap_err();
        assert!(err.to_string().contains("no render service_ids mapping"));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_nonzero_exit() {
        let env_name = unique_api_key_env("nonzero_exit");
        std::env::set_var(&env_name, "key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: false,
            stdout: b"Internal Server Error".to_vec(),
            stderr: vec![],
        }]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        let err = target
            .deploy_secret("KEY", "val", &make_target(Some("web"), "dev"))
            .unwrap_err();
        assert!(err.to_string().contains("render deploy failed"));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_delete_correct_config() {
        let env_name = unique_api_key_env("delete_correct");
        std::env::set_var(&env_name, "rnd_del_key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: vec![],
            stderr: vec![],
        }]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        target
            .delete_secret("MY_KEY", &make_target(Some("web"), "dev"))
            .unwrap();
        let calls = runner.take_calls();
        assert_eq!(
            calls[0].args,
            vec!["--config", "-", "--silent", "--fail-with-body"]
        );
        let stdin = String::from_utf8(calls[0].stdin.clone().unwrap()).unwrap();
        assert!(stdin.contains("Authorization: Bearer rnd_del_key"));
        assert!(stdin.contains("request = \"DELETE\""));
        assert!(stdin.contains("srv-abc123def456/env-vars/MY_KEY"));
        // No Content-Type or data for delete
        assert!(!stdin.contains("Content-Type"));
        assert!(!stdin.contains("data = "));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn render_delete_failure() {
        let env_name = unique_api_key_env("delete_failure");
        std::env::set_var(&env_name, "key");
        let fixture = make_config(&env_name);
        let config = fixture.config();
        let target_config = config.targets.render.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: false,
            stdout: b"Not Found".to_vec(),
            stderr: vec![],
        }]);
        let target = RenderTarget {
            config,
            target_config,
            runner: &runner,
        };
        let err = target
            .delete_secret("KEY", &make_target(Some("web"), "dev"))
            .unwrap_err();
        assert!(err.to_string().contains("render delete failed"));
        std::env::remove_var(&env_name);
    }

    #[test]
    fn curl_config_escape_special_chars() {
        assert_eq!(curl_config_escape(r#"a"b\c"#), r#"a\"b\\c"#);
        assert_eq!(curl_config_escape("normal"), "normal");
        assert_eq!(curl_config_escape(""), "");
    }
}