All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.gerrit.server.git.MergedByPushOp Maven / Gradle / Ivy

There is a newer version: 3.10.1
Show newest version
// Copyright (C) 2016 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.git;

import static com.google.gerrit.server.mail.EmailFactories.CHANGE_MERGED;
import static java.util.Objects.requireNonNull;

import com.google.common.flogger.FluentLogger;
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.LabelId;
import com.google.gerrit.entities.PatchSet;
import com.google.gerrit.entities.PatchSetInfo;
import com.google.gerrit.entities.SubmissionId;
import com.google.gerrit.server.ChangeMessagesUtil;
import com.google.gerrit.server.PatchSetUtil;
import com.google.gerrit.server.config.SendEmailExecutor;
import com.google.gerrit.server.extensions.events.ChangeMerged;
import com.google.gerrit.server.mail.EmailFactories;
import com.google.gerrit.server.mail.send.ChangeEmail;
import com.google.gerrit.server.mail.send.MessageIdGenerator;
import com.google.gerrit.server.mail.send.OutgoingEmail;
import com.google.gerrit.server.notedb.ChangeUpdate;
import com.google.gerrit.server.patch.PatchSetInfoFactory;
import com.google.gerrit.server.update.BatchUpdateOp;
import com.google.gerrit.server.update.ChangeContext;
import com.google.gerrit.server.update.PostUpdateContext;
import com.google.gerrit.server.util.RequestScopePropagator;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.assistedinject.Assisted;
import java.io.IOException;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevWalk;

/**
 * Operation to close a change on push.
 *
 * 

When we find a change corresponding to a commit that is pushed to a branch directly, we close * the change. This class marks the change as merged, and sends out the email notification. */ public class MergedByPushOp implements BatchUpdateOp { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); public interface Factory { MergedByPushOp create( RequestScopePropagator requestScopePropagator, PatchSet.Id psId, @Assisted SubmissionId submissionId, @Assisted("refName") String refName, @Assisted("mergeResultRevId") String mergeResultRevId); } private final RequestScopePropagator requestScopePropagator; private final PatchSetInfoFactory patchSetInfoFactory; private final ChangeMessagesUtil cmUtil; private final EmailFactories emailFactories; private final PatchSetUtil psUtil; private final ExecutorService sendEmailExecutor; private final ChangeMerged changeMerged; private final MessageIdGenerator messageIdGenerator; private final PatchSet.Id psId; private final SubmissionId submissionId; private final String refName; private final String mergeResultRevId; private Change change; private boolean correctBranch; private Provider patchSetProvider; private PatchSet patchSet; private PatchSetInfo info; @Inject MergedByPushOp( PatchSetInfoFactory patchSetInfoFactory, ChangeMessagesUtil cmUtil, EmailFactories emailFactories, PatchSetUtil psUtil, @SendEmailExecutor ExecutorService sendEmailExecutor, ChangeMerged changeMerged, MessageIdGenerator messageIdGenerator, @Assisted RequestScopePropagator requestScopePropagator, @Assisted PatchSet.Id psId, @Assisted SubmissionId submissionId, @Assisted("refName") String refName, @Assisted("mergeResultRevId") String mergeResultRevId) { this.patchSetInfoFactory = patchSetInfoFactory; this.cmUtil = cmUtil; this.emailFactories = emailFactories; this.psUtil = psUtil; this.sendEmailExecutor = sendEmailExecutor; this.changeMerged = changeMerged; this.messageIdGenerator = messageIdGenerator; this.requestScopePropagator = requestScopePropagator; this.submissionId = submissionId; this.psId = psId; this.refName = refName; this.mergeResultRevId = mergeResultRevId; } public String getMergedIntoRef() { return refName; } public MergedByPushOp setPatchSetProvider(Provider patchSetProvider) { this.patchSetProvider = requireNonNull(patchSetProvider); return this; } @Override public boolean updateChange(ChangeContext ctx) throws IOException { change = ctx.getChange(); correctBranch = refName.equals(change.getDest().branch()); if (!correctBranch) { return false; } if (patchSetProvider != null) { // Caller might have also arranged for construction of a new patch set // that is not present in the old notes so we can't use PatchSetUtil. patchSet = patchSetProvider.get(); } else { patchSet = requireNonNull( psUtil.get(ctx.getNotes(), psId), () -> String.format("patch set %s not found", psId)); } info = getPatchSetInfo(ctx); ChangeUpdate update = ctx.getUpdate(psId); if (change.isMerged()) { return true; } change.setCurrentPatchSet(info); change.setStatus(Change.Status.MERGED); change.setSubmissionId(submissionId.toString()); // we cannot reconstruct the submit records for when this change was // submitted, this is why we must fix the status and other details. update.fixStatusToMerged(submissionId); update.setCurrentPatchSet(); if (change.isWorkInProgress()) { change.setWorkInProgress(false); update.setWorkInProgress(false); } StringBuilder msgBuf = new StringBuilder(); msgBuf.append("Change has been successfully pushed"); if (!refName.equals(change.getDest().branch())) { msgBuf.append(" into "); if (refName.startsWith(Constants.R_HEADS)) { msgBuf.append("branch "); msgBuf.append(Repository.shortenRefName(refName)); } else { msgBuf.append(refName); } } msgBuf.append("."); cmUtil.setChangeMessage(update, msgBuf.toString(), ChangeMessagesUtil.TAG_MERGED); update.putApproval(LabelId.legacySubmit().get(), (short) 1); return true; } @Override public void postUpdate(PostUpdateContext ctx) { if (!correctBranch) { return; } @SuppressWarnings("unused") // Runnable already handles errors Future possiblyIgnoredError = sendEmailExecutor.submit( requestScopePropagator.wrap( new Runnable() { @Override public void run() { try { // The stickyApprovalDiff is always empty here since this is not supported // for direct pushes. ChangeEmail changeEmail = emailFactories.createChangeEmail( ctx.getProject(), psId.changeId(), emailFactories.createMergedChangeEmail( /* stickyApprovalDiff= */ Optional.empty())); changeEmail.setPatchSet(patchSet, info); OutgoingEmail outgoingEmail = emailFactories.createOutgoingEmail(CHANGE_MERGED, changeEmail); outgoingEmail.setFrom(ctx.getAccountId()); outgoingEmail.setMessageId( messageIdGenerator.fromChangeUpdate(ctx.getRepoView(), patchSet.id())); outgoingEmail.send(); } catch (Exception e) { logger.atSevere().withCause(e).log( "Cannot send email for submitted patch set %s", psId); } } @Override public String toString() { return "send-email merged"; } })); changeMerged.fire( ctx.getChangeData(change), patchSet, ctx.getAccount(), mergeResultRevId, ctx.getWhen()); } private PatchSetInfo getPatchSetInfo(ChangeContext ctx) throws IOException { RevWalk rw = ctx.getRevWalk(); RevCommit commit = rw.parseCommit(requireNonNull(patchSet).commitId()); return patchSetInfoFactory.get(rw, commit, psId); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy