| // Copyright (C) 2014 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; |
| |
| import static com.google.common.base.Preconditions.checkArgument; |
| import static com.google.common.base.Preconditions.checkState; |
| import static com.google.gerrit.server.project.ProjectCache.illegalState; |
| |
| import com.google.common.collect.HashBasedTable; |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.Table; |
| import com.google.common.flogger.FluentLogger; |
| import com.google.gerrit.common.Nullable; |
| import com.google.gerrit.common.data.LabelType; |
| import com.google.gerrit.entities.Account; |
| import com.google.gerrit.entities.PatchSet; |
| import com.google.gerrit.entities.PatchSetApproval; |
| import com.google.gerrit.extensions.client.ChangeKind; |
| import com.google.gerrit.server.change.ChangeKindCache; |
| import com.google.gerrit.server.change.LabelNormalizer; |
| import com.google.gerrit.server.logging.Metadata; |
| import com.google.gerrit.server.logging.TraceContext; |
| import com.google.gerrit.server.logging.TraceContext.TraceTimer; |
| import com.google.gerrit.server.notedb.ChangeNotes; |
| import com.google.gerrit.server.project.ProjectCache; |
| import com.google.gerrit.server.project.ProjectState; |
| import com.google.inject.Inject; |
| import com.google.inject.Singleton; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.Map; |
| import org.eclipse.jgit.lib.Config; |
| import org.eclipse.jgit.revwalk.RevWalk; |
| |
| /** |
| * Computes approvals for a given patch set by looking at approvals applied to the given patch set |
| * and by additionally inferring approvals from the patch set's parents. The latter is done by |
| * asserting a change's kind and checking the project config for allowed forward-inference. |
| * |
| * <p>The result of a copy may either be stored, as when stamping approvals in the database at |
| * submit time, or refreshed on demand, as when reading approvals from the NoteDb. |
| */ |
| @Singleton |
| public class ApprovalInference { |
| private static final FluentLogger logger = FluentLogger.forEnclosingClass(); |
| |
| private final ProjectCache projectCache; |
| private final ChangeKindCache changeKindCache; |
| private final LabelNormalizer labelNormalizer; |
| |
| @Inject |
| ApprovalInference( |
| ProjectCache projectCache, ChangeKindCache changeKindCache, LabelNormalizer labelNormalizer) { |
| this.projectCache = projectCache; |
| this.changeKindCache = changeKindCache; |
| this.labelNormalizer = labelNormalizer; |
| } |
| |
| /** |
| * Returns all approvals that apply to the given patch set. Honors direct and indirect (approval |
| * on parents) approvals. |
| */ |
| Iterable<PatchSetApproval> forPatchSet( |
| ChangeNotes notes, PatchSet.Id psId, @Nullable RevWalk rw, @Nullable Config repoConfig) { |
| ProjectState project; |
| try (TraceTimer traceTimer = |
| TraceContext.newTimer( |
| "Computing labels for patch set", |
| Metadata.builder() |
| .changeId(notes.load().getChangeId().get()) |
| .patchSetId(psId.get()) |
| .build())) { |
| project = |
| projectCache |
| .get(notes.getProjectName()) |
| .orElseThrow(illegalState(notes.getProjectName())); |
| Collection<PatchSetApproval> approvals = |
| getForPatchSetWithoutNormalization(notes, project, psId, rw, repoConfig); |
| return labelNormalizer.normalize(notes, approvals).getNormalized(); |
| } |
| } |
| |
| private static boolean canCopy( |
| ProjectState project, PatchSetApproval psa, PatchSet.Id psId, ChangeKind kind) { |
| int n = psa.key().patchSetId().get(); |
| checkArgument(n != psId.get()); |
| LabelType type = project.getLabelTypes().byLabel(psa.labelId()); |
| if (type == null) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d cannot be copied" |
| + " to patch set %d because the label no longer exists on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| project.getName()); |
| return false; |
| } else if (type.isCopyMinScore() && type.isMaxNegative(psa)) { |
| logger.atFine().log( |
| "veto approval %s on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because the label has set copyMinScore = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| project.getName()); |
| return true; |
| } else if (type.isCopyMaxScore() && type.isMaxPositive(psa)) { |
| logger.atFine().log( |
| "max approval %s on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because the label has set copyMaxScore = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| project.getName()); |
| return true; |
| } else if (type.isCopyAnyScore()) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because the label has set copyAnyScore = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| project.getName()); |
| return true; |
| } else if (type.getCopyValues().contains(psa.value())) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because the label has set copyValue = %d on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| psa.value(), |
| project.getName()); |
| return true; |
| } |
| switch (kind) { |
| case MERGE_FIRST_PARENT_UPDATE: |
| if (type.isCopyAllScoresOnMergeFirstParentUpdate()) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because change kind is %s and the label has set" |
| + " copyAllScoresOnMergeFirstParentUpdate = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| kind, |
| project.getName()); |
| return true; |
| } |
| return false; |
| case NO_CODE_CHANGE: |
| if (type.isCopyAllScoresIfNoCodeChange()) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because change kind is %s and the label has set" |
| + " copyAllScoresIfNoCodeChange = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| kind, |
| project.getName()); |
| return true; |
| } |
| return false; |
| case TRIVIAL_REBASE: |
| if (type.isCopyAllScoresOnTrivialRebase()) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because change kind is %s and the label has set" |
| + " copyAllScoresOnTrivialRebase = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| kind, |
| project.getName()); |
| return true; |
| } |
| return false; |
| case NO_CHANGE: |
| if (type.isCopyAllScoresIfNoChange()) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because change kind is %s and the label has set" |
| + " copyAllScoresIfNoCodeChange = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| kind, |
| project.getName()); |
| return true; |
| } |
| if (type.isCopyAllScoresOnTrivialRebase()) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because change kind is %s and the label has set" |
| + " copyAllScoresOnTrivialRebase = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| kind, |
| project.getName()); |
| return true; |
| } |
| if (type.isCopyAllScoresOnMergeFirstParentUpdate()) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because change kind is %s and the label has set" |
| + " copyAllScoresOnMergeFirstParentUpdate = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| kind, |
| project.getName()); |
| return true; |
| } |
| if (type.isCopyAllScoresIfNoCodeChange()) { |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d can be copied" |
| + " to patch set %d because change kind is %s and the label has set" |
| + " copyAllScoresIfNoCodeChange = true on project %s", |
| psa.value(), |
| psa.label(), |
| n, |
| psa.key().patchSetId().changeId().get(), |
| psId.get(), |
| kind, |
| project.getName()); |
| return true; |
| } |
| return false; |
| case REWORK: |
| default: |
| logger.atFine().log( |
| "approval %d on label %s of patch set %d of change %d cannot be copied" |
| + " to patch set %d because change kind is %s", |
| psa.value(), psa.label(), n, psa.key().patchSetId().changeId().get(), psId.get(), kind); |
| return false; |
| } |
| } |
| |
| private Collection<PatchSetApproval> getForPatchSetWithoutNormalization( |
| ChangeNotes notes, |
| ProjectState project, |
| PatchSet.Id psId, |
| @Nullable RevWalk rw, |
| @Nullable Config repoConfig) { |
| checkState( |
| project.getNameKey().equals(notes.getProjectName()), |
| "project must match %s, %s", |
| project.getNameKey(), |
| notes.getProjectName()); |
| |
| PatchSet ps = notes.load().getPatchSets().get(psId); |
| if (ps == null) { |
| return Collections.emptyList(); |
| } |
| |
| // Add approvals on the given patch set to the result |
| Table<String, Account.Id, PatchSetApproval> resultByUser = HashBasedTable.create(); |
| ImmutableList<PatchSetApproval> approvalsForGivenPatchSet = |
| notes.load().getApprovals().get(ps.id()); |
| approvalsForGivenPatchSet.forEach(psa -> resultByUser.put(psa.label(), psa.accountId(), psa)); |
| |
| // Bail out immediately if this is the first patch set. Return only approvals granted on the |
| // given patch set. |
| if (psId.get() == 1) { |
| return resultByUser.values(); |
| } |
| |
| // Call this algorithm recursively to check if the prior patch set had approvals. This has the |
| // advantage that all caches - most importantly ChangeKindCache - have values cached for what we |
| // need for this computation. |
| // The way this algorithm is written is that any approval will be copied forward by one patch |
| // set at a time if configs and change kind allow so. Once an approval is held back - for |
| // example because the patch set is a REWORK - it will not be picked up again in a future |
| // patch set. |
| Map.Entry<PatchSet.Id, PatchSet> priorPatchSet = notes.load().getPatchSets().lowerEntry(psId); |
| if (priorPatchSet == null) { |
| return resultByUser.values(); |
| } |
| |
| Iterable<PatchSetApproval> priorApprovals = |
| getForPatchSetWithoutNormalization( |
| notes, project, priorPatchSet.getValue().id(), rw, repoConfig); |
| if (!priorApprovals.iterator().hasNext()) { |
| return resultByUser.values(); |
| } |
| |
| // Add labels from the previous patch set to the result in case the label isn't already there |
| // and settings as well as change kind allow copying. |
| ChangeKind kind = |
| changeKindCache.getChangeKind( |
| project.getNameKey(), |
| rw, |
| repoConfig, |
| priorPatchSet.getValue().commitId(), |
| ps.commitId()); |
| logger.atFine().log( |
| "change kind for patch set %d of change %d against prior patch set %s is %s", |
| ps.id().get(), ps.id().changeId().get(), priorPatchSet.getValue().id().changeId(), kind); |
| for (PatchSetApproval psa : priorApprovals) { |
| if (resultByUser.contains(psa.label(), psa.accountId())) { |
| continue; |
| } |
| if (!canCopy(project, psa, ps.id(), kind)) { |
| continue; |
| } |
| resultByUser.put(psa.label(), psa.accountId(), psa.copyWithPatchSet(ps.id())); |
| } |
| return resultByUser.values(); |
| } |
| } |