se.bjurr.violations.lib.parsers.FindbugsParser 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 com.google.common.base.Charsets.UTF_8;
import static com.google.common.base.Throwables.propagate;
import static com.google.common.collect.Lists.newArrayList;
import static com.google.common.collect.Maps.newHashMap;
import static com.google.common.io.Resources.getResource;
import static se.bjurr.violations.lib.model.Violation.violationBuilder;

import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.Map;

import se.bjurr.violations.lib.model.SEVERITY;
import se.bjurr.violations.lib.model.Violation;

import com.google.common.base.Optional;
import com.google.common.io.Files;
import com.google.common.io.Resources;

public class FindbugsParser extends ViolationsParser {

 /**
  * Severity rank.
  */
 public static final String FINDBUGS_SPECIFIC_RANK = "RANK";

 @Override
 public List parseFile(File file) throws Exception {
  List violations = newArrayList();
  Map messagesPerType = getMessagesPerType();
  String string = Files.toString(file, UTF_8);
  List bugInstances = getChunks(string, "");
  for (String bugInstanceChunk : bugInstances) {
   String type = getAttribute(bugInstanceChunk, "type");
   Integer rank = getIntegerAttribute(bugInstanceChunk, "rank");
   String message = messagesPerType.get(type);
   if (message == null) {
    message = type;
   }
   SEVERITY severity = toSeverity(rank);

   List sourceLineChunks = getChunks(bugInstanceChunk, "");
   for (String sourceLineChunk : sourceLineChunks) {
    Optional startLine = findIntegerAttribute(sourceLineChunk, "start");
    Optional endLine = findIntegerAttribute(sourceLineChunk, "end");
    if (!startLine.isPresent() || !endLine.isPresent()) {
     continue;
    }
    String filename = getAttribute(sourceLineChunk, "sourcepath");
    String classname = getAttribute(sourceLineChunk, "classname");
    violations.add(//
      violationBuilder()//
        .setMessage(message)//
        .setFile(filename)//
        .setStartLine(startLine.get())//
        .setEndLine(endLine.get())//
        .setRule(type)//
        .setSeverity(severity)//
        .setSource(classname)//
        .setSpecific(FINDBUGS_SPECIFIC_RANK, rank)//
        .build()//
      );
   }
  }
  return violations;
 }

 /**
  * Bugs are given a rank 1-20, and grouped into the categories scariest (rank
  * 1-4), scary (rank 5-9), troubling (rank 10-14), and of concern (rank 15-20).
  */
 private SEVERITY toSeverity(Integer rank) {
  if (rank <= 9) {
   return SEVERITY.ERROR;
  }
  if (rank <= 14) {
   return SEVERITY.WARN;
  }
  return SEVERITY.INFO;
 }

 private Map getMessagesPerType() {
  Map messagesPerType = newHashMap();
  try {
   String string = Resources.toString(getResource("findbugs/messages.xml"), UTF_8);
   List bugPatterns = getChunks(string, "");
   for (String bugPattern : bugPatterns) {
    String type = getAttribute(bugPattern, "type");
    String shortDescription = getContent(bugPattern, "ShortDescription");
    String details = getContent(bugPattern, "Details");
    messagesPerType.put(type, shortDescription + "\n\n" + details);
   }
  } catch (IOException e) {
   propagate(e);
  }
  return messagesPerType;
 }

}