treeflow 0.2.1

CLI tool for simplified Git worktree management to speed up switching contexts when working collaboratively.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

#[cfg(test)]
mod utils;

#[cfg(test)]
mod review_tests {
    use std::fs;
    use tempdir::TempDir;
    use predicates::prelude::*;
    use treeflow::utils::Return;
    use crate::utils::git_command::GitCommand;
    use crate::utils::treeflow_command::TreeflowCommand;

    const TEST_BRANCH: &str = "feature/test";

    #[test]
    fn review_existing_branch_creates_worktree() {
        let config_dir = TempDir::new("config_dir").expect("should be able to create temp config dir");
        let repository_dir = TempDir::new("repository_dir").expect("should be able to create temp repository dir");
        let worktrees_dir = TempDir::new("worktrees_dir").expect("should be able to create temp worktrees dir");

        let config_dir_buf = config_dir.path().to_path_buf();
        let repository_dir_buf = repository_dir.path().to_path_buf();
        let worktrees_dir_buf = worktrees_dir.path().to_path_buf();

        GitCommand::init(&repository_dir_buf);
        GitCommand::create_branch(&repository_dir_buf, TEST_BRANCH);

        // Add project to config
        TreeflowCommand::new(config_dir_buf.clone())
            .project_add(&repository_dir_buf, Some(&worktrees_dir_buf))
            .current_dir(&repository_dir_buf)
            .cmd()
            .assert()
            .success();

        // Review an existing branch
        let expected_worktree_path = worktrees_dir_buf.join(TEST_BRANCH);

        TreeflowCommand::new(config_dir_buf)
            .current_dir(&repository_dir_buf)
            .review(TEST_BRANCH)
            .cmd()
            .assert()
            .success()
            .stdout(Return::Cd { path: expected_worktree_path }.print());
    }

    #[test]
    fn review_navigates_to_existing_worktree() {
        let config_dir = TempDir::new("config_dir").expect("should be able to create temp config dir");
        let repository_dir = TempDir::new("repository_dir").expect("should be able to create temp repository dir");
        let worktrees_dir = TempDir::new("worktrees_dir").expect("should be able to create temp worktrees dir");

        let config_dir_buf = config_dir.path().to_path_buf();
        let repository_dir_buf = repository_dir.path().to_path_buf();
        let worktrees_dir_buf = worktrees_dir.path().to_path_buf();

        let test_branch_worktree_dir_buf = &worktrees_dir_buf.join(TEST_BRANCH);

        GitCommand::init(&repository_dir_buf);
        GitCommand::create_worktree(&repository_dir_buf, TEST_BRANCH, test_branch_worktree_dir_buf);

        // Add project to config
        TreeflowCommand::new(config_dir_buf.clone())
            .project_add(&repository_dir_buf, Some(&worktrees_dir_buf))
            .current_dir(&repository_dir_buf)
            .cmd()
            .assert()
            .success();

        // Review should navigate to existing worktree
        TreeflowCommand::new(config_dir_buf)
            .current_dir(&repository_dir_buf)
            .review(TEST_BRANCH)
            .cmd()
            .assert()
            .success()
            .stdout(Return::Cd { path: test_branch_worktree_dir_buf.clone() }.print());
    }

    /// Tests that the review command fails gracefully when not in a project directory
    #[test]
    fn fails_when_not_in_project() {
        let config_dir = TempDir::new("config_dir").expect("should be able to create temp config dir");
        let outside_dir = TempDir::new("outside_dir").expect("should be able to create temp outside dir");

        let outside_dir_buf = outside_dir.path().to_path_buf();

        TreeflowCommand::new(config_dir.path().to_path_buf())
            .review(TEST_BRANCH)
            .current_dir(&outside_dir_buf)
            .cmd()
            .assert()
            .failure()
            .stderr(predicate::str::contains("not found").and(predicate::str::contains(outside_dir_buf.display().to_string())));
    }

    #[test]
    fn fails_when_worktree_dir_exists_but_is_not_valid() {
        let config_dir = TempDir::new("config_dir").expect("should be able to create temp config dir");
        let repository_dir = TempDir::new("repository_dir").expect("should be able to create temp repository dir");
        let worktrees_dir = TempDir::new("worktrees_dir").expect("should be able to create temp worktrees dir");

        let config_dir_buf = config_dir.path().to_path_buf();
        let repository_dir_buf = repository_dir.path().to_path_buf();
        let worktrees_dir_buf = worktrees_dir.path().to_path_buf();

        let expected_worktree_path = &worktrees_dir_buf.join(TEST_BRANCH);

        GitCommand::init(&repository_dir_buf);

        // Add project to config
        TreeflowCommand::new(config_dir_buf.clone())
            .project_add(&repository_dir_buf, Some(&worktrees_dir_buf))
            .current_dir(&repository_dir_buf)
            .cmd()
            .assert()
            .success();

        fs::create_dir_all(&expected_worktree_path).expect("Failed to create empty worktree directory");

        // Review command should succeed by removing the empty directory and creating a proper worktree
        TreeflowCommand::new(config_dir_buf)
            .current_dir(&repository_dir_buf)
            .review(TEST_BRANCH)
            .cmd()
            .assert()
            .failure()
            .stderr(predicate::str::contains(expected_worktree_path.to_str().expect("Conversion of worktree path failed")));
    }
}