gnostr_asyncgit/sync/remotes/

push.rs

use crossbeam_channel::Sender;
use git2::{PackBuilderStage, PushOptions};
use scopetime::scope_time;

use crate::{
    error::{Error, Result},
    progress::ProgressPercent,
    sync::{
        branch::branch_set_upstream_after_push,
        cred::BasicAuthCredential,
        remotes::{proxy_auto, Callbacks},
        repository::repo,
        CommitId, RepoPath,
    },
};

///
pub trait AsyncProgress: Clone + Send + Sync {
    ///
    fn is_done(&self) -> bool;
    ///
    fn progress(&self) -> ProgressPercent;
}

///
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ProgressNotification {
    ///
    UpdateTips {
        ///
        name: String,
        ///
        a: CommitId,
        ///
        b: CommitId,
    },
    ///
    Transfer {
        ///
        objects: usize,
        ///
        total_objects: usize,
    },
    ///
    PushTransfer {
        ///
        current: usize,
        ///
        total: usize,
        ///
        bytes: usize,
    },
    ///
    Packing {
        ///
        stage: PackBuilderStage,
        ///
        total: usize,
        ///
        current: usize,
    },
    ///
    Done,
}

impl AsyncProgress for ProgressNotification {
    fn is_done(&self) -> bool {
        *self == Self::Done
    }
    fn progress(&self) -> ProgressPercent {
        match *self {
            Self::Packing {
                stage,
                current,
                total,
            } => match stage {
                PackBuilderStage::AddingObjects | PackBuilderStage::Deltafication => {
                    ProgressPercent::new(current, total)
                }
            },
            Self::PushTransfer { current, total, .. } => ProgressPercent::new(current, total),
            Self::Transfer {
                objects,
                total_objects,
                ..
            } => ProgressPercent::new(objects, total_objects),
            _ => ProgressPercent::full(),
        }
    }
}

///
#[derive(Copy, Clone, Debug)]
pub enum PushType {
    ///
    Branch,
    ///
    Tag,
}

impl Default for PushType {
    fn default() -> Self {
        Self::Branch
    }
}

#[cfg(test)]
pub fn push_branch(
    repo_path: &RepoPath,
    remote: &str,
    branch: &str,
    force: bool,
    delete: bool,
    basic_credential: Option<BasicAuthCredential>,
    progress_sender: Option<Sender<ProgressNotification>>,
) -> Result<()> {
    push_raw(
        repo_path,
        remote,
        branch,
        PushType::Branch,
        force,
        delete,
        basic_credential,
        progress_sender,
    )
}

//TODO: clenaup
#[allow(clippy::too_many_arguments)]
pub fn push_raw(
    repo_path: &RepoPath,
    remote: &str,
    branch: &str,
    ref_type: PushType,
    force: bool,
    delete: bool,
    basic_credential: Option<BasicAuthCredential>,
    progress_sender: Option<Sender<ProgressNotification>>,
) -> Result<()> {
    scope_time!("push");

    let repo = repo(repo_path)?;
    let mut remote = repo.find_remote(remote)?;

    let mut options = PushOptions::new();
    options.proxy_options(proxy_auto());

    let callbacks = Callbacks::new(progress_sender, basic_credential);
    options.remote_callbacks(callbacks.callbacks());
    options.packbuilder_parallelism(0);

    let branch_modifier = match (force, delete) {
        (true, true) => "+:",
        (false, true) => ":",
        (true, false) => "+",
        (false, false) => "",
    };
    let ref_type = match ref_type {
        PushType::Branch => "heads",
        PushType::Tag => "tags",
    };

    let branch_name = format!("{branch_modifier}refs/{ref_type}/{branch}");
    remote.push(&[branch_name.as_str()], Some(&mut options))?;

    if let Some((reference, msg)) = callbacks.get_stats()?.push_rejected_msg {
        return Err(Error::Generic(format!(
            "push to '{reference}' rejected: {msg}"
        )));
    }

    if !delete {
        branch_set_upstream_after_push(&repo, branch)?;
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use std::{fs::File, io::Write, path::Path};

    use git2::Repository;

    use super::*;
    use crate::sync::{
        self,
        tests::{get_commit_ids, repo_clone, repo_init, repo_init_bare, write_commit_file},
    };

    #[test]
    fn test_force_push() {
        // This test mimics the scenario of 2 people having 2
        // local branches and both modifying the same file then
        // both pushing, sequentially
        let (tmp_repo_dir, repo) = repo_init().unwrap();
        let (tmp_other_repo_dir, other_repo) = repo_init().unwrap();
        let (tmp_upstream_dir, _) = repo_init_bare().unwrap();

        repo.remote("origin", tmp_upstream_dir.path().to_str().unwrap())
            .unwrap();

        other_repo
            .remote("origin", tmp_upstream_dir.path().to_str().unwrap())
            .unwrap();

        let tmp_repo_file_path = tmp_repo_dir.path().join("temp_file.txt");
        let mut tmp_repo_file = File::create(tmp_repo_file_path).unwrap();
        writeln!(tmp_repo_file, "TempSomething").unwrap();

        sync::commit(
            &tmp_repo_dir.path().to_str().unwrap().into(),
            "repo_1_commit",
        )
        .unwrap();

        push_branch(
            &tmp_repo_dir.path().to_str().unwrap().into(),
            "origin",
            "master",
            false,
            false,
            None,
            None,
        )
        .unwrap();

        let tmp_other_repo_file_path = tmp_other_repo_dir.path().join("temp_file.txt");
        let mut tmp_other_repo_file = File::create(tmp_other_repo_file_path).unwrap();
        writeln!(tmp_other_repo_file, "TempElse").unwrap();

        sync::commit(
            &tmp_other_repo_dir.path().to_str().unwrap().into(),
            "repo_2_commit",
        )
        .unwrap();

        // Attempt a normal push,
        // should fail as branches diverged
        assert_eq!(
            push_branch(
                &tmp_other_repo_dir.path().to_str().unwrap().into(),
                "origin",
                "master",
                false,
                false,
                None,
                None,
            )
            .is_err(),
            true
        );

        // Attempt force push,
        // should work as it forces the push through
        assert_eq!(
            push_branch(
                &tmp_other_repo_dir.path().to_str().unwrap().into(),
                "origin",
                "master",
                true,
                false,
                None,
                None,
            )
            .is_err(),
            false
        );
    }

    #[test]
    fn test_force_push_rewrites_history() {
        // This test mimics the scenario of 2 people having 2
        // local branches and both modifying the same file then
        // both pushing, sequentially

        let (tmp_repo_dir, repo) = repo_init().unwrap();
        let (tmp_other_repo_dir, other_repo) = repo_init().unwrap();
        let (tmp_upstream_dir, upstream) = repo_init_bare().unwrap();

        repo.remote("origin", tmp_upstream_dir.path().to_str().unwrap())
            .unwrap();

        other_repo
            .remote("origin", tmp_upstream_dir.path().to_str().unwrap())
            .unwrap();

        let tmp_repo_file_path = tmp_repo_dir.path().join("temp_file.txt");
        let mut tmp_repo_file = File::create(tmp_repo_file_path).unwrap();
        writeln!(tmp_repo_file, "TempSomething").unwrap();

        sync::stage_add_file(
            &tmp_repo_dir.path().to_str().unwrap().into(),
            Path::new("temp_file.txt"),
        )
        .unwrap();

        let repo_1_commit = sync::commit(
            &tmp_repo_dir.path().to_str().unwrap().into(),
            "repo_1_commit",
        )
        .unwrap();

        //NOTE: make sure the commit actually contains that file
        assert_eq!(
            sync::get_commit_files(
                &tmp_repo_dir.path().to_str().unwrap().into(),
                repo_1_commit,
                None
            )
            .unwrap()[0]
                .path,
            String::from("temp_file.txt")
        );

        let commits = get_commit_ids(&repo, 1);
        assert!(commits.contains(&repo_1_commit));

        push_branch(
            &tmp_repo_dir.path().to_str().unwrap().into(),
            "origin",
            "master",
            false,
            false,
            None,
            None,
        )
        .unwrap();

        let tmp_other_repo_file_path = tmp_other_repo_dir.path().join("temp_file.txt");
        let mut tmp_other_repo_file = File::create(tmp_other_repo_file_path).unwrap();
        writeln!(tmp_other_repo_file, "TempElse").unwrap();

        sync::stage_add_file(
            &tmp_other_repo_dir.path().to_str().unwrap().into(),
            Path::new("temp_file.txt"),
        )
        .unwrap();

        let repo_2_commit = sync::commit(
            &tmp_other_repo_dir.path().to_str().unwrap().into(),
            "repo_2_commit",
        )
        .unwrap();

        let repo_2_parent = other_repo
            .find_commit(repo_2_commit.into())
            .unwrap()
            .parents()
            .next()
            .unwrap()
            .id();

        let commits = get_commit_ids(&other_repo, 1);
        assert!(commits.contains(&repo_2_commit));

        // Attempt a normal push,
        // should fail as branches diverged
        assert_eq!(
            push_branch(
                &tmp_other_repo_dir.path().to_str().unwrap().into(),
                "origin",
                "master",
                false,
                false,
                None,
                None,
            )
            .is_err(),
            true
        );

        // Check that the other commit is not in upstream,
        // a normal push would not rewrite history
        let commits = get_commit_ids(&upstream, 1);
        assert!(!commits.contains(&repo_2_commit));

        // Attempt force push,
        // should work as it forces the push through

        push_branch(
            &tmp_other_repo_dir.path().to_str().unwrap().into(),
            "origin",
            "master",
            true,
            false,
            None,
            None,
        )
        .unwrap();

        let commits = get_commit_ids(&upstream, 1);
        assert!(commits.contains(&repo_2_commit));

        let new_upstream_parent = Repository::init_bare(tmp_upstream_dir.path())
            .unwrap()
            .find_commit(repo_2_commit.into())
            .unwrap()
            .parents()
            .next()
            .unwrap()
            .id();
        assert_eq!(new_upstream_parent, repo_2_parent,);
    }

    #[test]
    fn test_delete_remote_branch() {
        // This test mimics the scenario of a user creating a branch,
        // push it, and then remove it on the remote

        let (upstream_dir, upstream_repo) = repo_init_bare().unwrap();

        let (tmp_repo_dir, repo) = repo_clone(upstream_dir.path().to_str().unwrap()).unwrap();

        // You need a commit before being able to branch !
        let commit_1 = write_commit_file(&repo, "temp_file.txt", "SomeContent", "Initial commit");

        let commits = get_commit_ids(&repo, 1);
        assert!(commits.contains(&commit_1));

        push_branch(
            &tmp_repo_dir.path().to_str().unwrap().into(),
            "origin",
            "master",
            false,
            false,
            None,
            None,
        )
        .unwrap();

        // Create the local branch
        sync::create_branch(&tmp_repo_dir.path().to_str().unwrap().into(), "test_branch").unwrap();

        // Push the local branch
        push_branch(
            &tmp_repo_dir.path().to_str().unwrap().into(),
            "origin",
            "test_branch",
            false,
            false,
            None,
            None,
        )
        .unwrap();

        // Test if the branch exits on the remote
        assert_eq!(
            upstream_repo
                .branches(None)
                .unwrap()
                .map(std::result::Result::unwrap)
                .map(|(i, _)| i.name().unwrap().unwrap().to_string())
                .any(|i| &i == "test_branch"),
            true
        );

        // Delete the remote branch
        assert_eq!(
            push_branch(
                &tmp_repo_dir.path().to_str().unwrap().into(),
                "origin",
                "test_branch",
                false,
                true,
                None,
                None,
            )
            .is_ok(),
            true
        );

        // Test that the branch has be remove from the remote
        assert_eq!(
            upstream_repo
                .branches(None)
                .unwrap()
                .map(std::result::Result::unwrap)
                .map(|(i, _)| i.name().unwrap().unwrap().to_string())
                .any(|i| &i == "test_branch"),
            false
        );
    }
}