silver_platter/

publish.rs

pub use crate::proposal::DescriptionFormat;
use crate::vcs::open_branch;
use crate::Mode;
use breezyshim::branch::MemoryBranch;

use breezyshim::error::Error as BrzError;
use breezyshim::merge::{MergeType, Merger};
use breezyshim::{Branch, Forge, MergeProposal, RevisionId, Transport};
use std::collections::HashMap;

fn _tag_selector_from_tags(
    tags: std::collections::HashMap<String, RevisionId>,
) -> impl Fn(String) -> bool {
    move |tag| tags.contains_key(tag.as_str())
}

pub fn push_derived_changes(
    local_branch: &dyn Branch,
    main_branch: &dyn Branch,
    forge: &Forge,
    name: &str,
    overwrite_existing: Option<bool>,
    owner: Option<&str>,
    tags: Option<std::collections::HashMap<String, RevisionId>>,
    stop_revision: Option<&RevisionId>,
) -> Result<(Box<dyn Branch>, url::Url), BrzError> {
    let tags = tags.unwrap_or_default();
    let (remote_branch, public_branch_url) = forge.publish_derived(
        local_branch,
        main_branch,
        name,
        overwrite_existing,
        owner,
        stop_revision,
        Some(Box::new(_tag_selector_from_tags(tags))),
    )?;
    Ok((remote_branch, public_branch_url))
}

pub fn push_result(
    local_branch: &dyn Branch,
    remote_branch: &dyn Branch,
    additional_colocated_branches: Option<Vec<(String, String)>>,
    tags: Option<std::collections::HashMap<String, RevisionId>>,
    stop_revision: Option<&RevisionId>,
) -> Result<(), BrzError> {
    let tag_selector = Box::new(_tag_selector_from_tags(tags.clone().unwrap_or_default()));
    local_branch.push(remote_branch, false, stop_revision, Some(tag_selector))?;

    for (from_branch_name, to_branch_name) in additional_colocated_branches.unwrap_or_default() {
        match local_branch
            .controldir()
            .open_branch(Some(from_branch_name.as_str()))
        {
            Ok(branch) => {
                let tag_selector =
                    Box::new(_tag_selector_from_tags(tags.clone().unwrap_or_default()));
                remote_branch.controldir().push_branch(
                    branch.as_ref(),
                    Some(to_branch_name.as_str()),
                    None,
                    Some(false),
                    Some(tag_selector),
                )?;
            }
            Err(BrzError::NotBranchError(..)) => {}
            Err(e) => return Err(e),
        };
    }
    Ok(())
}

#[test]
fn test_push_result() {
    use breezyshim::controldir::{
        create_branch_convenience, create_standalone_workingtree, ControlDirFormat,
    };
    let td = tempfile::tempdir().unwrap();
    let target_path = td.path().join("target");
    let source_path = td.path().join("source");
    let target_url = url::Url::from_file_path(target_path).unwrap();
    let target =
        create_branch_convenience(&target_url, None, &ControlDirFormat::default()).unwrap();
    let source = create_standalone_workingtree(&source_path, &ControlDirFormat::default()).unwrap();
    let revid = source
        .build_commit()
        .message("Some change")
        .commit()
        .unwrap();
    push_result(source.branch().as_ref(), target.as_ref(), None, None, None).unwrap();
    assert_eq!(target.last_revision(), revid);
}

pub fn push_changes(
    local_branch: &dyn Branch,
    main_branch: &dyn Branch,
    forge: Option<&Forge>,
    possible_transports: Option<&mut Vec<Transport>>,
    additional_colocated_branches: Option<Vec<(String, String)>>,
    tags: Option<std::collections::HashMap<String, RevisionId>>,
    stop_revision: Option<&RevisionId>,
) -> Result<(), Error> {
    let push_url = if let Some(forge) = forge {
        forge.get_push_url(main_branch)
    } else {
        main_branch.get_user_url()
    };
    log::info!("pushing to {}", push_url);
    let target_branch = open_branch(&push_url, possible_transports, None, None)?;
    push_result(
        local_branch,
        target_branch.as_ref(),
        additional_colocated_branches,
        tags,
        stop_revision,
    )
    .map_err(Into::into)
}

/// Find an existing derived branch with the specified name, and proposal.
///
/// # Arguments:
///
/// * `main_branch` - Main branch
/// * `forge` - The forge
/// * `name` - Name of the derived branch
/// * `overwrite_unrelated` - Whether to overwrite existing (but unrelated) branches
/// * `owner` - Owner of the branch
/// * `preferred_schemes` - List of preferred schemes
///
/// # Returns:
///   Tuple with (resume_branch, overwrite_existing, existing_proposal)
///   The resume_branch is the branch to continue from; overwrite_existing
///   means there is an existing branch in place that should be overwritten.
pub fn find_existing_proposed(
    main_branch: &dyn Branch,
    forge: &Forge,
    name: &str,
    overwrite_unrelated: bool,
    owner: Option<&str>,
    preferred_schemes: Option<&[&str]>,
) -> Result<
    (
        Option<Box<dyn Branch>>,
        Option<bool>,
        Option<Vec<MergeProposal>>,
    ),
    BrzError,
> {
    let existing_branch =
        match forge.get_derived_branch(main_branch, name, owner, preferred_schemes) {
            Ok(branch) => branch,
            Err(BrzError::NotBranchError(..)) => {
                return Ok((None, None, None));
            }
            Err(e) => return Err(e.into()),
        };

    log::info!(
        "Branch {} already exists (branch at {})",
        name,
        crate::vcs::full_branch_url(existing_branch.as_ref())
    );

    let mut open_proposals = vec![];
    // If there is an open or rejected merge proposal, resume that.
    let mut merged_proposals = vec![];
    for mp in forge.iter_proposals(
        existing_branch.as_ref(),
        main_branch,
        breezyshim::MergeProposalStatus::All,
    )? {
        if !mp.is_closed()? && !mp.is_merged()? {
            open_proposals.push(mp);
        } else {
            merged_proposals.push(mp);
        }
    }
    if !open_proposals.is_empty() {
        Ok((Some(existing_branch), Some(false), Some(open_proposals)))
    } else if let Some(first_proposal) = merged_proposals.first() {
        log::info!(
            "There is a proposal that has already been merged at {}.",
            first_proposal.url()?
        );
        Ok((None, Some(true), None))
    } else {
        // No related merge proposals found, but there is an existing
        // branch (perhaps for a different target branch?)
        if overwrite_unrelated {
            Ok((None, Some(true), None))
        } else {
            //TODO(jelmer): What to do in this case?
            Ok((None, Some(false), None))
        }
    }
}

/// Create or update a merge proposal.
///
/// # Arguments
///
/// * `local_branch` - Local branch with changes to propose
/// * `main_branch` - Target branch to propose against
/// * `forge` - Associated forge for main branch
/// * `mp_description` - Merge proposal description
/// * `resume_branch` - Existing derived branch
/// * `resume_proposal` - Existing merge proposal to resume
/// * `overwrite_existing` - Whether to overwrite any other existing branch
/// * `labels` - Labels to add
/// * `commit_message` - Optional commit message
/// * `title` - Optional title
/// * `additional_colocated_branches` - Additional colocated branches to propose
/// * `allow_empty` - Whether to allow empty merge proposals
/// * `reviewers` - List of reviewers
/// * `tags` - Tags to push (None for default behaviour)
/// * `owner` - Derived branch owner
/// * `stop_revision` - Revision to stop pushing at
/// * `allow_collaboration` - Allow target branch owners to modify source branch
/// * `auto_merge` - Enable merging once CI passes
/// * `preferred_schemes` - List of preferred schemes
/// * `overwrite_unrelated` - Whether to overwrite existing (but unrelated) branches
///
/// # Returns
///   Tuple with (proposal, is_new)
pub fn propose_changes(
    local_branch: &dyn Branch,
    main_branch: &dyn Branch,
    forge: &Forge,
    name: &str,
    mp_description: &str,
    resume_branch: Option<&dyn Branch>,
    mut resume_proposal: Option<MergeProposal>,
    overwrite_existing: Option<bool>,
    labels: Option<Vec<String>>,
    commit_message: Option<&str>,
    title: Option<&str>,
    additional_colocated_branches: Option<Vec<(String, String)>>,
    allow_empty: Option<bool>,
    reviewers: Option<Vec<String>>,
    tags: Option<HashMap<String, RevisionId>>,
    owner: Option<&str>,
    stop_revision: Option<&RevisionId>,
    allow_collaboration: Option<bool>,
    auto_merge: Option<bool>,
) -> Result<(MergeProposal, bool), Error> {
    let mut ref_resume_branch = None;
    if !allow_empty.unwrap_or(false)
        && check_proposal_diff_empty(local_branch, main_branch, stop_revision)?
    {
        return Err(Error::EmptyMergeProposal);
    }
    let overwrite_existing = overwrite_existing.unwrap_or(true);
    let remote_branch = if let Some(resume_branch) = resume_branch {
        local_branch.push(
            resume_branch,
            overwrite_existing,
            stop_revision,
            tags.as_ref().map(|ts| {
                Box::new(_tag_selector_from_tags(ts.clone())) as Box<dyn Fn(String) -> bool>
            }),
        )?;
        resume_branch
    } else {
        ref_resume_branch = Some(
            forge
                .publish_derived(
                    local_branch,
                    main_branch,
                    name,
                    Some(overwrite_existing),
                    owner,
                    stop_revision,
                    tags.clone().map(|ts| {
                        Box::new(_tag_selector_from_tags(ts)) as Box<dyn Fn(String) -> bool>
                    }),
                )?
                .0,
        );

        ref_resume_branch.as_ref().unwrap().as_ref()
    };
    for (from_branch_name, to_branch_name) in additional_colocated_branches.unwrap_or_default() {
        match local_branch
            .controldir()
            .open_branch(Some(from_branch_name.as_str()))
        {
            Ok(b) => {
                remote_branch.controldir().push_branch(
                    b.as_ref(),
                    Some(to_branch_name.as_str()),
                    None,
                    Some(overwrite_existing),
                    tags.clone().map(|ts| {
                        Box::new(_tag_selector_from_tags(ts)) as Box<dyn Fn(String) -> bool>
                    }),
                )?;
            }
            Err(BrzError::NotBranchError(..)) => {}
            Err(e) => return Err(e.into()),
        }
    }
    if let Some(mp) = resume_proposal.as_ref() {
        if mp.is_closed()? {
            match mp.reopen() {
                Ok(_) => {}
                Err(e) => {
                    log::info!(
                        "Reopening existing proposal failed ({}). Creating new proposal.",
                        e
                    );
                    resume_proposal = None;
                }
            }
        }
    }
    if let Some(resume_proposal) = resume_proposal.take() {
        // Check that the proposal doesn't already has this description.
        // Setting the description (regardless of whether it changes)
        // causes Launchpad to send emails.
        if resume_proposal.get_description()?.as_deref() != Some(mp_description) {
            match resume_proposal.set_description(Some(mp_description)) {
                Ok(_) => (),
                Err(BrzError::UnsupportedOperation(..)) => (),
                Err(e) => return Err(e.into()),
            }
        }
        if resume_proposal.get_commit_message()?.as_deref() != commit_message {
            match resume_proposal.set_commit_message(commit_message) {
                Ok(_) => (),
                Err(BrzError::UnsupportedOperation(..)) => (),
                Err(e) => return Err(e.into()),
            }
        }
        if resume_proposal.get_title()?.as_deref() != title {
            match resume_proposal.set_title(title) {
                Ok(_) => (),
                Err(BrzError::UnsupportedOperation(..)) => (),
                Err(e) => return Err(e.into()),
            }
        }
        Ok((resume_proposal, false))
    } else {
        let mut proposal_builder = forge.get_proposer(remote_branch, main_branch)?;
        if forge.supports_merge_proposal_commit_message() {
            if let Some(commit_message) = commit_message {
                proposal_builder = proposal_builder.commit_message(commit_message);
            }
        }
        if forge.supports_merge_proposal_title() {
            if let Some(title) = title {
                proposal_builder = proposal_builder.title(title);
            }
        }
        if let Some(allow_collaboration) = allow_collaboration {
            proposal_builder = proposal_builder.allow_collaboration(allow_collaboration);
        }
        proposal_builder = proposal_builder.description(mp_description);
        if let Some(labels) = labels {
            proposal_builder = proposal_builder.labels(
                labels
                    .iter()
                    .map(|s| s.as_str())
                    .collect::<Vec<_>>()
                    .as_slice(),
            );
        }
        if let Some(reviewers) = reviewers {
            proposal_builder = proposal_builder.reviewers(
                reviewers
                    .iter()
                    .map(|s| s.as_str())
                    .collect::<Vec<_>>()
                    .as_slice(),
            );
        }
        let mp: MergeProposal = match proposal_builder.build() {
            Ok(mp) => mp,
            Err(BrzError::MergeProposalExists(_url, Some(existing_proposal_url))) => {
                MergeProposal::from_url(&existing_proposal_url)?
            }
            Err(e @ BrzError::PermissionDenied(..)) => {
                log::info!("Permission denied while trying to create proposal.");
                return Err(e.into());
            }
            Err(e) => return Err(e.into()),
        };
        if auto_merge.unwrap_or(false) {
            mp.merge(true)?;
        }
        Ok((mp, true))
    }
}

#[derive(Debug)]
pub enum Error {
    DivergedBranches(),
    UnrelatedBranchExists,
    Other(BrzError),
    UnsupportedForge(url::Url),
    ForgeLoginRequired,
    InsufficientChangesForNewProposal,
    BranchOpenError(crate::vcs::BranchOpenError),
    EmptyMergeProposal,
    PermissionDenied,
}

impl From<BrzError> for Error {
    fn from(e: BrzError) -> Self {
        match e {
            BrzError::DivergedBranches => Error::DivergedBranches(),
            BrzError::NotBranchError(..) => Error::UnrelatedBranchExists,
            BrzError::PermissionDenied(..) => Error::PermissionDenied,
            BrzError::UnsupportedForge(s) => Error::UnsupportedForge(s),
            BrzError::ForgeLoginRequired => Error::ForgeLoginRequired,
            _ => Error::Other(e),
        }
    }
}

impl From<crate::vcs::BranchOpenError> for Error {
    fn from(e: crate::vcs::BranchOpenError) -> Self {
        Error::BranchOpenError(e)
    }
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            Error::DivergedBranches() => write!(f, "Diverged branches"),
            Error::Other(e) => write!(f, "{}", e),
            Error::UnsupportedForge(u) => write!(f, "Unsupported forge: {}", u),
            Error::ForgeLoginRequired => write!(f, "Forge login required"),
            Error::BranchOpenError(e) => write!(f, "{}", e),
            Error::EmptyMergeProposal => write!(f, "Empty merge proposal"),
            Error::PermissionDenied => write!(f, "Permission denied"),
            Error::UnrelatedBranchExists => write!(f, "Unrelated branch exists"),
            Error::InsufficientChangesForNewProposal => {
                write!(f, "Insufficient changes for new proposal")
            }
        }
    }
}

#[cfg(feature = "pyo3")]
impl From<Error> for pyo3::PyErr {
    fn from(e: Error) -> Self {
        use pyo3::import_exception;
        use pyo3::prelude::*;
        import_exception!(breezy.errors, NotBranchError);
        import_exception!(breezy.errors, UnsupportedOperation);
        import_exception!(breezy.errors, MergeProposalExists);
        import_exception!(breezy.errors, PermissionDenied);
        import_exception!(breezy.errors, DivergedBranches);
        import_exception!(breezy.forge, UnsupportedForge);
        import_exception!(breezy.forge, ForgeLoginRequired);
        import_exception!(silver_platter, EmptyMergeProposal);
        import_exception!(silver_platter, UnrelatedBranchExists);
        import_exception!(silver_platter.publish, InsufficientChangesForNewProposal);

        match e {
            Error::DivergedBranches() => PyErr::new::<DivergedBranches, _>("DivergedBranches"),
            Error::Other(e) => e.into(),
            Error::BranchOpenError(e) => e.into(),
            Error::UnsupportedForge(u) => PyErr::new::<UnsupportedForge, _>(u.to_string()),
            Error::ForgeLoginRequired => PyErr::new::<ForgeLoginRequired, _>("ForgeLoginRequired"),
            Error::UnrelatedBranchExists => {
                PyErr::new::<UnrelatedBranchExists, _>("UnrelatedBranchExists")
            }
            Error::PermissionDenied => PyErr::new::<PermissionDenied, _>("PermissionDenied"),
            Error::EmptyMergeProposal => PyErr::new::<EmptyMergeProposal, _>("EmptyMergeProposal"),
            Error::InsufficientChangesForNewProposal => {
                PyErr::new::<InsufficientChangesForNewProposal, _>(
                    "InsufficientChangesForNewProposal",
                )
            }
        }
    }
}

/// Publish a set of changes.
///
/// # Arguments
/// * `local_branch` - Local branch to publish
/// * `main_branch` - Main branch to publish to
/// * `resume_branch` - Branch to resume publishing from
/// * `mode` - Mode to use ('push', 'push-derived', 'propose')
/// * `name` - Branch name to push
/// * `get_proposal_description` - Function to retrieve proposal description
/// * `get_proposal_commit_message` - Function to retrieve proposal commit message
/// * `get_proposal_title` - Function to retrieve proposal title
/// * `forge` - Forge, if known
/// * `allow_create_proposal` - Whether to allow creating proposals
/// * `labels` - Labels to set for any merge proposals
/// * `overwrite_existing` - Whether to overwrite existing (but unrelated) branch
/// * `existing_proposal` - Existing proposal to update
/// * `reviewers` - List of reviewers for merge proposal
/// * `tags` - Tags to push (None for default behaviour)
/// * `derived_owner` - Name of any derived branch
/// * `allow_collaboration` - Whether to allow target branch owners to modify source branch.
pub fn publish_changes(
    local_branch: &dyn Branch,
    main_branch: &dyn Branch,
    resume_branch: Option<&dyn Branch>,
    mut mode: Mode,
    name: &str,
    get_proposal_description: impl FnOnce(DescriptionFormat, Option<&MergeProposal>) -> String,
    get_proposal_commit_message: Option<impl FnOnce(Option<&MergeProposal>) -> Option<String>>,
    get_proposal_title: Option<impl FnOnce(Option<&MergeProposal>) -> Option<String>>,
    forge: Option<&Forge>,
    allow_create_proposal: Option<bool>,
    labels: Option<Vec<String>>,
    overwrite_existing: Option<bool>,
    existing_proposal: Option<MergeProposal>,
    reviewers: Option<Vec<String>>,
    tags: Option<HashMap<String, RevisionId>>,
    derived_owner: Option<&str>,
    allow_collaboration: Option<bool>,
    stop_revision: Option<&RevisionId>,
) -> Result<PublishResult, Error> {
    let stop_revision = stop_revision.map_or_else(|| local_branch.last_revision(), |r| r.clone());
    let allow_create_proposal = allow_create_proposal.unwrap_or(true);

    let forge = match forge {
        Some(forge) => forge.clone(),
        None => breezyshim::forge::get_forge(main_branch)?,
    };

    if stop_revision == main_branch.last_revision() {
        if let Some(existing_proposal) = existing_proposal.as_ref() {
            log::info!("closing existing merge proposal - no new revisions");
            existing_proposal.close()?;
        }
        return Ok(PublishResult {
            mode,
            target_branch: main_branch.get_user_url(),
            forge,
            proposal: existing_proposal,
            is_new: Some(false),
        });
    }

    if let Some(resume_branch) = resume_branch {
        if resume_branch.last_revision() == stop_revision {
            // No new revisions added on this iteration, but changes since main
            // branch. We may not have gotten round to updating/creating the
            // merge proposal last time.
            log::info!("No changes added; making sure merge proposal is up to date.");
        }
    }
    match mode {
        Mode::PushDerived => {
            let (_remote_branch, _public_url) = push_derived_changes(
                local_branch,
                main_branch,
                &forge,
                name,
                overwrite_existing,
                derived_owner,
                tags,
                Some(&stop_revision),
            )?;
            return Ok(PublishResult {
                mode,
                target_branch: main_branch.get_user_url(),
                forge: forge.clone(),
                proposal: None,
                is_new: None,
            });
        }
        Mode::Push | Mode::AttemptPush => {
            let read_lock = local_branch.lock_read()?;
            // breezy would do this check too, but we want to be *really* sure.
            let graph = local_branch.repository().get_graph();
            if !graph.is_ancestor(&main_branch.last_revision(), &stop_revision) {
                return Err(Error::DivergedBranches());
            }
            std::mem::drop(read_lock);
            match push_changes(
                local_branch,
                main_branch,
                Some(&forge),
                None,
                None,
                tags.clone(),
                Some(&stop_revision),
            ) {
                Err(e @ Error::PermissionDenied) => {
                    if mode == Mode::AttemptPush {
                        log::info!("push access denied, falling back to propose");
                        mode = Mode::Propose;
                    } else {
                        log::info!("permission denied during push");
                        return Err(e);
                    }
                }
                Ok(_) => {
                    return Ok(PublishResult {
                        proposal: None,
                        mode,
                        target_branch: main_branch.get_user_url(),
                        forge: forge.clone(),
                        is_new: None,
                    });
                }
                Err(e) => {
                    return Err(e);
                }
            }
        }
        Mode::Bts => {
            unimplemented!();
        }
        Mode::Propose => { // Handled below
        }
    }

    assert_eq!(mode, Mode::Propose);
    if resume_branch.is_none() && !allow_create_proposal {
        return Err(Error::InsufficientChangesForNewProposal);
    }

    let mp_description = get_proposal_description(
        forge.merge_proposal_description_format().parse().unwrap(),
        if resume_branch.is_some() {
            existing_proposal.as_ref()
        } else {
            None
        },
    );
    let commit_message = if let Some(get_proposal_commit_message) = get_proposal_commit_message {
        get_proposal_commit_message(if resume_branch.is_some() {
            existing_proposal.as_ref()
        } else {
            None
        })
    } else {
        None
    };
    let title = if let Some(get_proposal_title) = get_proposal_title {
        get_proposal_title(if resume_branch.is_some() {
            existing_proposal.as_ref()
        } else {
            None
        })
    } else {
        None
    };
    let title =
        title.unwrap_or_else(|| breezyshim::forge::determine_title(mp_description.as_str()));
    let (proposal, is_new) = propose_changes(
        local_branch,
        main_branch,
        &forge,
        name,
        mp_description.as_str(),
        resume_branch,
        existing_proposal,
        overwrite_existing,
        labels,
        commit_message.as_deref(),
        Some(title.as_str()),
        None,
        None,
        reviewers,
        tags,
        derived_owner,
        Some(&stop_revision),
        allow_collaboration,
        None,
    )?;
    Ok(PublishResult {
        mode,
        proposal: Some(proposal),
        is_new: Some(is_new),
        target_branch: main_branch.get_user_url(),
        forge,
    })
}

pub struct PublishResult {
    pub mode: Mode,
    pub proposal: Option<MergeProposal>,
    pub is_new: Option<bool>,
    pub target_branch: url::Url,
    pub forge: Forge,
}

pub fn check_proposal_diff_empty(
    other_branch: &dyn Branch,
    main_branch: &dyn Branch,
    stop_revision: Option<&RevisionId>,
) -> Result<bool, BrzError> {
    let stop_revision = match stop_revision {
        Some(rev) => rev.clone(),
        None => other_branch.last_revision(),
    };
    let main_revid = main_branch.last_revision();
    let other_repository = other_branch.repository();
    other_repository.fetch(&main_branch.repository(), Some(&main_revid))?;

    let lock = other_branch.lock_read();
    let main_tree = other_repository.revision_tree(&main_revid)?;
    let revision_graph = other_repository.get_graph();
    let tree_branch = MemoryBranch::new(&other_repository, None, &main_revid);
    let mut merger = Merger::new(&tree_branch, &main_tree, &revision_graph);
    merger.set_other_revision(&stop_revision, other_branch)?;
    if merger.find_base()?.is_none() {
        merger.set_base_revision(&RevisionId::null(), other_branch)?;
    }
    merger.set_merge_type(MergeType::Merge3);
    let tree_merger = merger.make_merger()?;
    let tt = tree_merger.make_preview_transform()?;
    let mut changes = tt.iter_changes()?;
    std::mem::drop(lock);
    Ok(!changes.any(|_| true))
}

#[test]
fn test_no_new_commits() {
    use breezyshim::controldir::create_standalone_workingtree;
    use breezyshim::controldir::ControlDirFormat;
    let td = tempfile::tempdir().unwrap();
    let orig = td.path().join("orig");
    let tree = create_standalone_workingtree(&orig, &ControlDirFormat::default()).unwrap();

    std::fs::write(orig.join("a"), "a").unwrap();
    tree.add(&[std::path::Path::new("a")]).unwrap();
    tree.build_commit().message("blah").commit().unwrap();

    let proposal_url = url::Url::from_file_path(orig.join("proposal")).unwrap();

    let proposal = tree
        .controldir()
        .sprout(proposal_url, None, None, None, None)
        .unwrap()
        .open_branch(None)
        .unwrap();
    assert!(check_proposal_diff_empty(proposal.as_ref(), tree.branch().as_ref(), None).unwrap());
}

#[test]
fn test_no_op_commits() {
    use breezyshim::controldir::create_standalone_workingtree;
    use breezyshim::controldir::ControlDirFormat;
    let td = tempfile::tempdir().unwrap();
    let orig = td.path().join("orig");
    let tree = create_standalone_workingtree(&orig, &ControlDirFormat::default()).unwrap();

    std::fs::write(orig.join("a"), "a").unwrap();
    tree.add(&[std::path::Path::new("a")]).unwrap();
    tree.build_commit().message("blah").commit().unwrap();

    let proposal_url = url::Url::from_file_path(orig.join("proposal")).unwrap();

    let proposal = tree
        .controldir()
        .sprout(proposal_url, None, None, None, None)
        .unwrap()
        .open_workingtree()
        .unwrap();
    proposal
        .build_commit()
        .message("another commit that is pointless")
        .commit()
        .unwrap();

    assert!(
        check_proposal_diff_empty(proposal.branch().as_ref(), tree.branch().as_ref(), None)
            .unwrap()
    );
}

#[test]
fn test_indep() {
    use breezyshim::bazaar::tree::MutableInventoryTree;
    use breezyshim::bazaar::FileId;
    use breezyshim::controldir::create_standalone_workingtree;
    use breezyshim::controldir::ControlDirFormat;
    let td = tempfile::tempdir().unwrap();
    let orig = td.path().join("orig");
    let tree = create_standalone_workingtree(&orig, &ControlDirFormat::default()).unwrap();

    std::fs::write(orig.join("a"), "a").unwrap();
    tree.add(&[std::path::Path::new("a")]).unwrap();
    tree.build_commit().message("blah").commit().unwrap();

    std::fs::write(orig.join("b"), "b").unwrap();
    std::fs::write(orig.join("c"), "c").unwrap();
    tree.add(&[std::path::Path::new("b"), std::path::Path::new("c")])
        .unwrap();
    tree.build_commit().message("independent").commit().unwrap();

    let proposal_path = orig.join("proposal");
    let proposal_url = url::Url::from_file_path(proposal_path.as_path()).unwrap();

    let proposal = tree
        .controldir()
        .sprout(proposal_url, None, None, None, None)
        .unwrap()
        .open_workingtree()
        .unwrap();

    assert!(proposal_path.exists());

    std::fs::write(proposal_path.join("b"), "b").unwrap();

    if proposal.supports_setting_file_ids() {
        MutableInventoryTree::add(
            &proposal,
            &[std::path::Path::new("b")],
            &[FileId::from("b")],
        )
        .unwrap();
    } else {
        proposal.add(&[std::path::Path::new("b")]).unwrap();
    }
    proposal
        .build_commit()
        .message("not pointless")
        .commit()
        .unwrap();

    assert!(
        check_proposal_diff_empty(proposal.branch().as_ref(), tree.branch().as_ref(), None)
            .unwrap()
    );

    std::mem::drop(td);
}

#[test]
fn test_changes() {
    use breezyshim::controldir::create_standalone_workingtree;
    use breezyshim::controldir::ControlDirFormat;
    let td = tempfile::tempdir().unwrap();
    let orig = td.path().join("orig");
    let tree = create_standalone_workingtree(&orig, &ControlDirFormat::default()).unwrap();
    std::fs::write(orig.join("a"), "a").unwrap();
    tree.add(&[std::path::Path::new("a")]).unwrap();
    tree.build_commit().message("blah").commit().unwrap();

    let proposal_url = url::Url::from_file_path(td.path().join("proposal")).unwrap();
    let proposal_tree = tree
        .controldir()
        .sprout(proposal_url, None, None, None, None)
        .unwrap()
        .open_workingtree()
        .unwrap();
    std::fs::write(proposal_tree.basedir().join("b"), "b").unwrap();
    proposal_tree.add(&[std::path::Path::new("b")]).unwrap();
    proposal_tree
        .build_commit()
        .message("not pointless")
        .commit()
        .unwrap();

    assert!(!check_proposal_diff_empty(
        proposal_tree.branch().as_ref(),
        tree.branch().as_ref(),
        None
    )
    .unwrap());
}

pub fn enable_tag_pushing(branch: &dyn Branch) -> Result<(), BrzError> {
    let config = branch.get_config();
    config.set_user_option("branch.fetch_tags", true)?;
    Ok(())
}