Add Sudo type (#221)

* Create `Sudo` type and `SudoKind` enum

* Fix build

* reformat

* Fix choco on windows

* Fix linux

* Fix linux more

* more fix stuff hehe hoho hahaha

* more fix stuff hehe hoho hahaha

Co-authored-by: Thomas Schönauer <37108907+DottoDev@users.noreply.github.com>

src/sudo.rs

@@ -1,3 +1,5 @@
+use std::ffi::OsStr;
+use std::path::Path;
 use std::path::PathBuf;
 
 use color_eyre::eyre::Context;
@@ -5,30 +7,102 @@ use color_eyre::eyre::Result;
 
 use crate::command::CommandExt;
 use crate::execution_context::ExecutionContext;
+use crate::executor::Executor;
 use crate::terminal::print_separator;
 use crate::utils::which;
 
-/// Get the path of the `sudo` utility.
-///
-/// Detects `doas`, `sudo`, `gsudo`, or `pkexec`.
-pub fn path() -> Option<PathBuf> {
-    which("doas")
-        .or_else(|| which("sudo"))
-        .or_else(|| which("gsudo"))
-        .or_else(|| which("pkexec"))
+#[derive(Clone, Debug)]
+pub struct Sudo {
+    /// The path to the `sudo` binary.
+    path: PathBuf,
+    /// The type of program being used as `sudo`.
+    kind: SudoKind,
 }
 
-/// Elevate permissions with `sudo`.
-pub fn elevate(ctx: &ExecutionContext, sudo: Option<&PathBuf>) -> Result<()> {
-    if let Some(sudo) = sudo {
-        print_separator("Sudo");
-        ctx.run_type()
-            .execute(sudo)
-            // TODO: Does this work with `doas`, `pkexec`, `gsudo`, GNU `sudo`...?
-            .arg("-v")
-            .status_checked()
-            .wrap_err("Failed to elevate permissions")?;
+impl Sudo {
+    /// Get the `sudo` binary for this platform.
+    pub fn detect() -> Option<Self> {
+        which("doas")
+            .map(|p| (p, SudoKind::Doas))
+            .or_else(|| which("sudo").map(|p| (p, SudoKind::Sudo)))
+            .or_else(|| which("gsudo").map(|p| (p, SudoKind::Gsudo)))
+            .or_else(|| which("pkexec").map(|p| (p, SudoKind::Pkexec)))
+            .map(|(path, kind)| Self { path, kind })
     }
 
-    Ok(())
+    /// Elevate permissions with `sudo`.
+    ///
+    /// This helps prevent blocking `sudo` prompts from stopping the run in the middle of a
+    /// step.
+    ///
+    /// See: https://github.com/topgrade-rs/topgrade/issues/205
+    pub fn elevate(&self, ctx: &ExecutionContext) -> Result<()> {
+        print_separator("Sudo");
+        let mut cmd = ctx.run_type().execute(self);
+        match self.kind {
+            SudoKind::Doas => {
+                // `doas` doesn't have anything like `sudo -v` to cache credentials,
+                // so we just execute a dummy `echo` command so we have something
+                // unobtrusive to run.
+                // See: https://man.openbsd.org/doas
+                cmd.arg("echo");
+            }
+            SudoKind::Sudo => {
+                // From `man sudo` on macOS:
+                //   -v, --validate
+                //   Update the user's cached credentials, authenticating the user
+                //   if necessary.  For the sudoers plugin, this extends the sudo
+                //   timeout for another 5 minutes by default, but does not run a
+                //   command.  Not all security policies support cached credentials.
+                cmd.arg("-v");
+            }
+            SudoKind::Gsudo => {
+                // Shows current user, cache and console status.
+                // See: https://gerardog.github.io/gsudo/docs/usage
+                cmd.arg("status");
+            }
+            SudoKind::Pkexec => {
+                // I don't think this does anything; `pkexec` usually asks for
+                // authentication every time, although it can be configured
+                // differently.
+                //
+                // See the note for `doas` above.
+                //
+                // See: https://linux.die.net/man/1/pkexec
+                cmd.arg("echo");
+            }
+        }
+        cmd.status_checked().wrap_err("Failed to elevate permissions")
+    }
+
+    /// Execute a command with `sudo`.
+    pub fn execute_elevated(&self, ctx: &ExecutionContext, command: &Path, interactive: bool) -> Executor {
+        let mut cmd = ctx.run_type().execute(self);
+
+        if let SudoKind::Sudo = self.kind {
+            cmd.arg("--preserve-env=DIFFPROG");
+        }
+
+        if interactive {
+            cmd.arg("-i");
+        }
+
+        cmd.arg(command);
+
+        cmd
+    }
+}
+
+#[derive(Clone, Copy, Debug)]
+enum SudoKind {
+    Doas,
+    Sudo,
+    Gsudo,
+    Pkexec,
+}
+
+impl AsRef<OsStr> for Sudo {
+    fn as_ref(&self) -> &OsStr {
+        self.path.as_ref()
+    }
 }