From 2a0e93cb41a2c74bc493990fa5a8388b57f5a475 Mon Sep 17 00:00:00 2001
From: maciektr <maciej.tratnowiecki@swmansion.com>
Date: Mon, 15 Apr 2024 18:33:01 +0200
Subject: [PATCH] Scarb UI to_env_vars trait (#1272)

---
 scarb/src/bin/scarb/commands/test.rs       |  9 ++-----
 scarb/src/ops/subcommands.rs               | 31 ++++------------------
 utils/scarb-ui/src/args/features.rs        | 19 +++++++++++++
 utils/scarb-ui/src/args/mod.rs             |  8 ++++++
 utils/scarb-ui/src/args/packages_filter.rs |  9 +++++++
 5 files changed, 43 insertions(+), 33 deletions(-)

diff --git a/scarb/src/bin/scarb/commands/test.rs b/scarb/src/bin/scarb/commands/test.rs
index bd6ecd0da..d23dd2c89 100644
--- a/scarb/src/bin/scarb/commands/test.rs
+++ b/scarb/src/bin/scarb/commands/test.rs
@@ -12,12 +12,7 @@ pub fn run(args: TestArgs, config: &Config) -> Result<()> {
         .match_many(&ws)?
         .iter()
         .try_for_each(|package| {
-            ops::execute_test_subcommand(
-                package,
-                &args.args,
-                &ws,
-                args.features.clone().try_into()?,
-            )
-            .map(|_| ())
+            ops::execute_test_subcommand(package, &args.args, &ws, args.features.clone())
+                .map(|_| ())
         })
 }
diff --git a/scarb/src/ops/subcommands.rs b/scarb/src/ops/subcommands.rs
index ce8d39b99..c958ce964 100644
--- a/scarb/src/ops/subcommands.rs
+++ b/scarb/src/ops/subcommands.rs
@@ -6,13 +6,14 @@ use std::{env, iter};
 
 use anyhow::{bail, Result};
 use camino::Utf8PathBuf;
+use scarb_ui::args::{FeaturesSpec, ToEnvVars};
 use tracing::debug;
 
 use scarb_ui::components::Status;
 
 use crate::core::{Config, Package, ScriptDefinition, Workspace};
 use crate::internal::fsx::is_executable;
-use crate::ops::{self, FeaturesSelector};
+use crate::ops::{self, FeaturesOpts};
 use crate::process::exec_replace;
 use crate::subcommands::{get_env_vars, EXTERNAL_CMD_PREFIX, SCARB_MANIFEST_PATH_ENV};
 
@@ -49,13 +50,15 @@ pub fn execute_test_subcommand(
     package: &Package,
     args: &[OsString],
     ws: &Workspace<'_>,
-    features: ops::FeaturesOpts,
+    features: FeaturesSpec,
 ) -> Result<()> {
     let package_name = &package.id.name;
     let mut env = HashMap::from_iter([(
         SCARB_MANIFEST_PATH_ENV.into(),
         package.manifest_path().to_string(),
     )]);
+    // Validate features opts.
+    let _: FeaturesOpts = features.clone().try_into()?;
     env.extend(features.to_env_vars());
     if let Some(script_definition) = package.manifest.scripts.get("test") {
         debug!("using `test` script: {script_definition}");
@@ -111,27 +114,3 @@ fn find_external_subcommand(cmd: &str, config: &Config) -> Result<Option<PathBuf
         .map(|dir| dir.join(&command_exe))
         .find(|file| is_executable(file)))
 }
-
-pub trait ToEnv {
-    fn to_env_vars(&self) -> HashMap<String, String>;
-}
-
-impl ToEnv for ops::FeaturesOpts {
-    fn to_env_vars(&self) -> HashMap<String, String> {
-        let mut env = HashMap::new();
-        match &self.features {
-            FeaturesSelector::AllFeatures => {
-                env.insert("SCARB_ALL_FEATURES".into(), true.to_string());
-            }
-            FeaturesSelector::Features(features) if !features.is_empty() => {
-                env.insert("SCARB_FEATURES".into(), features.join(","));
-            }
-            _ => {}
-        };
-        env.insert(
-            "SCARB_NO_DEFAULT_FEATURES".into(),
-            self.no_default_features.to_string(),
-        );
-        env
-    }
-}
diff --git a/utils/scarb-ui/src/args/features.rs b/utils/scarb-ui/src/args/features.rs
index c3927b7a8..ce532065d 100644
--- a/utils/scarb-ui/src/args/features.rs
+++ b/utils/scarb-ui/src/args/features.rs
@@ -25,3 +25,22 @@ pub struct FeaturesSpec {
     )]
     pub no_default_features: bool,
 }
+
+impl super::ToEnvVars for FeaturesSpec {
+    fn to_env_vars(self) -> Vec<(String, String)> {
+        let mut env = vec![("SCARB_FEATURES".to_string(), self.features.join(","))];
+        if self.all_features {
+            env.push((
+                "SCARB_ALL_FEATURES".to_string(),
+                self.all_features.to_string(),
+            ));
+        }
+        if self.no_default_features {
+            env.push((
+                "SCARB_NO_DEFAULT_FEATURES".to_string(),
+                self.no_default_features.to_string(),
+            ));
+        }
+        env
+    }
+}
diff --git a/utils/scarb-ui/src/args/mod.rs b/utils/scarb-ui/src/args/mod.rs
index 7a01900e5..04313652f 100644
--- a/utils/scarb-ui/src/args/mod.rs
+++ b/utils/scarb-ui/src/args/mod.rs
@@ -7,3 +7,11 @@ pub use verbosity::*;
 mod features;
 mod packages_filter;
 mod verbosity;
+
+/// This trait can be used to convert CLI argument into a set of environment variables.
+///
+/// This is useful when you want to pass CLI arguments and pass them to Scarb called in a child process.
+pub trait ToEnvVars {
+    /// Convert to a set of environment variables.
+    fn to_env_vars(self) -> Vec<(String, String)>;
+}
diff --git a/utils/scarb-ui/src/args/packages_filter.rs b/utils/scarb-ui/src/args/packages_filter.rs
index 7f45d7859..4deaf6b51 100644
--- a/utils/scarb-ui/src/args/packages_filter.rs
+++ b/utils/scarb-ui/src/args/packages_filter.rs
@@ -355,6 +355,15 @@ impl PackagesSource for Metadata {
     }
 }
 
+impl super::ToEnvVars for PackagesFilter {
+    fn to_env_vars(self) -> Vec<(String, String)> {
+        vec![(
+            "SCARB_PACKAGES_FILTER".into(),
+            self.to_env().to_string_lossy().to_string(),
+        )]
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use std::collections::HashSet;