Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace executables with broken symlinks during uv python install #9706

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Replace executables with broken symlinks during uv python install #9706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 38 additions & 20 deletions crates/uv/src/commands/python/install.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,32 +358,50 @@ pub(crate) async fn install(
target.simplified_display()
);

// Check if the existing link is valid
let valid_link = target
.read_link()
.and_then(|target| target.try_exists())
.inspect_err(|err| debug!("Failed to inspect executable with error: {err}"))
.unwrap_or(true);

// Figure out what installation it references, if any
let existing = find_matching_bin_link(
installations
.iter()
.copied()
.chain(existing_installations.iter()),
&target,
);
let existing = valid_link
.then(|| {
find_matching_bin_link(
installations
.iter()
.copied()
.chain(existing_installations.iter()),
&target,
)
})
.flatten();

match existing {
None => {
// There's an existing executable we don't manage, require `--force`
if !force {
errors.push((
installation.key(),
anyhow::anyhow!(
"Executable already exists at `{}` but is not managed by uv; use `--force` to replace it",
to.simplified_display()
),
));
continue;
if valid_link {
if !force {
errors.push((
installation.key(),
anyhow::anyhow!(
"Executable already exists at `{}` but is not managed by uv; use `--force` to replace it",
to.simplified_display()
),
));
continue;
}
debug!(
"Replacing existing executable at `{}` due to `--force`",
target.simplified_display()
);
} else {
debug!(
"Replacing broken symlink at `{}`",
target.simplified_display()
);
}
debug!(
"Replacing existing executable at `{}` due to `--force`",
target.simplified_display()
);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This logic only runs on Linux, right? It doesn't look like it's gated, but I assume the error it's handling only runs on Linux?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this technically would run on Windows too (which is valid, you could have a broken symlink it's just rare).

}
Some(existing) if existing == *installation => {
// The existing link points to the same installation, so we're done unless
Expand Down
37 changes: 37 additions & 0 deletions crates/uv/tests/it/python_install.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -839,3 +839,40 @@ fn python_install_unknown() {
error: `./foo` is not a valid Python download request; see `uv python help` for supported formats and `uv python list --only-downloads` for available versions
"###);
}

#[cfg(unix)]
#[test]
fn python_install_preview_broken_link() {
use assert_fs::prelude::PathCreateDir;
use fs_err::os::unix::fs::symlink;

let context: TestContext = TestContext::new_with_versions(&[])
.with_filtered_python_keys()
.with_filtered_exe_suffix();

let bin_python = context.temp_dir.child("bin").child("python3.13");

// Create a broken symlink
context.temp_dir.child("bin").create_dir_all().unwrap();
symlink(context.temp_dir.join("does-not-exist"), &bin_python).unwrap();

// Install
uv_snapshot!(context.filters(), context.python_install().arg("--preview").arg("3.13"), @r###"
success: true
exit_code: 0
----- stdout -----

----- stderr -----
Installed Python 3.13.1 in [TIME]
+ cpython-3.13.1-[PLATFORM] (python3.13)
"###);

// We should replace the broken symlink
insta::with_settings!({
filters => context.filters(),
}, {
insta::assert_snapshot!(
read_link_path(&bin_python), @"[TEMP_DIR]/managed/cpython-3.13.1-[PLATFORM]/bin/python3.13"
);
});
}
Loading