quack_rs/validate/description_yml/validator.rs
1// SPDX-License-Identifier: MIT
2// Copyright 2026 Tom F. <https://github.com/tomtom215/>
3// My way of giving something small back to the open source community
4// and encouraging more Rust development!
5
6use crate::error::ExtensionError;
7
8use super::model::DescriptionYml;
9use super::parser::parse_description_yml;
10
11/// Validates a `description.yml` string and returns `Ok(())` if it passes all checks.
12///
13/// This is a convenience wrapper around [`parse_description_yml`] for callers that
14/// only need a pass/fail result.
15///
16/// # Errors
17///
18/// Returns [`ExtensionError`] on the first validation failure.
19///
20/// # Example
21///
22/// ```rust
23/// use quack_rs::validate::description_yml::validate_description_yml_str;
24///
25/// let valid_yml = "extension:
26/// name: my_ext
27/// description: My extension.
28/// version: 0.1.0
29/// language: Rust
30/// build: cargo
31/// license: MIT
32/// requires_toolchains: rust;python3
33/// maintainers:
34/// - Jane Doe
35///
36/// repo:
37/// github: janedoe/duckdb-my-ext
38/// ref: main
39/// ";
40///
41/// assert!(validate_description_yml_str(valid_yml).is_ok());
42///
43/// // Missing required field
44/// assert!(validate_description_yml_str("extension:\n name: bad!Name\n").is_err());
45/// ```
46pub fn validate_description_yml_str(content: &str) -> Result<(), ExtensionError> {
47 parse_description_yml(content)?;
48 Ok(())
49}
50
51/// Validates that a Rust extension's `description.yml` follows pure-Rust best practices.
52///
53/// This function checks:
54/// - `language` is `"Rust"`
55/// - `build` is `"cargo"`
56/// - `requires_toolchains` includes `"rust"`
57///
58/// These are the required values for a pure-Rust extension built with `quack-rs`.
59///
60/// # Errors
61///
62/// Returns [`ExtensionError`] if any Rust-specific field is missing or wrong.
63///
64/// # Example
65///
66/// ```rust
67/// use quack_rs::validate::description_yml::{parse_description_yml, validate_rust_extension};
68///
69/// let yml = "extension:
70/// name: my_ext
71/// description: My extension.
72/// version: 0.1.0
73/// language: Rust
74/// build: cargo
75/// license: MIT
76/// requires_toolchains: rust;python3
77/// maintainers:
78/// - Jane Doe
79///
80/// repo:
81/// github: janedoe/duckdb-my-ext
82/// ref: main
83/// ";
84///
85/// let desc = parse_description_yml(yml).unwrap();
86/// assert!(validate_rust_extension(&desc).is_ok());
87/// ```
88pub fn validate_rust_extension(desc: &DescriptionYml) -> Result<(), ExtensionError> {
89 if desc.language != "Rust" {
90 return Err(ExtensionError::new(format!(
91 "description.yml: extension.language must be 'Rust' for a Rust extension, got '{}'",
92 desc.language
93 )));
94 }
95
96 if desc.build != "cargo" {
97 return Err(ExtensionError::new(format!(
98 "description.yml: extension.build must be 'cargo' for a Rust extension, got '{}'",
99 desc.build
100 )));
101 }
102
103 // extension-ci-tools tests `contains(format(';{0};', extra_toolchains),
104 // ';rust;')` (`_extension_distribution.yml`), an exact token match: in
105 // "python3; rust" the token is " rust", and no Rust toolchain is installed.
106 let toolchains: Vec<&str> = desc.requires_toolchains.split(';').collect();
107 if !toolchains.contains(&"rust") {
108 let padded = toolchains.iter().any(|t| t.trim() == "rust");
109 return Err(ExtensionError::new(if padded {
110 format!(
111 "description.yml: extension.requires_toolchains is '{}': the community build \
112 matches ';'-separated tokens exactly, so a space next to 'rust' means no Rust \
113 toolchain is installed — write the list without spaces, e.g. 'rust;python3'",
114 desc.requires_toolchains
115 )
116 } else {
117 format!(
118 "description.yml: extension.requires_toolchains must include 'rust' for a Rust \
119 extension, got '{}'",
120 desc.requires_toolchains
121 )
122 }));
123 }
124
125 Ok(())
126}