Merge pull request #1864 from itowlson/templates-add-merge-variables

Allow `spin add` to add variables to the manifest

Author: itowlson

Cargo.lock

@@ -30,5 +30,6 @@ spin-loader = { path = "../loader" }
 tempfile = "3.3.0"
 tokio = { version = "1.23", features = ["fs", "process", "rt", "macros"] }
 toml = "0.5"
+toml_edit = "0.20.2"
 url = "2.2.2"
 walkdir = "2"

crates/templates/Cargo.toml

@@ -953,6 +953,178 @@ mod tests {
         assert!(spin_toml.contains("source = \"encore/target/wasm32-wasi/release/hello_2.wasm\""));
     }
 
+    #[tokio::test]
+    async fn can_add_variables_from_template() {
+        let temp_dir = tempdir().unwrap();
+        let store = TemplateStore::new(temp_dir.path());
+        let manager = TemplateManager { store };
+        let source1 = TemplateSource::File(test_data_root());
+        let source2 = TemplateSource::File(project_root()); // We will need some of the standard templates too
+
+        manager
+            .install(&source1, &InstallOptions::default(), &DiscardingReporter)
+            .await
+            .unwrap();
+        manager
+            .install(&source2, &InstallOptions::default(), &DiscardingReporter)
+            .await
+            .unwrap();
+
+        let dest_temp_dir = tempdir().unwrap();
+        let application_dir = dest_temp_dir.path().join("spinvars");
+
+        // Set up the containing app
+        {
+            let template = manager.get("http-rust").unwrap().unwrap();
+
+            let values = [
+                ("project-description".to_owned(), "my desc".to_owned()),
+                ("http-base".to_owned(), "/".to_owned()),
+                ("http-path".to_owned(), "/...".to_owned()),
+            ]
+            .into_iter()
+            .collect();
+            let options = RunOptions {
+                variant: crate::template::TemplateVariantInfo::NewApplication,
+                output_path: application_dir.clone(),
+                name: "my various project".to_owned(),
+                values,
+                accept_defaults: false,
+            };
+
+            template.run(options).silent().await.unwrap();
+        }
+
+        let spin_toml_path = application_dir.join("spin.toml");
+        assert!(spin_toml_path.exists(), "expected spin.toml to be created");
+
+        // Now add the variables
+        {
+            let template = manager.get("add-variables").unwrap().unwrap();
+
+            let output_dir = "hello";
+            let values = [(
+                "service-url".to_owned(),
+                "https://service.example.com".to_owned(),
+            )]
+            .into_iter()
+            .collect();
+            let options = RunOptions {
+                variant: crate::template::TemplateVariantInfo::AddComponent {
+                    manifest_path: spin_toml_path.clone(),
+                },
+                output_path: PathBuf::from(output_dir),
+                name: "insertvars".to_owned(),
+                values,
+                accept_defaults: false,
+            };
+
+            template.run(options).silent().await.unwrap();
+        }
+
+        let spin_toml = tokio::fs::read_to_string(&spin_toml_path).await.unwrap();
+        assert!(spin_toml.contains("[variables]\nsecret"));
+        assert!(spin_toml.contains("url = { default = \"https://service.example.com\" }"));
+    }
+
+    #[tokio::test]
+    async fn can_overwrite_existing_variables() {
+        let temp_dir = tempdir().unwrap();
+        let store = TemplateStore::new(temp_dir.path());
+        let manager = TemplateManager { store };
+        let source1 = TemplateSource::File(test_data_root());
+        let source2 = TemplateSource::File(project_root()); // We will need some of the standard templates too
+
+        manager
+            .install(&source1, &InstallOptions::default(), &DiscardingReporter)
+            .await
+            .unwrap();
+        manager
+            .install(&source2, &InstallOptions::default(), &DiscardingReporter)
+            .await
+            .unwrap();
+
+        let dest_temp_dir = tempdir().unwrap();
+        let application_dir = dest_temp_dir.path().join("spinvars");
+
+        // Set up the containing app
+        {
+            let template = manager.get("http-rust").unwrap().unwrap();
+
+            let values = [
+                ("project-description".to_owned(), "my desc".to_owned()),
+                ("http-base".to_owned(), "/".to_owned()),
+                ("http-path".to_owned(), "/...".to_owned()),
+            ]
+            .into_iter()
+            .collect();
+            let options = RunOptions {
+                variant: crate::template::TemplateVariantInfo::NewApplication,
+                output_path: application_dir.clone(),
+                name: "my various project".to_owned(),
+                values,
+                accept_defaults: false,
+            };
+
+            template.run(options).silent().await.unwrap();
+        }
+
+        let spin_toml_path = application_dir.join("spin.toml");
+        assert!(spin_toml_path.exists(), "expected spin.toml to be created");
+
+        // Now add the variables
+        {
+            let template = manager.get("add-variables").unwrap().unwrap();
+
+            let output_dir = "hello";
+            let values = [(
+                "service-url".to_owned(),
+                "https://service.example.com".to_owned(),
+            )]
+            .into_iter()
+            .collect();
+            let options = RunOptions {
+                variant: crate::template::TemplateVariantInfo::AddComponent {
+                    manifest_path: spin_toml_path.clone(),
+                },
+                output_path: PathBuf::from(output_dir),
+                name: "insertvars".to_owned(),
+                values,
+                accept_defaults: false,
+            };
+
+            template.run(options).silent().await.unwrap();
+        }
+
+        // Now add them again but with different values
+        {
+            let template = manager.get("add-variables").unwrap().unwrap();
+
+            let output_dir = "hello";
+            let values = [(
+                "service-url".to_owned(),
+                "https://other.example.com".to_owned(),
+            )]
+            .into_iter()
+            .collect();
+            let options = RunOptions {
+                variant: crate::template::TemplateVariantInfo::AddComponent {
+                    manifest_path: spin_toml_path.clone(),
+                },
+                output_path: PathBuf::from(output_dir),
+                name: "insertvars".to_owned(),
+                values,
+                accept_defaults: false,
+            };
+
+            template.run(options).silent().await.unwrap();
+        }
+
+        let spin_toml = tokio::fs::read_to_string(&spin_toml_path).await.unwrap();
+        assert!(spin_toml.contains("url = { default = \"https://other.example.com\" }"));
+        assert!(!spin_toml.contains("service.example.com"));
+    }
+
     #[tokio::test]
     async fn cannot_add_component_that_does_not_match_trigger() {
         let temp_dir = tempdir().unwrap();

crates/templates/src/manager.rs

@@ -18,9 +18,14 @@ pub(crate) enum TemplateContent {
 
 pub(crate) enum RenderOperation {
     AppendToml(PathBuf, TemplateContent),
+    MergeToml(PathBuf, MergeTarget, TemplateContent), // file to merge into, table to merge into, content to merge
     WriteFile(PathBuf, TemplateContent),
 }
 
+pub(crate) enum MergeTarget {
+    Application(&'static str),
+}
+
 impl TemplateRenderer {
     pub(crate) fn render(self) -> anyhow::Result<TemplateOutputs> {
         let globals = self.renderer_globals();
@@ -64,6 +69,12 @@ impl RenderOperation {
                 let rendered_text = String::from_utf8(rendered)?;
                 Ok(TemplateOutput::AppendToml(path, rendered_text))
             }
+            Self::MergeToml(path, target, content) => {
+                let rendered = content.render(globals)?;
+                let rendered_text = String::from_utf8(rendered)?;
+                let MergeTarget::Application(target_table) = target;
+                Ok(TemplateOutput::MergeToml(path, target_table, rendered_text))
+            }
         }
     }
 }

crates/templates/src/renderer.rs

@@ -11,6 +11,7 @@ use walkdir::WalkDir;
 use crate::{
     cancellable::Cancellable,
     interaction::{InteractionStrategy, Interactive, Silent},
+    renderer::MergeTarget,
     template::TemplateVariantInfo,
 };
 use crate::{
@@ -248,9 +249,20 @@ impl Run {
                         Err(anyhow::anyhow!("Spin doesn't know what to do with a 'component' snippet outside an 'add component' operation")),
                 }
             },
+            "variables" => {
+                match &self.options.variant {
+                    TemplateVariantInfo::AddComponent { manifest_path } =>
+                        Ok(RenderOperation::MergeToml(
+                            manifest_path.clone(),
+                            MergeTarget::Application("variables"),
+                            content,
+                        )),
+                    TemplateVariantInfo::NewApplication =>
+                        Err(anyhow::anyhow!("Spin doesn't know what to do with a 'variables' snippet outside an 'add component' operation")),
+                }
+            },
             _ => Err(anyhow::anyhow!(
-                "Spin doesn't know what to do with snippet {}",
-                id
+                "Spin doesn't know what to do with snippet {id}",
             )),
         }
     }