mirror of
https://github.com/openai/codex.git
synced 2026-11-17 22:10:37 +00:00
## What changed - Add `shell_environment_policy.filters`, mapping environment-variable patterns to `include` or `exclude`, while continuing to accept the legacy `exclude` and `include_only` arrays. - Merge filter keys case-insensitively across config layers so higher-precedence entries can override individual patterns. Switching representations replaces the other representation instead of combining them. - Reject mixed, duplicate, or malformed filter definitions in enabled layers, config writes, and reloads, while retaining the previous session configuration when a reload is invalid. - Make config-manager reads and writes representation-aware and preserve existing formatting when updating individual policy values. ## Testing Add coverage for parsing, schema constraints, layered merging, validation and diagnostics, config writes, override metadata, and invalid session reloads. GitOrigin-RevId: e15464bca53e6e7ef31fcc97537fda60ed5d670a
265 lines
7.4 KiB
Rust
265 lines
7.4 KiB
Rust
use super::*;
|
|
use pretty_assertions::assert_eq;
|
|
use tempfile::TempDir;
|
|
|
|
fn test_user_config_path(temp_dir: &TempDir, file_name: &str) -> AbsolutePathBuf {
|
|
AbsolutePathBuf::from_absolute_path(temp_dir.path().join(file_name))
|
|
.expect("test user config path should be absolute")
|
|
}
|
|
|
|
#[test]
|
|
fn origins_use_canonical_key_aliases() {
|
|
let layer = ConfigLayerEntry::new(
|
|
ConfigLayerSource::SessionFlags,
|
|
toml::from_str(
|
|
r#"
|
|
[memories]
|
|
no_memories_if_mcp_or_web_search = true
|
|
"#,
|
|
)
|
|
.expect("config TOML should parse"),
|
|
);
|
|
let metadata = layer.metadata();
|
|
let stack = ConfigLayerStack::new(
|
|
vec![layer],
|
|
ConfigRequirements::default(),
|
|
ConfigRequirementsToml::default(),
|
|
)
|
|
.expect("single layer stack should be valid");
|
|
|
|
let origins = stack.origins();
|
|
|
|
assert_eq!(
|
|
origins.get("memories.disable_on_external_context"),
|
|
Some(&metadata)
|
|
);
|
|
assert!(
|
|
!origins.contains_key("memories.no_memories_if_mcp_or_web_search"),
|
|
"legacy key should be canonicalized before origin recording"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn enabled_layers_validate_shell_environment_policy() {
|
|
let layer = ConfigLayerEntry::new(
|
|
ConfigLayerSource::SessionFlags,
|
|
toml::from_str(
|
|
r#"
|
|
[shell_environment_policy]
|
|
exclude = ["LEGACY_*"]
|
|
|
|
[shell_environment_policy.filters]
|
|
"CANONICAL_*" = "include"
|
|
"#,
|
|
)
|
|
.expect("session config"),
|
|
);
|
|
|
|
let error = ConfigLayerStack::new(
|
|
vec![layer],
|
|
ConfigRequirements::default(),
|
|
ConfigRequirementsToml::default(),
|
|
)
|
|
.expect_err("enabled layers should be validated");
|
|
|
|
assert_eq!(error.kind(), std::io::ErrorKind::InvalidData);
|
|
assert!(
|
|
error
|
|
.to_string()
|
|
.contains("cannot mix `filters` with legacy `exclude` or `include_only`")
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn disabled_layers_do_not_validate_shell_environment_policy() {
|
|
let layer = ConfigLayerEntry::new_disabled(
|
|
ConfigLayerSource::Project {
|
|
dot_codex_folder: AbsolutePathBuf::from_absolute_path("/untrusted/.codex")
|
|
.expect("project path should be absolute"),
|
|
},
|
|
toml::from_str(
|
|
r#"
|
|
[shell_environment_policy]
|
|
exclude = ["LEGACY_*"]
|
|
|
|
[shell_environment_policy.filters]
|
|
"CANONICAL_*" = "include"
|
|
"#,
|
|
)
|
|
.expect("project config"),
|
|
"project is untrusted",
|
|
);
|
|
|
|
ConfigLayerStack::new(
|
|
vec![layer],
|
|
ConfigRequirements::default(),
|
|
ConfigRequirementsToml::default(),
|
|
)
|
|
.expect("disabled layers should not be validated");
|
|
}
|
|
|
|
#[test]
|
|
fn enabled_layers_only_validate_representation_sensitive_shell_policy_fields() {
|
|
let cases = [
|
|
r#"shell_environment_policy = 17"#,
|
|
r#"
|
|
[shell_environment_policy]
|
|
inherit = "invalid"
|
|
set = ["invalid"]
|
|
"#,
|
|
];
|
|
|
|
for contents in cases {
|
|
let layer = ConfigLayerEntry::new(
|
|
ConfigLayerSource::SessionFlags,
|
|
toml::from_str(contents).expect("session config"),
|
|
);
|
|
|
|
ConfigLayerStack::new(
|
|
vec![layer],
|
|
ConfigRequirements::default(),
|
|
ConfigRequirementsToml::default(),
|
|
)
|
|
.expect("unrelated shell policy fields should retain normal overlay semantics");
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn with_user_config_rejects_malformed_shell_policy_filter_fields() {
|
|
let temp_dir = TempDir::new().expect("tempdir");
|
|
let config_file = test_user_config_path(&temp_dir, "config.toml");
|
|
let cases = [
|
|
r#"
|
|
[shell_environment_policy]
|
|
exclude = ["SECRET_*", 17]
|
|
"#,
|
|
r#"
|
|
[shell_environment_policy.filters]
|
|
"SECRET_*" = "keep"
|
|
"#,
|
|
r#"
|
|
[shell_environment_policy]
|
|
exclude = ["SECRET_*"]
|
|
|
|
[shell_environment_policy.filters]
|
|
"PATH" = "include"
|
|
"#,
|
|
r#"
|
|
[shell_environment_policy.filters]
|
|
"SECRET_*" = "exclude"
|
|
"secret_*" = "include"
|
|
"#,
|
|
];
|
|
|
|
for contents in cases {
|
|
let error = ConfigLayerStack::default()
|
|
.with_user_config(&config_file, toml::from_str(contents).expect("user config"))
|
|
.expect_err("malformed shell policy filter fields should be rejected");
|
|
|
|
assert_eq!(error.kind(), std::io::ErrorKind::InvalidData);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn active_user_layer_is_highest_precedence_user_layer() {
|
|
let temp_dir = TempDir::new().expect("tempdir");
|
|
let base_file = test_user_config_path(&temp_dir, "config.toml");
|
|
let profile_file = test_user_config_path(&temp_dir, "work.config.toml");
|
|
let base_layer = ConfigLayerEntry::new(
|
|
ConfigLayerSource::User {
|
|
file: base_file,
|
|
profile: None,
|
|
},
|
|
toml::from_str(
|
|
r#"
|
|
model = "base"
|
|
approval_policy = "on-request"
|
|
"#,
|
|
)
|
|
.expect("base config"),
|
|
);
|
|
let profile_layer = ConfigLayerEntry::new(
|
|
ConfigLayerSource::User {
|
|
file: profile_file.clone(),
|
|
profile: Some("work".to_string()),
|
|
},
|
|
toml::from_str(r#"model = "profile""#).expect("profile config"),
|
|
);
|
|
let stack = ConfigLayerStack::new(
|
|
vec![base_layer, profile_layer],
|
|
ConfigRequirements::default(),
|
|
ConfigRequirementsToml::default(),
|
|
)
|
|
.expect("multiple user layers should be valid");
|
|
|
|
assert_eq!(stack.get_user_config_file(), Some(&profile_file));
|
|
assert_eq!(
|
|
stack
|
|
.effective_user_config()
|
|
.expect("merged user config")
|
|
.get("model")
|
|
.and_then(toml::Value::as_str),
|
|
Some("profile")
|
|
);
|
|
assert_eq!(
|
|
stack
|
|
.effective_user_config()
|
|
.expect("merged user config")
|
|
.get("approval_policy")
|
|
.and_then(toml::Value::as_str),
|
|
Some("on-request")
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn with_user_config_updates_matching_user_layer_without_replacing_active_profile() {
|
|
let temp_dir = TempDir::new().expect("tempdir");
|
|
let base_file = test_user_config_path(&temp_dir, "config.toml");
|
|
let profile_file = test_user_config_path(&temp_dir, "work.config.toml");
|
|
let base_layer = ConfigLayerEntry::new(
|
|
ConfigLayerSource::User {
|
|
file: base_file.clone(),
|
|
profile: None,
|
|
},
|
|
toml::from_str(r#"model = "base""#).expect("base config"),
|
|
);
|
|
let profile_layer = ConfigLayerEntry::new(
|
|
ConfigLayerSource::User {
|
|
file: profile_file.clone(),
|
|
profile: Some("work".to_string()),
|
|
},
|
|
toml::from_str(r#"approval_policy = "on-request""#).expect("profile config"),
|
|
);
|
|
let stack = ConfigLayerStack::new(
|
|
vec![base_layer, profile_layer],
|
|
ConfigRequirements::default(),
|
|
ConfigRequirementsToml::default(),
|
|
)
|
|
.expect("multiple user layers should be valid");
|
|
|
|
let updated = stack
|
|
.with_user_config(
|
|
&base_file,
|
|
toml::from_str(r#"model = "updated-base""#).expect("updated base config"),
|
|
)
|
|
.expect("updated user layer should be valid");
|
|
|
|
assert_eq!(updated.get_user_config_file(), Some(&profile_file));
|
|
assert_eq!(
|
|
updated
|
|
.effective_user_config()
|
|
.expect("merged user config")
|
|
.get("model")
|
|
.and_then(toml::Value::as_str),
|
|
Some("updated-base")
|
|
);
|
|
assert_eq!(
|
|
updated
|
|
.effective_user_config()
|
|
.expect("merged user config")
|
|
.get("approval_policy")
|
|
.and_then(toml::Value::as_str),
|
|
Some("on-request")
|
|
);
|
|
}
|