/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* SonarQube is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.batch.rule;
import com.google.common.collect.ImmutableSortedMap;
import org.apache.commons.lang.time.DateUtils;
import org.sonar.api.batch.Decorator;
import org.sonar.api.batch.DecoratorContext;
import org.sonar.api.batch.DependsUpon;
import org.sonar.api.batch.Event;
import org.sonar.api.batch.TimeMachine;
import org.sonar.api.batch.TimeMachineQuery;
import org.sonar.api.measures.CoreMetrics;
import org.sonar.api.measures.Measure;
import org.sonar.api.measures.Metric;
import org.sonar.api.resources.Language;
import org.sonar.api.resources.Languages;
import org.sonar.api.resources.Project;
import org.sonar.api.resources.Qualifiers;
import org.sonar.api.resources.Resource;
import org.sonar.api.utils.KeyValueFormat;
import org.sonar.batch.index.PersistenceManager;
import org.sonar.core.UtcDateUtils;
import javax.annotation.CheckForNull;
import java.util.Date;
import java.util.List;
import java.util.Map;
public class QProfileEventsDecorator implements Decorator {
private final TimeMachine timeMachine;
private final Languages languages;
private final PersistenceManager persistenceManager;
public QProfileEventsDecorator(TimeMachine timeMachine, Languages languages, PersistenceManager pm) {
this.timeMachine = timeMachine;
this.languages = languages;
this.persistenceManager = pm;
}
@DependsUpon
public Metric dependsUpon() {
return CoreMetrics.QUALITY_PROFILES;
}
@Override
public boolean shouldExecuteOnProject(Project project) {
return true;
}
@Override
public void decorate(Resource resource, DecoratorContext context) {
if (!Qualifiers.isProject(resource, true)) {
return;
}
// Load previous profiles
Measure previousMeasure = getPreviousMeasure(resource, CoreMetrics.QUALITY_PROFILES);
if (previousMeasure == null || previousMeasure.getData() == null) {
// first analysis -> do not generate events
return;
}
Map<String, QProfile> previousProfiles = UsedQProfiles.fromJson(previousMeasure.getData()).profilesByKey();
// Load current profiles
Measure currentMeasure = context.getMeasure(CoreMetrics.QUALITY_PROFILES);
Map<String, QProfile> currentProfiles = UsedQProfiles.fromJson(currentMeasure.getData()).profilesByKey();
detectNewOrUpdatedProfiles(context, previousProfiles, currentProfiles);
detectNoMoreUsedProfiles(context, previousProfiles, currentProfiles);
}
private void detectNoMoreUsedProfiles(DecoratorContext context, Map<String, QProfile> previousProfiles, Map<String, QProfile> currentProfiles) {
for (QProfile previousProfile : previousProfiles.values()) {
if (!currentProfiles.containsKey(previousProfile.getKey())) {
markAsRemoved(context, previousProfile);
}
}
}
private void detectNewOrUpdatedProfiles(DecoratorContext context, Map<String, QProfile> previousProfiles, Map<String, QProfile> currentProfiles) {
for (QProfile profile : currentProfiles.values()) {
QProfile previousProfile = previousProfiles.get(profile.getKey());
if (previousProfile != null) {
if (profile.getRulesUpdatedAt().after(previousProfile.getRulesUpdatedAt())) {
markAsChanged(context, previousProfile, profile);
}
} else {
markAsAdded(context, profile);
}
}
}
private void markAsChanged(DecoratorContext context, QProfile previousProfile, QProfile profile) {
// DecoratorContext does not allow to set event data, so SonarIndex must be used
Event event = new Event();
event.setName(String.format("Changes in %s", profileLabel(profile)));
event.setCategory(Event.CATEGORY_PROFILE);
Date from = previousProfile.getRulesUpdatedAt();
String data = KeyValueFormat.format(ImmutableSortedMap.of(
"key", profile.getKey(),
"from", UtcDateUtils.formatDateTime(fixDate(from)),
"to", UtcDateUtils.formatDateTime(fixDate(profile.getRulesUpdatedAt()))));
event.setData(data);
persistenceManager.saveEvent(context.getResource(), event);
}
/**
* This hack must be done because date precision is millisecond in db/es and date format is select only
*/
private Date fixDate(Date date) {
return DateUtils.addSeconds(date, 1);
}
private void markAsRemoved(DecoratorContext context, QProfile profile) {
context.createEvent(String.format("Stop using %s", profileLabel(profile)), null, Event.CATEGORY_PROFILE, null);
}
private void markAsAdded(DecoratorContext context, QProfile profile) {
context.createEvent(String.format("Use %s", profileLabel(profile)), null, Event.CATEGORY_PROFILE, null);
}
@CheckForNull
private Measure getPreviousMeasure(Resource project, Metric metric) {
TimeMachineQuery query = new TimeMachineQuery(project)
.setOnlyLastAnalysis(true)
.setMetrics(metric);
List<Measure> measures = timeMachine.getMeasures(query);
if (measures.isEmpty()) {
return null;
}
return measures.get(0);
}
private String profileLabel(QProfile profile) {
Language language = languages.get(profile.getLanguage());
String languageName = language != null ? language.getName() : profile.getLanguage();
return String.format("'%s' (%s)", profile.getName(), languageName);
}
@Override
public String toString() {
return getClass().getSimpleName();
}
}