source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2017 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.server.computation.task.projectanalysis.issue;
  21
  22 import com.google.common.base.Function;
  23 import com.google.common.base.MoreObjects;
  24 import com.google.common.base.Predicate;
  25 import com.google.common.collect.Lists;
  26 import com.google.common.collect.Ordering;
  27 import java.util.Calendar;
  28 import java.util.Collection;
  29 import java.util.Comparator;
  30 import java.util.Date;
  31 import java.util.Iterator;
  32 import java.util.List;
  33 import javax.annotation.CheckForNull;
  34 import javax.annotation.Nonnull;
  35 import javax.annotation.Nullable;
  36 import org.apache.commons.lang.time.DateUtils;
  37 import org.sonar.core.issue.DefaultIssue;
  38 import org.sonar.core.issue.FieldDiffs;
  39 import org.sonar.db.issue.IssueChangeDto;
  40 import org.sonar.server.computation.task.projectanalysis.period.Period;
  41 import org.sonar.server.issue.IssueFieldsSetter;
  42
  43 import static com.google.common.collect.FluentIterable.from;
  44
  45 /**
  46  * Gets the issue debt that was introduced on a period. The algorithm
  47  * is based on the issue changelog.
  48  */
  49 public class NewEffortCalculator {
  50
  51   /**
  52    * Changelog have to be sorted from newest to oldest.
  53    * Null date should be the first as this happen when technical debt has changed since previous analysis.
  54    */
  55   private static final Comparator<FieldDiffs> CHANGE_ORDERING = Ordering.natural().reverse().nullsFirst().onResultOf(new Function<FieldDiffs, Date>() {
  56     @Override
  57     public Date apply(@Nonnull FieldDiffs dto) {
  58       return dto.creationDate();
  59     }
  60   });
  61
  62   public long calculate(DefaultIssue issue, Collection<IssueChangeDto> debtChangelog, Period period) {
  63     if (issue.creationDate().getTime() > period.getSnapshotDate() + 1000L) {
  64       return MoreObjects.firstNonNull(issue.effortInMinutes(), 0L);
  65     }
  66     return calculateFromChangelog(issue, debtChangelog, period.getSnapshotDate());
  67   }
  68
  69   private static long calculateFromChangelog(DefaultIssue issue, Collection<IssueChangeDto> debtChangelog, long periodDate) {
  70     List<FieldDiffs> debtDiffs = from(debtChangelog).transform(ToFieldDiffs.INSTANCE).filter(HasDebtChange.INSTANCE).toSortedList(CHANGE_ORDERING);
  71     FieldDiffs currentChange = issue.currentChange();
  72     if (currentChange != null && HasDebtChange.INSTANCE.apply(currentChange)) {
  73       debtDiffs = Lists.newArrayList(debtDiffs);
  74       debtDiffs.add(currentChange);
  75     }
  76     long newDebt = issue.effortInMinutes();
  77
  78     for (Iterator<FieldDiffs> it = debtDiffs.iterator(); it.hasNext();) {
  79       FieldDiffs diffs = it.next();
  80       Date date = diffs.creationDate();
  81       // TODO use longs
  82       if (isBeforeOrEqual(date, new Date(periodDate))) {
  83         // return new value from the change that is just before the period date
  84         return subtract(newDebt, debtDiff(diffs).newValueLong());
  85       }
  86       if (!it.hasNext()) {
  87         // return old value from the change that is just after the period date when there's no more element in changelog
  88         return subtract(newDebt, debtDiff(diffs).oldValueLong());
  89       }
  90     }
  91     // no changelog
  92     return 0L;
  93   }
  94
  95   /**
  96    * SONAR-5059
  97    */
  98   @CheckForNull
  99   private static long subtract(long newDebt, @Nullable Long with) {
 100     if (with != null) {
 101       return Math.max(0L, newDebt - with);
 102     }
 103     return newDebt;
 104   }
 105
 106   private static boolean isBeforeOrEqual(@Nullable Date changeDate, Date periodDate) {
 107     return (changeDate != null) && (DateUtils.truncatedCompareTo(changeDate, periodDate, Calendar.SECOND) <= 0);
 108   }
 109
 110   private static FieldDiffs.Diff debtDiff(FieldDiffs diffs) {
 111     return diffs.diffs().get(IssueFieldsSetter.TECHNICAL_DEBT);
 112   }
 113
 114   private enum ToFieldDiffs implements Function<IssueChangeDto, FieldDiffs> {
 115     INSTANCE;
 116     @Override
 117     public FieldDiffs apply(@Nonnull IssueChangeDto dto) {
 118       return dto.toFieldDiffs();
 119     }
 120   }
 121
 122   private enum HasDebtChange implements Predicate<FieldDiffs> {
 123     INSTANCE;
 124     @Override
 125     public boolean apply(@Nonnull FieldDiffs diffs) {
 126       return diffs.diffs().containsKey(IssueFieldsSetter.TECHNICAL_DEBT);
 127     }
 128   }
 129 }