org.sonar.scanner.rule.ActiveRulesProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-scanner-engine Show documentation
Show all versions of sonar-scanner-engine Show documentation
Open source platform for continuous inspection of code quality
/*
* SonarQube
* Copyright (C) 2009-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program 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.
*
* This program 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.scanner.rule;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.sonar.api.batch.rule.LoadedActiveRule;
import org.sonar.api.batch.rule.internal.ActiveRulesBuilder;
import org.sonar.api.batch.rule.internal.DefaultActiveRules;
import org.sonar.api.batch.rule.internal.NewActiveRule;
import org.sonar.api.rule.RuleKey;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonar.api.utils.log.Profiler;
import org.springframework.context.annotation.Bean;
/**
* Loads the rules that are activated on the Quality profiles
* used by the current project and builds {@link org.sonar.api.batch.rule.ActiveRules}.
*/
public class ActiveRulesProvider {
private static final Logger LOG = Loggers.get(ActiveRulesProvider.class);
private static final String LOG_MSG = "Load active rules";
@Bean("ActiveRules")
public DefaultActiveRules provide(ActiveRulesLoader loader, QualityProfiles qProfiles) {
Profiler profiler = Profiler.create(LOG).startInfo(LOG_MSG);
DefaultActiveRules activeRules = load(loader, qProfiles);
profiler.stopInfo();
return activeRules;
}
private static DefaultActiveRules load(ActiveRulesLoader loader, QualityProfiles qProfiles) {
Collection qProfileKeys = getKeys(qProfiles);
Set loadedRulesKey = new HashSet<>();
ActiveRulesBuilder builder = new ActiveRulesBuilder();
for (String qProfileKey : qProfileKeys) {
Collection qProfileRules = load(loader, qProfileKey);
for (LoadedActiveRule r : qProfileRules) {
if (!loadedRulesKey.contains(r.getRuleKey())) {
loadedRulesKey.add(r.getRuleKey());
builder.addRule(transform(r, qProfileKey, r.getDeprecatedKeys()));
}
}
}
return builder.build();
}
private static NewActiveRule transform(LoadedActiveRule activeRule, String qProfileKey, Set deprecatedKeys) {
NewActiveRule.Builder builder = new NewActiveRule.Builder();
builder
.setRuleKey(activeRule.getRuleKey())
.setName(activeRule.getName())
.setSeverity(activeRule.getSeverity())
.setCreatedAt(activeRule.getCreatedAt())
.setUpdatedAt(activeRule.getUpdatedAt())
.setLanguage(activeRule.getLanguage())
.setInternalKey(activeRule.getInternalKey())
.setTemplateRuleKey(activeRule.getTemplateRuleKey())
.setQProfileKey(qProfileKey)
.setDeprecatedKeys(deprecatedKeys);
// load parameters
if (activeRule.getParams() != null) {
for (Map.Entry params : activeRule.getParams().entrySet()) {
builder.setParam(params.getKey(), params.getValue());
}
}
return builder.build();
}
private static List load(ActiveRulesLoader loader, String qProfileKey) {
return loader.load(qProfileKey);
}
private static Collection getKeys(QualityProfiles qProfiles) {
List keys = new ArrayList<>(qProfiles.findAll().size());
for (QProfile qp : qProfiles.findAll()) {
keys.add(qp.getKey());
}
return keys;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy