fix: build scripts for windows (#123)

* fix: build scripts for windows

* test: add tests

* fix: taplo

Author: baszalmstra

Cargo.lock

@@ -19,6 +19,7 @@ minijinja = "2.7.0"
 parking_lot = "0.12.3"
 reqwest = "0.12.12"
 reqwest-middleware = "0.4.0"
+rstest = "0.25.0"
 serde = "1.0"
 serde_yaml = "0.9"
 serde_json = "1.0"

Cargo.toml

@@ -6,45 +6,22 @@ edition.workspace = true
 [dependencies]
 async-trait = { workspace = true }
 chrono = { workspace = true }
-clap = { workspace = true, features = ["derive", "env"] }
-clap-verbosity-flag = { workspace = true }
-fs-err = { workspace = true }
-indexmap = { workspace = true }
-itertools = { workspace = true }
-log = { workspace = true }
 miette = { workspace = true }
-minijinja = { workspace = true }
-parking_lot = { workspace = true }
+minijinja = { workspace = true, features = ["json"] }
 rattler_conda_types = { workspace = true }
 rattler_package_streaming = { workspace = true }
-rattler_virtual_packages = { workspace = true }
 rattler-build = { workspace = true }
-reqwest = { workspace = true }
-reqwest-middleware = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
-serde_yaml = { workspace = true }
 serde_json = { workspace = true }
-toml_edit = { workspace = true }
 tempfile = { workspace = true }
 tokio = { workspace = true, features = ["macros"] }
-tracing-subscriber = { workspace = true }
-url = { workspace = true }
-pyproject-toml = { workspace = true }
-dirs = { workspace = true }
-pathdiff = { workspace = true }
 
 pixi-build-backend = { workspace = true }
 
 pixi_build_types = { workspace = true }
-pixi_consts = { workspace = true }
 pixi_manifest = { workspace = true }
-pixi_spec = { workspace = true }
 pixi_build_type_conversions = { workspace = true }
 
-jsonrpc-stdio-server = { workspace = true }
-jsonrpc-http-server = { workspace = true }
-jsonrpc-core = { workspace = true }
-
 [dev-dependencies]
 insta = { version = "1.42.1", features = ["yaml", "redactions", "filters"] }
-toml_edit = { version = "0.22.24" }
+rstest = { workspace = true }

crates/pixi-build-rust/Cargo.toml

@@ -1,13 +1,24 @@
-{% if export_openssl -%}
-export OPENSSL_DIR="$PREFIX"
-{% endif %}
+{% macro env(key) -%}
+{%- if is_bash %}{{ "$" ~key }}{% else %}{{ "%" ~ key ~ "%" }}{% endif -%}
+{% endmacro -%}
+{%- macro export(key, value) -%}
+{%- if is_bash -%}
+export {{ key }}={{ value }}
+{%- else -%}
+SET {{ key }}={{ value }}
+{%- endif -%}
+{%- endmacro -%}
 
-{% if has_sccache -%}
-export RUSTC_WRAPPER="sccache"
-{% endif %}
+{%- if has_openssl %}
+{{ export("OPENSSL_DIR", env("PREFIX")|tojson) }}
+{%- endif %}
+{%- if has_sccache %}
+{{ export("RUSTC_WRAPPER", "sccache") }}
+{%- endif %}
 
-cargo install --locked --root $PREFIX --path {{ source_dir }} --no-track {{ extra_args | join(" ") }} --force
+cargo install --locked --root "{{ env("PREFIX") }}" --path {{ source_dir }} --no-track {{ extra_args | join(" ") }} --force
+{%- if not is_bash %}
+if errorlevel 1 exit 1
+{%- endif %}
 
-{% if has_sccache -%}
-sccache --show-stats
-{% endif %}
+{% if has_sccache %}sccache --show-stats{% endif %}

crates/pixi-build-rust/src/build_script.j2

@@ -3,10 +3,20 @@ use serde::Serialize;
 
 #[derive(Serialize)]
 pub struct BuildScriptContext {
+    /// The location of the source
     pub source_dir: String,
+
+    /// Any additional args to pass to `cargo`
     pub extra_args: Vec<String>,
-    pub export_openssl: bool,
+
+    /// True if `openssl` is part of the build environment
+    pub has_openssl: bool,
+
+    /// True if `sccache` is available.
     pub has_sccache: bool,
+
+    /// The platform that is running the build.
+    pub is_bash: bool,
 }
 
 impl BuildScriptContext {
@@ -19,3 +29,62 @@ impl BuildScriptContext {
         rendered.lines().map(|s| s.to_string()).collect()
     }
 }
+
+#[cfg(test)]
+mod test {
+    use rstest::*;
+
+    #[rstest]
+    fn test_build_script(#[values(true, false)] is_bash: bool) {
+        let context = super::BuildScriptContext {
+            source_dir: String::from("my-prefix-dir"),
+            extra_args: vec![],
+            has_openssl: false,
+            has_sccache: false,
+            is_bash,
+        };
+        let script = context.render();
+
+        let mut settings = insta::Settings::clone_current();
+        settings.set_snapshot_suffix(if is_bash { "bash" } else { "cmdexe" });
+        settings.bind(|| {
+            insta::assert_snapshot!(script.join("\n"));
+        });
+    }
+
+    #[rstest]
+    fn test_sccache(#[values(true, false)] is_bash: bool) {
+        let context = super::BuildScriptContext {
+            source_dir: String::from("my-prefix-dir"),
+            extra_args: vec![],
+            has_openssl: false,
+            has_sccache: true,
+            is_bash,
+        };
+        let script = context.render();
+
+        let mut settings = insta::Settings::clone_current();
+        settings.set_snapshot_suffix(if is_bash { "bash" } else { "cmdexe" });
+        settings.bind(|| {
+            insta::assert_snapshot!(script.join("\n"));
+        });
+    }
+
+    #[rstest]
+    fn test_openssl(#[values(true, false)] is_bash: bool) {
+        let context = super::BuildScriptContext {
+            source_dir: String::from("my-prefix-dir"),
+            extra_args: vec![],
+            has_openssl: true,
+            has_sccache: false,
+            is_bash,
+        };
+        let script = context.render();
+
+        let mut settings = insta::Settings::clone_current();
+        settings.set_snapshot_suffix(if is_bash { "bash" } else { "cmdexe" });
+        settings.bind(|| {
+            insta::assert_snapshot!(script.join("\n"));
+        });
+    }
+}

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

@@ -96,7 +96,7 @@ impl<P: ProjectModel> RustBuildBackend<P> {
         let (has_sccache, requirements) =
             self.requirements(host_platform, channel_config, variant)?;
 
-        let export_openssl = self
+        let has_openssl = self
             .project_model
             .dependencies(Some(host_platform))
             .contains(&"openssl".into());
@@ -106,8 +106,9 @@ impl<P: ProjectModel> RustBuildBackend<P> {
         let build_script = BuildScriptContext {
             source_dir: self.manifest_root.display().to_string(),
             extra_args: self.config.extra_args.clone(),
-            export_openssl,
+            has_openssl,
             has_sccache,
+            is_bash: !Platform::current().is_windows(),
         }
         .render();
 
@@ -253,7 +254,7 @@ mod tests {
         ".requirements.build[0]" => insta::dynamic_redaction(|value, _path| {
             // assert that the value looks like a uuid here
             assert!(value.as_str().unwrap().contains("rust"));
-            }),
+        }),
         });
     }
 }

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

@@ -0,0 +1,5 @@
+---
+source: crates/pixi-build-rust/src/build_script.rs
+expression: "script.join(\"\\n\")"
+---
+cargo install --locked --root "$PREFIX" --path my-prefix-dir --no-track  --force

crates/pixi-build-rust/src/snapshots/pixi_build_rust__build_script__test__build_script@bash.snap

@@ -0,0 +1,6 @@
+---
+source: crates/pixi-build-rust/src/build_script.rs
+expression: "script.join(\"\\n\")"
+---
+cargo install --locked --root "%PREFIX%" --path my-prefix-dir --no-track  --force
+if errorlevel 1 exit 1

crates/pixi-build-rust/src/snapshots/pixi_build_rust__build_script__test__build_script@cmdexe.snap

@@ -0,0 +1,7 @@
+---
+source: crates/pixi-build-rust/src/build_script.rs
+expression: "script.join(\"\\n\")"
+---
+export OPENSSL_DIR="$PREFIX"
+
+cargo install --locked --root "$PREFIX" --path my-prefix-dir --no-track  --force

crates/pixi-build-rust/src/snapshots/pixi_build_rust__build_script__test__openssl@bash.snap

@@ -0,0 +1,8 @@
+---
+source: crates/pixi-build-rust/src/build_script.rs
+expression: "script.join(\"\\n\")"
+---
+SET OPENSSL_DIR="%PREFIX%"
+
+cargo install --locked --root "%PREFIX%" --path my-prefix-dir --no-track  --force
+if errorlevel 1 exit 1