feat: add accept-defaults to new templates

karthik2804 · karthik2804 · commit 19878813c3b6 · 2022-08-18T16:08:21.000-07:00
Signed-off-by: karthik Ganeshram &lt;karthik.ganeshram@fermyon.com&gt;
diff --git a/crates/templates/src/manager.rs b/crates/templates/src/manager.rs
@@ -387,7 +387,7 @@ impl InstallationResults {
 
 #[cfg(test)]
 mod tests {
-    use std::{fs, path::PathBuf};
+    use std::{collections::HashMap, fs, path::PathBuf};
 
     use tempfile::tempdir;
 
@@ -629,6 +629,7 @@ mod tests {
             output_path: output_dir.clone(),
             name: "my project".to_owned(),
             values,
+            accept_defaults: false,
         };
 
         template
@@ -644,4 +645,46 @@ mod tests {
             .unwrap();
         assert!(cargo.contains("name = \"my-project\""));
     }
+
+    #[tokio::test]
+    async fn can_run_template_with_accept_defaults() {
+        let temp_dir = tempdir().unwrap();
+        let store = TemplateStore::new(temp_dir.path());
+        let manager = TemplateManager { store };
+        let source = TemplateSource::File(project_root());
+
+        manager
+            .install(&source, &InstallOptions::default(), &DiscardingReporter)
+            .await
+            .unwrap();
+
+        let template = manager.get("http-rust").unwrap().unwrap();
+
+        let dest_temp_dir = tempdir().unwrap();
+        let output_dir = dest_temp_dir.path().join("myproj");
+        let values = HashMap::new();
+        let options = RunOptions {
+            output_path: output_dir.clone(),
+            name: "my project".to_owned(),
+            values,
+            accept_defaults: true,
+        };
+
+        template
+            .run(options)
+            .silent()
+            .await
+            .execute()
+            .await
+            .unwrap();
+
+        let cargo = tokio::fs::read_to_string(output_dir.join("Cargo.toml"))
+            .await
+            .unwrap();
+        assert!(cargo.contains("name = \"my-project\""));
+        let spin_toml = tokio::fs::read_to_string(output_dir.join("spin.toml"))
+            .await
+            .unwrap();
+        assert!(spin_toml.contains("route = \"/...\""));
+    }
 }
diff --git a/crates/templates/src/run.rs b/crates/templates/src/run.rs
@@ -25,6 +25,8 @@ pub struct RunOptions {
     pub output_path: PathBuf,
     /// The values to use for template parameters.
     pub values: HashMap<String, String>,
+    /// If true accept default values where available
+    pub accept_defaults: bool,
 }
 
 enum Cancellable<T, E> {
@@ -282,7 +284,10 @@ impl Run {
     fn populate_parameter_interactive(&self, parameter: &TemplateParameter) -> Option<String> {
         match self.options.values.get(parameter.id()) {
             Some(s) => Some(s.clone()),
-            None => crate::interaction::prompt_parameter(parameter),
+            None => match (self.options.accept_defaults, parameter.default_value()) {
+                (true, Some(v)) => Some(v.to_string()),
+                _ => crate::interaction::prompt_parameter(parameter),
+            },
         }
     }
 
@@ -298,7 +303,10 @@ impl Run {
     fn populate_parameter_silent(&self, parameter: &TemplateParameter) -> anyhow::Result<String> {
         match self.options.values.get(parameter.id()) {
             Some(s) => Ok(s.clone()),
-            None => Err(anyhow!("Parameter '{}' not provided", parameter.id())),
+            None => match (self.options.accept_defaults, parameter.default_value()) {
+                (true, Some(v)) => Ok(v.to_string()),
+                _ => Err(anyhow!("Parameter '{}' not provided", parameter.id())),
+            },
         }
     }
 
diff --git a/src/commands/new.rs b/src/commands/new.rs
@@ -34,6 +34,11 @@ pub struct NewCommand {
     /// file.
     #[clap(long = "values-file")]
     pub values_file: Option<PathBuf>,
+
+    /// An optional argument that allows to skip prompts for the manifest file
+    /// by accepting the defaults if available on the template
+    #[clap(long = "accept-defaults", takes_value = false)]
+    pub accept_defaults: bool,
 }
 
 impl NewCommand {
@@ -59,6 +64,7 @@ impl NewCommand {
             name: self.name.clone(),
             output_path,
             values,
+            accept_defaults: self.accept_defaults,
         };
 
         match template {
diff --git a/templates/http-c/metadata/spin-template.toml b/templates/http-c/metadata/spin-template.toml
@@ -3,6 +3,6 @@ id = "http-c"
 description = "HTTP request handler using C and the Zig toolchain"
 
 [parameters]
-project-description = { type = "string",  prompt = "Project description" }
+project-description = { type = "string",  prompt = "Project description", default = "" }
 http-base = { type = "string", prompt = "HTTP base", default = "/", pattern = "^/\\S*$" }
 http-path = { type = "string", prompt = "HTTP path", default = "/...", pattern = "^/\\S*$" }
diff --git a/templates/http-go/metadata/spin-template.toml b/templates/http-go/metadata/spin-template.toml
@@ -3,6 +3,6 @@ id = "http-go"
 description = "HTTP request handler using (Tiny)Go"
 
 [parameters]
-project-description = { type = "string",  prompt = "Project description" }
+project-description = { type = "string",  prompt = "Project description", default = "" }
 http-base = { type = "string", prompt = "HTTP base", default = "/", pattern = "^/\\S*$" }
 http-path = { type = "string", prompt = "HTTP path", default = "/...", pattern = "^/\\S*$" }
diff --git a/templates/http-grain/metadata/spin-template.toml b/templates/http-grain/metadata/spin-template.toml
@@ -3,6 +3,6 @@ id = "http-grain"
 description = "HTTP request handler using Grain"
 
 [parameters]
-project-description = { type = "string",  prompt = "Project description" }
+project-description = { type = "string",  prompt = "Project description", default = "" }
 http-base = { type = "string", prompt = "HTTP base", default = "/", pattern = "^/\\S*$" }
 http-path = { type = "string", prompt = "HTTP path", default = "/...", pattern = "^/\\S*$" }
diff --git a/templates/http-rust/metadata/spin-template.toml b/templates/http-rust/metadata/spin-template.toml
@@ -3,6 +3,6 @@ id = "http-rust"
 description = "HTTP request handler using Rust"
 
 [parameters]
-project-description = { type = "string",  prompt = "Project description" }
+project-description = { type = "string",  prompt = "Project description", default = "" }
 http-base = { type = "string", prompt = "HTTP base", default = "/", pattern = "^/\\S*$" }
 http-path = { type = "string", prompt = "HTTP path", default = "/...", pattern = "^/\\S*$" }
diff --git a/templates/http-swift/metadata/spin-template.toml b/templates/http-swift/metadata/spin-template.toml
@@ -3,6 +3,6 @@ id = "http-swift"
 description = "HTTP request handler using SwiftWasm"
 
 [parameters]
-project-description = { type = "string",  prompt = "Project description" }
+project-description = { type = "string",  prompt = "Project description", default = "" }
 http-base = { type = "string", prompt = "HTTP base", default = "/", pattern = "^/\\S*$" }
 http-path = { type = "string", prompt = "HTTP path", default = "/...", pattern = "^/\\S*$" }
diff --git a/templates/http-zig/metadata/spin-template.toml b/templates/http-zig/metadata/spin-template.toml
@@ -3,6 +3,6 @@ id = "http-zig"
 description = "HTTP request handler using Zig"
 
 [parameters]
-project-description = { type = "string",  prompt = "Project description" }
+project-description = { type = "string",  prompt = "Project description", default = "" }
 http-base = { type = "string", prompt = "HTTP base", default = "/", pattern = "^/\\S*$" }
 http-path = { type = "string", prompt = "HTTP path", default = "/...", pattern = "^/\\S*$" }
diff --git a/templates/redis-go/metadata/spin-template.toml b/templates/redis-go/metadata/spin-template.toml
@@ -3,6 +3,6 @@ id = "redis-go"
 description = "Redis message handler using (Tiny)Go"
 
 [parameters]
-project-description = { type = "string",  prompt = "Project description" }
+project-description = { type = "string",  prompt = "Project description", default = "" }
 redis-address = { type = "string", prompt = "Redis address", default = "redis://localhost:6379" }
 redis-channel = { type = "string", prompt = "Redis channel" }
diff --git a/templates/redis-rust/metadata/spin-template.toml b/templates/redis-rust/metadata/spin-template.toml
@@ -3,6 +3,6 @@ id = "redis-rust"
 description = "Redis message handler using Rust"
 
 [parameters]
-project-description = { type = "string",  prompt = "Project description" }
+project-description = { type = "string",  prompt = "Project description", default = "" }
 redis-address = { type = "string", prompt = "Redis address", default = "redis://localhost:6379" }
 redis-channel = { type = "string", prompt = "Redis channel" }

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@ pub struct RunOptions {`
`25`	`25`	`pub output_path: PathBuf,`
`26`	`26`	`/// The values to use for template parameters.`
`27`	`27`	`pub values: HashMap<String, String>,`
	`28`	`+ /// If true accept default values where available`
	`29`	`+ pub accept_defaults: bool,`
`28`	`30`	`}`
`29`	`31`
`30`	`32`	`enum Cancellable<T, E> {`
`@@ -282,7 +284,10 @@ impl Run {`
`282`	`284`	`fn populate_parameter_interactive(&self, parameter: &TemplateParameter) -> Option<String> {`
`283`	`285`	`match self.options.values.get(parameter.id()) {`
`284`	`286`	`Some(s) => Some(s.clone()),`
`285`		`- None => crate::interaction::prompt_parameter(parameter),`
	`287`	`+ None => match (self.options.accept_defaults, parameter.default_value()) {`
	`288`	`+ (true, Some(v)) => Some(v.to_string()),`
	`289`	`+ _ => crate::interaction::prompt_parameter(parameter),`
	`290`	`+ },`
`286`	`291`	`}`
`287`	`292`	`}`
`288`	`293`
`@@ -298,7 +303,10 @@ impl Run {`
`298`	`303`	`fn populate_parameter_silent(&self, parameter: &TemplateParameter) -> anyhow::Result<String> {`
`299`	`304`	`match self.options.values.get(parameter.id()) {`
`300`	`305`	`Some(s) => Ok(s.clone()),`
`301`		`- None => Err(anyhow!("Parameter '{}' not provided", parameter.id())),`
	`306`	`+ None => match (self.options.accept_defaults, parameter.default_value()) {`
	`307`	`+ (true, Some(v)) => Ok(v.to_string()),`
	`308`	`+ _ => Err(anyhow!("Parameter '{}' not provided", parameter.id())),`
	`309`	`+ },`
`302`	`310`	`}`
`303`	`311`	`}`
`304`	`312`