nils-api-testing-core 0.27.0

Library crate for nils-api-testing-core in the nils-cli workspace.
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
use std::io::Write;
use std::path::Path;

use crate::{Result, cli_util, env_file, jwt};

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ProfileTokenSource {
    None,
    Profile,
    EnvFallback { env_name: String },
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CliAuthSource {
    None,
    TokenProfile,
    EnvFallback { env_name: String },
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CliJwtValidationEnv<'a> {
    pub enabled_var: &'a str,
    pub strict_var: &'a str,
    pub leeway_var: &'a str,
    pub tool_label: &'a str,
}

impl From<ProfileTokenSource> for CliAuthSource {
    fn from(value: ProfileTokenSource) -> Self {
        match value {
            ProfileTokenSource::None => Self::None,
            ProfileTokenSource::Profile => Self::TokenProfile,
            ProfileTokenSource::EnvFallback { env_name } => Self::EnvFallback { env_name },
        }
    }
}

pub fn validate_cli_bearer_jwt(
    bearer_token: &str,
    auth_source: &CliAuthSource,
    token_name: &str,
    env: CliJwtValidationEnv<'_>,
    stderr: &mut dyn Write,
) -> Result<()> {
    let enabled = cli_util::bool_from_env(
        std::env::var(env.enabled_var).ok(),
        env.enabled_var,
        true,
        Some(env.tool_label),
        stderr,
    );
    let strict = cli_util::bool_from_env(
        std::env::var(env.strict_var).ok(),
        env.strict_var,
        false,
        Some(env.tool_label),
        stderr,
    );
    let leeway_seconds = cli_util::parse_u64_default(std::env::var(env.leeway_var).ok(), 0, 0);

    let label = match auth_source {
        CliAuthSource::TokenProfile => format!("token profile '{token_name}'"),
        CliAuthSource::EnvFallback { env_name } => env_name.to_string(),
        CliAuthSource::None => "token".to_string(),
    };

    let opts = jwt::JwtValidationOptions {
        enabled,
        strict,
        leeway_seconds: i64::try_from(leeway_seconds).unwrap_or(i64::MAX),
    };

    match jwt::check_bearer_jwt(bearer_token, &label, opts)? {
        jwt::JwtCheck::Ok => Ok(()),
        jwt::JwtCheck::Warn(msg) => {
            let tool_label = env.tool_label.trim();
            if tool_label.is_empty() {
                let _ = writeln!(stderr, "warning: {msg}");
            } else {
                let _ = writeln!(stderr, "{tool_label}: warning: {msg}");
            }
            Ok(())
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ProfileTokenResolution {
    pub bearer_token: Option<String>,
    pub token_name: String,
    pub source: ProfileTokenSource,
}

#[derive(Debug, Clone, Copy)]
pub struct ProfileTokenConfig<'a> {
    pub token_name_arg: Option<&'a str>,
    pub token_name_env_var: &'a str,
    pub token_name_file_var: &'a str,
    pub token_var_prefix: &'a str,
    pub tokens_env: &'a Path,
    pub tokens_local: &'a Path,
    pub tokens_files: &'a [&'a Path],
    pub missing_profile_hint: &'a str,
    pub env_fallback_keys: &'a [&'a str],
}

pub fn resolve_profile_or_env_fallback(
    config: ProfileTokenConfig<'_>,
) -> Result<ProfileTokenResolution> {
    let token_name_arg = config.token_name_arg.and_then(cli_util::trim_non_empty);
    let token_name_env = std::env::var(config.token_name_env_var)
        .ok()
        .and_then(|s| cli_util::trim_non_empty(&s));
    let token_name_file = if !config.tokens_files.is_empty() {
        env_file::read_var_last_wins(config.token_name_file_var, config.tokens_files)?
    } else {
        None
    };

    let token_profile_selected =
        token_name_arg.is_some() || token_name_env.is_some() || token_name_file.is_some();
    let token_name = token_name_arg
        .or(token_name_env)
        .or(token_name_file)
        .unwrap_or_else(|| "default".to_string())
        .to_ascii_lowercase();

    if token_profile_selected {
        let token_key = cli_util::to_env_key(&token_name);
        let token_var = format!("{}{}", config.token_var_prefix, token_key);
        let bearer_token = env_file::read_var_last_wins(&token_var, config.tokens_files)?;
        let Some(bearer_token) = bearer_token else {
            let available = available_token_profiles(
                config.tokens_env,
                config.tokens_local,
                config.token_var_prefix,
            );
            anyhow::bail!(
                "Token profile '{token_name}' is empty/missing (available: {available}). {}",
                config.missing_profile_hint
            );
        };

        return Ok(ProfileTokenResolution {
            bearer_token: Some(bearer_token),
            token_name,
            source: ProfileTokenSource::Profile,
        });
    }

    if let Some((token, env_name)) = resolve_env_fallback(config.env_fallback_keys) {
        return Ok(ProfileTokenResolution {
            bearer_token: Some(token),
            token_name,
            source: ProfileTokenSource::EnvFallback { env_name },
        });
    }

    Ok(ProfileTokenResolution {
        bearer_token: None,
        token_name,
        source: ProfileTokenSource::None,
    })
}

fn available_token_profiles(
    tokens_env: &Path,
    tokens_local: &Path,
    token_var_prefix: &str,
) -> String {
    let mut available = cli_util::list_available_suffixes(tokens_env, token_var_prefix);
    if tokens_local.is_file() {
        available.extend(cli_util::list_available_suffixes(
            tokens_local,
            token_var_prefix,
        ));
        available.sort();
        available.dedup();
    }
    available.retain(|name| name != "name");
    if available.is_empty() {
        "none".to_string()
    } else {
        available.join(" ")
    }
}

pub fn resolve_env_fallback(keys: &[&str]) -> Option<(String, String)> {
    for &key in keys {
        let Ok(value) = std::env::var(key) else {
            continue;
        };
        if let Some(token) = cli_util::trim_non_empty(&value) {
            return Some((token, key.to_string()));
        }
    }
    None
}

#[cfg(test)]
mod tests {
    use super::*;
    use nils_test_support::{EnvGuard, GlobalStateLock};
    use tempfile::TempDir;

    fn write_file(path: &Path, contents: &str) {
        std::fs::create_dir_all(path.parent().expect("parent")).expect("mkdir");
        std::fs::write(path, contents).expect("write");
    }

    fn test_jwt_env() -> CliJwtValidationEnv<'static> {
        CliJwtValidationEnv {
            enabled_var: "TEST_JWT_VALIDATE_ENABLED",
            strict_var: "TEST_JWT_VALIDATE_STRICT",
            leeway_var: "TEST_JWT_VALIDATE_LEEWAY_SECONDS",
            tool_label: "api-test",
        }
    }

    #[test]
    fn resolve_env_fallback_prefers_order() {
        let lock = GlobalStateLock::new();
        let _access = EnvGuard::set(&lock, "ACCESS_TOKEN", "access");
        let _service = EnvGuard::set(&lock, "SERVICE_TOKEN", "service");

        assert_eq!(
            resolve_env_fallback(&["ACCESS_TOKEN", "SERVICE_TOKEN"]),
            Some(("access".to_string(), "ACCESS_TOKEN".to_string()))
        );
    }

    #[test]
    fn cli_auth_source_maps_profile_source_variants() {
        assert_eq!(
            CliAuthSource::from(ProfileTokenSource::None),
            CliAuthSource::None
        );
        assert_eq!(
            CliAuthSource::from(ProfileTokenSource::Profile),
            CliAuthSource::TokenProfile
        );
        assert_eq!(
            CliAuthSource::from(ProfileTokenSource::EnvFallback {
                env_name: "ACCESS_TOKEN".to_string()
            }),
            CliAuthSource::EnvFallback {
                env_name: "ACCESS_TOKEN".to_string()
            }
        );
    }

    #[test]
    fn validate_cli_bearer_jwt_warns_when_non_strict() {
        let lock = GlobalStateLock::new();
        let _enabled = EnvGuard::set(&lock, "TEST_JWT_VALIDATE_ENABLED", "true");
        let _strict = EnvGuard::set(&lock, "TEST_JWT_VALIDATE_STRICT", "false");
        let _leeway = EnvGuard::remove(&lock, "TEST_JWT_VALIDATE_LEEWAY_SECONDS");

        let mut stderr = Vec::new();
        validate_cli_bearer_jwt(
            "not.a.jwt",
            &CliAuthSource::None,
            "default",
            test_jwt_env(),
            &mut stderr,
        )
        .expect("non-strict invalid token should warn");

        let msg = String::from_utf8(stderr).expect("utf8");
        assert!(msg.contains("api-test: warning:"));
        assert!(msg.contains("token for token is not a valid JWT"));
    }

    #[test]
    fn validate_cli_bearer_jwt_errors_when_strict_invalid() {
        let lock = GlobalStateLock::new();
        let _enabled = EnvGuard::set(&lock, "TEST_JWT_VALIDATE_ENABLED", "true");
        let _strict = EnvGuard::set(&lock, "TEST_JWT_VALIDATE_STRICT", "true");
        let _leeway = EnvGuard::remove(&lock, "TEST_JWT_VALIDATE_LEEWAY_SECONDS");

        let mut stderr = Vec::new();
        let err = validate_cli_bearer_jwt(
            "not.a.jwt",
            &CliAuthSource::TokenProfile,
            "svc",
            test_jwt_env(),
            &mut stderr,
        )
        .expect_err("strict invalid token should fail");

        assert!(
            err.to_string()
                .contains("invalid JWT for token profile 'svc'")
        );
    }

    #[test]
    fn resolve_env_fallback_skips_empty_and_whitespace() {
        let lock = GlobalStateLock::new();
        let _access = EnvGuard::set(&lock, "ACCESS_TOKEN", "  ");
        let _service = EnvGuard::set(&lock, "SERVICE_TOKEN", "service");

        assert_eq!(
            resolve_env_fallback(&["ACCESS_TOKEN", "SERVICE_TOKEN"]),
            Some(("service".to_string(), "SERVICE_TOKEN".to_string()))
        );
    }

    #[test]
    fn resolve_env_fallback_returns_none_when_missing() {
        let lock = GlobalStateLock::new();
        let _access = EnvGuard::remove(&lock, "ACCESS_TOKEN");
        let _service = EnvGuard::remove(&lock, "SERVICE_TOKEN");

        assert_eq!(
            resolve_env_fallback(&["ACCESS_TOKEN", "SERVICE_TOKEN"]),
            None
        );
    }

    #[test]
    fn resolve_profile_or_env_fallback_prefers_selected_profile() {
        let lock = GlobalStateLock::new();
        let _access = EnvGuard::set(&lock, "ACCESS_TOKEN", "env-token");
        let _name = EnvGuard::remove(&lock, "REST_TOKEN_NAME");

        let tmp = TempDir::new().expect("tmp");
        let tokens_env = tmp.path().join("tokens.env");
        let tokens_local = tmp.path().join("tokens.local.env");
        write_file(&tokens_env, "REST_TOKEN_SVC=svc-token\n");

        let files = [&tokens_env as &Path, &tokens_local as &Path];
        let resolved = resolve_profile_or_env_fallback(ProfileTokenConfig {
            token_name_arg: Some("svc"),
            token_name_env_var: "REST_TOKEN_NAME",
            token_name_file_var: "REST_TOKEN_NAME",
            token_var_prefix: "REST_TOKEN_",
            tokens_env: &tokens_env,
            tokens_local: &tokens_local,
            tokens_files: &files,
            missing_profile_hint: "hint",
            env_fallback_keys: &["ACCESS_TOKEN", "SERVICE_TOKEN"],
        })
        .expect("profile token resolution");

        assert_eq!(resolved.bearer_token.as_deref(), Some("svc-token"));
        assert_eq!(resolved.token_name, "svc");
        assert_eq!(resolved.source, ProfileTokenSource::Profile);
    }

    #[test]
    fn resolve_profile_or_env_fallback_uses_env_fallback_without_profile_selection() {
        let lock = GlobalStateLock::new();
        let _access = EnvGuard::set(&lock, "ACCESS_TOKEN", "env-token");
        let _name = EnvGuard::remove(&lock, "REST_TOKEN_NAME");

        let tmp = TempDir::new().expect("tmp");
        let tokens_env = tmp.path().join("tokens.env");
        let tokens_local = tmp.path().join("tokens.local.env");
        let files = [&tokens_env as &Path, &tokens_local as &Path];

        let resolved = resolve_profile_or_env_fallback(ProfileTokenConfig {
            token_name_arg: None,
            token_name_env_var: "REST_TOKEN_NAME",
            token_name_file_var: "REST_TOKEN_NAME",
            token_var_prefix: "REST_TOKEN_",
            tokens_env: &tokens_env,
            tokens_local: &tokens_local,
            tokens_files: &files,
            missing_profile_hint: "hint",
            env_fallback_keys: &["ACCESS_TOKEN", "SERVICE_TOKEN"],
        })
        .expect("fallback resolution");

        assert_eq!(resolved.bearer_token.as_deref(), Some("env-token"));
        assert_eq!(resolved.token_name, "default");
        assert_eq!(
            resolved.source,
            ProfileTokenSource::EnvFallback {
                env_name: "ACCESS_TOKEN".to_string()
            }
        );
    }

    #[test]
    fn resolve_profile_or_env_fallback_reports_available_profiles_when_missing() {
        let lock = GlobalStateLock::new();
        let _name = EnvGuard::set(&lock, "REST_TOKEN_NAME", "missing");
        let _access = EnvGuard::remove(&lock, "ACCESS_TOKEN");

        let tmp = TempDir::new().expect("tmp");
        let tokens_env = tmp.path().join("tokens.env");
        let tokens_local = tmp.path().join("tokens.local.env");
        write_file(
            &tokens_env,
            "REST_TOKEN_SVC=svc-token\nREST_TOKEN_DEV=dev-token\n",
        );
        let files = [&tokens_env as &Path, &tokens_local as &Path];

        let err = resolve_profile_or_env_fallback(ProfileTokenConfig {
            token_name_arg: None,
            token_name_env_var: "REST_TOKEN_NAME",
            token_name_file_var: "REST_TOKEN_NAME",
            token_var_prefix: "REST_TOKEN_",
            tokens_env: &tokens_env,
            tokens_local: &tokens_local,
            tokens_files: &files,
            missing_profile_hint: "Set it in setup/rest/tokens.local.env.",
            env_fallback_keys: &["ACCESS_TOKEN", "SERVICE_TOKEN"],
        })
        .expect_err("missing profile should error");

        let text = err.to_string();
        assert!(text.contains("Token profile 'missing' is empty/missing"));
        assert!(text.contains("svc dev") || text.contains("dev svc"));
        assert!(text.contains("setup/rest/tokens.local.env"));
    }

    #[test]
    fn resolve_profile_or_env_fallback_prefers_env_over_file_for_name() {
        let lock = GlobalStateLock::new();
        let _name = EnvGuard::set(&lock, "REST_TOKEN_NAME", "prod");

        let tmp = TempDir::new().expect("tmp");
        let tokens_env = tmp.path().join("tokens.env");
        let tokens_local = tmp.path().join("tokens.local.env");
        write_file(
            &tokens_env,
            "REST_TOKEN_NAME=staging\nREST_TOKEN_PROD=prod-token\n",
        );
        let files = [&tokens_env as &Path, &tokens_local as &Path];

        let resolved = resolve_profile_or_env_fallback(ProfileTokenConfig {
            token_name_arg: None,
            token_name_env_var: "REST_TOKEN_NAME",
            token_name_file_var: "REST_TOKEN_NAME",
            token_var_prefix: "REST_TOKEN_",
            tokens_env: &tokens_env,
            tokens_local: &tokens_local,
            tokens_files: &files,
            missing_profile_hint: "hint",
            env_fallback_keys: &["ACCESS_TOKEN", "SERVICE_TOKEN"],
        })
        .expect("env token name resolution");

        assert_eq!(resolved.bearer_token.as_deref(), Some("prod-token"));
        assert_eq!(resolved.token_name, "prod");
        assert_eq!(resolved.source, ProfileTokenSource::Profile);
    }
}