osp-cli 1.5.1

CLI and REPL for querying and managing OSP infrastructure data
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
use std::collections::{BTreeMap, BTreeSet};

use crate::config::bootstrap::{
    ResolutionFrame, explain_default_profile_bootstrap, explain_default_profile_key,
    prepare_resolution,
};
use crate::config::explain::{
    build_runtime_explain, explain_layers_for_runtime_key, selected_value,
};
use crate::config::interpolate::{explain_interpolation, interpolate_all};
use crate::config::selector::{LayerRef, ScopeSelector, SelectedLayerEntry};
use crate::config::{
    BootstrapConfigExplain, ConfigError, ConfigExplain, ConfigLayer, ConfigSchema, ConfigSource,
    ConfigValue, LoadedLayers, ResolveOptions, ResolvedConfig, ResolvedValue, Scope, is_alias_key,
    is_bootstrap_only_key,
};

/// Resolves layered config input into the runtime view seen by the rest of the
/// application.
///
/// Callers usually populate the individual source layers first and then ask
/// the resolver for either the final runtime view or an explanation trace.
///
/// High-level flow:
///
/// - select one winning raw value per key using source and scope precedence
/// - interpolate placeholders inside the selected winners
/// - adapt and validate the interpolated values against the schema
/// - optionally expose an explanation trace that shows why each winner won
///
/// Contract:
///
/// - precedence rules live here, not in callers
/// - schema adaptation happens after winner selection, not while scanning layers
/// - bootstrap handling stays aligned with the config bootstrap helpers rather
///   than becoming a separate merge system
#[derive(Debug, Clone, Default)]
pub struct ConfigResolver {
    layers: LoadedLayers,
    schema: ConfigSchema,
}

/// Resolution happens in two steps:
/// 1. pick the winning raw value for each key using source + scope precedence
/// 2. interpolate placeholders and then run schema adaptation on those winners
#[derive(Debug, Clone)]
struct ResolvedMaps {
    pre_interpolated: BTreeMap<String, ResolvedValue>,
    final_values: BTreeMap<String, ResolvedValue>,
    alias_values: BTreeMap<String, ResolvedValue>,
}

impl ConfigResolver {
    /// Creates a resolver from pre-loaded config layers.
    pub fn from_loaded_layers(layers: LoadedLayers) -> Self {
        Self::from_loaded_layers_with_schema(layers, ConfigSchema::default())
    }

    /// Creates a resolver from pre-loaded config layers and an explicit schema.
    pub fn from_loaded_layers_with_schema(layers: LoadedLayers, schema: ConfigSchema) -> Self {
        Self { layers, schema }
    }

    /// Replaces the schema used for validation and adaptation.
    pub fn set_schema(&mut self, schema: ConfigSchema) {
        self.schema = schema;
    }

    /// Returns mutable access to the active schema.
    pub fn schema_mut(&mut self) -> &mut ConfigSchema {
        &mut self.schema
    }

    /// Returns mutable access to the built-in defaults layer.
    pub fn defaults_mut(&mut self) -> &mut ConfigLayer {
        &mut self.layers.defaults
    }

    /// Returns mutable access to the config file layer.
    pub fn file_mut(&mut self) -> &mut ConfigLayer {
        &mut self.layers.file
    }

    /// Returns mutable access to the presentation defaults layer.
    pub fn presentation_mut(&mut self) -> &mut ConfigLayer {
        &mut self.layers.presentation
    }

    /// Returns mutable access to the secrets layer.
    pub fn secrets_mut(&mut self) -> &mut ConfigLayer {
        &mut self.layers.secrets
    }

    /// Returns mutable access to the environment layer.
    pub fn env_mut(&mut self) -> &mut ConfigLayer {
        &mut self.layers.env
    }

    /// Returns mutable access to the CLI layer.
    pub fn cli_mut(&mut self) -> &mut ConfigLayer {
        &mut self.layers.cli
    }

    /// Returns mutable access to the session layer.
    pub fn session_mut(&mut self) -> &mut ConfigLayer {
        &mut self.layers.session
    }

    /// Replaces the built-in defaults layer.
    pub fn set_defaults(&mut self, layer: ConfigLayer) {
        self.layers.defaults = layer;
    }

    /// Replaces the config file layer.
    pub fn set_file(&mut self, layer: ConfigLayer) {
        self.layers.file = layer;
    }

    /// Replaces the presentation defaults layer.
    pub fn set_presentation(&mut self, layer: ConfigLayer) {
        self.layers.presentation = layer;
    }

    /// Replaces the secrets layer.
    pub fn set_secrets(&mut self, layer: ConfigLayer) {
        self.layers.secrets = layer;
    }

    /// Replaces the environment layer.
    pub fn set_env(&mut self, layer: ConfigLayer) {
        self.layers.env = layer;
    }

    /// Replaces the CLI layer.
    pub fn set_cli(&mut self, layer: ConfigLayer) {
        self.layers.cli = layer;
    }

    /// Replaces the session layer.
    pub fn set_session(&mut self, layer: ConfigLayer) {
        self.layers.session = layer;
    }

    /// Resolves all configured layers into the final runtime config.
    ///
    /// Source precedence still applies inside this API, so later layers like
    /// session or CLI overrides can replace lower-priority defaults.
    ///
    /// # Examples
    ///
    /// ```
    /// use osp_cli::config::{ConfigResolver, LoadedLayers, ResolveOptions};
    ///
    /// let mut layers = LoadedLayers::default();
    /// layers.defaults.set("profile.default", "default");
    /// layers.defaults.set("theme.name", "plain");
    /// layers.session.set("theme.name", "dracula");
    ///
    /// let resolved = ConfigResolver::from_loaded_layers(layers)
    ///     .resolve(ResolveOptions::default())
    ///     .unwrap();
    ///
    /// assert_eq!(resolved.get_string("theme.name"), Some("dracula"));
    /// ```
    pub fn resolve(&self, options: ResolveOptions) -> Result<ResolvedConfig, ConfigError> {
        tracing::debug!(
            profile_override = ?options.profile_override,
            terminal = ?options.terminal,
            "resolving config"
        );
        let frame = prepare_resolution(self.layers(), options)?;
        let resolved = self.resolve_maps_for_frame(&frame)?;
        let config = ResolvedConfig {
            active_profile: frame.active_profile,
            terminal: frame.terminal,
            known_profiles: frame.known_profiles,
            values: resolved.final_values,
            aliases: resolved.alias_values,
        };
        tracing::debug!(
            active_profile = %config.active_profile(),
            terminal = ?config.terminal(),
            values = config.values().len(),
            aliases = config.aliases().len(),
            "resolved config"
        );
        Ok(config)
    }

    /// Explains how a runtime key was selected, interpolated, and adapted.
    ///
    /// The explanation keeps the raw winning value as well as the final
    /// adapted value so callers can see where interpolation or type coercion
    /// changed the original input.
    ///
    /// # Examples
    ///
    /// ```
    /// use osp_cli::config::{ConfigResolver, LoadedLayers, ResolveOptions};
    ///
    /// let mut layers = LoadedLayers::default();
    /// layers.defaults.set("profile.default", "default");
    /// layers.defaults.set("theme.name", "plain");
    /// layers.cli.set("theme.name", "dracula");
    ///
    /// let explain = ConfigResolver::from_loaded_layers(layers)
    ///     .explain_key("theme.name", ResolveOptions::default())
    ///     .unwrap();
    ///
    /// assert_eq!(explain.key, "theme.name");
    /// assert_eq!(
    ///     explain.final_entry.unwrap().value.reveal(),
    ///     &osp_cli::config::ConfigValue::String("dracula".to_string())
    /// );
    /// ```
    pub fn explain_key(
        &self,
        key: &str,
        options: ResolveOptions,
    ) -> Result<ConfigExplain, ConfigError> {
        if key.eq_ignore_ascii_case("profile.default") {
            return explain_default_profile_key(self.layers(), options);
        }

        let frame = prepare_resolution(self.layers(), options)?;
        let layers = explain_layers_for_runtime_key(self.layers(), key, &frame);
        let resolved = self.resolve_maps_for_frame(&frame)?;
        let final_entry = if is_alias_key(key) {
            resolved.alias_values.get(key).cloned()
        } else {
            resolved.final_values.get(key).cloned()
        };
        // Explaining interpolation intentionally re-reads the pre-interpolated
        // values so the trace shows the original placeholder chain rather than
        // the already-expanded end state.
        let interpolation =
            explain_interpolation(key, &resolved.pre_interpolated, &resolved.final_values)?;

        Ok(build_runtime_explain(
            key,
            frame,
            layers,
            final_entry,
            if is_alias_key(key) {
                None
            } else {
                interpolation
            },
        ))
    }

    /// Explains bootstrap resolution for a bootstrap-only key.
    pub fn explain_bootstrap_key(
        &self,
        key: &str,
        options: ResolveOptions,
    ) -> Result<BootstrapConfigExplain, ConfigError> {
        if key.eq_ignore_ascii_case("profile.default") {
            return explain_default_profile_bootstrap(self.layers(), options);
        }

        Err(ConfigError::InvalidConfigKey {
            key: key.to_string(),
            reason: "not a bootstrap key".to_string(),
        })
    }

    /// Run the resolver's two actual phases:
    /// 1. select the winning raw value for each key
    /// 2. interpolate/adapt those winners into final values
    fn resolve_maps_for_frame(&self, frame: &ResolutionFrame) -> Result<ResolvedMaps, ConfigError> {
        tracing::trace!(
            active_profile = %frame.active_profile,
            terminal = ?frame.terminal,
            "resolving config maps for frame"
        );
        let mut pre_interpolated = self.collect_selected_values_for_frame(frame);
        // Aliases are selected with the same precedence rules so explain can
        // still show their winning raw source, but they stay out of ordinary
        // runtime interpolation and schema validation.
        let alias_values = Self::drain_alias_values(&mut pre_interpolated);
        // Keep both snapshots: normal resolution only needs `final_values`, but
        // `config explain` needs the selected raw winners alongside the final
        // interpolated/adapted view.
        let mut final_values = pre_interpolated.clone();
        interpolate_all(&mut final_values)?;
        self.schema.validate_and_adapt(&mut final_values)?;

        tracing::trace!(
            pre_interpolated = pre_interpolated.len(),
            final_values = final_values.len(),
            aliases = alias_values.len(),
            "resolved config maps for frame"
        );
        Ok(ResolvedMaps {
            pre_interpolated,
            final_values,
            alias_values,
        })
    }

    /// Pick one raw winner per key using source precedence + scope precedence.
    ///
    /// Interpolation is intentionally excluded here; this map is the exact
    /// input to the later placeholder-expansion pass.
    fn collect_selected_values_for_frame(
        &self,
        frame: &ResolutionFrame,
    ) -> BTreeMap<String, ResolvedValue> {
        let selector = ScopeSelector::scoped(&frame.active_profile, frame.terminal.as_deref());
        let keys = self.collect_keys();

        let mut values = BTreeMap::new();
        for key in keys {
            if is_bootstrap_only_key(&key) {
                continue;
            }
            if let Some(selected) = self.select_across_layers(&key, selector) {
                values.insert(key, selected_value(&selected));
            }
        }

        values.insert(
            "profile.active".to_string(),
            Self::derived_active_profile_value(frame),
        );

        values
    }

    /// Expose the chosen profile as a normal resolved value so later schema
    /// defaults/interpolation can refer to it without special-case APIs.
    fn derived_active_profile_value(frame: &ResolutionFrame) -> ResolvedValue {
        ResolvedValue {
            raw_value: ConfigValue::String(frame.active_profile.to_string()),
            value: ConfigValue::String(frame.active_profile.to_string()),
            source: ConfigSource::Derived,
            scope: Scope::global(),
            origin: None,
        }
    }

    fn collect_keys(&self) -> BTreeSet<String> {
        let mut keys = BTreeSet::new();

        for layer in self.layers() {
            for entry in &layer.layer.entries {
                keys.insert(entry.key.clone());
            }
        }

        keys
    }

    fn drain_alias_values(
        values: &mut BTreeMap<String, ResolvedValue>,
    ) -> BTreeMap<String, ResolvedValue> {
        let alias_keys = values
            .keys()
            .filter(|key| is_alias_key(key))
            .cloned()
            .collect::<Vec<_>>();
        let mut aliases = BTreeMap::new();
        for key in alias_keys {
            if let Some(value) = values.remove(&key) {
                aliases.insert(key, value);
            }
        }
        aliases
    }

    fn select_across_layers<'a>(
        &'a self,
        key: &str,
        selector: ScopeSelector<'a>,
    ) -> Option<SelectedLayerEntry<'a>> {
        let mut selected: Option<SelectedLayerEntry<'a>> = None;

        // Layers are returned in ascending priority order, so later matches
        // intentionally overwrite earlier ones.
        for layer in self.layers() {
            if let Some(entry) = selector.select(layer, key) {
                if let Some(previous) = &selected {
                    if should_preserve_selected_secret(previous, &entry) {
                        tracing::trace!(
                            key = %key,
                            secret_origin = ?previous.entry.origin,
                            env_origin = ?entry.entry.origin,
                            "preserving secret env override over plain env value"
                        );
                        continue;
                    }
                    tracing::trace!(
                        key = %key,
                        previous_source = ?previous.source,
                        next_source = ?entry.source,
                        "config key winner changed across layers"
                    );
                }
                selected = Some(entry);
            }
        }

        selected
    }

    fn layers(&self) -> [LayerRef<'_>; 7] {
        // Keep this order in ascending priority so later layers can override
        // earlier ones in `select_across_layers()`.
        [
            LayerRef {
                source: ConfigSource::BuiltinDefaults,
                layer: &self.layers.defaults,
            },
            LayerRef {
                source: ConfigSource::PresentationDefaults,
                layer: &self.layers.presentation,
            },
            LayerRef {
                source: ConfigSource::ConfigFile,
                layer: &self.layers.file,
            },
            LayerRef {
                source: ConfigSource::Secrets,
                layer: &self.layers.secrets,
            },
            LayerRef {
                source: ConfigSource::Environment,
                layer: &self.layers.env,
            },
            LayerRef {
                source: ConfigSource::Cli,
                layer: &self.layers.cli,
            },
            LayerRef {
                source: ConfigSource::Session,
                layer: &self.layers.session,
            },
        ]
    }
}

fn should_preserve_selected_secret(
    previous: &SelectedLayerEntry<'_>,
    next: &SelectedLayerEntry<'_>,
) -> bool {
    previous.source == ConfigSource::Secrets
        && next.source == ConfigSource::Environment
        && previous.entry.value.is_secret()
        && previous
            .entry
            .origin
            .as_deref()
            .is_some_and(|origin| origin.starts_with("OSP_SECRET__"))
}

#[cfg(test)]
mod tests {
    use super::ConfigResolver;
    use crate::config::{
        ConfigError, ConfigLayer, ConfigSource, ConfigValue, ResolveOptions, Scope,
    };

    #[test]
    fn resolver_layer_mutators_and_setters_are_callable_unit() {
        let mut resolver = ConfigResolver::default();
        resolver.defaults_mut().set("profile.default", "default");
        resolver.file_mut().set("theme.name", "file");
        resolver.secrets_mut().set("profile.default", "default");
        resolver.env_mut().set("theme.name", "env");
        resolver.cli_mut().set("theme.name", "cli");
        resolver.session_mut().set("theme.name", "session");

        let resolved = resolver
            .resolve(ResolveOptions::default().with_terminal("cli"))
            .expect("resolver should resolve");
        assert_eq!(resolved.get_string("theme.name"), Some("session"));
        assert_eq!(resolved.active_profile(), "default");

        let mut replacement = ConfigLayer::default();
        replacement.set("profile.default", "default");
        replacement.set("theme.name", "replaced");
        resolver.set_defaults(replacement);
        resolver.set_file(ConfigLayer::default());
        resolver.set_secrets(ConfigLayer::default());
        resolver.set_env(ConfigLayer::default());
        resolver.set_cli(ConfigLayer::default());
        resolver.set_session(ConfigLayer::default());

        let replaced = resolver
            .resolve(ResolveOptions::default().with_terminal("cli"))
            .expect("replacement config should resolve");
        assert_eq!(replaced.get_string("theme.name"), Some("replaced"));

        let mut resolver = ConfigResolver::default();
        resolver.defaults_mut().set("profile.default", "default");
        resolver.secrets_mut().insert_with_origin(
            "extensions.demo.token",
            ConfigValue::String("secret-token".to_string()).into_secret(),
            Scope::global(),
            Some("OSP_SECRET__AUTH__TOKEN"),
        );
        resolver.env_mut().insert_with_origin(
            "extensions.demo.token",
            ConfigValue::String("plain-token".to_string()),
            Scope::global(),
            Some("OSP__AUTH__TOKEN"),
        );

        let resolved = resolver
            .resolve(ResolveOptions::default())
            .expect("resolver should resolve");
        let entry = resolved
            .get_value_entry("extensions.demo.token")
            .expect("extensions.demo.token should resolve");

        assert!(entry.value.is_secret());
        assert_eq!(
            entry.value.reveal(),
            &ConfigValue::String("secret-token".to_string())
        );
        assert_eq!(entry.source, ConfigSource::Secrets);

        let err = ConfigResolver::default()
            .explain_bootstrap_key("ui.theme", ResolveOptions::default())
            .expect_err("non-bootstrap key should fail");
        assert!(matches!(
            err,
            ConfigError::InvalidConfigKey { key, .. } if key == "ui.theme"
        ));

        let mut resolver = ConfigResolver::default();
        resolver.defaults_mut().set("profile.default", "ops");
        let resolved = resolver
            .resolve(ResolveOptions::default())
            .expect("selected profile without scoped entries should resolve");
        assert_eq!(resolved.active_profile(), "ops");
        assert!(resolved.known_profiles().contains("ops"));
    }
}