Skip to main content

oven_cli/git/
mod.rs

1use std::path::{Path, PathBuf};
2
3use anyhow::{Context, Result};
4use tokio::process::Command;
5
6/// A git worktree created for an issue pipeline.
7#[derive(Debug, Clone)]
8pub struct Worktree {
9    pub path: PathBuf,
10    pub branch: String,
11    pub issue_number: u32,
12}
13
14/// Info about an existing worktree from `git worktree list`.
15#[derive(Debug, Clone)]
16pub struct WorktreeInfo {
17    pub path: PathBuf,
18    pub branch: Option<String>,
19}
20
21/// Generate a branch name for an issue: `oven/issue-{number}-{short_hex}`.
22fn branch_name(issue_number: u32) -> String {
23    let short_hex = &uuid::Uuid::new_v4().to_string()[..8];
24    format!("oven/issue-{issue_number}-{short_hex}")
25}
26
27/// Create a worktree for the given issue, branching from `base_branch`.
28pub async fn create_worktree(
29    repo_dir: &Path,
30    issue_number: u32,
31    base_branch: &str,
32) -> Result<Worktree> {
33    let branch = branch_name(issue_number);
34    let worktree_path =
35        repo_dir.join(".oven").join("worktrees").join(format!("issue-{issue_number}"));
36
37    // Ensure parent directory exists
38    if let Some(parent) = worktree_path.parent() {
39        tokio::fs::create_dir_all(parent).await.context("creating worktree parent directory")?;
40    }
41
42    run_git(
43        repo_dir,
44        &["worktree", "add", "-b", &branch, &worktree_path.to_string_lossy(), base_branch],
45    )
46    .await
47    .context("creating worktree")?;
48
49    Ok(Worktree { path: worktree_path, branch, issue_number })
50}
51
52/// Remove a worktree by path.
53pub async fn remove_worktree(repo_dir: &Path, worktree_path: &Path) -> Result<()> {
54    run_git(repo_dir, &["worktree", "remove", "--force", &worktree_path.to_string_lossy()])
55        .await
56        .context("removing worktree")?;
57    Ok(())
58}
59
60/// List all worktrees in the repository.
61pub async fn list_worktrees(repo_dir: &Path) -> Result<Vec<WorktreeInfo>> {
62    let output = run_git(repo_dir, &["worktree", "list", "--porcelain"])
63        .await
64        .context("listing worktrees")?;
65
66    let mut worktrees = Vec::new();
67    let mut current_path: Option<PathBuf> = None;
68    let mut current_branch: Option<String> = None;
69
70    for line in output.lines() {
71        if let Some(path_str) = line.strip_prefix("worktree ") {
72            // Save previous worktree if we have one
73            if let Some(path) = current_path.take() {
74                worktrees.push(WorktreeInfo { path, branch: current_branch.take() });
75            }
76            current_path = Some(PathBuf::from(path_str));
77        } else if let Some(branch_ref) = line.strip_prefix("branch ") {
78            // Extract branch name from refs/heads/...
79            current_branch =
80                Some(branch_ref.strip_prefix("refs/heads/").unwrap_or(branch_ref).to_string());
81        }
82    }
83
84    // Don't forget the last one
85    if let Some(path) = current_path {
86        worktrees.push(WorktreeInfo { path, branch: current_branch });
87    }
88
89    Ok(worktrees)
90}
91
92/// Prune stale worktrees and return the count pruned.
93pub async fn clean_worktrees(repo_dir: &Path) -> Result<u32> {
94    let before = list_worktrees(repo_dir).await?;
95    run_git(repo_dir, &["worktree", "prune"]).await.context("pruning worktrees")?;
96    let after = list_worktrees(repo_dir).await?;
97
98    let pruned = if before.len() > after.len() { before.len() - after.len() } else { 0 };
99    Ok(u32::try_from(pruned).unwrap_or(u32::MAX))
100}
101
102/// Delete a local branch.
103pub async fn delete_branch(repo_dir: &Path, branch: &str) -> Result<()> {
104    run_git(repo_dir, &["branch", "-D", branch]).await.context("deleting branch")?;
105    Ok(())
106}
107
108/// List merged branches matching `oven/*`.
109pub async fn list_merged_branches(repo_dir: &Path, base: &str) -> Result<Vec<String>> {
110    let output = run_git(repo_dir, &["branch", "--merged", base])
111        .await
112        .context("listing merged branches")?;
113
114    let branches = output
115        .lines()
116        .map(|l| l.trim().trim_start_matches("* ").to_string())
117        .filter(|b| b.starts_with("oven/"))
118        .collect();
119
120    Ok(branches)
121}
122
123/// Create an empty commit (used to seed a branch before PR creation).
124pub async fn empty_commit(repo_dir: &Path, message: &str) -> Result<()> {
125    run_git(repo_dir, &["commit", "--allow-empty", "-m", message])
126        .await
127        .context("creating empty commit")?;
128    Ok(())
129}
130
131/// Push a branch to origin.
132pub async fn push_branch(repo_dir: &Path, branch: &str) -> Result<()> {
133    run_git(repo_dir, &["push", "origin", branch]).await.context("pushing branch")?;
134    Ok(())
135}
136
137/// Force-push a branch to origin using `--force-with-lease` for safety.
138///
139/// Used after rebasing a pipeline branch onto the updated base branch.
140pub async fn force_push_branch(repo_dir: &Path, branch: &str) -> Result<()> {
141    run_git(repo_dir, &["push", "--force-with-lease", "origin", branch])
142        .await
143        .context("force-pushing branch")?;
144    Ok(())
145}
146
147/// Rebase the current branch onto the latest `origin/<base_branch>`.
148///
149/// Fetches the base branch first, then attempts a rebase. If the rebase fails
150/// (merge conflicts), it aborts the rebase and returns an error.
151pub async fn rebase_on_base(repo_dir: &Path, base_branch: &str) -> Result<()> {
152    run_git(repo_dir, &["fetch", "origin", base_branch])
153        .await
154        .context("fetching base branch before rebase")?;
155
156    let target = format!("origin/{base_branch}");
157    if run_git(repo_dir, &["rebase", &target]).await.is_ok() {
158        return Ok(());
159    }
160
161    let _ = run_git(repo_dir, &["rebase", "--abort"]).await;
162    anyhow::bail!("merge conflicts with {base_branch} that could not be automatically resolved")
163}
164
165/// Get the default branch name (main or master).
166pub async fn default_branch(repo_dir: &Path) -> Result<String> {
167    // Try symbolic-ref first
168    if let Ok(output) = run_git(repo_dir, &["symbolic-ref", "refs/remotes/origin/HEAD"]).await {
169        if let Some(branch) = output.strip_prefix("refs/remotes/origin/") {
170            return Ok(branch.to_string());
171        }
172    }
173
174    // Fallback: check if main exists, otherwise master
175    if run_git(repo_dir, &["rev-parse", "--verify", "main"]).await.is_ok() {
176        return Ok("main".to_string());
177    }
178    if run_git(repo_dir, &["rev-parse", "--verify", "master"]).await.is_ok() {
179        return Ok("master".to_string());
180    }
181
182    // Last resort: whatever HEAD points to
183    let output = run_git(repo_dir, &["rev-parse", "--abbrev-ref", "HEAD"])
184        .await
185        .context("detecting default branch")?;
186    Ok(output)
187}
188
189async fn run_git(repo_dir: &Path, args: &[&str]) -> Result<String> {
190    let output = Command::new("git")
191        .args(args)
192        .current_dir(repo_dir)
193        .kill_on_drop(true)
194        .output()
195        .await
196        .context("spawning git")?;
197
198    if !output.status.success() {
199        let stderr = String::from_utf8_lossy(&output.stderr);
200        anyhow::bail!("git {} failed: {}", args.join(" "), stderr.trim());
201    }
202
203    Ok(String::from_utf8_lossy(&output.stdout).trim().to_string())
204}
205
206#[cfg(test)]
207mod tests {
208    use super::*;
209
210    async fn init_temp_repo() -> tempfile::TempDir {
211        let dir = tempfile::tempdir().unwrap();
212
213        // Init a repo with an initial commit so we have a branch to work from
214        Command::new("git").args(["init"]).current_dir(dir.path()).output().await.unwrap();
215
216        Command::new("git")
217            .args(["config", "user.email", "test@test.com"])
218            .current_dir(dir.path())
219            .output()
220            .await
221            .unwrap();
222
223        Command::new("git")
224            .args(["config", "user.name", "Test"])
225            .current_dir(dir.path())
226            .output()
227            .await
228            .unwrap();
229
230        tokio::fs::write(dir.path().join("README.md"), "hello").await.unwrap();
231
232        Command::new("git").args(["add", "."]).current_dir(dir.path()).output().await.unwrap();
233
234        Command::new("git")
235            .args(["commit", "-m", "initial"])
236            .current_dir(dir.path())
237            .output()
238            .await
239            .unwrap();
240
241        dir
242    }
243
244    #[tokio::test]
245    async fn create_and_remove_worktree() {
246        let dir = init_temp_repo().await;
247
248        // Detect the current branch name
249        let branch = run_git(dir.path(), &["rev-parse", "--abbrev-ref", "HEAD"]).await.unwrap();
250
251        let wt = create_worktree(dir.path(), 42, &branch).await.unwrap();
252        assert!(wt.path.exists());
253        assert!(wt.branch.starts_with("oven/issue-42-"));
254        assert_eq!(wt.issue_number, 42);
255
256        remove_worktree(dir.path(), &wt.path).await.unwrap();
257        assert!(!wt.path.exists());
258    }
259
260    #[tokio::test]
261    async fn list_worktrees_includes_created() {
262        let dir = init_temp_repo().await;
263        let branch = run_git(dir.path(), &["rev-parse", "--abbrev-ref", "HEAD"]).await.unwrap();
264
265        let _wt = create_worktree(dir.path(), 99, &branch).await.unwrap();
266
267        let worktrees = list_worktrees(dir.path()).await.unwrap();
268        // Should have at least the main worktree + the one we created
269        assert!(worktrees.len() >= 2);
270        assert!(
271            worktrees
272                .iter()
273                .any(|w| { w.branch.as_deref().is_some_and(|b| b.starts_with("oven/issue-99-")) })
274        );
275    }
276
277    #[tokio::test]
278    async fn branch_naming_convention() {
279        let name = branch_name(123);
280        assert!(name.starts_with("oven/issue-123-"));
281        assert_eq!(name.len(), "oven/issue-123-".len() + 8);
282        // The hex part should be valid hex
283        let hex_part = &name["oven/issue-123-".len()..];
284        assert!(hex_part.chars().all(|c| c.is_ascii_hexdigit()));
285    }
286
287    #[tokio::test]
288    async fn default_branch_detection() {
289        let dir = init_temp_repo().await;
290        let branch = default_branch(dir.path()).await.unwrap();
291        // git init creates "main" or "master" depending on config
292        assert!(branch == "main" || branch == "master", "got: {branch}");
293    }
294
295    #[tokio::test]
296    async fn error_on_non_git_dir() {
297        let dir = tempfile::tempdir().unwrap();
298        let result = list_worktrees(dir.path()).await;
299        assert!(result.is_err());
300    }
301
302    #[tokio::test]
303    async fn rebase_on_base_clean() {
304        let dir = init_temp_repo().await;
305        let branch = run_git(dir.path(), &["rev-parse", "--abbrev-ref", "HEAD"]).await.unwrap();
306
307        // Create a feature branch with a non-conflicting change
308        run_git(dir.path(), &["checkout", "-b", "feature"]).await.unwrap();
309        tokio::fs::write(dir.path().join("feature.txt"), "feature work").await.unwrap();
310        run_git(dir.path(), &["add", "."]).await.unwrap();
311        run_git(dir.path(), &["commit", "-m", "feature commit"]).await.unwrap();
312
313        // Add a non-conflicting commit on the base branch
314        run_git(dir.path(), &["checkout", &branch]).await.unwrap();
315        tokio::fs::write(dir.path().join("base.txt"), "base work").await.unwrap();
316        run_git(dir.path(), &["add", "."]).await.unwrap();
317        run_git(dir.path(), &["commit", "-m", "base commit"]).await.unwrap();
318
319        // Go back to feature branch and rebase
320        run_git(dir.path(), &["checkout", "feature"]).await.unwrap();
321
322        // rebase_on_base fetches from origin, so we need a remote.
323        // Use the repo itself as origin for testing.
324        run_git(dir.path(), &["remote", "add", "origin", &dir.path().to_string_lossy()])
325            .await
326            .unwrap();
327
328        let result = rebase_on_base(dir.path(), &branch).await;
329        assert!(result.is_ok());
330
331        // Verify both files exist after rebase
332        assert!(dir.path().join("feature.txt").exists());
333        assert!(dir.path().join("base.txt").exists());
334    }
335
336    #[tokio::test]
337    async fn rebase_on_base_conflict_aborts() {
338        let dir = init_temp_repo().await;
339        let branch = run_git(dir.path(), &["rev-parse", "--abbrev-ref", "HEAD"]).await.unwrap();
340
341        // Create a feature branch with a conflicting change to README.md
342        run_git(dir.path(), &["checkout", "-b", "feature"]).await.unwrap();
343        tokio::fs::write(dir.path().join("README.md"), "feature version").await.unwrap();
344        run_git(dir.path(), &["add", "."]).await.unwrap();
345        run_git(dir.path(), &["commit", "-m", "feature conflict"]).await.unwrap();
346
347        // Add a conflicting commit on the base branch
348        run_git(dir.path(), &["checkout", &branch]).await.unwrap();
349        tokio::fs::write(dir.path().join("README.md"), "base version").await.unwrap();
350        run_git(dir.path(), &["add", "."]).await.unwrap();
351        run_git(dir.path(), &["commit", "-m", "base conflict"]).await.unwrap();
352
353        // Go back to feature and set up origin
354        run_git(dir.path(), &["checkout", "feature"]).await.unwrap();
355        run_git(dir.path(), &["remote", "add", "origin", &dir.path().to_string_lossy()])
356            .await
357            .unwrap();
358
359        let result = rebase_on_base(dir.path(), &branch).await;
360        assert!(result.is_err());
361        assert!(
362            result.unwrap_err().to_string().contains("merge conflicts"),
363            "error should mention merge conflicts"
364        );
365
366        // Verify rebase was aborted (no .git/rebase-merge directory)
367        assert!(!dir.path().join(".git/rebase-merge").exists());
368    }
369
370    #[tokio::test]
371    async fn force_push_branch_works() {
372        let dir = init_temp_repo().await;
373
374        // Set up a bare remote to push to
375        let remote_dir = tempfile::tempdir().unwrap();
376        Command::new("git")
377            .args(["clone", "--bare", &dir.path().to_string_lossy(), "."])
378            .current_dir(remote_dir.path())
379            .output()
380            .await
381            .unwrap();
382
383        run_git(dir.path(), &["remote", "add", "origin", &remote_dir.path().to_string_lossy()])
384            .await
385            .unwrap();
386
387        // Create a branch, push it, then amend and force-push
388        run_git(dir.path(), &["checkout", "-b", "test-branch"]).await.unwrap();
389        tokio::fs::write(dir.path().join("new.txt"), "v1").await.unwrap();
390        run_git(dir.path(), &["add", "."]).await.unwrap();
391        run_git(dir.path(), &["commit", "-m", "v1"]).await.unwrap();
392        push_branch(dir.path(), "test-branch").await.unwrap();
393
394        // Amend the commit (simulating a rebase)
395        tokio::fs::write(dir.path().join("new.txt"), "v2").await.unwrap();
396        run_git(dir.path(), &["add", "."]).await.unwrap();
397        run_git(dir.path(), &["commit", "--amend", "-m", "v2"]).await.unwrap();
398
399        // Regular push should fail, force push should succeed
400        assert!(push_branch(dir.path(), "test-branch").await.is_err());
401        assert!(force_push_branch(dir.path(), "test-branch").await.is_ok());
402    }
403}