[pve-devel] [PATCH for-PVE-9.0/installer 5/5] assistant: add deprecation notice for snakecased parameters

[Daniel Kral]

Print a deprecation notice if the auto-installer-assistant detects any
snakecased parameters while parsing the answer file, which is deprecated
and users should change them to kebab-cased parameters. This includes
all parameters except the filter match rules (e.g. "ID_MODEL") as those
correspond to the output of udevadm.

The detection is best effort since the TOML format allows many ways to
parse keys (e.g. '=' are allowed in quoted keys, whitespaces is allowed
around the seperating dot '.'), but should cover the relevant cases used
by our users.

Signed-off-by: Daniel Kral <d.kral at proxmox.com>
---
 proxmox-auto-install-assistant/src/main.rs | 24 ++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/proxmox-auto-install-assistant/src/main.rs b/proxmox-auto-install-assistant/src/main.rs
index 969922c..c6e4249 100644
--- a/proxmox-auto-install-assistant/src/main.rs
+++ b/proxmox-auto-install-assistant/src/main.rs
@@ -584,6 +584,20 @@ fn get_udev_properties(path: impl AsRef<Path> + fmt::Debug) -> Result<String> {
     Ok(String::from_utf8(udev_output.stdout)?)
 }
 
+fn get_deprecated_properties(s: &str) -> Vec<&str> {
+    s.lines()
+        .map(|line| line.trim())
+        .filter(|line| line.contains('='))
+        // Ignore commented out config lines
+        .filter(|line| !line.starts_with('#'))
+        .filter_map(|line| line.split_once('='))
+        .filter(|(key, _)| key.contains('_'))
+        // Ignore keys for udev filter rules
+        .filter(|(key, _)| !key.starts_with("filter."))
+        .map(|(key, _)| key.trim())
+        .collect()
+}
+
 fn parse_answer(path: impl AsRef<Path> + fmt::Debug) -> Result<Answer> {
     let mut file = match fs::File::open(&path) {
         Ok(file) => file,
@@ -594,6 +608,16 @@ fn parse_answer(path: impl AsRef<Path> + fmt::Debug) -> Result<Answer> {
         bail!("Reading from file {path:?} failed: {err}");
     }
 
+    let deprecated_props = get_deprecated_properties(&contents);
+    if !deprecated_props.is_empty() {
+        let prop_list = deprecated_props.join(", ");
+        println!("The answer file contains the following snake_cased parameters: {prop_list}.");
+        println!(
+            "Snakecased parameters are deprecated in favor of kebab-cased parameters and \
+            support will be removed in the next major release.\n"
+        );
+    }
+
     match toml::from_str(&contents) {
         Ok(answer) => {
             verify_locale_settings(&answer, &serde_json::from_str(LOCALE_INFO)?)?;
-- 
2.39.5