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.

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

Avoid removing partial paths when uninstalling #3092

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/cli/self_update.rs
Original file line number Diff line number Diff line change
Expand Up @@ -949,7 +949,7 @@ pub(crate) fn uninstall(no_prompt: bool) -> Result<utils::ExitCode> {
info!("removing cargo home");

// Remove CARGO_HOME/bin from PATH
do_remove_from_path()?;
do_remove_from_paths()?;
do_remove_from_programs()?;

// Delete everything in CARGO_HOME *except* the rustup bin
Expand Down
119 changes: 98 additions & 21 deletions src/cli/self_update/unix.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ use std::process::Command;

use anyhow::{bail, Context, Result};

use super::install_bins;
use super::shell;
use crate::cli::self_update::shell::Shell;
use crate::process;
use crate::utils::utils;
use crate::utils::Notification;

use super::install_bins;
use super::shell;

// If the user is trying to install with sudo, on some systems this will
// result in writing root-owned files to the user's home directory, because
// sudo is configured not to change $HOME. Don't let that bogosity happen.
Expand Down Expand Up @@ -52,33 +54,43 @@ pub(crate) fn delete_rustup_and_cargo_home() -> Result<()> {
utils::remove_dir("cargo_home", &cargo_home, &|_: Notification<'_>| ())
}

pub(crate) fn do_remove_from_path() -> Result<()> {
pub(crate) fn do_remove_from_paths() -> Result<()> {
for sh in shell::get_available_shells() {
let source_bytes = format!("{}\n", sh.source_string()?).into_bytes();

// Check more files for cleanup than normally are updated.
for rc in sh.rcfiles().iter().filter(|rc| rc.is_file()) {
let file = utils::read_file("rcfile", rc)?;
let file_bytes = file.into_bytes();
// FIXME: This is whitespace sensitive where it should not be.
if let Some(idx) = file_bytes
.windows(source_bytes.len())
.position(|w| w == source_bytes.as_slice())
{
// Here we rewrite the file without the offending line.
let mut new_bytes = file_bytes[..idx].to_vec();
new_bytes.extend(&file_bytes[idx + source_bytes.len()..]);
let new_file = String::from_utf8(new_bytes).unwrap();
utils::write_file("rcfile", rc, &new_file)?;
do_remove_from_path(&sh)?;
}
remove_legacy_paths()?;

Ok(())
}

pub(crate) fn do_remove_from_path(sh: &Shell) -> Result<()> {
let source_string = sh.source_string()?;

// Check more files for cleanup than normally are updated.
for rc in sh.rcfiles().iter().filter(|rc| rc.is_file()) {
let file = utils::read_file("rcfile", rc)?;

let mut new_file = String::new();
for line in file.lines() {
let line = normalize_whitespaces_in_line(line);

if line != source_string {
new_file.push_str(&line);
new_file.push('\n')
}

utils::write_file("rcfile", rc, &new_file)?;
}
}

remove_legacy_paths()?;

Ok(())
}

fn normalize_whitespaces_in_line(line: &str) -> String {
let words: Vec<_> = line.trim().split_whitespace().collect();
words.join(" ")
}

pub(crate) fn do_add_to_path() -> Result<()> {
for sh in shell::get_available_shells() {
let source_cmd = sh.source_string()?;
Expand Down Expand Up @@ -183,3 +195,68 @@ fn remove_legacy_paths() -> Result<()> {

Ok(())
}

#[cfg(test)]
mod tests {
use std::fs;
use std::io::Write;

use tempfile::NamedTempFile;

use crate::cli::self_update::shell::UnixShell;

use super::*;

struct TestShell {
rcfile: NamedTempFile,
}

impl TestShell {
pub fn new(rcfile_content: &String) -> Result<TestShell> {
let mut rcfile = NamedTempFile::new()?;
rcfile.write(rcfile_content.as_bytes())?;

Ok(TestShell { rcfile })
}
}

impl UnixShell for TestShell {
fn does_exist(&self) -> bool {
true
}

fn rcfiles(&self) -> Vec<PathBuf> {
vec![self.rcfile.path().to_path_buf()]
}

fn update_rcs(&self) -> Vec<PathBuf> {
unimplemented!()
}

fn source_string(&self) -> Result<String> {
Ok("source \"$HOME/.cargo/env\"".to_string())
}
}

#[test]
fn test_normalize_whitespace() {
let input = " foo bar baz ";
assert_eq!("foo bar baz", normalize_whitespaces_in_line(input));
}

#[test]
fn test_regression_dont_remove_parts_of_rcfile_lines() {
let expected =
"some code\n[ -f \"$HOME/.cargo/env\" ] && source \"$HOME/.cargo/env\"\nsome more\n"
.to_string();

let sh = TestShell::new(&expected).unwrap();
let path = sh.rcfile.path().to_owned();
let sh: Box<(dyn UnixShell)> = Box::new(sh);

do_remove_from_path(&sh).unwrap();

let content = fs::read_to_string(path).unwrap();
assert_eq!(expected, content);
}
}
2 changes: 1 addition & 1 deletion src/cli/self_update/windows.rs
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ where
.and_then(|old_path| f(old_path, OsString::from(path_str).encode_wide().collect())))
}

pub(crate) fn do_remove_from_path() -> Result<()> {
pub(crate) fn do_remove_from_paths() -> Result<()> {
let new_path = _with_path_cargo_home_bin(_remove_from_path)?;
_apply_new_path(new_path)
}
Expand Down