Support GoLint #17

CHANGELOG.md

@@ -8,7 +8,15 @@ Changelog of Git Changelog.
 **PHPMD and PHPCS**
 
 
-[7a14ff2c22834d4](https://github.com/tomasbjerre/violations-lib/commit/7a14ff2c22834d4) Tomas Bjerre *2017-02-18 19:57:29*
+[f7212555f7a986b](https://github.com/tomasbjerre/violations-lib/commit/f7212555f7a986b) Tomas Bjerre *2017-02-18 20:01:36*
+
+
+### GitHub [#17](https://github.com/tomasbjerre/violations-lib/issues/17) Support golint
+
+**Support GoLint**
+
+
+[37123c1e2e4d37f](https://github.com/tomasbjerre/violations-lib/commit/37123c1e2e4d37f) Tomas Bjerre *2017-02-18 20:47:01*
 
 
 ## 1.22

README.md

@@ -19,6 +19,8 @@ It supports:
   * [_PyFlakes_](https://pypi.python.org/pypi/pyflakes)
  * [_FxCop_](https://en.wikipedia.org/wiki/FxCop)
  * [_Gendarme_](http://www.mono-project.com/docs/tools+libraries/tools/gendarme/)
+ * [_GoLint_](https://github.com/golang/lint)
+  * [_GoVet_](https://golang.org/cmd/vet/) Same format as GoLint.
  * [_JSHint_](http://jshint.com/)
  * _Lint_ A common XML format, used by different linters.
  * [_JCReport_](https://github.com/jCoderZ/fawkez/wiki/JcReport)

src/main/java/se/bjurr/violations/lib/parsers/GoLintParser.java

@@ -0,0 +1,62 @@
+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.parsers.ViolationParserUtils.getLines;
+import static se.bjurr.violations.lib.reports.Reporter.GOLINT;
+import static se.bjurr.violations.lib.util.Utils.isNullOrEmpty;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import se.bjurr.violations.lib.model.SEVERITY;
+import se.bjurr.violations.lib.model.Violation;
+
+public class GoLintParser implements ViolationsParser {
+
+  @Override
+  public List<Violation> parseReportOutput(String reportContent) throws Exception {
+    List<Violation> violations = new ArrayList<>();
+    List<List<String>> partsPerLine = getLines(reportContent, "^([^:]+?):(\\d*):?(\\d*?):?([^:]*?)?:? (.*)$");
+    for (List<String> parts : partsPerLine) {
+      String fileName = parts.get(1);
+      Integer lineNumber = 0;
+      if (!parts.get(2).isEmpty()) {
+        lineNumber = parseInt(parts.get(2));
+      }
+      Integer columnNumber = 0;
+      if (!parts.get(3).isEmpty()) {
+        columnNumber = parseInt(parts.get(3));
+      }
+      String severity = parts.get(4);
+      String message = parts.get(5);
+      violations.add(//
+          violationBuilder()//
+              .setReporter(GOLINT)//
+              .setStartLine(lineNumber)//
+              .setColumn(columnNumber)//
+              .setFile(fileName)//
+              .setSeverity(toSeverity(severity))//
+              .setMessage(message)//
+              .build()//
+      );
+    }
+    return violations;
+  }
+
+  public SEVERITY toSeverity(String severity) {
+    if (isNullOrEmpty(severity)) {
+      return INFO;
+    }
+    if (severity.equalsIgnoreCase("error")) {
+      return ERROR;
+    }
+    if (severity.equalsIgnoreCase("warning")) {
+      return WARN;
+    }
+    return INFO;
+  }
+}

src/main/java/se/bjurr/violations/lib/reports/Reporter.java

@@ -20,6 +20,7 @@
 import se.bjurr.violations.lib.parsers.Flake8Parser;
 import se.bjurr.violations.lib.parsers.FxCopParser;
 import se.bjurr.violations.lib.parsers.GendarmeParser;
+import se.bjurr.violations.lib.parsers.GoLintParser;
 import se.bjurr.violations.lib.parsers.JCReportParser;
 import se.bjurr.violations.lib.parsers.JSHintParser;
 import se.bjurr.violations.lib.parsers.LintParser;
@@ -53,6 +54,7 @@ public enum Reporter {
  JSHINT(new JSHintParser()), //
  LINT(new LintParser()), //
  MYPY(new MyPyParser()), //
+ GOLINT(new GoLintParser()), //
  PERLCRITIC(new PerlCriticParser()), //
  PITEST(new PiTestParser()), //
  PMD(new PMDParser()), //

src/main/java/se/bjurr/violations/lib/util/Utils.java

@@ -32,8 +32,8 @@ public static InputStream getResource(String filename) {
     return Thread.currentThread().getContextClassLoader().getSystemResourceAsStream(filename);
   }
 
-  public static boolean isNullOrEmpty(String findbugsMessagesXml) {
-    return findbugsMessagesXml == null || findbugsMessagesXml.isEmpty();
+  public static boolean isNullOrEmpty(String str) {
+    return str == null || str.isEmpty();
   }
 
   @SuppressWarnings("resource")

src/test/java/se/bjurr/violations/lib/GoLintTest.java

@@ -0,0 +1,82 @@
+package se.bjurr.violations.lib;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static se.bjurr.violations.lib.TestUtils.getRootFolder;
+import static se.bjurr.violations.lib.ViolationsReporterApi.violationsReporterApi;
+import static se.bjurr.violations.lib.model.SEVERITY.INFO;
+import static se.bjurr.violations.lib.model.SEVERITY.WARN;
+import static se.bjurr.violations.lib.reports.Reporter.GOLINT;
+
+import java.util.List;
+
+import org.junit.Test;
+
+import se.bjurr.violations.lib.model.Violation;
+
+public class GoLintTest {
+
+  @Test
+  public void testThatGoLintViolationsCanBeParsed() {
+    String rootFolder = getRootFolder();
+
+    List<Violation> actual = violationsReporterApi() //
+        .withPattern(".*/golint/golint\\.txt$") //
+        .inFolder(rootFolder) //
+        .findAll(GOLINT) //
+        .violations();
+
+    assertThat(actual)//
+        .hasSize(7);
+
+    assertThat(actual.get(0).getMessage())//
+        .isEqualTo(
+            "comment on exported type RestDataSource should be of the form \"RestDataSource ...\" (with optional leading article)");
+    assertThat(actual.get(0).getFile())//
+        .isEqualTo("src/bla/bla/bla/dataSource.go");
+    assertThat(actual.get(0).getSeverity())//
+        .isEqualTo(INFO);
+    assertThat(actual.get(0).getRule().orNull())//
+        .isEqualTo(null);
+    assertThat(actual.get(0).getStartLine())//
+        .isEqualTo(28);
+    assertThat(actual.get(0).getEndLine())//
+        .isEqualTo(28);
+
+    assertThat(actual.get(2).getMessage())//
+        .isEqualTo("declaration of err shadows declaration at journalevent.go:165: (vet shadow)  ");
+    assertThat(actual.get(2).getFile())//
+        .isEqualTo("journalevent.go");
+    assertThat(actual.get(2).getSeverity())//
+        .isEqualTo(WARN);
+    assertThat(actual.get(2).getRule().orNull())//
+        .isEqualTo(null);
+    assertThat(actual.get(2).getStartLine())//
+        .isEqualTo(182);
+    assertThat(actual.get(2).getEndLine())//
+        .isEqualTo(182);
+  }
+
+  @Test
+  public void testThatGoVetViolationsCanBeParsed() {
+    String rootFolder = getRootFolder();
+
+    List<Violation> actual = violationsReporterApi() //
+        .withPattern(".*/golint/govet\\.txt$") //
+        .inFolder(rootFolder) //
+        .findAll(GOLINT) //
+        .violations();
+
+    assertThat(actual)//
+        .hasSize(1);
+
+    assertThat(actual.get(0).getMessage())//
+        .isEqualTo(
+            "this is a message");
+    assertThat(actual.get(0).getFile())//
+        .isEqualTo("my_file.go");
+    assertThat(actual.get(0).getSeverity())//
+        .isEqualTo(INFO);
+    assertThat(actual.get(0).getStartLine())//
+        .isEqualTo(46);
+  }
+}

src/test/resources/golint/golint.txt

@@ -0,0 +1,7 @@
+src/bla/bla/bla/dataSource.go:28:1: comment on exported type RestDataSource should be of the form "RestDataSource ..." (with optional leading article)
+journalevent.go:308:1:warning: exported function NewSendJournalEventJob should have comment or be unexported (golint)
+journalevent.go:182::warning: declaration of err shadows declaration at journalevent.go:165: (vet shadow)  
+journalevent.go:::: testing1
+journalevent.go::: testing2
+journalevent.go:: testing3
+journalevent.go: testing4

src/test/resources/golint/govet.txt

@@ -0,0 +1,2 @@
+my_file.go:46: this is a message
+exit status 1