refactor: Factor out code for calling arbitrary bundled binaries

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ## DFX
 
+### refactor: Factor out code for calling arbitrary bundled binaries
+
+The function for calling sns can now call any bundled binary.
+
 ### fix: Only kill main process on `dfx stop`
 Removes misleading panics when running `dfx stop`.
 

src/dfx/src/lib/sns/sns_cli.rs → src/dfx/src/lib/call_bundled.rs

@@ -1,4 +1,4 @@
-//! Library for calling the `sns` command line tool.
+//! Library for calling bundled command line tools.
 use anyhow::{anyhow, Context};
 use fn_error_context::context;
 use std::ffi::OsStr;
@@ -8,23 +8,27 @@ use std::process::{self, Command};
 use crate::lib::error::DfxResult;
 use crate::Environment;
 
-/// Calls the sns command line tool from the SNS codebase in the ic repo.
+/// Calls a bundled command line tool.
+///
+/// # Returns
+/// - On success, returns stdout as a string.
+/// - On error, returns an error message including stdout and stderr.
 #[context("Failed to call sns CLI.")]
-pub fn call_sns_cli<S, I>(env: &dyn Environment, args: I) -> DfxResult<String>
+pub fn call_bundled<S, I>(env: &dyn Environment, command: &str, args: I) -> DfxResult<String>
 where
     I: IntoIterator<Item = S>,
     S: AsRef<OsStr>,
 {
-    let cli_name = "sns";
-    let sns_cli = env
+    let binary = env
         .get_cache()
-        .get_binary_command_path(cli_name)
-        .with_context(|| format!("Could not find bundled binary '{cli_name}'."))?;
-    let mut command = Command::new(&sns_cli);
+        .get_binary_command_path(command)
+        .with_context(|| format!("Could not find bundled binary '{command}'."))?;
+    let mut command = Command::new(&binary);
     command.args(args);
     // The sns command line tool itself calls dfx; it should call this dfx.
     // The sns command line tool should not rely on commands not packaged with dfx.
-    command.env("PATH", sns_cli.parent().unwrap_or_else(|| Path::new(".")));
+    // The same applies to other bundled binaries.
+    command.env("PATH", binary.parent().unwrap_or_else(|| Path::new(".")));
     command
         .stdin(process::Stdio::null())
         .output()
@@ -39,7 +43,7 @@ where
                     .map(OsStr::to_string_lossy)
                     .collect();
                 Err(anyhow!(
-                    "SNS cli call failed:\n{:?} {}\nStdout:\n{}\n\nStderr:\n{}",
+                    "Call failed:\n{:?} {}\nStdout:\n{}\n\nStderr:\n{}",
                     command.get_program(),
                     args.join(" "),
                     String::from_utf8_lossy(&output.stdout),

src/dfx/src/lib/mod.rs

@@ -1,5 +1,6 @@
 pub mod bitcoin;
 pub mod builders;
+pub mod call_bundled;
 pub mod canister_http;
 pub mod canister_info;
 pub mod config;

src/dfx/src/lib/sns/create_config.rs

@@ -3,8 +3,8 @@ use fn_error_context::context;
 use std::ffi::OsString;
 use std::path::Path;
 
+use crate::lib::call_bundled::call_bundled;
 use crate::lib::error::DfxResult;
-use crate::lib::sns::sns_cli::call_sns_cli;
 use crate::Environment;
 
 /// Ceates an SNS configuration template.
@@ -16,6 +16,6 @@ pub fn create_config(env: &dyn Environment, path: &Path) -> DfxResult {
         OsString::from(path),
         OsString::from("new"),
     ];
-    call_sns_cli(env, &args)?;
+    call_bundled(env, "sns", &args)?;
     Ok(())
 }

src/dfx/src/lib/sns/deploy.rs

@@ -3,8 +3,8 @@ use fn_error_context::context;
 use std::ffi::OsString;
 use std::path::Path;
 
+use crate::lib::call_bundled::call_bundled;
 use crate::lib::error::DfxResult;
-use crate::lib::sns::sns_cli::call_sns_cli;
 use crate::Environment;
 
 /// Creates an SNS.  This requires funds but no proposal.
@@ -15,5 +15,6 @@ pub fn deploy_sns(env: &dyn Environment, path: &Path) -> DfxResult<String> {
         OsString::from("--init-config-file"),
         OsString::from(path),
     ];
-    call_sns_cli(env, &args).map(|stdout| format!("Deployed SNS: {}\n{}", path.display(), stdout))
+    call_bundled(env, "sns", &args)
+        .map(|stdout| format!("Deployed SNS: {}\n{}", path.display(), stdout))
 }

src/dfx/src/lib/sns/mod.rs

@@ -2,7 +2,6 @@
 #![warn(clippy::missing_docs_in_private_items)]
 pub mod create_config;
 pub mod deploy;
-pub mod sns_cli;
 pub mod validate_config;
 
 /// The default location of an SNS configuration file.

src/dfx/src/lib/sns/validate_config.rs

@@ -3,8 +3,8 @@ use fn_error_context::context;
 use std::ffi::OsString;
 use std::path::Path;
 
+use crate::lib::call_bundled::call_bundled;
 use crate::lib::error::DfxResult;
-use crate::lib::sns::sns_cli::call_sns_cli;
 use crate::Environment;
 
 /// Checks whether an SNS configuration file is valid.
@@ -16,5 +16,5 @@ pub fn validate_config(env: &dyn Environment, path: &Path) -> DfxResult<String>
         OsString::from(path),
         OsString::from("validate"),
     ];
-    call_sns_cli(env, &args).map(|_| format!("SNS config file is valid: {}", path.display()))
+    call_bundled(env, "sns", &args).map(|_| format!("SNS config file is valid: {}", path.display()))
 }