feat!: add CONFIG_DIR and CONFIG_NAME in host_pre_init and env expansion

This should allow easy execution of external scripts that are carried with the
config, like for example using a python script as host_pre_init
Also had to rework config --options so it does not show internal fields

Author: sandorex

src/commands/cmd_config.rs

@@ -38,18 +38,37 @@ fn get_image_config(ctx: &Context, image: &str) -> Result<String> {
 }
 
 fn show_options() -> Result<()> {
-    let docstring = Config::commented_fields()
-        .unwrap()
-        // replacing vec with array for people that dont know rust
-        .replace("Vec<", "Array<");
-
-    // print config version in same style
+    // print config version in same style as the rest of options
     println!(
-        "/// Schema version, must be one of {:?}\nversion: u32\n",
-        (1..=Config::VERSION).collect::<Vec<_>>()
+        "/// Config schema version (valid versions: {})\nversion: u32\n",
+        (1..=Config::VERSION)
+            .map(|x| x.to_string())
+            .collect::<Vec<_>>()
+            .join(", ")
     );
 
-    println!(r#"{docstring}"#);
+    let iter = Config::field_names()
+        .into_iter()
+        .zip(Config::field_types().into_iter())
+        .zip(Config::field_docs().into_iter())
+        .map(|((name, r#type), docs)| (name, r#type, docs));
+
+    // convert some types to be easier to understand for non-rust users
+    let convert_type = |x: &str| -> String { x.replace("Vec<", "Array<") };
+
+    for (name, t, docs) in iter {
+        // skip any that contains '@skip' in its docs
+        if docs.join("\n").contains("@skip") {
+            continue;
+        }
+
+        // format like rust docs
+        for i in docs {
+            println!("///{i}");
+        }
+
+        println!("{name}: {}\n", convert_type(t));
+    }
 
     Ok(())
 }

src/commands/cmd_start.rs

@@ -63,7 +63,14 @@ pub fn start_container(ctx: Context, mut cli_args: CmdStartArgs) -> Result<()> {
             }
         };
 
-        // TODO add env var that points to the directory where the config was located!
+        let config_dir = match config.path.as_ref() {
+            // NOTE it should never be a directory so it should always work right?
+            Some(x) => x.parent().unwrap(),
+            None => panic!("Config path is None after loading!"),
+        };
+
+        let config_name = config.name.expect("Config name is not set after loading!");
+
         if let Some(host_pre_init) = &config.host_pre_init {
             // avoid infinite loop using env var
             if std::env::var(crate::ENV_EXE_PATH).is_err() {
@@ -85,6 +92,8 @@ pub fn start_container(ctx: Context, mut cli_args: CmdStartArgs) -> Result<()> {
                     .args(std::env::args().skip(2))
                     // pass the path to arcam in the env var
                     .env(crate::ENV_EXE_PATH, argv0)
+                    .env(crate::ENV_CFG_DIR, config_dir)
+                    .env(crate::ENV_CFG_NAME, config_name)
                     .exec()
                     .into());
             }
@@ -104,6 +113,8 @@ pub fn start_container(ctx: Context, mut cli_args: CmdStartArgs) -> Result<()> {
                 "HOME" => Some(home.to_string()),
                 "CONTAINER" | "CONTAINER_NAME" => Some(container_name.clone()),
                 "RAND" | "RANDOM" => Some(rand::random::<u32>().to_string()),
+                "CONFIG_DIR" => Some(config_dir.to_string_lossy().to_string()),
+                "CONFIG_NAME" => Some(config_name.clone()),
 
                 // fallback to environ
                 _ => {

src/config.rs

@@ -44,8 +44,16 @@ impl ConfigFile {
         let file_contents = std::fs::read_to_string(file)
             .with_context(|| format!("while reading config file {:?}", file))?;
 
-        Self::config_from_str(&file_contents)
-            .with_context(|| format!("while parsing config file {:?}", file))
+        let mut config = Self::config_from_str(&file_contents)
+            .with_context(|| format!("while parsing config file {:?}", file))?;
+
+        // set the original path of file
+        config.path = Some(file.to_path_buf());
+
+        // set name of the config to be file name (no extension)
+        config.name = file.file_stem().map(|x| x.to_string_lossy().to_string());
+
+        Ok(config)
     }
 }
 

src/config/v1.rs

@@ -2,6 +2,7 @@
 
 use code_docs::{code_docs_struct, DocumentedStruct};
 use serde::{Deserialize, Serialize};
+use std::path::PathBuf;
 
 // save all the fields and docs so they can be printed as always up-to-date documentation
 code_docs_struct! {
@@ -10,6 +11,18 @@ code_docs_struct! {
     #[derive(Debug, Clone, Default, PartialEq, Deserialize, Serialize)]
     #[serde(deny_unknown_fields)]
     pub struct ConfigV1 {
+        /// Path to the config
+        /// @skip
+        #[serde(skip)]
+        pub path: Option<PathBuf>,
+
+        /// Name of the config
+        /// @skip
+        #[serde(skip)]
+        pub name: Option<String>,
+
+        // --- real config options --- //
+
         /// Image used for the container
         pub image: String,
 

src/vars.rs

@@ -61,6 +61,12 @@ pub const ENV_ENTER_ON_START: &str = ENV_VAR_PREFIX!("ENTER_ON_START");
 /// Stores path to arcam executable and prevents infinite loop with host_pre_init
 pub const ENV_EXE_PATH: &str = ENV_VAR_PREFIX!("EXE_PATH");
 
+/// Path to the directory where the config was loaded from
+pub const ENV_CFG_DIR: &str = ENV_VAR_PREFIX!("CFG_DIR");
+
+/// Name of the config loaded
+pub const ENV_CFG_NAME: &str = ENV_VAR_PREFIX!("CFG_NAME");
+
 /// Where scripts are executed from
 pub const INIT_D_DIR: &str = "/init.d";