| // Copyright (C) 2012 The Android Open Source Project |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| package com.google.gerrit.server.submit; |
| |
| import static com.google.common.base.Preconditions.checkState; |
| import static com.google.gerrit.server.submit.CommitMergeStatus.EMPTY_COMMIT; |
| import static com.google.gerrit.server.submit.CommitMergeStatus.SKIPPED_IDENTICAL_TREE; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.gerrit.entities.BooleanProjectConfig; |
| import com.google.gerrit.entities.PatchSet; |
| import com.google.gerrit.exceptions.StorageException; |
| import com.google.gerrit.extensions.restapi.MergeConflictException; |
| import com.google.gerrit.extensions.restapi.ResourceConflictException; |
| import com.google.gerrit.extensions.restapi.RestApiException; |
| import com.google.gerrit.server.ChangeUtil; |
| import com.google.gerrit.server.change.RebaseChangeOp; |
| import com.google.gerrit.server.git.CodeReviewCommit; |
| import com.google.gerrit.server.git.MergeTip; |
| import com.google.gerrit.server.permissions.PermissionBackendException; |
| import com.google.gerrit.server.project.InvalidChangeOperationException; |
| import com.google.gerrit.server.project.NoSuchChangeException; |
| import com.google.gerrit.server.update.ChangeContext; |
| import com.google.gerrit.server.update.Context; |
| import com.google.gerrit.server.update.RepoContext; |
| import java.io.IOException; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.List; |
| import org.eclipse.jgit.lib.ObjectId; |
| import org.eclipse.jgit.lib.PersonIdent; |
| import org.eclipse.jgit.lib.Repository; |
| import org.eclipse.jgit.revwalk.RevCommit; |
| |
| /** This strategy covers RebaseAlways and RebaseIfNecessary ones. */ |
| public class RebaseSubmitStrategy extends SubmitStrategy { |
| private final boolean rebaseAlways; |
| |
| RebaseSubmitStrategy(SubmitStrategy.Arguments args, boolean rebaseAlways) { |
| super(args); |
| this.rebaseAlways = rebaseAlways; |
| } |
| |
| @Override |
| public List<SubmitStrategyOp> buildOps(Collection<CodeReviewCommit> toMerge) |
| throws IntegrationException { |
| List<CodeReviewCommit> sorted; |
| try { |
| sorted = args.rebaseSorter.sort(toMerge); |
| } catch (IOException | StorageException e) { |
| throw new IntegrationException("Commit sorting failed", e); |
| } |
| List<SubmitStrategyOp> ops = new ArrayList<>(sorted.size()); |
| boolean first = true; |
| |
| for (CodeReviewCommit c : sorted) { |
| if (c.getParentCount() > 1) { |
| // Since there is a merge commit, sort and prune again using |
| // MERGE_IF_NECESSARY semantics to avoid creating duplicate |
| // commits. |
| // |
| sorted = args.mergeUtil.reduceToMinimalMerge(args.mergeSorter, sorted); |
| break; |
| } |
| } |
| |
| while (!sorted.isEmpty()) { |
| CodeReviewCommit n = sorted.remove(0); |
| if (first && args.mergeTip.getInitialTip() == null) { |
| // TODO(tandrii): Cherry-Pick strategy does this too, but it's wrong |
| // and can be fixed. |
| ops.add(new FastForwardOp(args, n)); |
| } else if (n.getParentCount() == 0) { |
| ops.add(new RebaseRootOp(n)); |
| } else if (n.getParentCount() == 1) { |
| ops.add(new RebaseOneOp(n)); |
| } else { |
| ops.add(new RebaseMultipleParentsOp(n)); |
| } |
| first = false; |
| } |
| return ops; |
| } |
| |
| private class RebaseRootOp extends SubmitStrategyOp { |
| private RebaseRootOp(CodeReviewCommit toMerge) { |
| super(RebaseSubmitStrategy.this.args, toMerge); |
| } |
| |
| @Override |
| public void updateRepoImpl(RepoContext ctx) { |
| // Refuse to merge a root commit into an existing branch, we cannot obtain |
| // a delta for the cherry-pick to apply. |
| toMerge.setStatusCode(CommitMergeStatus.CANNOT_REBASE_ROOT); |
| } |
| } |
| |
| private class RebaseOneOp extends SubmitStrategyOp { |
| private RebaseChangeOp rebaseOp; |
| private CodeReviewCommit newCommit; |
| private PatchSet.Id newPatchSetId; |
| |
| private RebaseOneOp(CodeReviewCommit toMerge) { |
| super(RebaseSubmitStrategy.this.args, toMerge); |
| } |
| |
| @Override |
| public void updateRepoImpl(RepoContext ctx) |
| throws IntegrationException, InvalidChangeOperationException, RestApiException, IOException, |
| PermissionBackendException { |
| if (args.mergeUtil.canFastForward( |
| args.mergeSorter, args.mergeTip.getCurrentTip(), args.rw, toMerge)) { |
| if (!rebaseAlways) { |
| if (args.project.is(BooleanProjectConfig.REJECT_EMPTY_COMMIT) |
| && toMerge.getTree().equals(toMerge.getParent(0).getTree())) { |
| toMerge.setStatusCode(EMPTY_COMMIT); |
| return; |
| } |
| |
| args.mergeTip.moveTipTo(amendGitlink(toMerge), toMerge); |
| toMerge.setStatusCode(CommitMergeStatus.CLEAN_MERGE); |
| acceptMergeTip(args.mergeTip); |
| return; |
| } |
| // RebaseAlways means we modify commit message. |
| args.rw.parseBody(toMerge); |
| newPatchSetId = |
| ChangeUtil.nextPatchSetIdFromChangeRefs( |
| ctx.getRepoView().getRefs(getId().toRefPrefix()).keySet(), |
| toMerge.change().currentPatchSetId()); |
| RevCommit mergeTip = args.mergeTip.getCurrentTip(); |
| args.rw.parseBody(mergeTip); |
| String cherryPickCmtMsg = args.mergeUtil.createCommitMessageOnSubmit(toMerge, mergeTip); |
| PersonIdent committer = |
| args.caller.newCommitterIdent(ctx.getWhen(), args.serverIdent.getTimeZone()); |
| try { |
| newCommit = |
| args.mergeUtil.createCherryPickFromCommit( |
| ctx.getInserter(), |
| ctx.getRepoView().getConfig(), |
| args.mergeTip.getCurrentTip(), |
| toMerge, |
| committer, |
| cherryPickCmtMsg, |
| args.rw, |
| 0, |
| true, |
| false); |
| } catch (MergeConflictException mce) { |
| // Unlike in Cherry-pick case, this should never happen. |
| toMerge.setStatusCode(CommitMergeStatus.REBASE_MERGE_CONFLICT); |
| throw new IllegalStateException("MergeConflictException on message edit must not happen"); |
| } catch (MergeIdenticalTreeException mie) { |
| // this should not happen |
| toMerge.setStatusCode(SKIPPED_IDENTICAL_TREE); |
| return; |
| } |
| ctx.addRefUpdate(ObjectId.zeroId(), newCommit, newPatchSetId.toRefName()); |
| } else { |
| // Stale read of patch set is ok; see comments in RebaseChangeOp. |
| PatchSet origPs = args.psUtil.get(toMerge.getNotes(), toMerge.getPatchsetId()); |
| rebaseOp = |
| args.rebaseFactory |
| .create(toMerge.notes(), origPs, args.mergeTip.getCurrentTip()) |
| .setFireRevisionCreated(false) |
| // Bypass approval copier since SubmitStrategyOp copy all approvals |
| // later anyway. |
| .setValidate(false) |
| .setCheckAddPatchSetPermission(false) |
| // RebaseAlways should set always modify commit message like |
| // Cherry-Pick strategy. |
| .setDetailedCommitMessage(rebaseAlways) |
| // Do not post message after inserting new patchset because there |
| // will be one about change being merged already. |
| .setPostMessage(false) |
| .setSendEmail(false) |
| .setMatchAuthorToCommitterDate( |
| args.project.is(BooleanProjectConfig.MATCH_AUTHOR_TO_COMMITTER_DATE)); |
| try { |
| rebaseOp.updateRepo(ctx); |
| } catch (MergeConflictException | NoSuchChangeException e) { |
| toMerge.setStatusCode(CommitMergeStatus.REBASE_MERGE_CONFLICT); |
| throw new IntegrationException( |
| "Cannot rebase " + toMerge.name() + ": " + e.getMessage(), e); |
| } |
| newCommit = args.rw.parseCommit(rebaseOp.getRebasedCommit()); |
| newPatchSetId = rebaseOp.getPatchSetId(); |
| } |
| if (args.project.is(BooleanProjectConfig.REJECT_EMPTY_COMMIT) |
| && newCommit.getTree().equals(newCommit.getParent(0).getTree())) { |
| toMerge.setStatusCode(EMPTY_COMMIT); |
| return; |
| } |
| newCommit = amendGitlink(newCommit); |
| newCommit.copyFrom(toMerge); |
| newCommit.setPatchsetId(newPatchSetId); |
| newCommit.setStatusCode(CommitMergeStatus.CLEAN_REBASE); |
| args.mergeTip.moveTipTo(newCommit, newCommit); |
| args.commitStatus.put(args.mergeTip.getCurrentTip()); |
| acceptMergeTip(args.mergeTip); |
| } |
| |
| @Override |
| public PatchSet updateChangeImpl(ChangeContext ctx) |
| throws NoSuchChangeException, ResourceConflictException, IOException { |
| if (newCommit == null) { |
| checkState(!rebaseAlways, "RebaseAlways must never fast forward"); |
| // otherwise, took the fast-forward option, nothing to do. |
| return null; |
| } |
| |
| PatchSet newPs; |
| if (rebaseOp != null) { |
| rebaseOp.updateChange(ctx); |
| newPs = rebaseOp.getPatchSet(); |
| } else { |
| // CherryPick |
| PatchSet prevPs = args.psUtil.current(ctx.getNotes()); |
| newPs = |
| args.psUtil.insert( |
| ctx.getRevWalk(), |
| ctx.getUpdate(newPatchSetId), |
| newPatchSetId, |
| newCommit, |
| prevPs != null ? prevPs.groups() : ImmutableList.of(), |
| null, |
| null); |
| } |
| ctx.getChange() |
| .setCurrentPatchSet( |
| args.patchSetInfoFactory.get(ctx.getRevWalk(), newCommit, newPatchSetId)); |
| newCommit.setNotes(ctx.getNotes()); |
| return newPs; |
| } |
| |
| @Override |
| public void postUpdateImpl(Context ctx) { |
| if (rebaseOp != null) { |
| rebaseOp.postUpdate(ctx); |
| } |
| } |
| } |
| |
| private class RebaseMultipleParentsOp extends SubmitStrategyOp { |
| private RebaseMultipleParentsOp(CodeReviewCommit toMerge) { |
| super(RebaseSubmitStrategy.this.args, toMerge); |
| } |
| |
| @Override |
| public void updateRepoImpl(RepoContext ctx) throws IntegrationException, IOException { |
| // There are multiple parents, so this is a merge commit. We don't want |
| // to rebase the merge as clients can't easily rebase their history with |
| // that merge present and replaced by an equivalent merge with a different |
| // first parent. So instead behave as though MERGE_IF_NECESSARY was |
| // configured. |
| // TODO(tandrii): this is not in spirit of RebaseAlways strategy because |
| // the commit messages can not be modified in the process. It's also |
| // possible to implement rebasing of merge commits. E.g., the Cherry Pick |
| // REST endpoint already supports cherry-picking of merge commits. |
| // For now, users of RebaseAlways strategy for whom changed commit footers |
| // are important would be well advised to prohibit uploading patches with |
| // merge commits. |
| MergeTip mergeTip = args.mergeTip; |
| if (args.rw.isMergedInto(mergeTip.getCurrentTip(), toMerge) |
| && !args.submoduleOp.hasSubscription(args.destBranch)) { |
| mergeTip.moveTipTo(toMerge, toMerge); |
| } else { |
| PersonIdent caller = |
| ctx.getIdentifiedUser().newCommitterIdent(ctx.getWhen(), ctx.getTimeZone()); |
| CodeReviewCommit newTip = |
| args.mergeUtil.mergeOneCommit( |
| caller, |
| caller, |
| args.rw, |
| ctx.getInserter(), |
| ctx.getRepoView().getConfig(), |
| args.destBranch, |
| mergeTip.getCurrentTip(), |
| toMerge); |
| mergeTip.moveTipTo(amendGitlink(newTip), toMerge); |
| } |
| args.mergeUtil.markCleanMerges( |
| args.rw, args.canMergeFlag, mergeTip.getCurrentTip(), args.alreadyAccepted); |
| acceptMergeTip(mergeTip); |
| } |
| } |
| |
| private void acceptMergeTip(MergeTip mergeTip) { |
| args.alreadyAccepted.add(mergeTip.getCurrentTip()); |
| } |
| |
| static boolean dryRun( |
| SubmitDryRun.Arguments args, |
| Repository repo, |
| CodeReviewCommit mergeTip, |
| CodeReviewCommit toMerge) |
| throws IntegrationException { |
| // Test for merge instead of cherry pick to avoid false negatives |
| // on commit chains. |
| return args.mergeUtil.canMerge(args.mergeSorter, repo, mergeTip, toMerge); |
| } |
| } |
