sopsy 1.3.3

//! Git helpers used by `init`, `doctor`, and `check`.
//!
//! sopsy needs to know whether it is inside a repository, which files are
//! tracked (so `check` can ensure no plaintext secrets are committed), and
//! whether sensitive paths are ignored. These helpers shell out to `git`.

use std::path::{Path, PathBuf};
use std::process::Command;

use crate::error::{Error, Result};
use crate::ui::Ui;

/// The name of the external binary this module drives.
pub const GIT_BIN: &str = "git";

/// Run `git -C <dir> <args...>` and return the captured [`std::process::Output`].
///
/// I/O failures (e.g. `git` missing) are mapped to [`Error::Io`]; the exit
/// status is left for the caller to interpret since several git subcommands
/// communicate meaning through non-zero exit codes.
fn git(dir: &Path, args: &[&str]) -> Result<std::process::Output> {
    let output = Command::new(GIT_BIN)
        .arg("-C")
        .arg(dir)
        .args(args)
        .output()?;
    Ok(output)
}

/// Locate the root of the git repository containing `start`.
///
/// Runs `git -C <start> rev-parse --show-toplevel`, returning
/// [`Error::NotAGitRepo`] when `start` is not inside a repository.
pub fn repo_root(start: &Path) -> Result<PathBuf> {
    let output = git(start, &["rev-parse", "--show-toplevel"])?;
    if !output.status.success() {
        return Err(Error::NotAGitRepo);
    }
    let path = String::from_utf8_lossy(&output.stdout).trim().to_string();
    if path.is_empty() {
        return Err(Error::NotAGitRepo);
    }
    Ok(PathBuf::from(path))
}

/// List files tracked by git under `repo`.
///
/// Runs `git -C <repo> ls-files`, returning one [`PathBuf`] per tracked path
/// (relative to `repo`).
pub fn tracked_files(repo: &Path) -> Result<Vec<PathBuf>> {
    let output = git(repo, &["ls-files"])?;
    if !output.status.success() {
        return Err(Error::ProcessFailed {
            tool: GIT_BIN.to_string(),
            code: output.status.code().unwrap_or(-1),
            message: String::from_utf8_lossy(&output.stderr).trim().to_string(),
        });
    }
    Ok(String::from_utf8_lossy(&output.stdout)
        .lines()
        .filter(|line| !line.is_empty())
        .map(PathBuf::from)
        .collect())
}

/// Report whether `path` is tracked by git.
///
/// Runs `git -C <repo> ls-files --error-unmatch <path>`: exit 0 means tracked,
/// a non-zero exit means untracked. `path` is interpreted relative to `repo`
/// (absolute paths inside the repo also work).
pub fn is_tracked(repo: &Path, path: &Path) -> Result<bool> {
    let path_str = path.to_string_lossy();
    let output = git(repo, &["ls-files", "--error-unmatch", &path_str])?;
    Ok(output.status.success())
}

/// Report whether `path` is ignored by git (matched by a `.gitignore` rule).
///
/// Runs `git -C <repo> check-ignore <path>`: exit 0 means ignored, exit 1 means
/// not ignored, and any other exit code is surfaced as [`Error::ProcessFailed`].
pub fn is_ignored(repo: &Path, path: &Path) -> Result<bool> {
    let path_str = path.to_string_lossy();
    let output = git(repo, &["check-ignore", "--quiet", &path_str])?;
    match output.status.code() {
        Some(0) => Ok(true),
        Some(1) => Ok(false),
        other => Err(Error::ProcessFailed {
            tool: GIT_BIN.to_string(),
            code: other.unwrap_or(-1),
            message: String::from_utf8_lossy(&output.stderr).trim().to_string(),
        }),
    }
}

/// `git add` the given committable files, skipping any that don't exist, and
/// return the ones actually staged.
///
/// Callers can therefore pass their full *managed* set even when some entries
/// are optional (e.g. an absent `.env.example`): only present paths are staged.
pub fn stage(repo: &Path, files: &[PathBuf]) -> Result<Vec<PathBuf>> {
    let existing: Vec<PathBuf> = files.iter().filter(|path| path.exists()).cloned().collect();
    if existing.is_empty() {
        return Ok(existing);
    }
    // `--` guards against any path that looks like an option.
    let mut args: Vec<String> = vec!["add".to_string(), "--".to_string()];
    args.extend(
        existing
            .iter()
            .map(|path| path.to_string_lossy().into_owned()),
    );
    let refs: Vec<&str> = args.iter().map(String::as_str).collect();
    let output = git(repo, &refs)?;
    if !output.status.success() {
        return Err(Error::ProcessFailed {
            tool: GIT_BIN.to_string(),
            code: output.status.code().unwrap_or(-1),
            message: String::from_utf8_lossy(&output.stderr).trim().to_string(),
        });
    }
    Ok(existing)
}

/// The current branch name, or `None` on a detached HEAD.
///
/// Uses `symbolic-ref` rather than `rev-parse --abbrev-ref` so it still returns
/// the branch name on an *unborn* branch (a fresh repo with no commits yet,
/// exactly the state right after `sopsy init`).
pub fn current_branch(repo: &Path) -> Option<String> {
    let output = git(repo, &["symbolic-ref", "--quiet", "--short", "HEAD"]).ok()?;
    if !output.status.success() {
        return None;
    }
    let branch = String::from_utf8_lossy(&output.stdout).trim().to_string();
    if branch.is_empty() {
        None
    } else {
        Some(branch)
    }
}

/// Stage `files` and print copy-pasteable commit + pull-request instructions.
///
/// The entry point for the global `--git` flag: a command that just changed
/// files passes the concrete set it touched plus a commit subject. Only files
/// that exist are staged (see [`stage`]), and the printed `git push`/`gh pr`
/// lines are tailored to the current branch.
pub fn stage_and_advise(
    ui: &Ui,
    repo: &Path,
    files: &[PathBuf],
    commit_subject: &str,
) -> Result<()> {
    let staged = stage(repo, files)?;
    ui.header("Staged for you (--git)");
    if staged.is_empty() {
        ui.warn("no changed files were found to stage");
        return Ok(());
    }
    for path in &staged {
        ui.success(format!("git add {}", relative_display(repo, path)));
    }

    ui.header("Next: commit and open a pull request");
    ui.command(format!("git commit -m {}", quote(commit_subject)));
    match current_branch(repo) {
        Some(branch) => ui.command(format!("git push -u origin {branch}")),
        None => ui.command("git push -u origin HEAD"),
    }
    ui.command("gh pr create --fill   # or open a pull request on your Git host");
    Ok(())
}

/// Display `path` relative to `repo` when possible, for tidy `git add` output.
fn relative_display(repo: &Path, path: &Path) -> String {
    path.strip_prefix(repo)
        .unwrap_or(path)
        .to_string_lossy()
        .into_owned()
}

/// Double-quote a commit subject for safe shell copy-paste, escaping `\` and `"`.
fn quote(subject: &str) -> String {
    let escaped = subject.replace('\\', "\\\\").replace('"', "\\\"");
    format!("\"{escaped}\"")
}

/// Ensure `pattern` is present in the repository's `.gitignore`, appending it if
/// missing. Returns `true` if the file was modified, `false` if `pattern` was
/// already present. Idempotent.
pub fn ensure_gitignored(repo: &Path, pattern: &str) -> Result<bool> {
    let gitignore = repo.join(".gitignore");
    let existing = match std::fs::read_to_string(&gitignore) {
        Ok(contents) => contents,
        Err(err) if err.kind() == std::io::ErrorKind::NotFound => String::new(),
        Err(err) => return Err(Error::Io(err)),
    };

    let already_present = existing
        .lines()
        .map(str::trim)
        .any(|line| line == pattern.trim());
    if already_present {
        return Ok(false);
    }

    let mut updated = existing;
    if !updated.is_empty() && !updated.ends_with('\n') {
        updated.push('\n');
    }
    updated.push_str(pattern.trim_end());
    updated.push('\n');
    std::fs::write(&gitignore, updated)?;
    Ok(true)
}

#[cfg(test)]
mod tests {
    use super::*;

    // The public `stage` / `current_branch` / `stage_and_advise` are exercised
    // against a real repo in `tests/git.rs`; here we cover only the private
    // formatting helpers, which integration tests cannot reach.

    #[test]
    fn quote_escapes_quotes_and_backslashes() {
        assert_eq!(quote("simple"), "\"simple\"");
        assert_eq!(quote(r#"a "b" \c"#), r#""a \"b\" \\c""#);
    }

    #[test]
    fn relative_display_strips_the_repo_prefix() {
        let repo = Path::new("/repo");
        assert_eq!(
            relative_display(repo, Path::new("/repo/.sops.yaml")),
            ".sops.yaml"
        );
        // Paths outside the repo are shown verbatim.
        assert_eq!(relative_display(repo, Path::new("/other/x")), "/other/x");
    }
}