se.bjurr.violations.lib.parsers.CodeNarcParser Maven / Gradle / Ivy

Go to download
package se.bjurr.violations.lib.parsers;

import static java.nio.charset.StandardCharsets.UTF_8;
import static javax.xml.stream.XMLStreamConstants.START_ELEMENT;
import static se.bjurr.violations.lib.model.SEVERITY.ERROR;
import static se.bjurr.violations.lib.model.SEVERITY.INFO;
import static se.bjurr.violations.lib.model.SEVERITY.WARN;
import static se.bjurr.violations.lib.model.Violation.violationBuilder;
import static se.bjurr.violations.lib.reports.Parser.CODENARC;
import static se.bjurr.violations.lib.util.ViolationParserUtils.getAttribute;
import static se.bjurr.violations.lib.util.ViolationParserUtils.getIntegerAttribute;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import se.bjurr.violations.lib.ViolationsLogger;
import se.bjurr.violations.lib.model.SEVERITY;
import se.bjurr.violations.lib.model.Violation;
import se.bjurr.violations.lib.util.ViolationParserUtils;

public class CodeNarcParser implements ViolationsParser {

  private SEVERITY getSeverity(final Integer from) {
    if (from == 1) {
      return ERROR;
    }
    if (from == 2) {
      return WARN;
    }
    return INFO;
  }

  @Override
  public Set parseReportOutput(
      final String string, final ViolationsLogger violationsLogger) throws Exception {
    final Set violations = new TreeSet<>();

    final Map rules = this.getRules(string);

    final String sourceDirectory = this.getSourceDirectory(string);

    try (InputStream input = new ByteArrayInputStream(string.getBytes(StandardCharsets.UTF_8))) {

      final XMLStreamReader xmlr = ViolationParserUtils.createXmlReader(input);

      String path = null;
      String name = null;
      while (xmlr.hasNext()) {
        final int eventType = xmlr.next();
        if (eventType == START_ELEMENT) {
          if (xmlr.getLocalName().equalsIgnoreCase("Package")) {
            path = getAttribute(xmlr, "path");
          }
          if (xmlr.getLocalName().equalsIgnoreCase("File")) {
            name = getAttribute(xmlr, "name");
          }
          if (xmlr.getLocalName().equalsIgnoreCase("Violation")) {
            final String ruleName = getAttribute(xmlr, "ruleName");
            final Integer priority = getIntegerAttribute(xmlr, "priority");
            final String lineNumberString = getAttribute(xmlr, "lineNumber");
            int lineNumber = 1;
            if (!lineNumberString.isEmpty()) {
              lineNumber = Integer.parseInt(lineNumberString);
            }
            String message = rules.get(ruleName);
            if (message == null) {
              message = ruleName;
            }
            String fileString;
            if (sourceDirectory.isEmpty()) {
              fileString = path + "/" + name;
            } else {
              fileString = sourceDirectory + "/" + path + "/" + name;
            }
            final Violation violation =
                violationBuilder() //
                    .setParser(CODENARC) //
                    .setFile(fileString.replace("//", "/")) //
                    .setMessage(message) //
                    .setRule(ruleName) //
                    .setSeverity(this.getSeverity(priority)) //
                    .setStartLine(lineNumber) //
                    .build();
            violations.add(violation);
          }
        }
      }
    }
    return violations;
  }

  private String getSourceDirectory(final String string) throws Exception {
    try (InputStream input = new ByteArrayInputStream(string.getBytes(UTF_8))) {
      final XMLStreamReader xmlr = ViolationParserUtils.createXmlReader(input);
      while (xmlr.hasNext()) {
        final int eventType = xmlr.next();
        if (eventType == START_ELEMENT) {
          if (xmlr.getLocalName().equalsIgnoreCase("SourceDirectory")) {
            return xmlr.getElementText().trim();
          }
        }
      }
    }
    return "";
  }

  private Map getRules(final String string) throws IOException, XMLStreamException {
    final Map rules = new HashMap<>();
    try (InputStream input = new ByteArrayInputStream(string.getBytes(StandardCharsets.UTF_8))) {
      final XMLStreamReader xmlr = ViolationParserUtils.createXmlReader(input);
      String name = null;
      while (xmlr.hasNext()) {
        final int eventType = xmlr.next();
        if (eventType == START_ELEMENT) {
          if (xmlr.getLocalName().equalsIgnoreCase("Rule")) {
            name = getAttribute(xmlr, "name");
          }
          if (xmlr.getLocalName().equalsIgnoreCase("Description")) {
            final String description = xmlr.getElementText().trim();
            rules.put(name, description);
          }
        }
      }
    }
    return rules;
  }
}