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
//! Azure App Service target — deploys app settings via the `az` CLI.
//!
//! Azure App Service is Microsoft's PaaS for hosting web apps, REST APIs,
//! and mobile backends. App settings are exposed as environment variables
//! to the running application.
//!
//! CLI: `az` (Azure CLI).
//! Commands: `az webapp config appsettings set` / `az webapp config appsettings delete`.
//!
//! The Azure CLI does **not** reliably support stdin for setting values, so
//! they are passed as `--settings KEY=VALUE` command-line arguments (visible
//! in `ps` output). Requires an app name (mapped from esk's app config) and
//! a resource group.

use anyhow::{Context, Result};

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

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

impl AzureAppServiceTarget<'_> {
    fn resolve_app(&self, target: &ResolvedTarget) -> Result<&str> {
        let app = target
            .app
            .as_deref()
            .context("azure_app_service target requires an app")?;
        self.target_config
            .app_names
            .get(app)
            .map(std::string::String::as_str)
            .with_context(|| format!("no azure_app_service app_names mapping for '{app}'"))
    }

    fn resolve_slot(&self, env: &str) -> Option<&str> {
        self.target_config.slot.get(env).map(String::as_str)
    }

    fn base_args(&self) -> Vec<String> {
        let mut args = Vec::new();
        if let Some(sub) = &self.target_config.subscription {
            args.push("--subscription".to_string());
            args.push(sub.clone());
        }
        args
    }
}

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

    fn passes_value_as_cli_arg(&self) -> bool {
        true
    }

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

    fn preflight(&self) -> Result<()> {
        check_command(self.runner, "az").map_err(|_| {
            anyhow::anyhow!(
                "az is not installed or not in PATH. Install it from: https://learn.microsoft.com/en-us/cli/azure/install-azure-cli"
            )
        })?;
        let base = self.base_args();
        let mut args: Vec<&str> = vec!["account", "show"];
        args.extend(base.iter().map(String::as_str));
        let output = self
            .runner
            .run("az", &args, CommandOpts::default())
            .context("failed to run az account show")?;
        if !output.success {
            anyhow::bail!("az is not authenticated. Run: az login");
        }
        Ok(())
    }

    // SECURITY: az CLI has no reliable stdin support for appsettings set. Secret values are
    // exposed in process arguments (visible via `ps aux`). No workaround available.
    fn deploy_secret(&self, key: &str, value: &str, target: &ResolvedTarget) -> Result<()> {
        let azure_app = self.resolve_app(target)?;
        let rg = &self.target_config.resource_group;
        let kv = format!("{key}={value}");
        let base = self.base_args();

        let flag_parts = resolve_env_flags(&self.target_config.env_flags, &target.environment);
        let mut args: Vec<&str> = vec![
            "webapp",
            "config",
            "appsettings",
            "set",
            "--name",
            azure_app,
            "--resource-group",
            rg,
            "--settings",
            &kv,
        ];
        if let Some(slot) = self.resolve_slot(&target.environment) {
            args.push("--slot");
            args.push(slot);
        }
        args.extend(base.iter().map(String::as_str));
        args.extend(flag_parts.iter().map(String::as_str));

        let output = self
            .runner
            .run("az", &args, CommandOpts::default())
            .with_context(|| format!("failed to run az webapp config appsettings set for {key}"))?;

        output.check("az webapp config appsettings set", key)
    }

    fn delete_secret(&self, key: &str, target: &ResolvedTarget) -> Result<()> {
        let azure_app = self.resolve_app(target)?;
        let rg = &self.target_config.resource_group;
        let base = self.base_args();

        let flag_parts = resolve_env_flags(&self.target_config.env_flags, &target.environment);
        let mut args: Vec<&str> = vec![
            "webapp",
            "config",
            "appsettings",
            "delete",
            "--name",
            azure_app,
            "--resource-group",
            rg,
            "--setting-names",
            key,
        ];
        if let Some(slot) = self.resolve_slot(&target.environment) {
            args.push("--slot");
            args.push(slot);
        }
        args.extend(base.iter().map(String::as_str));
        args.extend(flag_parts.iter().map(String::as_str));

        let output = self
            .runner
            .run("az", &args, CommandOpts::default())
            .with_context(|| {
                format!("failed to run az webapp config appsettings delete for {key}")
            })?;

        output.check("az webapp config appsettings delete", key)
    }
}

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

    fn make_config() -> ConfigFixture {
        let yaml = r#"
project: x
environments: [dev, staging, prod]
apps:
  web:
    path: apps/web
targets:
  azure_app_service:
    resource_group: my-resource-group
    app_names:
      web: my-azure-webapp
    slot:
      staging: staging
    subscription: my-sub-id
    env_flags:
      prod: "--debug"
"#;
        ConfigFixture::new(yaml).expect("fixture")
    }

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

    #[test]
    fn preflight_success() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![
            CommandOutput {
                success: true,
                stdout: b"2.50.0".to_vec(),
                stderr: vec![],
            },
            CommandOutput {
                success: true,
                stdout: b"{}".to_vec(),
                stderr: vec![],
            },
        ]);
        let target = AzureAppServiceTarget {
            config,
            target_config,
            runner: &runner,
        };
        assert!(target.preflight().is_ok());
        let calls = runner.take_calls();
        assert_eq!(calls[0].args, vec!["--version"]);
        assert_eq!(
            calls[1].args,
            vec!["account", "show", "--subscription", "my-sub-id"]
        );
    }

    #[test]
    fn preflight_auth_failure() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![
            CommandOutput {
                success: true,
                stdout: b"2.50.0".to_vec(),
                stderr: vec![],
            },
            CommandOutput {
                success: false,
                stdout: vec![],
                stderr: b"not logged in".to_vec(),
            },
        ]);
        let target = AzureAppServiceTarget {
            config,
            target_config,
            runner: &runner,
        };
        let err = target.preflight().unwrap_err();
        assert!(err.to_string().contains("az is not authenticated"));
    }

    #[test]
    fn preflight_missing_cli() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = ErrorCommandRunner::missing_command();
        let target = AzureAppServiceTarget {
            config,
            target_config,
            runner: &runner,
        };
        let err = target.preflight().unwrap_err();
        assert!(err.to_string().contains("az is not installed"));
    }

    #[test]
    fn deploy_correct_args() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: vec![],
            stderr: vec![],
        }]);
        let target = AzureAppServiceTarget {
            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].program, "az");
        assert_eq!(
            calls[0].args,
            vec![
                "webapp",
                "config",
                "appsettings",
                "set",
                "--name",
                "my-azure-webapp",
                "--resource-group",
                "my-resource-group",
                "--settings",
                "MY_KEY=secret_val",
                "--subscription",
                "my-sub-id",
            ]
        );
    }

    #[test]
    fn deploy_with_env_flags() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: vec![],
            stderr: vec![],
        }]);
        let target = AzureAppServiceTarget {
            config,
            target_config,
            runner: &runner,
        };
        target
            .deploy_secret("KEY", "val", &make_target(Some("web"), "prod"))
            .unwrap();
        let calls = runner.take_calls();
        assert!(calls[0].args.contains(&"--debug".to_string()));
    }

    #[test]
    fn deploy_with_slot() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: vec![],
            stderr: vec![],
        }]);
        let target = AzureAppServiceTarget {
            config,
            target_config,
            runner: &runner,
        };
        target
            .deploy_secret("KEY", "val", &make_target(Some("web"), "staging"))
            .unwrap();
        let calls = runner.take_calls();
        assert_eq!(
            calls[0].args,
            vec![
                "webapp",
                "config",
                "appsettings",
                "set",
                "--name",
                "my-azure-webapp",
                "--resource-group",
                "my-resource-group",
                "--settings",
                "KEY=val",
                "--slot",
                "staging",
                "--subscription",
                "my-sub-id",
            ]
        );
    }

    #[test]
    fn delete_correct_args() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: true,
            stdout: vec![],
            stderr: vec![],
        }]);
        let target = AzureAppServiceTarget {
            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![
                "webapp",
                "config",
                "appsettings",
                "delete",
                "--name",
                "my-azure-webapp",
                "--resource-group",
                "my-resource-group",
                "--setting-names",
                "MY_KEY",
                "--subscription",
                "my-sub-id",
            ]
        );
    }

    #[test]
    fn requires_app() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![]);
        let target = AzureAppServiceTarget {
            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"));
    }

    #[test]
    fn unknown_app_mapping() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![]);
        let target = AzureAppServiceTarget {
            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 azure_app_service app_names mapping"));
    }

    #[test]
    fn nonzero_exit() {
        let fixture = make_config();
        let config = fixture.config();
        let target_config = config.targets.azure_app_service.as_ref().unwrap();
        let runner = MockCommandRunner::from_outputs(vec![CommandOutput {
            success: false,
            stdout: vec![],
            stderr: b"auth error".to_vec(),
        }]);
        let target = AzureAppServiceTarget {
            config,
            target_config,
            runner: &runner,
        };
        let err = target
            .deploy_secret("KEY", "val", &make_target(Some("web"), "dev"))
            .unwrap_err();
        assert!(err.to_string().contains("auth error"));
    }
}