feat: Support scheme 'file' to process local conda files (#166)

Co-authored-by: amamiya-len <yuanhang.zhao@timeplus.io>
Co-authored-by: Pavel Zwerschke <pavelzw@gmail.com>

Author: 3 people

.gitignore

@@ -116,7 +116,6 @@ $RECYCLE.BIN/
 # pixi-pack
 activate.*
 cache/
-channel/
 env/
 environment.yml
 environment

.typos.toml

@@ -1,2 +1,5 @@
 [default.extend-words]
 intoto = "intoto"
+
+[files]
+extend-exclude = ["pixi.lock.template"]

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "pixi-pack"
 description = "A command line tool to pack and unpack conda environments for easy sharing"
-version = "0.6.4"
+version = "0.6.5"
 edition = "2024"
 
 # See https://doc.rust-lang.org/cargo/reference/profiles.html

Cargo.toml

@@ -0,0 +1,24 @@
+{
+  "info": {
+    "subdir": "noarch"
+  },
+  "packages": {},
+  "packages.conda": {
+    "my-webserver-0.1.0-pyh4616a5c_0.conda": {
+      "build": "pyh4616a5c_0",
+      "build_number": 0,
+      "constrains": ["pydantic >=2,<3"],
+      "depends": ["python >=3.12", "fastapi", "python"],
+      "md5": "243def6b96cf556936d075033a2f1ae4",
+      "name": "my-webserver",
+      "noarch": "python",
+      "sha256": "8bc75a2f9baab61004b02b022bb0c6a08fcc57dee5d521a5a61640f861f69da9",
+      "size": 6581,
+      "subdir": "noarch",
+      "timestamp": 1729264746409,
+      "version": "0.1.0"
+    }
+  },
+  "removed": [],
+  "repodata_version": 1
+}

examples/local-channel/channel/noarch/my-webserver-0.1.0-pyh4616a5c_0.conda

@@ -0,0 +1,7 @@
+[project]
+channels = ["<local-channel-url>", "conda-forge"]
+name = "no-timestamp"
+platforms = ["linux-64", "linux-aarch64", "win-64", "osx-64", "osx-arm64"]
+
+[dependencies]
+my-webserver = "*"

examples/local-channel/channel/noarch/repodata.json

@@ -395,17 +395,25 @@ async fn download_package(
         }
     }
 
-    let mut dest = File::create(&output_path).await?;
-
-    tracing::debug!("Fetching package {}", package.location);
-    let url = match &package.location {
-        UrlOrPath::Url(url) => url,
-        UrlOrPath::Path(path) => anyhow::bail!("Path not supported: {}", path),
-    };
+    let url = package.location.try_into_url()?;
+    match url.scheme() {
+        "file" => {
+            let local_path = url
+                .to_file_path()
+                .map_err(|_| anyhow!("could not convert url: {} to file path", url))?;
+            tracing::debug!("Copying from path: {}", local_path.display());
+            // Copy file
+            fs::copy(local_path, &output_path).await?;
+        }
+        _ => {
+            let mut dest = File::create(&output_path).await?;
 
-    let mut response = client.get(url.clone()).send().await?.error_for_status()?;
-    while let Some(chunk) = response.chunk().await? {
-        dest.write_all(&chunk).await?;
+            tracing::debug!("Fetching package {}", package.location);
+            let mut response = client.get(url.clone()).send().await?.error_for_status()?;
+            while let Some(chunk) = response.chunk().await? {
+                dest.write_all(&chunk).await?;
+            }
+        }
     }
 
     // Save to cache if enabled

examples/local-channel/pixi.lock.template

@@ -770,3 +770,58 @@ async fn test_pixi_pack_source(
     let sha256_digest = sha256_digest_bytes(&output_file);
     insta::assert_snapshot!(format!("sha256-{}-executable", platform), &sha256_digest);
 }
+
+#[fixture]
+fn templated_pixi_toml() -> (PathBuf, TempDir) {
+    use url::Url;
+    let temp_pixi_project = tempdir().expect("Couldn't create a temp dir for tests");
+    let absolute_path_to_local_channel =
+        std::path::absolute("examples/local-channel/channel").unwrap();
+    let absolute_path_to_package = absolute_path_to_local_channel
+        .join("noarch/my-webserver-0.1.0-pyh4616a5c_0.conda")
+        .to_str()
+        .unwrap()
+        .to_owned();
+    let local_channel_url = Url::from_directory_path(&absolute_path_to_local_channel)
+        .unwrap()
+        .to_string();
+
+    let pixi_toml = temp_pixi_project.path().join("pixi.toml");
+    let pixi_lock = temp_pixi_project.path().join("pixi.lock");
+    let pixi_toml_contents = fs::read_to_string("examples/local-channel/pixi.toml.template")
+        .unwrap()
+        .replace("<local-channel-url>", &local_channel_url);
+    let pixi_lock_contents = fs::read_to_string("examples/local-channel/pixi.lock.template")
+        .unwrap()
+        .replace("<local-channel-url>", &local_channel_url)
+        .replace("<absolute-path-to-package>", &absolute_path_to_package);
+
+    fs::write(&pixi_toml, pixi_toml_contents).unwrap();
+    fs::write(&pixi_lock, pixi_lock_contents).unwrap();
+
+    (pixi_toml, temp_pixi_project)
+}
+
+#[rstest]
+#[tokio::test]
+async fn test_local_channel(
+    #[allow(unused_variables)] templated_pixi_toml: (PathBuf, TempDir),
+    #[with(templated_pixi_toml.0.clone())] options: Options,
+) {
+    let pack_options = options.pack_options;
+    let pack_result = pixi_pack::pack(pack_options).await;
+    assert!(pack_result.is_ok(), "{:?}", pack_result);
+
+    let unpack_options = options.unpack_options;
+    let unpack_result = pixi_pack::unpack(unpack_options.clone()).await;
+    assert!(unpack_result.is_ok(), "{:?}", unpack_result);
+
+    assert!(
+        unpack_options
+            .output_directory
+            .join("env")
+            .join("conda-meta")
+            .join("my-webserver-0.1.0-pyh4616a5c_0.json")
+            .exists()
+    );
+}