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

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

import static java.lang.Integer.parseInt;
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.PYLINT;
import static se.bjurr.violations.lib.util.ViolationParserUtils.getLines;

import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import se.bjurr.violations.lib.ViolationsLogger;
import se.bjurr.violations.lib.model.SEVERITY;
import se.bjurr.violations.lib.model.Violation;

/**
 * PyLint.

 * 
 * pylint --output-format=parseable
 * 
 */
public class PyLintParser implements ViolationsParser {

  @Override
  public Set parseReportOutput(final String string, ViolationsLogger violationsLogger)
      throws Exception {
    final Set violations = new TreeSet<>();
    final List> partsPerLine =
        getLines(string, "([^:]*):(\\d+): \\[(\\D)(\\d*)\\(([^\\]]*)\\), ([^\\]]*)] (.*)");
    for (final List parts : partsPerLine) {
      final String filename = parts.get(1);
      final Integer line = parseInt(parts.get(2));
      final String severity = parts.get(3);
      final String ruleCode = parts.get(4);
      final String rule = parts.get(5);
      final String method = parts.get(6);
      final String message = parts.get(7);
      violations.add( //
          violationBuilder() //
              .setParser(PYLINT) //
              .setStartLine(line) //
              .setFile(filename) //
              .setRule(severity + ruleCode + "(" + rule + ")") //
              .setSeverity(this.toSeverity(severity)) //
              .setMessage(message) //
              .setSpecific("method", method) //
              .build() //
          );
    }
    return violations;
  }

  /**
   *
   *
   *    * The different message types are:
   * (C) convention, for programming standard violation
   * (R) refactor, for bad code smell
   * (W) warning, for python specific problems
   * (E) error, for much probably bugs in the code
   * (F) fatal, if an error occured which prevented pylint from doing
   *     further processing.
   * 
   */
  public SEVERITY toSeverity(final String severity) {
    if (severity.equalsIgnoreCase("E") || severity.equalsIgnoreCase("F")) {
      return ERROR;
    }
    if (severity.equalsIgnoreCase("W")) {
      return WARN;
    }
    return INFO;
  }
}