Only update shell startup files in user mode on macOS

Like on Linux. Cf. krlmlr/scriptlets#27.

Author: gaborcsardi

NEWS.md

@@ -41,6 +41,9 @@
 * rig now warns instead of failing when it encounters a broken R
   installation (#346).
 
+* rig now does not edit the shell startup files in admin mode,
+  like rig 0.8.1 did on macOS. rig now only does this in user mode.
+
 # rig 0.8.1
 
 * The `RIG_PLATFORM` environment variable works correctly again (#325).

src/alias.rs

@@ -74,9 +74,13 @@ pub fn get_alias(args: &ArgMatches) -> Option<String> {
 
 #[cfg(target_os = "macos")]
 pub fn add_alias(ver: &str, alias: &str) -> Result<(), Box<dyn Error>> {
+    let mode = crate::utils::get_mode()?;
     let msg = "Adding R-".to_string() + alias + " alias";
-    if crate::utils::get_mode()? == crate::utils::Mode::Admin {
+    if mode == crate::utils::Mode::Admin {
         escalate(&msg)?;
+    } else {
+        let binary_dir = get_binary_dir()?;
+        std::fs::create_dir_all(&binary_dir)?;
     }
 
     check_local_bin_path()?;

src/macos.rs

@@ -740,9 +740,12 @@ pub fn sc_rm(args: &ArgMatches) -> Result<(), Box<dyn Error>> {
 pub fn sc_system_make_links() -> Result<(), Box<dyn Error>> {
     let binary_dir = get_binary_dir()?;
     let mode = get_mode()?;
-    if mode == crate::utils::Mode::Admin && access(binary_dir.as_str(), AccessFlags::W_OK).is_err()
-    {
-        escalate("making R-* quick links")?;
+    if mode == crate::utils::Mode::Admin {
+        if access(binary_dir.as_str(), AccessFlags::W_OK).is_err() {
+            escalate("making R-* quick links")?;
+        }
+    } else {
+        std::fs::create_dir_all(&binary_dir)?;
     }
     check_local_bin_path()?;
     let vers = sc_get_list()?;
@@ -1864,8 +1867,11 @@ pub fn sc_set_default(ver: &str) -> Result<(), Box<dyn Error>> {
         }
     };
 
-    check_local_bin_path()?;
     let binary_dir = get_binary_dir()?;
+    if get_mode()? == crate::utils::Mode::User {
+        std::fs::create_dir_all(&binary_dir)?;
+    }
+    check_local_bin_path()?;
 
     let r = Path::new(&binary_dir).join("R");
     if !r.exists() {

src/utils.rs

@@ -590,18 +590,25 @@ pub fn check_local_bin_path() -> Result<(), Box<dyn Error>> {
         usr_local_bin_idx
     );
 
-    let needs_add = match (local_bin_idx, usr_local_bin_idx) {
-        (None, _) => true,
-        (Some(l), Some(u)) if l > u => true,
-        _ => false,
-    };
+    // Only user mode puts rig's quick links into ~/.local/bin, so only user
+    // mode has a reason to edit the user's shell startup files. In admin mode
+    // we merely warn below if the binary directory is not on the PATH.
+    let mode = get_mode()?;
+    let needs_add = mode == Mode::User
+        && match (local_bin_idx, usr_local_bin_idx) {
+            (None, _) => true,
+            (Some(l), Some(u)) if l > u => true,
+            _ => false,
+        };
 
     if needs_add && !ADD_DONE.swap(true, Ordering::Relaxed) {
         debug!(
             "Updating shell profiles to put {} on PATH",
             local_bin.display()
         );
         add_local_bin_to_path()?;
+    } else if mode == Mode::Admin {
+        debug!("Admin mode, not touching shell startup files");
     } else if !needs_add {
         debug!(
             "{} is already correctly placed on PATH",
@@ -814,6 +821,26 @@ mod tests {
         });
     }
 
+    #[test]
+    fn test_check_local_bin_path_admin_mode_does_not_touch_dotfiles() {
+        with_temp_home(|home| {
+            let zshrc = home.join(".zshrc");
+            fs::write(&zshrc, "# existing\n").unwrap();
+            unsafe {
+                std::env::set_var("PATH", "/usr/local/bin:/usr/bin:/bin");
+            }
+            set_mode(Mode::Admin).unwrap();
+
+            check_local_bin_path().unwrap();
+
+            // ~/.local/bin is not on the PATH here, but in admin mode rig has
+            // no business editing the user's shell startup files.
+            assert_eq!(fs::read_to_string(&zshrc).unwrap(), "# existing\n");
+            assert!(!home.join(".local/bin/rigenv").exists());
+            assert!(!home.join(".profile").exists());
+        });
+    }
+
     #[test]
     fn os_converts_to_osstring() {
         assert_eq!(os("hello"), OsString::from("hello"));