eu.arthepsy.sonar.plugins.scapegoat.rule.ScapegoatQualityProfile.java Source code

Introduction

Here is the source code for eu.arthepsy.sonar.plugins.scapegoat.rule.ScapegoatQualityProfile.java

Source

/*
 * Scapegoat
 * Copyright (C) 2014 Andris Raugulis
 * moo@arthepsy.eu
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package eu.arthepsy.sonar.plugins.scapegoat.rule;

import eu.arthepsy.sonar.plugins.scapegoat.ScapegoatConfiguration;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.codehaus.staxmate.SMInputFactory;
import org.codehaus.staxmate.in.SMHierarchicCursor;
import org.codehaus.staxmate.in.SMInputCursor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.profiles.ProfileDefinition;
import org.sonar.api.profiles.RulesProfile;
import org.sonar.api.rule.RuleStatus;
import org.sonar.api.rule.Severity;
import org.sonar.api.rules.Rule;
import org.sonar.api.rules.RulePriority;
import org.sonar.api.utils.ValidationMessages;
import eu.arthepsy.sonar.plugins.scapegoat.language.Scala;
import eu.arthepsy.sonar.plugins.scapegoat.util.XmlUtils;

import javax.xml.stream.XMLStreamException;
import java.io.InputStream;

public class ScapegoatQualityProfile extends ProfileDefinition {

    private static final String SCAPEGOAT_RULES_FILE = "/scapegoat_rules.xml";
    private static final String SCAPEGOAT_PROFILE = "Sonar way";

    private static final Logger LOG = LoggerFactory.getLogger(ScapegoatQualityProfile.class);
    private static final String LOG_PREFIX = ScapegoatConfiguration.LOG_PREFIX;

    @Override
    public RulesProfile createProfile(ValidationMessages validationMessages) {
        final RulesProfile profile = RulesProfile.create(SCAPEGOAT_PROFILE, Scala.KEY);
        this.loadProfile(profile, validationMessages);
        return profile;
    }

    private void loadProfile(RulesProfile profile, ValidationMessages messages) {
        SMInputFactory factory = XmlUtils.createFactory();
        InputStream stream = getClass().getResourceAsStream(SCAPEGOAT_RULES_FILE);
        try {
            SMHierarchicCursor rootC = factory.rootElementCursor(stream);
            rootC.advance();
            SMInputCursor ruleC = rootC.childElementCursor("rule");
            while (ruleC.getNext() != null) {
                this.processRule(profile, ruleC, messages);
            }
        } catch (XMLStreamException e) {
            LOG.error(LOG_PREFIX + "rules file is not valid", e.getMessage());
            messages.addErrorText("Scapegoat rules file is not valid: " + e.getMessage());
        } finally {
            IOUtils.closeQuietly(stream);
        }
    }

    private void processRule(RulesProfile profile, SMInputCursor ruleC, ValidationMessages messages)
            throws XMLStreamException {
        String key = null, severity = Severity.defaultSeverity(), status = null;

        SMInputCursor cursor = ruleC.childElementCursor();
        while (cursor.getNext() != null) {
            String nodeName = cursor.getLocalName();
            if (StringUtils.equalsIgnoreCase("key", nodeName)) {
                key = XmlUtils.getNodeText(cursor);
            } else if (StringUtils.equalsIgnoreCase("severity", nodeName)) {
                severity = XmlUtils.getNodeText(cursor);
            } else if (StringUtils.equalsIgnoreCase("status", nodeName)) {
                status = XmlUtils.getNodeText(cursor);
            }
        }
        if (status != null && RuleStatus.valueOf(status) != RuleStatus.READY) {
            return;
        }
        profile.activateRule(Rule.create(ScapegoatRulesDefinition.SCAPEGOAT_REPOSITORY, key),
                RulePriority.valueOf(severity));
    }

}