org.sonar.plugins.pmd.profile.PmdProfileImporter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sonar-pmd-plugin Show documentation
Sonar-PMD is a plugin that provides coding rules from PMD.
There is a newer version: 3.5.1
/*
 * SonarQube PMD Plugin
 * Copyright (C) 2012-2019 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.plugins.pmd.profile;

import java.io.Reader;

import org.sonar.api.profiles.ProfileImporter;
import org.sonar.api.profiles.RulesProfile;
import org.sonar.api.rules.ActiveRule;
import org.sonar.api.rules.Rule;
import org.sonar.api.rules.RuleFinder;
import org.sonar.api.rules.RuleQuery;
import org.sonar.api.utils.ValidationMessages;
import org.sonar.plugins.pmd.PmdConstants;
import org.sonar.plugins.pmd.PmdLevelUtils;
import org.sonar.plugins.pmd.xml.PmdProperty;
import org.sonar.plugins.pmd.xml.PmdRule;
import org.sonar.plugins.pmd.xml.PmdRuleSet;
import org.sonar.plugins.pmd.xml.PmdRuleSets;

public class PmdProfileImporter extends ProfileImporter {

    private final RuleFinder ruleFinder;

    public PmdProfileImporter(RuleFinder ruleFinder) {
        super(PmdConstants.REPOSITORY_KEY, PmdConstants.PLUGIN_NAME);
        setSupportedLanguages(PmdConstants.LANGUAGE_KEY);
        this.ruleFinder = ruleFinder;
    }

    private void setParameters(ActiveRule activeRule, PmdRule pmdRule, Rule rule, ValidationMessages messages) {
        for (PmdProperty prop : pmdRule.getProperties()) {
            String paramName = prop.getName();
            if (rule.getParam(paramName) == null) {
                messages.addWarningText("The property '" + paramName + "' is not supported in the pmd rule: " + pmdRule.getRef());
            } else {
                activeRule.setParameter(paramName, prop.getValue());
            }
        }
    }

    @Override
    public RulesProfile importProfile(Reader pmdConfigurationFile, ValidationMessages messages) {
        PmdRuleSet pmdRuleset = PmdRuleSets.from(pmdConfigurationFile, messages);
        RulesProfile profile = RulesProfile.create();
        for (PmdRule pmdRule : pmdRuleset.getPmdRules()) {
            String ruleClassName = pmdRule.getClazz();
            if (PmdConstants.XPATH_CLASS.equals(ruleClassName)) {
                messages.addWarningText("PMD XPath rule '" + pmdRule.getName()
                        + "' can't be imported automatically. The rule must be created manually through the SonarQube web interface.");
            } else {
                String ruleRef = pmdRule.getRef();
                if (ruleRef == null) {
                    messages.addWarningText("A PMD rule without 'ref' attribute can't be imported. see '" + ruleClassName + "'");
                } else {
                    Rule rule = ruleFinder.find(RuleQuery.create().withRepositoryKey(PmdConstants.REPOSITORY_KEY).withConfigKey(ruleRef));
                    if (rule != null) {
                        ActiveRule activeRule = profile.activateRule(rule, PmdLevelUtils.fromLevel(pmdRule.getPriority()));
                        setParameters(activeRule, pmdRule, rule, messages);
                    } else {
                        messages.addWarningText("Unable to import unknown PMD rule '" + ruleRef + "'");
                    }
                }
            }
        }
        return profile;
    }
}