Add checkstyle plugin to enforce consistency (#605)

* Add checkstyle plugin to enforce consistency

* Use checkstyle version 6.18

* Don't use the 'check' task to run tests since checkstyle screws it up

* Change import order, remove dependencies from checkstyle tasks

Also formatted build.gradle and checkstyle.xml

New import order:

edu.wpi.grip.*
non-GRIP imports, alphabetically
static imports, alphabetically

Author: SamCarlberg

.travis.yml

@@ -30,7 +30,7 @@ install:
   - '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && ./gradlew :ui:assemble --stacktrace || ./gradlew --stacktrace '
 
 script:
-  - ./gradlew check --stacktrace -Pheadless=true -PlogTests
+  - ./gradlew checkstyleMain checkstyleTest jacocoTestReport jacocoRootReport test --stacktrace -Pheadless=true -PlogTests
 
 after_success:
   - if [[ "$TRAVIS_OS_NAME" != "osx" ]]; then codecov         ; fi

appveyor.yml

@@ -6,7 +6,7 @@ build_script:
 
 # to run your custom scripts instead of automatic tests
 test_script:
-  - gradlew.bat check --stacktrace -Pheadless=true -PlogTests
+  - gradlew.bat checkstyleMain checkstyleTest jacocoTestReport jacocoRootReport test --stacktrace -Pheadless=true -PlogTests
 
 platform:
   - x64

build.gradle

@@ -30,7 +30,7 @@ def getGitCommit = { ->
 idea.project {
     ipr.withXml { provider ->
         def node = provider.asNode()
-        def compilerConfig = node.component.find { it.'@name' == 'CompilerConfiguration'}
+        def compilerConfig = node.component.find { it.'@name' == 'CompilerConfiguration' }
         compilerConfig.annotationProcessing[0].'@enabled' = 'true'
 //        def ccfg = node.component.find { it.@name == 'CompilerConfiguration' }
 //        ccfg.remove(ccfg.annotationProcessing)
@@ -89,11 +89,22 @@ allprojects {
     apply plugin: 'application'
     apply plugin: 'jacoco'
     apply plugin: 'net.ltgt.errorprone'
+    apply plugin: 'checkstyle'
 
     configurations.errorprone {
         resolutionStrategy.force 'com.google.errorprone:error_prone_core:2.0.9'
     }
 
+    checkstyle {
+        configFile = new File(rootDir, "checkstyle.xml")
+        toolVersion = '6.19'
+    }
+
+    tasks.withType(Checkstyle) {
+        // Remove checkstyle dependencies on compilation
+        // (This neuters :core:checkstyleGenerated, but since that's not needed anyway, who cares)
+        it.dependsOn = []
+    }
 
     repositories {
         mavenCentral()
@@ -125,8 +136,6 @@ allprojects {
         }
     }
 
-    check.dependsOn jacocoTestReport
-
     tasks.withType(Javadoc) {
         source compileJava.source
         options.addStringOption('Xdoclint:all,-html', '-quiet')
@@ -141,7 +150,7 @@ allprojects {
     test {
         testLogging {
             if (project.hasProperty('logTests')) {
-                events  "started", "passed", "skipped", "failed"
+                events "started", "passed", "skipped", "failed"
             } else {
                 events "failed"
             }
@@ -372,7 +381,6 @@ task jacocoRootReport(type: JacocoReport, group: 'Coverage reports') {
         executionData = files(executionData.findAll { it.exists() })
     }
 }
-check.dependsOn jacocoRootReport
 
 task wrapper(type: Wrapper) {
     gradleVersion = '2.13'

buildSrc/src/main/java/edu/wpi/gripgenerator/FileParser.java

@@ -8,6 +8,7 @@
 import com.github.javaparser.ast.expr.FieldAccessExpr;
 import com.github.javaparser.ast.expr.NameExpr;
 import com.github.javaparser.ast.type.PrimitiveType;
+
 import edu.wpi.gripgenerator.defaults.DefaultValueCollector;
 import edu.wpi.gripgenerator.defaults.EnumDefaultValue;
 import edu.wpi.gripgenerator.defaults.PrimitiveDefaultValue;
@@ -24,116 +25,120 @@
 import java.util.Set;
 
 public class FileParser {
-    /**
-     * Regex splits the parameter into three distinct capture groups.
-     * <ol>
-     * <li>The type and the param with optional varargs.</li>
-     * <li>The comment that is after the parameter.</li>
-     * <li>The various ways that the parameter can end.</li>
-     * </ol>
-     */
-    protected static final String methodReorderPattern = "([A-Za-z1-9]+ (?:\\.\\.\\.)?[a-z][A-Za-z0-9_]*)(/\\*=[^ ]*\\*/)((?:,)|(?:\\s*\\)))";
-
-    /**
-     * Reorders the {@link FileParser#methodReorderPattern} capture groups so the JavaParser can correctly
-     * associate the params with their respective comments.
-     */
-    protected static final String methodNewOrder = "$2$1$3";
-
-    /**
-     * There is a bug in the JavaParser that will incorrectly associate comments after a parameter but
-     * before a comma will incorrectly associate that comment with the next param in the method's params.
-     *
-     * @param stream The original input file.
-     * @return The processed output stream.
-     * @see <a href="https://github.com/javaparser/javaparser/issues/199">Javaparser Issue:199</a>
-     */
-    private static InputStream preProcessStream(InputStream stream) {
-        //FIXME: This is a hack around. This should be removed once the above noted issue is resolved.
-        java.util.Scanner s = new java.util.Scanner(stream, StandardCharsets.UTF_8.name()).useDelimiter("\\A");
-        String input = s.hasNext() ? s.next() : "";
-        input = input.replaceAll(methodReorderPattern, methodNewOrder);
-        return new ByteArrayInputStream(input.getBytes(StandardCharsets.UTF_8));
-    }
-
-    private static CompilationUnit readFile(URL url) {
-        try {
-            return JavaParser.parse(preProcessStream(url.openStream()));
-        } catch (IOException e) {
-            throw new IllegalStateException(e);
-        } catch (ParseException e) {
-            throw new IllegalStateException(e);
-        }
+  /**
+   * Regex splits the parameter into three distinct capture groups. <ol> <li>The type and the param
+   * with optional varargs.</li> <li>The comment that is after the parameter.</li> <li>The various
+   * ways that the parameter can end.</li> </ol>
+   */
+  protected static final String methodReorderPattern = "([A-Za-z1-9]+ (?:\\.\\.\\.)" +
+      "?[a-z][A-Za-z0-9_]*)(/\\*=[^ ]*\\*/)((?:,)|(?:\\s*\\)))";
+
+  /**
+   * Reorders the {@link FileParser#methodReorderPattern} capture groups so the JavaParser can
+   * correctly associate the params with their respective comments.
+   */
+  protected static final String methodNewOrder = "$2$1$3";
+
+  /**
+   * There is a bug in the JavaParser that will incorrectly associate comments after a parameter but
+   * before a comma will incorrectly associate that comment with the next param in the method's
+   * params.
+   *
+   * @param stream The original input file.
+   * @return The processed output stream.
+   * @see <a href="https://github.com/javaparser/javaparser/issues/199">Javaparser Issue:199</a>
+   */
+  private static InputStream preProcessStream(InputStream stream) {
+    //FIXME: This is a hack around. This should be removed once the above noted issue is resolved.
+    java.util.Scanner s = new java.util.Scanner(stream, StandardCharsets.UTF_8.name())
+        .useDelimiter("\\A");
+    String input = s.hasNext() ? s.next() : "";
+    input = input.replaceAll(methodReorderPattern, methodNewOrder);
+    return new ByteArrayInputStream(input.getBytes(StandardCharsets.UTF_8));
+  }
+
+  private static CompilationUnit readFile(URL url) {
+    try {
+      return JavaParser.parse(preProcessStream(url.openStream()));
+    } catch (IOException e) {
+      throw new IllegalStateException(e);
+    } catch (ParseException e) {
+      throw new IllegalStateException(e);
     }
-
-    /**
-     * Generates all of the source code from the opencv bindings
-     *
-     * @return A map of the filename with the compilation units
-     */
-    public static Map<String, CompilationUnit> generateAllSourceCode() {
-        URL INPUT_URL = FileParser.class.getResource("/org/bytedeco/javacpp/opencv_core.txt");
-        CompilationUnit compilationUnit = readFile(INPUT_URL);
-        Map<String, CompilationUnit> returnMap = new HashMap<>();
-        DefaultValueCollector collector = new DefaultValueCollector();
-        collector.add(new PrimitiveDefaultValue(new PrimitiveType(PrimitiveType.Primitive.Double)) {
-            @Override
-            protected Set<String> getDefaultValues() {
-                return Collections.singleton("CV_PI");
-            }
-
-            @Override
-            public Expression getDefaultValue(String defaultValue) {
-                return new FieldAccessExpr(
-                        new NameExpr("Math"),
-                        "PI"
-                );
-            }
-        });
-
-        collector.add(new EnumDefaultValue("edu.wpi.grip.core.operations.opencv.enumeration", "FlipCode", "X_AXIS", "Y_AXIS", "BOTH_AXES"));
-
-        OperationList operationList = new OperationList(
-                new ImportDeclaration(new NameExpr("edu.wpi.grip.generated.opencv_core"), false, true),
-                new ImportDeclaration(new NameExpr("edu.wpi.grip.generated.opencv_imgproc"), false, true)
+  }
+
+  /**
+   * Generates all of the source code from the opencv bindings
+   *
+   * @return A map of the filename with the compilation units
+   */
+  public static Map<String, CompilationUnit> generateAllSourceCode() {
+    URL openCvCoreUrl = FileParser.class.getResource("/org/bytedeco/javacpp/opencv_core.txt");
+    CompilationUnit compilationUnit = readFile(openCvCoreUrl);
+    Map<String, CompilationUnit> returnMap = new HashMap<>();
+    DefaultValueCollector collector = new DefaultValueCollector();
+    collector.add(new PrimitiveDefaultValue(new PrimitiveType(PrimitiveType.Primitive.Double)) {
+      @Override
+      protected Set<String> getDefaultValues() {
+        return Collections.singleton("CV_PI");
+      }
+
+      @Override
+      public Expression getDefaultValue(String defaultValue) {
+        return new FieldAccessExpr(
+            new NameExpr("Math"),
+            "PI"
         );
+      }
+    });
 
-        if (compilationUnit != null) {
-            returnMap.putAll(parseOpenCVCore(compilationUnit, collector, operationList));
-        } else {
-            System.err.print("Invalid File input");
-        }
-        URL INPUT_URL2 = FileParser.class.getResource("/org/bytedeco/javacpp/opencv_imgproc.txt");
-        compilationUnit = readFile(INPUT_URL2);
-        if (compilationUnit != null) {
-            returnMap.putAll(parseOpenImgprc(compilationUnit, collector, operationList));
-
-        }
-        return returnMap;
-    }
-
-    public static Map<String, CompilationUnit> parseOpenImgprc(CompilationUnit imgprocDeclaration, DefaultValueCollector collector, OperationList operations) {
-        Map<String, CompilationUnit> compilationUnits = new HashMap<>();
-        final String baseClassName = "opencv_imgproc";
-
-        OpenCVEnumVisitor enumVisitor = new OpenCVEnumVisitor(baseClassName, collector);
-        enumVisitor.visit(imgprocDeclaration, compilationUnits);
-        compilationUnits.putAll(enumVisitor.generateCompilationUnits());
-        return compilationUnits;
-    }
+    collector.add(new EnumDefaultValue("edu.wpi.grip.core.operations.opencv.enumeration",
+        "FlipCode", "X_AXIS", "Y_AXIS", "BOTH_AXES"));
 
-    public static Map<String, CompilationUnit> parseOpenCVCore(CompilationUnit coreDeclaration, DefaultValueCollector collector, OperationList operations) {
-        Map<String, CompilationUnit> compilationUnits = new HashMap<>();
-        final String baseClassName = "opencv_core";
+    OperationList operationList = new OperationList(
+        new ImportDeclaration(new NameExpr("edu.wpi.grip.generated.opencv_core"), false, true),
+        new ImportDeclaration(new NameExpr("edu.wpi.grip.generated.opencv_imgproc"), false, true)
+    );
 
-        OpenCVEnumVisitor enumVisitor = new OpenCVEnumVisitor(baseClassName, collector);
-        enumVisitor.visit(coreDeclaration, compilationUnits);
-        compilationUnits.putAll(enumVisitor.generateCompilationUnits());
-
-        return compilationUnits;
+    if (compilationUnit != null) {
+      returnMap.putAll(parseOpenCVCore(compilationUnit, collector, operationList));
+    } else {
+      System.err.print("Invalid File input");
     }
-
-    public static void main(String... args) {
-        FileParser.generateAllSourceCode();
+    URL openCvImgprocUrl = FileParser.class.getResource("/org/bytedeco/javacpp/opencv_imgproc.txt");
+    compilationUnit = readFile(openCvImgprocUrl);
+    if (compilationUnit != null) {
+      returnMap.putAll(parseOpenImgprc(compilationUnit, collector, operationList));
     }
+    return returnMap;
+  }
+
+  public static Map<String, CompilationUnit> parseOpenImgprc(CompilationUnit imgprocDeclaration,
+                                                             DefaultValueCollector collector,
+                                                             OperationList operations) {
+    Map<String, CompilationUnit> compilationUnits = new HashMap<>();
+    final String baseClassName = "opencv_imgproc";
+
+    OpenCVEnumVisitor enumVisitor = new OpenCVEnumVisitor(baseClassName, collector);
+    enumVisitor.visit(imgprocDeclaration, compilationUnits);
+    compilationUnits.putAll(enumVisitor.generateCompilationUnits());
+    return compilationUnits;
+  }
+
+  public static Map<String, CompilationUnit> parseOpenCVCore(CompilationUnit coreDeclaration,
+                                                             DefaultValueCollector collector,
+                                                             OperationList operations) {
+    Map<String, CompilationUnit> compilationUnits = new HashMap<>();
+    final String baseClassName = "opencv_core";
+
+    OpenCVEnumVisitor enumVisitor = new OpenCVEnumVisitor(baseClassName, collector);
+    enumVisitor.visit(coreDeclaration, compilationUnits);
+    compilationUnits.putAll(enumVisitor.generateCompilationUnits());
+
+    return compilationUnits;
+  }
+
+  public static void main(String... args) {
+    FileParser.generateAllSourceCode();
+  }
 }