Merge pull request #49 from Rust-GPU/fix/cargo-update

fix: crate defined output-dir is relative to the Cargo.toml it's defined in

Author: schell

.cargo/config.toml

@@ -0,0 +1,3 @@
+[alias]
+xtask = "run --package xtask --"
+build-test-shader = "xtask test-build"

.github/workflows/push.yaml

@@ -35,7 +35,7 @@ jobs:
           rustup update
       - run: cargo test
       - name: Run a full build
-        run: just build-shader-template
+        run: cargo xtask test-build
 
 
   lints:
@@ -45,5 +45,7 @@ jobs:
       - uses: moonrepo/setup-rust@v1
       - uses: extractions/setup-just@v2
       - uses: cargo-bins/cargo-binstall@main
-      - run: just setup-lints
-      - run: just lints
+      - run: cargo binstall cargo-shear
+      - run: cargo clippy -- --deny warnings
+      - run: cargo fmt --check
+      - run: cargo shear

Cargo.lock

@@ -1,6 +1,7 @@
 [workspace]
 members = [
-    "crates/cargo-gpu",
+    "crates/cargo-gpu", 
+		"crates/xtask",
 ]
 
 exclude = [
@@ -22,14 +23,14 @@ clap = { version = "4.4.8", features = ["derive"] }
 chrono = { version = "0.4.38", default-features = false, features = ["std"] }
 crossterm = "0.28.1"
 directories = "5.0.1"
-env_home = "0.1.0"
 env_logger = "0.10"
 http = "1.2.0"
 log = "0.4"
 relative-path = "1.9.3"
 serde = { version = "1.0.214", features = ["derive"] }
 serde_json = "1.0.132"
 toml = "0.8.19"
+tempdir = "0.3.7"
 test-log = "0.2.16"
 
 [workspace.lints.rust]

Cargo.toml

@@ -1,3 +1,5 @@
+#![allow(clippy::shadow_reuse, reason = "let's not be silly")]
+#![allow(clippy::unwrap_used, reason = "this is basically a test")]
 //! `cargo gpu build`, analogous to `cargo build`
 
 use anyhow::Context as _;
@@ -20,6 +22,7 @@ pub struct Build {
 
 impl Build {
     /// Entrypoint
+    #[expect(clippy::too_many_lines, reason = "these lines are fine")]
     pub fn run(&mut self) -> anyhow::Result<()> {
         let spirv_builder_cli_path = self.install.run()?;
 
@@ -100,11 +103,19 @@ impl Build {
                             .file_name()
                             .context("Couldn't parse file name from shader module path")?,
                     );
+                    log::debug!("copying {} to {}", filepath.display(), path.display());
                     std::fs::copy(&filepath, &path)?;
-                    let path_relative_to_shader_crate = path
-                        .relative_to(&self.install.spirv_install.shader_crate)?
-                        .to_path("");
-                    Ok(Linkage::new(entry, path_relative_to_shader_crate))
+                    log::debug!(
+                        "linkage of {} relative to {}",
+                        path.display(),
+                        self.install.spirv_install.shader_crate.display()
+                    );
+                    let spv_path = path
+                        .relative_to(&self.install.spirv_install.shader_crate)
+                        .map_or(path, |path_relative_to_shader_crate| {
+                            path_relative_to_shader_crate.to_path("")
+                        });
+                    Ok(Linkage::new(entry, spv_path))
                 },
             )
             .collect::<anyhow::Result<Vec<Linkage>>>()?;
@@ -173,7 +184,7 @@ mod test {
             // For some reason running a full build (`build.run()`) inside tests fails on Windows.
             // The error is in the `build.rs` step of compiling `spirv-tools-sys`. It is not clear
             // from the logged error what the problem is. For now we'll just run a full build
-            // outside the tests environment, see `justfile`'s `build-shader-template`.
+            // outside the tests environment, see `xtask`'s `test-build`.
         } else {
             panic!("was not a build command");
         }

crates/cargo-gpu/src/build.rs

@@ -104,9 +104,10 @@ impl Config {
             }
             (left, right) => {
                 if let Some(pointer) = maybe_pointer {
-                    let default = defaults
-                        .pointer(pointer)
-                        .context(format!("Config `{pointer}` not found in defaults"))?;
+                    let default = defaults.pointer(pointer).context(format!(
+                        "Configuration option with path `{pointer}` was not found in the default configuration, \
+                        which is:\ndefaults: {defaults:#?}"
+                    ))?;
                     if &right != default {
                         // Only overwrite if the new value differs from the defaults.
                         *left = right;
@@ -184,10 +185,17 @@ mod test {
         let shader_crate_path = update_cargo_output_dir();
 
         let args = Config::clap_command_with_cargo_config(&shader_crate_path, vec![]).unwrap();
-        assert_eq!(
-            args.build_args.output_dir,
-            std::path::Path::new("/the/moon")
-        );
+        if cfg!(target_os = "windows") {
+            assert_eq!(
+                args.build_args.output_dir,
+                std::path::Path::new("C:/the/moon")
+            );
+        } else {
+            assert_eq!(
+                args.build_args.output_dir,
+                std::path::Path::new("/the/moon")
+            );
+        }
     }
 
     #[test_log::test]

crates/cargo-gpu/src/config.rs

@@ -221,25 +221,25 @@ impl Install {
                 self.spirv_install.shader_crate.display()
             );
 
-            let mut command = std::process::Command::new("cargo");
-            command
+            let mut build_command = std::process::Command::new("cargo");
+            build_command
                 .current_dir(&checkout)
                 .arg(format!("+{}", spirv_version.channel))
                 .args(["build", "--release"])
                 .args(["--no-default-features"]);
 
-            command.args([
+            build_command.args([
                 "--features",
                 &Self::get_required_spirv_builder_version(spirv_version.date)?,
             ]);
 
-            log::debug!("building artifacts with `{:?}`", command);
+            log::debug!("building artifacts with `{:?}`", build_command);
 
-            let output = command
+            let build_output = build_command
                 .stdout(std::process::Stdio::inherit())
                 .stderr(std::process::Stdio::inherit())
                 .output()?;
-            anyhow::ensure!(output.status.success(), "...build error!");
+            anyhow::ensure!(build_output.status.success(), "...build error!");
 
             if dylib_path.is_file() {
                 log::info!("successfully built {}", dylib_path.display());

crates/cargo-gpu/src/install.rs

@@ -1,5 +1,7 @@
 //! Get config from the shader crate's `Cargo.toml` `[*.metadata.rust-gpu.*]`
 
+use serde_json::Value;
+
 /// `Metadata` refers to the `[metadata.*]` section of `Cargo.toml` that `cargo` formally
 /// ignores so that packages can implement their own behaviour with it.
 #[derive(Debug)]
@@ -47,12 +49,33 @@ impl Metadata {
         let mut metadata = crate::config::Config::defaults_as_json()?;
         crate::config::Config::json_merge(
             &mut metadata,
-            Self::get_workspace_metadata(cargo_json),
+            {
+                log::debug!("looking for workspace metadata");
+                let ws_meta = Self::get_workspace_metadata(cargo_json);
+                log::trace!("workspace_metadata: {ws_meta:#?}");
+                ws_meta
+            },
             None,
         )?;
         crate::config::Config::json_merge(
             &mut metadata,
-            Self::get_crate_metadata(cargo_json, path)?,
+            {
+                log::debug!("looking for crate metadata");
+                let mut crate_meta = Self::get_crate_metadata(cargo_json, path)?;
+                log::trace!("crate_metadata: {crate_meta:#?}");
+                if let Some(output_path) = crate_meta.pointer_mut("/build/output_dir") {
+                    log::debug!("found output-dir path in crate metadata: {:?}", output_path);
+                    if let Some(output_dir) = output_path.clone().as_str() {
+                        let new_output_path = path.join(output_dir);
+                        *output_path = Value::String(format!("{}", new_output_path.display()));
+                        log::debug!(
+                            "setting that to be relative to the Cargo.toml it was found in: {}",
+                            new_output_path.display()
+                        );
+                    }
+                }
+                crate_meta
+            },
             None,
         )?;
 
@@ -118,6 +141,7 @@ impl Metadata {
                     let manifest_path = manifest_path_dirty.replace(r"\\?\", "");
                     log::debug!("Matching shader crate path with manifest path: {shader_crate_path} == {manifest_path}?");
                     if manifest_path == shader_crate_path {
+                        log::debug!("...matches! Getting metadata");
                         let mut metadata = package
                             .pointer("/metadata/rust-gpu")
                             .unwrap_or(&empty_json_object)