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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of violations-lib Show documentation
Library for parsing report files from static code analyzis.
There is a newer version: 1.157.3
package se.bjurr.violations.lib.parsers;

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.PMD;
import static se.bjurr.violations.lib.util.ViolationParserUtils.findAttribute;
import static se.bjurr.violations.lib.util.ViolationParserUtils.findIntegerAttribute;
import static se.bjurr.violations.lib.util.ViolationParserUtils.getAttribute;
import static se.bjurr.violations.lib.util.ViolationParserUtils.getChunks;
import static se.bjurr.violations.lib.util.ViolationParserUtils.getContent;
import static se.bjurr.violations.lib.util.ViolationParserUtils.getIntegerAttribute;

import java.util.ArrayList;
import java.util.List;
import se.bjurr.violations.lib.model.SEVERITY;
import se.bjurr.violations.lib.model.Violation;
import se.bjurr.violations.lib.util.Optional;

public class PMDParser implements ViolationsParser {

  @Override
  public List parseReportOutput(String string) throws Exception {
    final List violations = new ArrayList<>();
    final List files = getChunks(string, "");
    for (final String fileChunk : files) {
      final String filename = getAttribute(fileChunk, "name");
      final List violationsChunks = getChunks(fileChunk, "");
      for (final String violationChunk : violationsChunks) {
        final Integer beginLine = getIntegerAttribute(violationChunk, "beginline");
        final Integer endLine = getIntegerAttribute(violationChunk, "endline");
        final Optional beginColumn = findIntegerAttribute(violationChunk, "begincolumn");
        final String rule = getAttribute(violationChunk, "rule").trim();
        final Optional ruleSetOpt = findAttribute(violationChunk, "ruleset");
        final Optional externalInfoUrlOpt =
            findAttribute(violationChunk, "externalInfoUrl");
        final Integer priority = getIntegerAttribute(violationChunk, "priority");
        final SEVERITY severity = toSeverity(priority);
        final String content = getContent(violationChunk, "violation");
        final String message =
            content + "\n\n" + ruleSetOpt.or("") + " " + externalInfoUrlOpt.or("");
        violations.add( //
            violationBuilder() //
                .setParser(PMD) //
                .setStartLine(beginLine) //
                .setEndLine(endLine) //
                .setColumn(beginColumn.orNull()) //
                .setFile(filename) //
                .setSeverity(severity) //
                .setRule(rule) //
                .setCategory(ruleSetOpt.orNull())
                .setMessage(message.trim()) //
                .build() //
            );
      }
    }
    return violations;
  }

  public SEVERITY toSeverity(Integer priority) {
    if (priority < 3) {
      return ERROR;
    }
    if (priority < 5) {
      return WARN;
    }
    return INFO;
  }
}