git-bonsai 0.3.0

/*
 * Copyright 2021 Aurélien Gâteau <mail@agateau.com>
 *
 * This file is part of git-bonsai.
 *
 * Git-bonsai is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#[cfg(test)]
mod integ {
    extern crate assert_fs;
    extern crate claim;
    extern crate git_bonsai;

    use std::collections::HashSet;
    use std::fs::File;
    use structopt::StructOpt;

    use assert_fs::prelude::*;
    use claim::*;
    use predicates::prelude::*;

    use git_bonsai::app::{self, App, AppError, DEFAULT_BRANCH_CONFIG_KEY};
    use git_bonsai::batchappui::BatchAppUi;
    use git_bonsai::cliargs::CliArgs;
    use git_bonsai::git::create_test_repository;
    use git_bonsai::git::Repository;

    fn create_repository() -> (assert_fs::TempDir, Repository) {
        let dir = assert_fs::TempDir::new().unwrap();
        let repo = create_test_repository(dir.path());
        repo.set_config_key(DEFAULT_BRANCH_CONFIG_KEY, "master")
            .unwrap();
        (dir, repo)
    }

    fn clone_repository(url: &str) -> (assert_fs::TempDir, Repository) {
        let dir = assert_fs::TempDir::new().unwrap();
        let repo = Repository::clone(dir.path(), &url).unwrap();
        (dir, repo)
    }

    fn create_branch(repo: &Repository, name: &str) {
        repo.git("checkout", &["-b", name]).unwrap();
        create_and_commit_file(&repo, name);
    }

    fn create_and_commit_file(repo: &Repository, name: &str) {
        File::create(repo.path.join(name)).unwrap();
        repo.git("add", &[name]).unwrap();
        repo.git("commit", &["-m", &format!("Create file {}", name)])
            .unwrap();
    }

    fn merge_branch(repo: &Repository, name: &str) {
        repo.git("merge", &["--no-ff", name, "-m", "Merging branch"])
            .unwrap();
    }

    fn run_git_bonsai(cwd: &str, argv: &[&str]) -> i32 {
        let mut full_argv = vec!["git-bonsai"];
        full_argv.extend(argv);
        let args = CliArgs::from_iter(full_argv);
        app::run(args, &cwd)
    }

    fn create_app(cwd: &str, argv: &[&str]) -> App {
        let mut full_argv = vec!["git-bonsai"];
        full_argv.extend(argv);
        let ui = Box::new(BatchAppUi {});
        let args = CliArgs::from_iter(full_argv);
        App::new(&args, ui, &cwd)
    }

    macro_rules! assert_branches_eq {
        ($repo:expr, $expected_branches:expr) => {
            let branches = $repo.list_branches().unwrap();
            assert_eq!(branches, $expected_branches);
        };
    }

    #[test]
    fn no_op() {
        // GIVEN a repository with a single branch
        let (dir, _repo) = create_repository();
        let path_str = dir.path().to_str().unwrap();

        // WHEN git-bonsai runs
        let result = run_git_bonsai(&path_str, &["-y"]);

        // THEN it succeeds
        assert_eq!(result, 0);
    }

    #[test]
    fn delete_merged_branch() {
        // GIVEN a repository with two topic branches, topic1 and topic2
        let (dir, repo) = create_repository();
        let path_str = dir.path().to_str().unwrap();
        create_branch(&repo, "topic1");
        create_branch(&repo, "topic2");
        // AND topic1 has been merged in master
        repo.checkout("master").unwrap();
        merge_branch(&repo, "topic1");

        assert_branches_eq!(&repo, &["master", "topic1", "topic2"]);

        // WHEN git-bonsai runs
        {
            let app = create_app(&path_str, &[]);
            assert_ok!(app.remove_merged_branches());
        }

        // THEN only the topic1 branch has been removed
        assert_branches_eq!(&repo, &["master", "topic2"]);
    }

    #[test]
    fn skip_protected_branch() {
        // GIVEN a repository with a protected, merged branch: "protected"
        let (dir, repo) = create_repository();
        let path_str = dir.path().to_str().unwrap();
        create_branch(&repo, "protected");
        repo.checkout("master").unwrap();
        merge_branch(&repo, "protected");

        assert_branches_eq!(&repo, &["master", "protected"]);

        // WHEN git-bonsai runs with "-x protected"
        {
            let app = create_app(&path_str, &["-x", "protected"]);
            assert_ok!(app.remove_merged_branches());
        }

        // THEN the protected branch is still there
        assert_branches_eq!(&repo, &["master", "protected"]);

        // WHEN git-bonsai runs without "-x protected"
        {
            let app = create_app(&path_str, &[]);
            assert_ok!(app.remove_merged_branches());
        }

        // THEN the protected branch is gone
        assert_branches_eq!(&repo, &["master"]);
    }

    #[test]
    fn update_branch() {
        // GIVEN a source repository
        let (source_dir, source_repo) = create_repository();

        // AND a clone of it
        let (clone_dir, _clone_repo) = clone_repository(source_dir.path().to_str().unwrap());
        let clone_dir_str = clone_dir.path().to_str().unwrap();

        // AND a new commit in the source repository
        create_and_commit_file(&source_repo, "new");

        // WHEN git-bonsai runs in the clone
        let result = run_git_bonsai(&clone_dir_str, &["-y"]);
        assert_eq!(result, 0);

        // THEN the clone repository now contains the new commit
        clone_dir.child("new").assert(predicate::path::exists());
    }

    #[test]
    fn identical_sha1_no_other_branch() {
        // GIVEN a repository with three branches pointing to the same sha1, contained in no other
        // branch
        let (dir, repo) = create_repository();
        let path_str = dir.path().to_str().unwrap();
        create_branch(&repo, "topic1");
        repo.git("branch", &["topic2", "topic1"]).unwrap();
        repo.git("branch", &["topic3", "topic1"]).unwrap();

        // WHEN git-bonsai runs
        let app = create_app(&path_str, &[]);
        assert_ok!(app.delete_identical_branches());

        // THEN only the first topic branch remains
        assert_branches_eq!(&repo, &["master", "topic1"]);
    }

    #[test]
    fn identical_sha1_contained_in_master() {
        // GIVEN a repository with two branches pointing to the same sha1, contained in the master
        // branch
        let (dir, repo) = create_repository();
        let path_str = dir.path().to_str().unwrap();
        repo.git("branch", &["topic1"]).unwrap();
        repo.git("branch", &["topic2"]).unwrap();

        // WHEN git-bonsai runs
        let app = create_app(&path_str, &[]);
        assert_ok!(app.delete_identical_branches());

        // THEN only the master branch remains
        assert_branches_eq!(&repo, &["master"]);
    }

    #[test]
    fn skip_worktree_branches() {
        // GIVEN a source repository with two branches
        let (source_dir, source_repo) = create_repository();
        create_branch(&source_repo, "topic1");
        source_repo.checkout("master").unwrap();

        // AND a clone of this repository
        let (clone_dir, clone_repo) = clone_repository(source_dir.path().to_str().unwrap());
        let clone_path_str = clone_dir.path().to_str().unwrap();

        // with the topic1 branch checked-out in a separate worktree
        let worktree_dir = assert_fs::TempDir::new().unwrap();
        let worktree_path_str = worktree_dir.path().to_str().unwrap();
        clone_repo
            .git("worktree", &["add", worktree_path_str, "topic1"])
            .unwrap();

        let worktree_repo = Repository::new(worktree_dir.path());
        worktree_repo.checkout("topic1").unwrap();

        // WHEN git-bonsai updates the branches of the clone
        // THEN it does not fail
        let app = create_app(&clone_path_str, &[]);
        assert_ok!(app.update_tracking_branches());
    }

    #[test]
    fn safe_delete_branch() {
        // GIVEN a repository with a test branch equals to master
        let (dir, repo) = create_repository();
        repo.git("branch", &["test"]).unwrap();
        repo.checkout("master").unwrap();

        // WHEN I call safe_delete_branch
        let app = create_app(&dir.path().to_str().unwrap(), &[]);
        let result = app.safe_delete_branch("test");

        // THEN it succeeds
        assert_eq!(result, Ok(()));

        // AND only the master branch remains
        assert_eq!(repo.list_branches().unwrap(), &["master"]);
    }

    #[test]
    fn cant_delete_unique_branch() {
        // GIVEN a repository with a test branch containing unique content
        let (dir, repo) = create_repository();
        create_branch(&repo, "test");
        repo.checkout("master").unwrap();

        // WHEN I call safe_delete_branch
        let app = create_app(&dir.path().to_str().unwrap(), &[]);
        let result = app.safe_delete_branch("test");

        // THEN it fails
        assert_eq!(result, Err(AppError::UnsafeDelete));

        // AND the test branch still exists
        assert_eq!(repo.list_branches().unwrap(), &["master", "test"]);
    }

    #[test]
    fn test_protected_branches_from_git_config() {
        // GIVEN a repository with protected branches declared in git-config
        let (dir, repo) = create_repository();
        create_branch(&repo, "test");
        repo.checkout("master").unwrap();
        repo.git(
            "config",
            &["--add", "git-bonsai.protected-branches", "custom1"],
        )
        .unwrap();
        repo.git(
            "config",
            &["--add", "git-bonsai.protected-branches", "custom2"],
        )
        .unwrap();

        // WHEN app is instantiated
        let mut app = create_app(&dir.path().to_str().unwrap(), &[]);
        app.add_default_branch_to_protected_branches().unwrap();

        // THEN app.protected_branches contains all protected branches
        let expected_branches: HashSet<String> = ["custom1", "custom2", "master"]
            .iter()
            .map(|x| x.to_string())
            .collect();
        assert_eq!(app.get_protected_branches(), expected_branches);
    }
}