feat: allow to set environment variables from configuration (#118)

* feat: allow to set environment variables from configuration

Fixes #117

* Fix clippy lint

* Add tests

* Rename `env_vars` to `env`

Author: Hofer-Julian

Cargo.lock

@@ -16,7 +16,7 @@ use rattler_build::{
     hash::HashInfo,
     metadata::{BuildConfiguration, PackagingSettings},
     recipe::{
-        parser::{Build, Dependency, Package, Requirements, ScriptContent},
+        parser::{Build, Dependency, Package, Requirements, Script, ScriptContent},
         variable::Variable,
         Recipe,
     },
@@ -152,7 +152,11 @@ impl<P: ProjectModel> CMakeBuildBackend<P> {
                 string: Default::default(),
 
                 // skip: Default::default(),
-                script: ScriptContent::Commands(build_script).into(),
+                script: Script {
+                    content: ScriptContent::Commands(build_script),
+                    env: self.config.env.clone(),
+                    ..Default::default()
+                },
                 noarch: noarch_type,
 
                 // TODO: Python is not exposed properly
@@ -254,14 +258,38 @@ pub(crate) fn construct_configuration(
 mod tests {
     use std::{collections::BTreeMap, path::PathBuf};
 
+    use indexmap::IndexMap;
     use pixi_build_type_conversions::to_project_model_v1;
     use pixi_manifest::Manifests;
-    use rattler_build::console_utils::LoggingOutputHandler;
+    use rattler_build::{console_utils::LoggingOutputHandler, recipe::Recipe};
     use rattler_conda_types::{ChannelConfig, Platform};
     use tempfile::tempdir;
 
     use crate::{cmake::CMakeBuildBackend, config::CMakeBackendConfig};
 
+    fn recipe(manifest_source: &str, config: CMakeBackendConfig) -> Recipe {
+        let tmp_dir = tempdir().unwrap();
+        let tmp_manifest = tmp_dir.path().join("pixi.toml");
+        std::fs::write(&tmp_manifest, manifest_source).unwrap();
+        let manifest = Manifests::from_workspace_manifest_path(tmp_manifest.clone()).unwrap();
+        let package = manifest.value.package.unwrap();
+        let channel_config = ChannelConfig::default_with_root_dir(tmp_dir.path().to_path_buf());
+        let project_model = to_project_model_v1(&package.value, &channel_config).unwrap();
+
+        let cmake_backend = CMakeBuildBackend::new(
+            &tmp_manifest,
+            project_model,
+            config,
+            LoggingOutputHandler::default(),
+            None,
+        )
+        .unwrap();
+
+        cmake_backend
+            .recipe(Platform::current(), &channel_config, &BTreeMap::new())
+            .unwrap()
+    }
+
     #[tokio::test]
     async fn test_setting_host_and_build_requirements() {
         // get cargo manifest dir
@@ -355,4 +383,33 @@ mod tests {
 
         Manifests::from_workspace_manifest_path(tmp_manifest).unwrap();
     }
+
+    #[test]
+    fn test_env_vars_are_set() {
+        let manifest_source = r#"
+        [workspace]
+        platforms = []
+        channels = []
+        preview = ["pixi-build"]
+
+        [package]
+        name = "foobar"
+        version = "0.1.0"
+
+        [package.build]
+        backend = { name = "pixi-build-rust", version = "*" }
+        "#;
+
+        let env = IndexMap::from([("foo".to_string(), "bar".to_string())]);
+
+        let recipe = recipe(
+            manifest_source,
+            CMakeBackendConfig {
+                env: env.clone(),
+                ..Default::default()
+            },
+        );
+
+        assert_eq!(recipe.build.script.env, env);
+    }
 }

crates/pixi-build-cmake/src/cmake.rs

@@ -1,8 +1,11 @@
+use indexmap::IndexMap;
 use serde::Deserialize;
 
 #[derive(Debug, Default, Deserialize)]
 #[serde(rename_all = "kebab-case")]
 pub struct CMakeBackendConfig {
     /// Extra args for CMake invocation
     pub extra_args: Vec<String>,
+    /// Environment Variables
+    pub env: IndexMap<String, String>,
 }

crates/pixi-build-cmake/src/config.rs

@@ -1,3 +1,4 @@
+use indexmap::IndexMap;
 use serde::Deserialize;
 use std::convert::identity;
 
@@ -8,6 +9,9 @@ pub struct PythonBackendConfig {
     /// to `true`.
     #[serde(default)]
     pub noarch: Option<bool>,
+
+    /// Environment Variables
+    pub env: IndexMap<String, String>,
 }
 
 impl PythonBackendConfig {

crates/pixi-build-python/src/config.rs

@@ -12,7 +12,7 @@ use rattler_build::{
     hash::HashInfo,
     metadata::{BuildConfiguration, PackagingSettings},
     recipe::{
-        parser::{Build, Package, PathSource, Python, Requirements, ScriptContent, Source},
+        parser::{Build, Package, PathSource, Python, Requirements, Script, ScriptContent, Source},
         variable::Variable,
         Recipe,
     },
@@ -187,7 +187,11 @@ impl<P: ProjectModel> PythonBuildBackend<P> {
                 string: Default::default(),
 
                 // skip: Default::default(),
-                script: ScriptContent::Commands(build_script).into(),
+                script: Script {
+                    content: ScriptContent::Commands(build_script),
+                    env: self.config.env.clone(),
+                    ..Default::default()
+                },
                 noarch: noarch_type,
 
                 python,
@@ -293,6 +297,7 @@ mod tests {
 
     use std::{collections::BTreeMap, path::PathBuf};
 
+    use indexmap::IndexMap;
     use pixi_build_type_conversions::to_project_model_v1;
 
     use pixi_manifest::Manifests;
@@ -346,6 +351,7 @@ mod tests {
         backend = { name = "pixi-build-python", version = "*" }
         "#, PythonBackendConfig {
             noarch: Some(false),
+            ..Default::default()
         }), {
             ".source[0].path" => "[ ... path ... ]",
             ".build.script" => "[ ... script ... ]",
@@ -566,4 +572,33 @@ requires = ["hatchling"]
             ".build.script" => "[ ... script ... ]",
         });
     }
+
+    #[test]
+    fn test_env_vars_are_set() {
+        let manifest_source = r#"
+        [workspace]
+        platforms = []
+        channels = []
+        preview = ["pixi-build"]
+
+        [package]
+        name = "foobar"
+        version = "0.1.0"
+
+        [package.build]
+        backend = { name = "pixi-build-python", version = "*" }
+        "#;
+
+        let env = IndexMap::from([("foo".to_string(), "bar".to_string())]);
+
+        let recipe = recipe(
+            manifest_source,
+            PythonBackendConfig {
+                env: env.clone(),
+                ..Default::default()
+            },
+        );
+
+        assert_eq!(recipe.build.script.env, env);
+    }
 }

crates/pixi-build-python/src/python.rs

@@ -6,6 +6,7 @@ edition.workspace = true
 [dependencies]
 async-trait = { workspace = true }
 chrono = { workspace = true }
+indexmap = { workspace = true }
 miette = { workspace = true }
 minijinja = { workspace = true, features = ["json"] }
 rattler_conda_types = { workspace = true }

crates/pixi-build-rust/Cargo.toml

@@ -1,8 +1,13 @@
+use indexmap::IndexMap;
+
 use serde::Deserialize;
 
 #[derive(Debug, Default, Deserialize)]
 #[serde(rename_all = "kebab-case")]
 pub struct RustBackendConfig {
     /// Extra args to pass for cargo
     pub extra_args: Vec<String>,
+
+    /// Environment Variables
+    pub env: IndexMap<String, String>,
 }

crates/pixi-build-rust/src/config.rs

@@ -13,7 +13,7 @@ use rattler_build::{
     hash::HashInfo,
     metadata::{BuildConfiguration, PackagingSettings},
     recipe::{
-        parser::{Build, Dependency, Package, Requirements, ScriptContent},
+        parser::{Build, Dependency, Package, Requirements, Script, ScriptContent},
         variable::Variable,
         Recipe,
     },
@@ -127,7 +127,11 @@ impl<P: ProjectModel> RustBuildBackend<P> {
             build: Build {
                 number: build_number,
                 string: Default::default(),
-                script: ScriptContent::Commands(build_script).into(),
+                script: Script {
+                    content: ScriptContent::Commands(build_script),
+                    env: self.config.env.clone(),
+                    ..Default::default()
+                },
                 noarch: noarch_type,
                 ..Build::default()
             },
@@ -202,6 +206,7 @@ mod tests {
 
     use std::collections::BTreeMap;
 
+    use indexmap::IndexMap;
     use pixi_build_type_conversions::to_project_model_v1;
 
     use pixi_manifest::Manifests;
@@ -257,4 +262,33 @@ mod tests {
         }),
         });
     }
+
+    #[test]
+    fn test_env_vars_are_set() {
+        let manifest_source = r#"
+        [workspace]
+        platforms = []
+        channels = []
+        preview = ["pixi-build"]
+
+        [package]
+        name = "foobar"
+        version = "0.1.0"
+
+        [package.build]
+        backend = { name = "pixi-build-rust", version = "*" }
+        "#;
+
+        let env = IndexMap::from([("foo".to_string(), "bar".to_string())]);
+
+        let recipe = recipe(
+            manifest_source,
+            RustBackendConfig {
+                env: env.clone(),
+                ..Default::default()
+            },
+        );
+
+        assert_eq!(recipe.build.script.env, env);
+    }
 }