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
//! Infisical remote — syncs secrets via the `infisical` CLI.
//!
//! Infisical is an open-source secrets management platform. Secrets are
//! organized into projects, environments (slugs), and folder paths.
//!
//! CLI: `infisical` (Infisical's official CLI).
//! Commands: `infisical secrets set --file=<path>` / `infisical export --format=json`.
//!
//! Push uses a temp file in `.env` format (`KEY=VALUE\n`) with `secrets set --file`.
//! Because `secrets set --file` is **upsert-only** (does not delete absent keys),
//! push first exports the current remote state, diffs it, and explicitly deletes
//! orphaned keys via `infisical secrets delete`.

use anyhow::{Context, Result};
use std::collections::BTreeMap;
use std::io::Write;

use crate::config::{Config, InfisicalRemoteConfig};
use crate::store::StorePayload;
use crate::targets::{CommandOpts, CommandRunner};

use super::SyncRemote;

pub struct InfisicalRemote<'a> {
    remote_config: InfisicalRemoteConfig,
    runner: &'a dyn CommandRunner,
}

impl<'a> InfisicalRemote<'a> {
    pub fn new(remote_config: InfisicalRemoteConfig, runner: &'a dyn CommandRunner) -> Self {
        Self {
            remote_config,
            runner,
        }
    }

    /// Resolve the Infisical environment slug for an esk environment.
    fn env_slug(&self, env: &str) -> String {
        self.remote_config
            .env_map
            .get(env)
            .cloned()
            .unwrap_or_else(|| env.to_string())
    }

    /// Build the common CLI args shared across push/pull/delete calls.
    fn base_args(&self, slug: &str) -> Vec<String> {
        vec![
            "--projectId".to_string(),
            self.remote_config.project_id.clone(),
            "--env".to_string(),
            slug.to_string(),
            "--path".to_string(),
            self.remote_config.path.clone(),
        ]
    }
}

/// Parse Infisical's JSON export format (array of objects) into a flat key→value map.
///
/// Infisical exports: `[{"key":"K","value":"V","type":"shared",...}, ...]`
fn parse_export_json(stdout: &[u8]) -> Result<BTreeMap<String, String>> {
    let entries: Vec<serde_json::Value> =
        serde_json::from_slice(stdout).context("failed to parse Infisical export JSON")?;
    let mut map = BTreeMap::new();
    for entry in entries {
        let key = entry
            .get("key")
            .and_then(|v| v.as_str())
            .context("Infisical export entry missing 'key' field")?;
        let value = entry.get("value").and_then(|v| v.as_str()).unwrap_or("");
        map.insert(key.to_string(), value.to_string());
    }
    Ok(map)
}

impl SyncRemote for InfisicalRemote<'_> {
    fn name(&self) -> &'static str {
        "infisical"
    }

    fn preflight(&self) -> Result<()> {
        crate::targets::check_command(self.runner, "infisical").map_err(|_| {
            anyhow::anyhow!(
                "Infisical CLI (infisical) is not installed or not in PATH. Install it from: https://infisical.com/docs/cli/overview"
            )
        })?;
        Ok(())
    }

    fn push(&self, payload: &StorePayload, _config: &Config, env: &str) -> Result<()> {
        let Some((env_secrets, version)) = payload.env_secrets(env) else {
            return Ok(());
        };

        let slug = self.env_slug(env);
        let base = self.base_args(&slug);

        // Build the push map: bare keys + version metadata
        let mut push_map: BTreeMap<String, String> = env_secrets;
        push_map.insert(super::ESK_VERSION_KEY.to_string(), version.to_string());

        // Delete orphaned keys: export current remote state, diff, delete absent keys.
        // If the export fails (empty project, etc.), skip deletion and proceed with set.
        let mut export_args = vec!["export", "--format", "json"];
        export_args.extend(base.iter().map(String::as_str));

        if let Ok(output) = self
            .runner
            .run("infisical", &export_args, CommandOpts::default())
        {
            if output.success {
                if let Ok(remote_keys) = parse_export_json(&output.stdout) {
                    let orphans: Vec<&str> = remote_keys
                        .keys()
                        .filter(|k| !push_map.contains_key(k.as_str()))
                        .map(String::as_str)
                        .collect();

                    if !orphans.is_empty() {
                        let mut delete_args = vec!["secrets", "delete"];
                        delete_args.extend(orphans);
                        delete_args.extend(base.iter().map(String::as_str));

                        let del_output = self
                            .runner
                            .run("infisical", &delete_args, CommandOpts::default())
                            .context("failed to run infisical secrets delete")?;
                        if !del_output.success {
                            let stderr = String::from_utf8_lossy(&del_output.stderr);
                            anyhow::bail!("infisical secrets delete failed: {stderr}");
                        }
                    }
                }
            }
        }

        // Write secrets to a temp file in .env format and push via --file
        let mut tmpfile =
            tempfile::NamedTempFile::new().context("failed to create temp file for push")?;
        for (key, value) in &push_map {
            writeln!(tmpfile, "{key}={value}").context("failed to write to temp file")?;
        }
        tmpfile.flush().context("failed to flush temp file")?;

        let tmppath = tmpfile.path().to_string_lossy().to_string();
        let file_arg = format!("--file={tmppath}");
        let mut set_args = vec!["secrets", "set", &file_arg, "--silent"];
        set_args.extend(base.iter().map(String::as_str));

        let output = self
            .runner
            .run("infisical", &set_args, CommandOpts::default())
            .context("failed to run infisical secrets set")?;
        if !output.success {
            let stderr = String::from_utf8_lossy(&output.stderr);
            anyhow::bail!("infisical secrets set failed: {stderr}");
        }

        Ok(())
    }

    fn pull(&self, _config: &Config, env: &str) -> Result<Option<(BTreeMap<String, String>, u64)>> {
        let slug = self.env_slug(env);
        let base = self.base_args(&slug);

        let mut args = vec!["export", "--format", "json"];
        args.extend(base.iter().map(String::as_str));

        let output = self
            .runner
            .run("infisical", &args, CommandOpts::default())
            .context("failed to run infisical export")?;

        if !output.success {
            return Ok(None);
        }

        let data = parse_export_json(&output.stdout)?;
        Ok(Some(super::parse_pulled_secrets(data, env)))
    }
}

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

    fn make_remote(runner: &dyn CommandRunner) -> InfisicalRemote<'_> {
        InfisicalRemote::new(
            InfisicalRemoteConfig {
                project_id: "proj123".to_string(),
                env_map: {
                    let mut m = BTreeMap::new();
                    m.insert("dev".to_string(), "development".to_string());
                    m.insert("prod".to_string(), "production".to_string());
                    m
                },
                path: "/".to_string(),
            },
            runner,
        )
    }

    fn make_payload(secrets: &[(&str, &str)], version: u64) -> StorePayload {
        let mut map = BTreeMap::new();
        for (k, v) in secrets {
            map.insert((*k).to_string(), (*v).to_string());
        }
        StorePayload {
            secrets: map,
            version,
            ..Default::default()
        }
    }

    fn make_config() -> ConfigFixture {
        ConfigFixture::new(
            r"
project: myapp
environments: [dev, prod]
remotes:
  infisical:
    project_id: proj123
    env_map:
      dev: development
      prod: production
",
        )
        .unwrap()
    }

    fn export_json(entries: &[(&str, &str)]) -> Vec<u8> {
        let arr: Vec<serde_json::Value> = entries
            .iter()
            .map(|(k, v)| {
                serde_json::json!({
                    "key": k,
                    "value": v,
                    "type": "shared"
                })
            })
            .collect();
        serde_json::to_vec(&arr).unwrap()
    }

    #[test]
    fn env_slug_from_map() {
        let runner = MockCommandRunner::from_outputs(vec![]);
        let remote = make_remote(&runner);
        assert_eq!(remote.env_slug("dev"), "development");
        assert_eq!(remote.env_slug("prod"), "production");
    }

    #[test]
    fn env_slug_fallback() {
        let runner = MockCommandRunner::from_outputs(vec![]);
        let remote = make_remote(&runner);
        assert_eq!(remote.env_slug("staging"), "staging");
    }

    #[test]
    fn preflight_success() {
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: b"infisical/0.28.1".to_vec(),
            stderr: Vec::new(),
        }]);
        let remote = make_remote(&runner);
        assert!(remote.preflight().is_ok());
        let c = runner.calls();
        assert_eq!(c.len(), 1);
        assert_eq!(c[0].program, "infisical");
        assert_eq!(c[0].args, vec!["--version"]);
    }

    #[test]
    fn preflight_missing_cli() {
        let runner = ErrorCommandRunner::missing_command();
        let remote = make_remote(&runner);
        let err = remote.preflight().unwrap_err();
        assert!(err.to_string().contains("Infisical CLI"));
        assert!(err.to_string().contains("not installed"));
    }

    #[test]
    fn push_sets_via_tempfile() {
        let fixture = make_config();
        let runner = MockCommandRunner::from_outputs(vec![
            // export (for orphan detection)
            CommandOutput {
                success: true,
                stdout: export_json(&[("API_KEY", "old"), ("_esk_version", "2")]),
                stderr: Vec::new(),
            },
            // secrets set
            CommandOutput {
                success: true,
                stdout: Vec::new(),
                stderr: Vec::new(),
            },
        ]);
        let remote = make_remote(&runner);
        let payload = make_payload(&[("API_KEY:dev", "sk_test"), ("DB_URL:dev", "pg://")], 3);
        remote.push(&payload, fixture.config(), "dev").unwrap();

        let c = runner.calls();
        assert_eq!(c.len(), 2);

        // First call: export for orphan detection
        assert_eq!(c[0].program, "infisical");
        assert!(c[0].args.contains(&"export".to_string()));
        assert!(c[0].args.contains(&"--projectId".to_string()));
        assert!(c[0].args.contains(&"proj123".to_string()));
        assert!(c[0].args.contains(&"--env".to_string()));
        assert!(c[0].args.contains(&"development".to_string()));

        // Second call: secrets set with --file
        assert_eq!(c[1].program, "infisical");
        assert!(c[1].args.contains(&"secrets".to_string()));
        assert!(c[1].args.contains(&"set".to_string()));
        assert!(c[1].args.iter().any(|a| a.starts_with("--file=")));
        assert!(c[1].args.contains(&"--silent".to_string()));
        assert!(c[1].args.contains(&"development".to_string()));
    }

    #[test]
    fn push_deletes_orphaned_keys() {
        let fixture = make_config();
        let runner = MockCommandRunner::from_outputs(vec![
            // export: remote has 3 keys, we're pushing 2
            CommandOutput {
                success: true,
                stdout: export_json(&[
                    ("API_KEY", "old"),
                    ("DB_URL", "old_pg"),
                    ("OLD_KEY", "stale"),
                    ("_esk_version", "2"),
                ]),
                stderr: Vec::new(),
            },
            // delete orphaned
            CommandOutput {
                success: true,
                stdout: Vec::new(),
                stderr: Vec::new(),
            },
            // secrets set
            CommandOutput {
                success: true,
                stdout: Vec::new(),
                stderr: Vec::new(),
            },
        ]);
        let remote = make_remote(&runner);
        let payload = make_payload(&[("API_KEY:dev", "new_key"), ("DB_URL:dev", "new_pg")], 3);
        remote.push(&payload, fixture.config(), "dev").unwrap();

        let c = runner.calls();
        assert_eq!(c.len(), 3);

        // Second call: delete orphaned key
        assert_eq!(c[1].program, "infisical");
        assert!(c[1].args.contains(&"secrets".to_string()));
        assert!(c[1].args.contains(&"delete".to_string()));
        assert!(c[1].args.contains(&"OLD_KEY".to_string()));
    }

    #[test]
    fn push_skips_empty_env() {
        let fixture = make_config();
        let runner = MockCommandRunner::from_outputs(vec![]);
        let remote = make_remote(&runner);
        let payload = make_payload(&[("KEY:prod", "val")], 1);
        remote.push(&payload, fixture.config(), "dev").unwrap();

        let c = runner.calls();
        assert!(c.is_empty());
    }

    #[test]
    fn push_skips_delete_on_export_failure() {
        let fixture = make_config();
        let runner = MockCommandRunner::from_outputs(vec![
            // export fails
            CommandOutput {
                success: false,
                stdout: Vec::new(),
                stderr: b"project not found".to_vec(),
            },
            // secrets set still runs
            CommandOutput {
                success: true,
                stdout: Vec::new(),
                stderr: Vec::new(),
            },
        ]);
        let remote = make_remote(&runner);
        let payload = make_payload(&[("API_KEY:dev", "val")], 1);
        remote.push(&payload, fixture.config(), "dev").unwrap();

        let c = runner.calls();
        assert_eq!(c.len(), 2);
        // No delete call — just export + set
        assert!(c[0].args.contains(&"export".to_string()));
        assert!(c[1].args.contains(&"set".to_string()));
    }

    #[test]
    fn pull_success() {
        let fixture = make_config();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: export_json(&[
                ("API_KEY", "sk_test"),
                ("DB_URL", "pg://localhost"),
                ("_esk_version", "7"),
            ]),
            stderr: Vec::new(),
        }]);
        let remote = make_remote(&runner);
        let (secrets, version) = remote.pull(fixture.config(), "dev").unwrap().unwrap();

        assert_eq!(version, 7);
        assert_eq!(secrets.get("API_KEY:dev").unwrap(), "sk_test");
        assert_eq!(secrets.get("DB_URL:dev").unwrap(), "pg://localhost");
        assert!(!secrets.contains_key("_esk_version:dev"));

        let c = runner.calls();
        assert_eq!(c.len(), 1);
        assert!(c[0].args.contains(&"export".to_string()));
        assert!(c[0].args.contains(&"development".to_string()));
    }

    #[test]
    fn pull_not_found_returns_none() {
        let fixture = make_config();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: false,
            stdout: Vec::new(),
            stderr: b"project not found".to_vec(),
        }]);
        let remote = make_remote(&runner);
        assert!(remote.pull(fixture.config(), "dev").unwrap().is_none());
    }

    #[test]
    fn parse_export_json_extracts_key_value() {
        let json = serde_json::to_vec(&serde_json::json!([
            {"key": "A", "value": "1", "type": "shared"},
            {"key": "B", "value": "2", "type": "personal"},
            {"key": "C", "value": "", "type": "shared"}
        ]))
        .unwrap();
        let map = parse_export_json(&json).unwrap();
        assert_eq!(map.len(), 3);
        assert_eq!(map["A"], "1");
        assert_eq!(map["B"], "2");
        assert_eq!(map["C"], "");
    }
}