Add tests, clean up, doc string

Signed-off-by: Mikayla Thompson <[email protected]>

Author: mikaylathompson

crates/uv-cli/src/lib.rs

@@ -6853,15 +6853,17 @@ pub enum WorkspaceCommand {
     /// Display package metadata.
     #[command(hide = true)]
     Metadata(MetadataArgs),
+    /// Display path to workspace root or member packages.
     #[command(hide = true)]
-    Dir(DirArgs)
+    Dir(WorkspaceDirArgs)
 }
 
 #[derive(Args, Debug)]
 pub struct MetadataArgs;
 
 #[derive(Args, Debug)]
-pub struct DirArgs {
+pub struct WorkspaceDirArgs {
+    #[arg(long)]
     pub package: Option<PackageName>
 }
 

crates/uv/src/commands/workspace/dir.rs

@@ -3,7 +3,7 @@ use std::path::Path;
 
 use anyhow::{Result, bail};
 
-use uv_cli::DirArgs;
+use uv_cli::WorkspaceDirArgs;
 use uv_fs::{PortablePathBuf};
 use uv_preview::{Preview, PreviewFeatures};
 use uv_warnings::warn_user;
@@ -14,7 +14,7 @@ use crate::printer::Printer;
 
 /// Print the path to the workspace dir
 pub(crate) async fn dir(
-    args: &DirArgs,
+    args: &WorkspaceDirArgs,
     project_dir: &Path,
     preview: Preview,
     printer: Printer,
@@ -35,18 +35,17 @@ pub(crate) async fn dir(
             PortablePathBuf::from(workspace.install_path().as_path()).to_string()
         },
         Some(package) => {
-            if let Some(p) = workspace.packages().get(&package) {
+            if let Some(p) = workspace.packages().get(package) {
                 PortablePathBuf::from(p.root().as_path()).to_string()
             } else {
-                bail!("Package {} does not exist.", package)
+                bail!("Package `{package}` not found in workspace.")
             }
         }
     };
 
     writeln!(
         printer.stdout(),
-        "{}",
-        dir
+        "{dir}"
     )?;
 
     Ok(ExitStatus::Success)

crates/uv/tests/it/common/mod.rs

@@ -1072,6 +1072,14 @@ impl TestContext {
         command
     }
 
+    /// Create a `uv workspace dir` command with options shared across scenarios.
+    pub fn workspace_dir(&self) -> Command {
+        let mut command = Self::new_command();
+        command.arg("workspace").arg("dir");
+        self.add_shared_options(&mut command, false);
+        command
+    }
+
     /// Create a `uv export` command with options shared across scenarios.
     pub fn export(&self) -> Command {
         let mut command = Self::new_command();

crates/uv/tests/it/main.rs

@@ -142,3 +142,4 @@ mod workflow;
 mod extract;
 mod workspace;
 mod workspace_metadata;
+mod workspace_dir;

crates/uv/tests/it/workspace_dir.rs

@@ -0,0 +1,135 @@
+use std::env;
+use std::path::PathBuf;
+
+use anyhow::Result;
+use assert_cmd::assert::OutputAssertExt;
+use assert_fs::fixture::PathChild;
+
+use crate::common::{TestContext, copy_dir_ignore, uv_snapshot};
+
+fn workspaces_dir() -> PathBuf {
+    env::current_dir()
+        .unwrap()
+        .parent()
+        .unwrap()
+        .parent()
+        .unwrap()
+        .join("scripts")
+        .join("workspaces")
+}
+
+/// Test basic output for a simple workspace with one member.
+#[test]
+fn workspace_dir_simple() {
+    let context = TestContext::new("3.12");
+
+    // Initialize a workspace with one member
+    context.init().arg("foo").assert().success();
+
+    let workspace = context.temp_dir.child("foo");
+
+    uv_snapshot!(context.filters(), context.workspace_dir().current_dir(&workspace), @r###"
+    success: true
+    exit_code: 0
+    ----- stdout -----
+    [TEMP_DIR]/foo
+
+    ----- stderr -----
+    "###
+    );
+}
+
+// Workspace dir output when run with `--package`
+#[test]
+fn workspace_dir_specific_package() {
+    let context = TestContext::new("3.12");
+    context.init().arg("foo").assert().success();
+    context.init().arg("foo/bar").assert().success();
+    let workspace = context.temp_dir.child("foo");
+    
+    // root workspace
+    uv_snapshot!(context.filters(), context.workspace_dir().current_dir(&workspace), @r###"
+    success: true
+    exit_code: 0
+    ----- stdout -----
+    [TEMP_DIR]/foo
+
+    ----- stderr -----
+    "###
+    );
+
+    // with --package bar
+    uv_snapshot!(context.filters(), context.workspace_dir().arg("--package").arg("bar").current_dir(&workspace), @r###"
+    success: true
+    exit_code: 0
+    ----- stdout -----
+    [TEMP_DIR]/foo/bar
+
+    ----- stderr -----
+    "###
+    );
+}
+
+
+/// Test output when run from a workspace member directory.
+#[test]
+fn workspace_metadata_from_member() -> Result<()> {
+    let context = TestContext::new("3.12");
+    let workspace = context.temp_dir.child("workspace");
+
+    copy_dir_ignore(
+        workspaces_dir().join("albatross-root-workspace"),
+        &workspace,
+    )?;
+
+    let member_dir = workspace.join("packages").join("bird-feeder");
+
+    uv_snapshot!(context.filters(), context.workspace_dir().current_dir(&member_dir), @r###"
+    success: true
+    exit_code: 0
+    ----- stdout -----
+    [TEMP_DIR]/workspace
+
+    ----- stderr -----
+    "###
+    );
+
+    Ok(())
+}
+
+/// Test workspace dir error output for a non-existent package.
+#[test]
+fn workspace_dir_package_doesnt_exist() {
+    let context = TestContext::new("3.12");
+
+    // Initialize a workspace with one member
+    context.init().arg("foo").assert().success();
+
+    let workspace = context.temp_dir.child("foo");
+
+    uv_snapshot!(context.filters(), context.workspace_dir().arg("--package").arg("bar").current_dir(&workspace), @r###"
+    success: false
+    exit_code: 2
+    ----- stdout -----
+
+    ----- stderr -----
+    error: Package `bar` not found in workspace.
+    "###
+    );
+}
+
+/// Test workspace dir error ouptut when not in a project.
+#[test]
+fn workspace_metadata_no_project() {
+    let context = TestContext::new("3.12");
+
+    uv_snapshot!(context.filters(), context.workspace_dir(), @r###"
+    success: false
+    exit_code: 2
+    ----- stdout -----
+
+    ----- stderr -----
+    error: No `pyproject.toml` found in current directory or any parent directory
+    "###
+    );
+}