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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

#[cfg(test)]
mod utils;

#[cfg(test)]
mod finish_tests {
    use crate::utils::git_command::GitCommand;
    use crate::utils::treeflow_command::TreeflowCommand;
    use std::fs;
    use std::path::PathBuf;
    use tempdir::TempDir;
    use treeflow::utils::Return;

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

    fn setup_config(config_dir_buf: &PathBuf, repository_dir_buf: &PathBuf, worktrees_dir_buf: &PathBuf) {
        TreeflowCommand::new(config_dir_buf.clone())
            .project_add(&repository_dir_buf, Some(&worktrees_dir_buf))
            .current_dir(&repository_dir_buf)
            .cmd()
            .assert()
            .success();
    }

    #[test]
    fn finish_from_main_working_tree_fails() {
        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();

        setup_config(&config_dir_buf, &repository_dir_buf, &worktrees_dir_buf);
        GitCommand::init(&repository_dir_buf);

        // Run finish command from repository directory
        TreeflowCommand::new(config_dir_buf)
            .current_dir(&repository_dir_buf)
            .cmd()
            .arg("finish")
            .assert()
            .failure()
            .stderr(predicates::str::contains("main working tree"));
    }

    #[test]
    fn removes_worktree_and_navigates_to_primary() {
        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 worktree_dir = worktrees_dir_buf.join(TEST_BRANCH);

        setup_config(&config_dir_buf, &repository_dir_buf, &worktrees_dir_buf);
        GitCommand::init(&repository_dir_buf);

        // Create the actual worktree directory inside the worktrees parent directory
        GitCommand::create_worktree(&repository_dir_buf, TEST_BRANCH, &worktree_dir);

        // Verify worktree directory exists
        assert!(worktree_dir.exists(), "Worktree directory should exist before finish");

        // Run finish command
        TreeflowCommand::new(config_dir_buf)
            .current_dir(&worktree_dir)
            .cmd()
            .arg("finish")
            .assert()
            .success()
            .stdout(Return::Cd { path: repository_dir_buf.clone() }.print());

        assert!(!GitCommand::worktree_exists(&repository_dir_buf, &worktree_dir), "Worktree should be removed after finish");
        assert!(!worktree_dir.exists(), "Worktree directory should be removed after finish");
        assert!(!GitCommand::branch_exists(&repository_dir_buf, TEST_BRANCH), "Branch should be deleted after finish");
    }

    #[test]
    fn force_removes_worktree_and_navigates_to_primary() {
        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 worktree_dir = worktrees_dir_buf.join(TEST_BRANCH);

        setup_config(&config_dir_buf, &repository_dir_buf, &worktrees_dir_buf);
        GitCommand::init(&repository_dir_buf);

        // Create the actual worktree directory inside the worktrees parent directory
        GitCommand::create_worktree(&repository_dir_buf, TEST_BRANCH, &worktree_dir);

        // Create an untracked file in the worktree directory
        fs::write(worktree_dir.join("untracked_file.txt"), "This file is not tracked by Git, requires force to remove").expect("Failed to create untracked file");

        // Run finish command
        TreeflowCommand::new(config_dir_buf)
            .current_dir(&worktree_dir)
            .cmd()
            .args(["finish", "--force"])
            .assert()
            .success()
            .stdout(Return::Cd { path: repository_dir_buf.clone() }.print());

        assert!(!GitCommand::worktree_exists(&repository_dir_buf, &worktree_dir), "Worktree should be removed after finish");
        assert!(!worktree_dir.exists(), "Worktree directory should be removed after finish");
        assert!(!GitCommand::branch_exists(&repository_dir_buf, TEST_BRANCH), "Branch should be deleted after finish");
    }

    #[test]
    fn untracked_changes_without_force_fails() {
        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 worktree_dir = worktrees_dir_buf.join(TEST_BRANCH);

        setup_config(&config_dir_buf, &repository_dir_buf, &worktrees_dir_buf);
        GitCommand::init(&repository_dir_buf);

        // Create the actual worktree directory inside the worktrees parent directory
        GitCommand::create_worktree(&repository_dir_buf, TEST_BRANCH, &worktree_dir);

        // Create an untracked file in the worktree directory
        fs::write(worktree_dir.join("untracked_file.txt"), "This file is not tracked by Git, requires force to remove").expect("Failed to create untracked file");

        // Run finish command
        TreeflowCommand::new(config_dir_buf)
            .current_dir(&worktree_dir)
            .cmd()
            .arg("finish")
            .assert()
            .failure();

        assert!(GitCommand::worktree_exists(&repository_dir_buf, &worktree_dir), "Worktree should exist still after failed finish");
        assert!(worktree_dir.exists(), "Worktree directory should not be removed after failed finish");
        assert!(GitCommand::branch_exists(&repository_dir_buf, TEST_BRANCH), "Branch should not be deleted after failed finish");
    }
}