refactor: simplified stdout/stderr mocking in tests (#1163)

jdx · Dec 13, 2023 · f83a556 · f83a556
1 parent 13255b1
commit f83a556
Show file tree

Hide file tree

Showing 66 changed files with 354 additions and 443 deletions.
diff --git a/.markdown-link-check.json b/.markdown-link-check.json
@@ -1,7 +1,3 @@
 {
-  "ignorePatterns": [
-    {
-      "pattern": "^https://crates.io"
-    }
-  ]
+  "ignorePatterns": [{ "pattern": "^https://crates.io" }]
 }
diff --git a/src/cli/activate.rs b/src/cli/activate.rs
@@ -4,7 +4,6 @@ use crate::config::Config;
 use crate::dirs;
 use crate::env::RTX_EXE;
 use crate::file::touch_dir;
-use crate::output::Output;
 use crate::shell::{get_shell, ShellType};
 
 /// Initializes rtx in the current shell
@@ -46,15 +45,15 @@ pub struct Activate {
 }
 
 impl Activate {
-    pub fn run(self, _config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, _config: Config) -> Result<()> {
         let shell = get_shell(self.shell_type.or(self.shell))
             .expect("no shell provided, use `--shell=zsh`");
 
         // touch ROOT to allow hook-env to run
         let _ = touch_dir(&dirs::DATA);
 
         let output = shell.activate(&RTX_EXE, self.status);
-        out.stdout.write(output);
+        rtxprint!("{output}");
 
         Ok(())
     }

diff --git a/src/cli/alias/get.rs b/src/cli/alias/get.rs
@@ -1,7 +1,6 @@
 use color_eyre::eyre::{eyre, Result};
 
 use crate::config::Config;
-use crate::output::Output;
 
 /// Show an alias for a plugin
 ///
@@ -17,10 +16,10 @@ pub struct AliasGet {
 }
 
 impl AliasGet {
-    pub fn run(self, config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, config: Config) -> Result<()> {
         match config.get_all_aliases().get(&self.plugin) {
             Some(plugin) => match plugin.get(&self.alias) {
-                Some(alias) => Ok(rtxprintln!(out, "{}", alias)),
+                Some(alias) => Ok(rtxprintln!("{}", alias)),
                 None => Err(eyre!("Unknown alias: {}", &self.alias)),
             },
             None => Err(eyre!("Unknown plugin: {}", &self.plugin)),

diff --git a/src/cli/alias/ls.rs b/src/cli/alias/ls.rs
@@ -1,7 +1,7 @@
 use color_eyre::eyre::Result;
 
 use crate::config::Config;
-use crate::output::Output;
+
 use crate::plugins::PluginName;
 
 /// List aliases
@@ -21,7 +21,7 @@ pub struct AliasLs {
 }
 
 impl AliasLs {
-    pub fn run(self, config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, config: Config) -> Result<()> {
         for (plugin_name, aliases) in config.get_all_aliases() {
             if let Some(plugin) = &self.plugin {
                 if plugin_name != plugin {
@@ -35,9 +35,9 @@ impl AliasLs {
                     continue;
                 }
                 if self.plugin.is_some() {
-                    rtxprintln!(out, "{:20} {}", from, to);
+                    rtxprintln!("{:20} {}", from, to);
                 } else {
-                    rtxprintln!(out, "{:20} {:20} {}", plugin_name, from, to);
+                    rtxprintln!("{:20} {:20} {}", plugin_name, from, to);
                 }
             }
         }

diff --git a/src/cli/alias/mod.rs b/src/cli/alias/mod.rs
@@ -2,7 +2,6 @@ use clap::Subcommand;
 use color_eyre::eyre::Result;
 
 use crate::config::Config;
-use crate::output::Output;
 use crate::plugins::PluginName;
 
 mod get;
@@ -30,22 +29,22 @@ enum Commands {
 }
 
 impl Commands {
-    pub fn run(self, config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, config: Config) -> Result<()> {
         match self {
-            Self::Get(cmd) => cmd.run(config, out),
-            Self::Ls(cmd) => cmd.run(config, out),
-            Self::Set(cmd) => cmd.run(config, out),
-            Self::Unset(cmd) => cmd.run(config, out),
+            Self::Get(cmd) => cmd.run(config),
+            Self::Ls(cmd) => cmd.run(config),
+            Self::Set(cmd) => cmd.run(config),
+            Self::Unset(cmd) => cmd.run(config),
         }
     }
 }
 
 impl Alias {
-    pub fn run(self, config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, config: Config) -> Result<()> {
         let cmd = self.command.unwrap_or(Commands::Ls(ls::AliasLs {
             plugin: self.plugin,
         }));
 
-        cmd.run(config, out)
+        cmd.run(config)
     }
 }
diff --git a/src/cli/alias/set.rs b/src/cli/alias/set.rs
@@ -2,7 +2,6 @@ use color_eyre::eyre::Result;
 
 use crate::config::config_file::ConfigFile;
 use crate::config::Config;
-use crate::output::Output;
 
 /// Add/update an alias for a plugin
 ///
@@ -19,7 +18,7 @@ pub struct AliasSet {
 }
 
 impl AliasSet {
-    pub fn run(self, mut config: Config, _out: &mut Output) -> Result<()> {
+    pub fn run(self, mut config: Config) -> Result<()> {
         config
             .global_config
             .set_alias(&self.plugin, &self.alias, &self.value);

diff --git a/src/cli/alias/unset.rs b/src/cli/alias/unset.rs
@@ -2,7 +2,6 @@ use color_eyre::eyre::Result;
 
 use crate::config::config_file::ConfigFile;
 use crate::config::Config;
-use crate::output::Output;
 
 /// Clears an alias for a plugin
 ///
@@ -17,7 +16,7 @@ pub struct AliasUnset {
 }
 
 impl AliasUnset {
-    pub fn run(self, mut config: Config, _out: &mut Output) -> Result<()> {
+    pub fn run(self, mut config: Config) -> Result<()> {
         config.global_config.remove_alias(&self.plugin, &self.alias);
         config.global_config.save()
     }

diff --git a/src/cli/asdf.rs b/src/cli/asdf.rs
@@ -4,7 +4,7 @@ use itertools::Itertools;
 
 use crate::cli::Cli;
 use crate::config::Config;
-use crate::output::Output;
+
 use crate::toolset::ToolsetBuilder;
 
 /// [internal] simulates asdf for plugins that call "asdf" internally
@@ -17,32 +17,32 @@ pub struct Asdf {
 }
 
 impl Asdf {
-    pub fn run(mut self, config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(mut self, config: Config) -> Result<()> {
         let mut args = vec![String::from("rtx")];
         args.append(&mut self.args);
 
         match args.get(1).map(|s| s.as_str()) {
-            Some("reshim") => Cli::new().run(config, &args, out),
-            Some("list") => list_versions(config, out, &args),
+            Some("reshim") => Cli::new().run(config, &args),
+            Some("list") => list_versions(config, &args),
             Some("install") => {
                 if args.len() == 4 {
                     let version = args.pop().unwrap();
                     args[2] = format!("{}@{}", args[2], version);
                 }
-                Cli::new().run(config, &args, out)
+                Cli::new().run(config, &args)
             }
-            _ => Cli::new().run(config, &args, out),
+            _ => Cli::new().run(config, &args),
         }
     }
 }
 
-fn list_versions(config: Config, out: &mut Output, args: &Vec<String>) -> Result<()> {
+fn list_versions(config: Config, args: &Vec<String>) -> Result<()> {
     if args[2] == "all" {
         let mut new_args: Vec<String> = vec!["rtx".into(), "ls-remote".into()];
         if args.len() >= 3 {
             new_args.push(args[3].clone());
         }
-        return Cli::new().run(config, &new_args, out);
+        return Cli::new().run(config, &new_args);
     }
     let ts = ToolsetBuilder::new().build(&config)?;
     let mut versions = ts.list_installed_versions(&config)?;
@@ -53,16 +53,16 @@ fn list_versions(config: Config, out: &mut Output, args: &Vec<String>) -> Result
     if let Some(plugin) = plugin {
         versions.retain(|(_, v)| v.plugin_name.as_str() == plugin);
         for (_, version) in versions {
-            rtxprintln!(out, "{}", version.version);
+            rtxprintln!("{}", version.version);
         }
     } else {
         for (plugin, versions) in &versions
             .into_iter()
             .group_by(|(_, v)| v.plugin_name.to_string())
         {
-            rtxprintln!(out, "{}", plugin);
+            rtxprintln!("{}", plugin);
             for (_, tv) in versions {
-                rtxprintln!(out, "  {}", tv.version);
+                rtxprintln!("  {}", tv.version);
             }
         }
     }

diff --git a/src/cli/bin_paths.rs b/src/cli/bin_paths.rs
@@ -1,7 +1,7 @@
 use color_eyre::eyre::Result;
 
 use crate::config::Config;
-use crate::output::Output;
+
 use crate::toolset::ToolsetBuilder;
 
 /// List all the active runtime bin paths
@@ -10,10 +10,10 @@ use crate::toolset::ToolsetBuilder;
 pub struct BinPaths {}
 
 impl BinPaths {
-    pub fn run(self, config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, config: Config) -> Result<()> {
         let ts = ToolsetBuilder::new().build(&config)?;
         for p in ts.list_paths(&config) {
-            rtxprintln!(out, "{}", p.display());
+            rtxprintln!("{}", p.display());
         }
         Ok(())
     }

diff --git a/src/cli/cache/clear.rs b/src/cli/cache/clear.rs
@@ -3,7 +3,6 @@ use color_eyre::eyre::Result;
 use crate::config::Config;
 use crate::dirs::CACHE;
 use crate::file::{display_path, remove_all};
-use crate::output::Output;
 
 /// Deletes all cache files in rtx
 #[derive(Debug, clap::Args)]
@@ -15,7 +14,7 @@ pub struct CacheClear {
 }
 
 impl CacheClear {
-    pub fn run(self, _config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, _config: Config) -> Result<()> {
         let cache_dirs = match &self.plugin {
             Some(plugins) => plugins.iter().map(|p| CACHE.join(p)).collect(),
             None => vec![CACHE.to_path_buf()],
@@ -27,8 +26,8 @@ impl CacheClear {
             }
         }
         match &self.plugin {
-            Some(plugins) => rtxstatusln!(out, "cache cleared for {}", plugins.join(", ")),
-            None => rtxstatusln!(out, "cache cleared"),
+            Some(plugins) => rtxstatusln!("cache cleared for {}", plugins.join(", ")),
+            None => rtxstatusln!("cache cleared"),
         }
         Ok(())
     }

diff --git a/src/cli/cache/mod.rs b/src/cli/cache/mod.rs
@@ -3,7 +3,6 @@ use color_eyre::eyre::Result;
 
 use crate::config::Config;
 use crate::env;
-use crate::output::Output;
 
 mod clear;
 
@@ -23,20 +22,20 @@ enum Commands {
 }
 
 impl Commands {
-    pub fn run(self, config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, config: Config) -> Result<()> {
         match self {
-            Self::Clear(cmd) => cmd.run(config, out),
+            Self::Clear(cmd) => cmd.run(config),
         }
     }
 }
 
 impl Cache {
-    pub fn run(self, config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, config: Config) -> Result<()> {
         match self.command {
-            Some(cmd) => cmd.run(config, out),
+            Some(cmd) => cmd.run(config),
             None => {
                 // just show the cache dir
-                rtxprintln!(out, "{}", env::RTX_CACHE_DIR.display());
+                rtxprintln!("{}", env::RTX_CACHE_DIR.display());
                 Ok(())
             }
         }

diff --git a/src/cli/completion.rs b/src/cli/completion.rs
@@ -4,7 +4,6 @@ use color_eyre::eyre::Result;
 use std::fmt::Display;
 
 use crate::config::Config;
-use crate::output::Output;
 
 /// Generate shell completions
 #[derive(Debug, clap::Args)]
@@ -20,13 +19,13 @@ pub struct Completion {
 }
 
 impl Completion {
-    pub fn run(self, _config: Config, out: &mut Output) -> Result<()> {
+    pub fn run(self, _config: Config) -> Result<()> {
         let c = match self.shell.or(self.shell_type).unwrap() {
             Shell::Bash => include_str!("../../completions/rtx.bash"),
             Shell::Fish => include_str!("../../completions/rtx.fish"),
             Shell::Zsh => include_str!("../../completions/_rtx"),
         };
-        rtxprintln!(out, "{}", c.trim());
+        rtxprintln!("{}", c.trim());
 
         Ok(())
     }