feat(v0.4.0): add typed read-only variables, improve state persistence & UI conditional rendering

Author: st4s1k

README.md

@@ -24,12 +24,12 @@ Scenario configurations are defined in TOML files:
 ```toml
 # Basic structure for a scenario configuration
 [credentials]
-username = "your-username"
-password = "your-password"  # Optional, will use SSH agent if not provided
+username = "your-username" # will be added to the variables
+password = "your-password" # optional, will use SSH agent if not provided
 
 [server]
-host = "your-server.example.com"
-port = "22"
+host = "your-server.example.com" # required
+port = "22" # optional, default is 22
 
 [execute]
 # Define the execution order of tasks
@@ -39,21 +39,18 @@ steps = [
   { task = "copy_config", on-fail = ["rollback_deployment"] }  # With error recovery
 ]
 
-# Variables generated by the app
-[variables.special]
-timestamp = "%Y-%m-%dT%H%M%S%:z"
+# Variables that must be provided by the user
+[variables.required]
+app_archive = { type = "Path", label = "Application Archive" }
+deployment_env = { type = "String", label = "Environment" }
+timestamp = { type = "Timestamp", label = "Deployment Time", format = "%Y-%m-%dT%H%M%S%:z", read_only = true }
 
 # Define variables to be used in commands and file paths
 [variables.defined]
 app_name = "myapp"
 app_version = "1.0.0"
 remote_app_path = "/opt/{app_name}"
 
-# Variables that must be provided by the user
-[variables.required]
-"path:app_archive" = "Application Archive"  # Special path handling
-deployment_env = "Environment"  # Format: variable_name = "Label"
-
 # Define tasks that can be referenced in execution steps
 [tasks.deploy_app]
 type = "RemoteSudo"
@@ -81,6 +78,14 @@ command = "rm -rf {remote_app_path}/*"
 error_message = "Failed to rollback deployment"
 ```
 
+### Variable Types
+
+The application supports different variable types:
+
+- **String**: Regular text input
+- **Path**: File path with special handling (automatically extracts basename)
+- **Timestamp**: Automatically generated timestamp with specified format
+
 ### Inheritance
 
 You can split your configuration across multiple files and use inheritance:
@@ -94,6 +99,9 @@ username = "default-user"
 host = "default-host"
 port = "22"
 
+[variables.required]
+timestamp = { type = "Timestamp", label = "Deployment Time", format = "%Y-%m-%d", read_only = true }
+
 [variables.defined]
 app_name = "default-app"
 ```
@@ -105,6 +113,9 @@ parent = "base.toml"  # Will inherit and override from parent
 [credentials]
 username = "specific-user"
 
+[variables.required]
+env_name = { type = "String", label = "Environment Name" }
+
 [variables.defined]
 app_version = "1.0.0"  # Adds new variable while keeping app_name from parent
 ```

cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cli"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2021"
 
 [[bin]]

core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "core"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2021"
 
 [dependencies]

core/src/config.rs

@@ -1,6 +1,5 @@
 use crate::scenario::errors::ScenarioConfigError;
 use serde::Deserialize;
-use std::collections::BTreeMap;
 use std::{
     collections::HashMap,
     ops::{Deref, DerefMut},
@@ -215,15 +214,12 @@ pub struct VariablesConfig {
     #[serde(default)]
     pub required: RequiredVariablesConfig,
     #[serde(default)]
-    pub special: SpecialVariablesConfig,
-    #[serde(default)]
     pub defined: DefinedVariablesConfig,
 }
 
 #[derive(Deserialize, Clone, Debug)]
 pub struct PartialVariablesConfig {
     pub required: Option<RequiredVariablesConfig>,
-    pub special: Option<SpecialVariablesConfig>,
     pub defined: Option<DefinedVariablesConfig>,
 }
 
@@ -249,14 +245,6 @@ impl PartialVariablesConfig {
 
         PartialVariablesConfig {
             required: Some(merged_required),
-            special: match (&self.special, &other.special) {
-                (Some(self_special), Some(other_special)) => {
-                    Some(self_special.merge(other_special))
-                }
-                (None, Some(special)) => Some(special.clone()),
-                (Some(special), None) => Some(special.clone()),
-                (None, None) => None,
-            },
             defined: Some(merged_defined),
         }
     }
@@ -268,17 +256,27 @@ impl TryFrom<PartialVariablesConfig> for VariablesConfig {
     fn try_from(partial: PartialVariablesConfig) -> Result<Self, Self::Error> {
         Ok(VariablesConfig {
             required: partial.required.unwrap_or_default(),
-            special: partial.special.unwrap_or_default(),
             defined: partial.defined.unwrap_or_default(),
         })
     }
 }
 
+#[derive(Deserialize, Clone, Debug)]
+pub struct RequiredVariableConfig {
+    #[serde(flatten)]
+    pub var_type: VariableTypeConfig,
+    #[serde(default)]
+    pub label: Option<String>,
+    #[serde(default)]
+    pub read_only: bool,
+}
+
 #[derive(Deserialize, Clone, Debug, Default)]
-pub struct RequiredVariablesConfig(pub BTreeMap</* name */ String, /* label */ String>);
+pub struct RequiredVariablesConfig(pub HashMap<String, RequiredVariableConfig>);
 
 impl Deref for RequiredVariablesConfig {
-    type Target = BTreeMap<String, String>;
+    type Target = HashMap<String, RequiredVariableConfig>;
+
     fn deref(&self) -> &Self::Target {
         &self.0
     }
@@ -300,6 +298,16 @@ impl RequiredVariablesConfig {
     }
 }
 
+#[derive(Deserialize, Clone, Debug, PartialEq, Eq)]
+#[serde(tag = "type")]
+pub enum VariableTypeConfig {
+    String,
+    Path,
+    Timestamp {
+        format: String,
+    },
+}
+
 #[derive(Deserialize, Clone, Debug, Default)]
 pub struct SpecialVariablesConfig(HashMap<String, String>);
 

core/src/scenario/variables.rs

@@ -1,14 +1,14 @@
 pub mod required;
 
+
 use crate::{
-    config::{SpecialVariablesConfig, VariablesConfig},
+    config::VariablesConfig,
     scenario::{
         errors::PlaceholderResolutionError, utils::HasPlaceholders,
         variables::required::RequiredVariables,
     },
 };
-use chrono::Local;
-use std::{collections::HashMap, ops::Deref, path::PathBuf, str::FromStr};
+use std::{collections::HashMap, ops::Deref};
 
 #[derive(Clone, Debug)]
 pub struct Variables {
@@ -27,27 +27,10 @@ impl Default for Variables {
 
 impl From<&VariablesConfig> for Variables {
     fn from(config: &VariablesConfig) -> Self {
-        let mut variables_map = HashMap::<String, String>::new();
-        variables_map.extend(config.defined.deref().clone());
-
-        for (key, value) in &variables_map.clone() {
-            if key.starts_with("path:") {
-                PathBuf::from_str(value.as_str())
-                    .ok()
-                    .and_then(|path| path.file_name().map(|file_name| file_name.to_owned()))
-                    .and_then(|file_name| file_name.to_str().map(|s| s.to_string()))
-                    .map(|file_name| {
-                        let basename_key = key.replace("path:", "basename:");
-                        variables_map.insert(basename_key, file_name.to_string());
-                    });
-            }
-        }
-        let mut variables = Variables {
+        Variables {
             required: RequiredVariables::from(&config.required),
-            defined: variables_map,
-        };
-        variables._resolve_special_variables(&config.special);
-        variables
+            defined: config.defined.deref().clone(),
+        }
     }
 }
 
@@ -87,7 +70,7 @@ impl Variables {
         loop {
             let previous = output.clone();
 
-            for (key, value) in &variables {
+            for (key, value) in dbg!(&variables) {
                 let placeholder = format!("{{{}}}", key);
                 output = output.replace(&placeholder, value);
             }
@@ -104,13 +87,6 @@ impl Variables {
         }
     }
 
-    fn _resolve_special_variables(&mut self, config: &SpecialVariablesConfig) {
-        if let Some(timestamp_format) = &config.get("timestamp") {
-            let timestamp: String = Local::now().format(timestamp_format).to_string();
-            self.defined.insert("timestamp".to_string(), timestamp);
-        }
-    }
-
     fn _resolve_placeholders(&self) -> Result<HashMap<String, String>, PlaceholderResolutionError> {
         let mut resolved_variables = self.defined.clone();
         self.required.iter().for_each(|(name, required_variable)| {