mod preconditions;
use super::extras::Language;
use super::output::validate_output_segment;
use super::resolved::ResolvedCrateConfig;
use crate::core::error::AlefError;
use preconditions::{
build_main_fields, clean_main_fields, lint_main_fields, setup_main_fields, test_main_fields, update_main_fields,
validate_build_dependency_preconditions, validate_section, validate_test_e2e_precondition, validate_tools,
};
pub fn validate_resolved(config: &ResolvedCrateConfig) -> Result<(), AlefError> {
validate_tools(&config.tools)?;
validate_package_metadata(config)?;
validate_e2e_env_keys(config)?;
validate_extra_lint_paths(config)?;
validate_section("lint", &config.lint, lint_main_fields, |c| c.precondition.as_deref())?;
validate_section("test", &config.test, test_main_fields, |c| c.precondition.as_deref())?;
validate_test_e2e_precondition(&config.test)?;
validate_section("build_commands", &config.build_commands, build_main_fields, |c| {
c.precondition.as_deref()
})?;
validate_build_dependency_preconditions(&config.build_commands)?;
validate_section("setup", &config.setup, setup_main_fields, |c| c.precondition.as_deref())?;
validate_section("update", &config.update, update_main_fields, |c| {
c.precondition.as_deref()
})?;
validate_section("clean", &config.clean, clean_main_fields, |c| c.precondition.as_deref())?;
validate_trait_bridges(config)?;
validate_dart_library_name(config)?;
Ok(())
}
fn validate_dart_library_name(config: &ResolvedCrateConfig) -> Result<(), AlefError> {
if !config.targets(Language::Dart) {
return Ok(());
}
validate_output_segment(&config.dart_library_name(), "dart.lib_name (derived from crate name)")
.map_err(|detail| AlefError::Config(format!("crate `{}`: {detail}", config.name)))
}
fn validate_trait_bridges(config: &ResolvedCrateConfig) -> Result<(), AlefError> {
for bridge in &config.trait_bridges {
if bridge.register_fn.is_some() && bridge.registry_getter.is_none() {
return Err(AlefError::Config(format!(
"trait bridge `{}` sets `register_fn` but no `registry_getter`. Add `registry_getter` \
to `[[crates.trait_bridges]]` for `{}`, or drop `register_fn`.",
bridge.trait_name, bridge.trait_name
)));
}
}
Ok(())
}
pub(crate) fn is_valid_env_var_name(name: &str) -> bool {
let mut chars = name.chars();
match chars.next() {
Some(c) if c.is_ascii_alphabetic() || c == '_' => {}
_ => return false,
}
chars.all(|c| c.is_ascii_alphanumeric() || c == '_')
}
fn validate_e2e_env_keys(config: &ResolvedCrateConfig) -> Result<(), AlefError> {
let Some(e2e) = &config.e2e else {
return Ok(());
};
let mut invalid: Vec<&str> = e2e
.env
.keys()
.map(String::as_str)
.filter(|key| !is_valid_env_var_name(key))
.collect();
if invalid.is_empty() {
return Ok(());
}
invalid.sort_unstable();
Err(AlefError::Config(format!(
"invalid `[crates.e2e.env]` key(s) for crate `{}`: {}. Environment variable names must \
match `[A-Za-z_][A-Za-z0-9_]*` -- they are forwarded into shell commands and into \
several generated languages' own source, and a name outside this pattern cannot be \
expressed safely in all of them.",
config.name,
invalid.join(", ")
)))
}
fn is_well_formed_path_char(c: char) -> bool {
c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.' | '/')
}
fn validate_extra_lint_paths(config: &ResolvedCrateConfig) -> Result<(), AlefError> {
let mut invalid: Vec<String> = Vec::new();
for lang in Language::ALL {
for path in config.extra_lint_paths_for_language(lang) {
if path.is_empty() || !path.chars().all(is_well_formed_path_char) {
invalid.push(format!("{lang}: {path:?}"));
}
}
}
if invalid.is_empty() {
return Ok(());
}
Err(AlefError::Config(format!(
"invalid `extra_lint_paths` entries for crate `{}`: {}. Entries are appended verbatim \
into a lint/format shell command with no quoting, so they must match \
`[A-Za-z0-9._/-]+` -- no whitespace or shell metacharacters.",
config.name,
invalid.join(", ")
)))
}
fn validate_package_metadata(config: &ResolvedCrateConfig) -> Result<(), AlefError> {
const CRATES_IO_LIST_LIMIT: usize = 5;
let Some(meta) = &config.package_metadata else {
return Ok(());
};
if !meta.truncate_registry_lists {
if meta.keywords.len() > CRATES_IO_LIST_LIMIT {
return Err(AlefError::Config(format!(
"crate `{}` package_metadata.keywords has {} entries; crates.io supports at most {CRATES_IO_LIST_LIMIT}. \
Reduce the list or set package_metadata.truncate_registry_lists = true.",
config.name,
meta.keywords.len()
)));
}
if meta.categories.len() > CRATES_IO_LIST_LIMIT {
return Err(AlefError::Config(format!(
"crate `{}` package_metadata.categories has {} entries; crates.io supports at most {CRATES_IO_LIST_LIMIT}. \
Reduce the list or set package_metadata.truncate_registry_lists = true.",
config.name,
meta.categories.len()
)));
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use crate::core::config::new_config::NewAlefConfig;
use tracing_test::traced_test;
fn resolve_first(toml_str: &str) -> ResolvedCrateConfig {
let cfg: NewAlefConfig = toml::from_str(toml_str).expect("config should parse");
cfg.resolve().expect("config should resolve").remove(0)
}
fn base_config() -> &'static str {
r#"
[workspace]
languages = ["python"]
[[crates]]
name = "test-lib"
sources = ["src/lib.rs"]
"#
}
#[test]
fn no_user_overrides_is_valid() {
let config = resolve_first(base_config());
validate_resolved(&config).expect("default config should validate");
}
#[test]
fn e2e_env_key_with_shell_syntax_is_rejected() {
let toml = format!(
"{base}\n[crates.e2e]\nfixtures = \"fixtures\"\noutput = \"e2e\"\n\
[crates.e2e.call]\nfunction = \"process\"\nmodule = \"test-lib\"\n\
[crates.e2e.env]\n\"MYVAR; touch pwned\" = \"safe\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let err = validate_resolved(&config).expect_err("shell-shaped env key must be rejected");
let msg = format!("{err}");
assert!(
msg.contains("MYVAR; touch pwned"),
"error should name the bad key: {msg}"
);
assert!(
msg.contains("[A-Za-z_][A-Za-z0-9_]*"),
"error should name the required pattern: {msg}"
);
}
#[test]
fn e2e_env_key_valid_identifier_is_accepted() {
let toml = format!(
"{base}\n[crates.e2e]\nfixtures = \"fixtures\"\noutput = \"e2e\"\n\
[crates.e2e.call]\nfunction = \"process\"\nmodule = \"test-lib\"\n\
[crates.e2e.env]\nALLOW_PRIVATE_NETWORK = \"true\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect("identifier-shaped env key should validate");
}
#[test]
fn extra_lint_paths_entry_with_shell_syntax_is_rejected() {
let toml = format!(
"{base}\n[crates.python]\nextra_lint_paths = [\"scripts; touch pwned\"]\n",
base = base_config()
);
let config = resolve_first(&toml);
let err = validate_resolved(&config).expect_err("shell-shaped extra_lint_paths entry must be rejected");
let msg = format!("{err}");
assert!(
msg.contains("scripts; touch pwned"),
"error should name the bad entry: {msg}"
);
assert!(
msg.contains("[A-Za-z0-9._/-]+"),
"error should name the required pattern: {msg}"
);
}
#[test]
fn extra_lint_paths_entry_valid_path_is_accepted() {
let toml = format!(
"{base}\n[crates.python]\nextra_lint_paths = [\"scripts/helpers.py\"]\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect("path-shaped extra_lint_paths entry should validate");
}
#[test]
fn is_valid_env_var_name_accepts_identifiers_and_rejects_shell_syntax() {
for ok in ["MOCK_SERVER_URL", "_leading_underscore", "A1", "a"] {
assert!(is_valid_env_var_name(ok), "expected {ok:?} to be valid");
}
for bad in [
"",
"1LEADING_DIGIT",
"HAS-HYPHEN",
"HAS SPACE",
"HAS;SEMI",
"HAS'QUOTE",
"$(cmd)",
] {
assert!(!is_valid_env_var_name(bad), "expected {bad:?} to be rejected");
}
}
#[test]
fn is_well_formed_path_char_accepts_paths_and_rejects_shell_syntax() {
for ok in ["scripts/helpers.py", "a_b-c.d", "vendor/third_party"] {
assert!(
ok.chars().all(is_well_formed_path_char),
"expected {ok:?} to be all well-formed path chars"
);
}
for bad in [
"scripts; touch pwned",
"scripts`touch pwned`",
"scripts$(touch pwned)",
"has space",
"has'quote",
] {
assert!(
!bad.chars().all(is_well_formed_path_char),
"expected {bad:?} to contain a rejected char"
);
}
}
#[test]
fn lint_override_with_main_cmd_no_precondition_errors() {
let toml = format!(
"{base}\n[crates.lint.python]\nformat = \"black .\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let err = validate_resolved(&config).expect_err("missing precondition should error");
let msg = format!("{err}");
assert!(msg.contains("[lint.python]"), "error should name the section: {msg}");
assert!(msg.contains("precondition"), "error should mention precondition: {msg}");
}
#[test]
fn lint_override_with_main_cmd_and_precondition_is_ok() {
let toml = format!(
"{base}\n[crates.lint.python]\nprecondition = \"command -v black\"\nformat = \"black .\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect("config with precondition should validate");
}
#[test]
fn lint_override_with_only_before_no_precondition_is_ok() {
let toml = format!(
"{base}\n[crates.lint.python]\nbefore = \"echo hi\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect("table with only `before` should validate");
}
#[test]
fn test_override_with_main_cmd_no_precondition_errors() {
let toml = format!(
"{base}\n[crates.test.python]\ncommand = \"pytest\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let err = validate_resolved(&config).expect_err("missing precondition should error");
assert!(format!("{err}").contains("[test.python]"));
}
#[test]
fn test_override_with_only_e2e_requires_precondition() {
let toml = format!(
"{base}\n[crates.test.python]\ne2e = \"pytest tests/e2e\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let err = validate_resolved(&config).expect_err("e2e without precondition or e2e_precondition should error");
let msg = format!("{err}");
assert!(msg.contains("[test.python]"), "{msg}");
assert!(msg.contains("e2e_precondition"), "{msg}");
}
#[test]
fn test_override_with_only_e2e_and_e2e_precondition_is_ok() {
let toml = format!(
"{base}\n[crates.test.python]\ne2e_precondition = \"command -v uv\"\ne2e = \"pytest tests/e2e\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect("e2e with e2e_precondition alone should validate");
}
#[test]
fn test_override_with_e2e_and_command_needs_only_top_level_precondition() {
let toml = format!(
"{base}\n[crates.test.python]\nprecondition = \"command -v pytest\"\ncommand = \"pytest\"\ne2e = \
\"pytest tests/e2e\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config)
.expect("a top-level precondition still satisfies both command and e2e when no e2e_precondition is set");
}
#[test]
fn build_override_with_main_cmd_no_precondition_errors() {
let toml = format!(
"{base}\n[crates.build_commands.python]\nbuild = \"maturin develop\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let err = validate_resolved(&config).expect_err("missing precondition should error");
assert!(format!("{err}").contains("[build_commands.python]"));
}
#[test]
fn build_dependency_precondition_without_remediation_errors() {
let toml = format!(
"{base}\n[crates.build_commands.python]\nprecondition = \"command -v maturin\"\n\
build = \"maturin develop\"\ndependency_precondition = \"[ -d .venv ]\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let err = validate_resolved(&config).expect_err("dependency check without remediation should error");
let msg = format!("{err}");
assert!(msg.contains("[build_commands.python]"), "{msg}");
assert!(msg.contains("dependency_remediation"), "{msg}");
}
#[test]
fn build_dependency_precondition_with_remediation_is_ok() {
let toml = format!(
"{base}\n[crates.build_commands.python]\nprecondition = \"command -v maturin\"\n\
build = \"maturin develop\"\ndependency_precondition = \"[ -d .venv ]\"\n\
dependency_remediation = \"uv venv\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect("declared pair should validate");
}
#[test]
fn user_build_override_drops_the_builtin_dependency_precondition() {
let toml = format!(
"{base}\n[crates.build_commands.python]\nprecondition = \"command -v maturin\"\n\
build = \"maturin build --out dist\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let effective = config.build_command_config_for_language(crate::core::config::Language::Python);
assert_eq!(effective.dependency_precondition, None);
assert_eq!(effective.dependency_remediation, None);
}
#[test]
fn a_before_only_override_keeps_the_builtin_dependency_precondition() {
let toml = format!(
"{base}\n[crates.build_commands.python]\nbefore = \"echo hi\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let effective = config.build_command_config_for_language(crate::core::config::Language::Python);
assert!(effective.dependency_precondition.is_some());
assert!(effective.dependency_remediation.is_some());
}
#[test]
fn setup_override_with_install_no_precondition_errors() {
let toml = format!(
"{base}\n[crates.setup.python]\ninstall = \"uv sync --no-install-project --no-install-workspace\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect_err("setup install without precondition should error");
}
#[test]
fn update_override_with_main_cmd_no_precondition_errors() {
let toml = format!(
"{base}\n[crates.update.python]\nupdate = \"uv sync --upgrade\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect_err("update without precondition should error");
}
#[test]
fn clean_override_with_main_cmd_no_precondition_errors() {
let toml = format!(
"{base}\n[crates.clean.python]\nclean = \"rm -rf dist\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect_err("clean without precondition should error");
}
#[test]
fn error_message_lists_only_actually_set_main_fields() {
let toml = format!(
"{base}\n[crates.lint.python]\nformat = \"black .\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let msg = format!("{}", validate_resolved(&config).unwrap_err());
assert!(msg.contains("`format`"), "expected `format`, got: {msg}");
assert!(!msg.contains("`check`"), "should not mention unset `check`: {msg}");
assert!(
!msg.contains("`typecheck`"),
"should not mention unset `typecheck`: {msg}"
);
}
#[test]
fn before_plus_main_cmd_without_precondition_still_errors() {
let toml = format!(
"{base}\n[crates.lint.python]\nbefore = \"echo hi\"\nformat = \"black .\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect_err("before + main without precondition must error");
}
#[test]
fn malformed_python_package_manager_value_is_rejected() {
let toml = format!(
"{base}\n[workspace.tools]\npython_package_manager = \"uv; rm -rf /\"\n",
base = base_config()
);
let config = resolve_first(&toml);
let err = validate_resolved(&config).expect_err("non-identifier tool name must be rejected");
assert!(format!("{err}").contains("well-formed"));
}
#[test]
fn malformed_node_package_manager_value_is_rejected() {
let toml = format!(
"{base}\n[workspace.tools]\nnode_package_manager = \"pnpm$(echo bad)\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect_err("non-identifier tool name must be rejected");
}
#[test]
fn malformed_rust_dev_tool_entry_is_rejected() {
let toml = format!(
"{base}\n[workspace.tools]\nrust_dev_tools = [\"cargo-edit\", \"cargo`evil`\"]\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect_err("non-identifier tool name must be rejected");
}
#[test]
fn whitespace_in_tool_name_is_rejected() {
let toml = format!(
"{base}\n[workspace.tools]\npython_package_manager = \"uv \"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect_err("trailing whitespace must be rejected");
}
#[test]
fn empty_tool_name_is_rejected() {
let toml = format!(
"{base}\n[workspace.tools]\npython_package_manager = \"\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect_err("empty tool name must be rejected");
}
#[test]
fn safe_tool_names_are_accepted() {
let toml = format!(
"{base}\n[workspace.tools]\npython_package_manager = \"uv\"\n\
node_package_manager = \"pnpm\"\n\
rust_dev_tools = [\"cargo-edit\", \"cargo_sort\", \"tool.v2\"]\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect("normal tool names should validate");
}
#[test]
fn package_metadata_keywords_over_crates_io_limit_errors() {
let toml = format!(
"{base}\n[crates.package_metadata]\nkeywords = [\"a\", \"b\", \"c\", \"d\", \"e\", \"f\"]\n",
base = base_config()
);
let config = resolve_first(&toml);
let err = validate_resolved(&config).expect_err("too many crates.io keywords should error");
let msg = format!("{err}");
assert!(msg.contains("package_metadata.keywords"), "got: {msg}");
assert!(msg.contains("at most 5"), "got: {msg}");
}
#[test]
fn package_metadata_can_opt_into_registry_list_truncation() {
let toml = format!(
"{base}\n[crates.package_metadata]\n\
truncate_registry_lists = true\n\
keywords = [\"a\", \"b\", \"c\", \"d\", \"e\", \"f\"]\n\
categories = [\"a\", \"b\", \"c\", \"d\", \"e\", \"f\"]\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect("explicit truncation opt-in should validate");
}
#[test]
fn override_with_main_cmd_and_precondition_validates_for_each_section() {
for (section, field, lang) in [
("lint", "format", "python"),
("test", "command", "python"),
("build_commands", "build", "python"),
("setup", "install", "python"),
("update", "update", "python"),
("clean", "clean", "python"),
] {
let toml = format!(
"{base}\n[crates.{section}.{lang}]\nprecondition = \"command -v tool\"\n{field} = \"tool run\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).unwrap_or_else(|e| panic!("[{section}] with precondition should validate: {e}"));
}
}
#[traced_test]
#[test]
fn lint_verbatim_default_emits_warning() {
use crate::core::config::extras::Language;
use crate::core::config::lint_defaults;
use crate::core::config::tools::LangContext;
let config = resolve_first(base_config());
let ctx = LangContext::default(&config.tools);
let default = lint_defaults::default_lint_config(Language::Python, "packages/python", &ctx);
let Some(fmt_cmd) = default.format.as_ref().map(|c| c.commands().join(" ")) else {
return;
};
let toml = format!(
"{base}\n[crates.lint.python]\nformat = {fmt_cmd:?}\n",
base = base_config()
);
let _resolved = resolve_first(&toml);
}
#[traced_test]
#[test]
fn lint_all_custom_emits_no_warning() {
let toml = format!(
"{base}\n[crates.lint.python]\nprecondition = \"command -v custom\"\nformat = \"custom-fmt\"\n",
base = base_config()
);
let config = resolve_first(&toml);
validate_resolved(&config).expect("custom lint with precondition must validate");
assert!(!logs_contain("matches the built-in default"));
}
#[traced_test]
#[test]
fn node_custom_value_no_warning() {
let toml_str = r#"
[workspace]
languages = ["node"]
[[crates]]
name = "test-lib"
sources = ["src/lib.rs"]
[crates.lint.node]
precondition = "command -v custom-linter"
check = "custom-linter src/"
"#;
let config = resolve_first(toml_str);
validate_resolved(&config).expect("custom node lint must validate");
assert!(!logs_contain("matches the built-in default"));
}
#[test]
fn crate_name_with_a_path_separator_is_rejected_before_the_dart_check_can_run() {
let toml_str = r#"
[workspace]
languages = ["dart"]
[[crates]]
name = "sample/evil"
sources = ["src/lib.rs"]
[crates.output]
dart = "packages/dart/lib/src"
"#;
let cfg: NewAlefConfig = toml::from_str(toml_str).expect("config should parse");
let err = cfg
.resolve()
.expect_err("a `/` in the crate name must be rejected at resolve time");
let message = err.to_string();
assert!(
message.contains("sample/evil"),
"error should name the crate: {message}"
);
assert!(
message.contains("invalid name"),
"error should point at the crate `name` field, not a Dart-specific one: {message}"
);
assert!(
message.contains("path separators are not allowed"),
"error should explain why: {message}"
);
}
#[test]
fn dart_library_name_accepts_an_ordinary_crate_name_when_unconfigured() {
let toml_str = r#"
[workspace]
languages = ["dart"]
[[crates]]
name = "sample-core"
sources = ["src/lib.rs"]
"#;
let config = resolve_first(toml_str);
validate_resolved(&config).expect("an ordinary crate name must still validate");
}
#[test]
fn dart_library_name_is_not_checked_for_a_crate_that_does_not_target_dart() {
let toml_str = r#"
[workspace]
languages = ["python"]
[[crates]]
name = "sample-core"
sources = ["src/lib.rs"]
[crates.dart]
pubspec_name = "sample/evil"
[crates.output]
python = "packages/python"
"#;
let config = resolve_first(toml_str);
assert_eq!(
config.dart_library_name(),
"sample/evil",
"fixture must carry the hazard through unvalidated"
);
validate_resolved(&config).expect("a crate not targeting dart must not be checked");
}
}