Split prj in multiple files for better structure and testing (#17)

Author: filipesperandio

Dockerfile

@@ -20,4 +20,4 @@ RUN chown -R app:app /usr/src/app
 
 USER app
 
-CMD ["/usr/src/app/pmd.groovy", "--codeFolder=/code", "--configFile=/config.json"]
+CMD ["/usr/src/app/pmd", "--codeFolder=/code", "--configFile=/config.json"]

fixtures/config.new.json

@@ -2,7 +2,7 @@
   "enabled": true,
   "channel": "beta",
   "config": {
-    "file": "fixtures/rules.xml",
+    "file": "specified_rules.xml",
   },
   "include_paths": [
     "Main.java"

fixtures/config.old.json

@@ -1,7 +1,7 @@
 {
   "enabled": true,
   "channel": "beta",
-  "config": "fixtures/rules.xml",
+  "config": "specified_rules.xml",
   "include_paths": [
     "Main.java"
   ]

fixtures/rules.xml renamed to fixtures/specified_rules.xml

@@ -9,8 +9,8 @@ The Basic ruleset contains a collection of good practices which should be follow
   </description>
 
 	<rule name="JumbledIncrementer"
-    	  language="java"
-    	  since="1.0"
+	  language="java"
+	  since="1.0"
           message="Avoid modifying an outer loop incrementer in an inner loop for update expression"
           class="net.sourceforge.pmd.lang.rule.XPathRule"
           externalInfoUrl="${pmd.website.baseurl}/rules/java/basic.html#JumbledIncrementer">
@@ -144,9 +144,9 @@ public class Foo {
 			synchronized(this) {
 				if (baz == null) {
 					baz = new Object();
-        		}
-      		}
-    	}
+			}
+		}
+	}
 		return baz;
 	}
 }
@@ -386,7 +386,7 @@ BigDecimal bd = new BigDecimal(12);     	// preferred approach, ok for integer v
 
 
     <rule  name="MisplacedNullCheck"
-    	   language="java"
+	   language="java"
            since="3.5"
            message="The null check here is misplaced; if the variable is null there will be a NullPointerException"
            class="net.sourceforge.pmd.lang.rule.XPathRule"
@@ -441,7 +441,7 @@ public class Foo {
 
 
     <rule  name="AvoidThreadGroup"
-    	   language="java"
+	   language="java"
            since="3.6"
            message="Avoid using java.lang.ThreadGroup; it is not thread safe"
            class="net.sourceforge.pmd.lang.rule.XPathRule"
@@ -527,10 +527,10 @@ bi4 = new BigInteger(0);				// reference BigInteger.ZERO instead
             class="net.sourceforge.pmd.lang.java.rule.basic.AvoidUsingOctalValuesRule"
             externalInfoUrl="${pmd.website.baseurl}/rules/java/basic.html#AvoidUsingOctalValues">
     <description>
-    	<![CDATA[
+	<![CDATA[
 Integer literals should not start with zero since this denotes that the rest of literal will be
 interpreted as an octal value.
-    	]]>
+	]]>
     </description>
     <priority>3</priority>
     <example>
@@ -548,10 +548,10 @@ k = i * j;		// set k with 80 not 120
             class="net.sourceforge.pmd.lang.java.rule.basic.AvoidUsingHardCodedIPRule"
             externalInfoUrl="${pmd.website.baseurl}/rules/java/basic.html#AvoidUsingHardCodedIP">
 	    <description>
-	    	<![CDATA[
+		<![CDATA[
 Application with hard-coded IP addresses can become impossible to deploy in some cases.
 Externalizing IP adresses is preferable.
-	    	]]>
+		]]>
 	    </description>
 	    <priority>3</priority>
 	     <properties>
@@ -567,7 +567,7 @@ public class Foo {
     </rule>
 
   <rule name="CheckResultSet"
-    	language="java"
+	language="java"
         since="4.1"
         class="net.sourceforge.pmd.lang.java.rule.basic.CheckResultSetRule"
         message="Always check the return of one of the navigation method (next,previous,first,last) of a ResultSet."
@@ -633,7 +633,7 @@ int j = -~7;
     </rule>
 
   <rule name="ExtendsObject"
-  		language="java"
+		language="java"
         since="5.0"
         message="No need to explicitly extend Object."
         class="net.sourceforge.pmd.lang.rule.XPathRule"
@@ -659,10 +659,10 @@ public class Foo extends Object { 	// not required
 
 	<rule name="CheckSkipResult"
 	      language="java"
-	  	  since="5.0"
+		  since="5.0"
           message="Check the value returned by the skip() method of an InputStream to see if the requested number of bytes has been skipped."
           class="net.sourceforge.pmd.lang.java.rule.basic.CheckSkipResultRule"
-	  	  externalInfoUrl="${pmd.website.baseurl}/rules/java/basic.html#CheckSkipResult">
+		  externalInfoUrl="${pmd.website.baseurl}/rules/java/basic.html#CheckSkipResult">
         <description>The skip() method may skip a smaller number of bytes than requested. Check the returned value to find out if it was the case or not.</description>
         <priority>3</priority>
         <example>
@@ -688,7 +688,7 @@ public class Foo {
     </rule>
 
 	<rule name="AvoidBranchingStatementAsLastInLoop"
-	  	  since="5.0"
+		  since="5.0"
 		  class="net.sourceforge.pmd.lang.java.rule.basic.AvoidBranchingStatementAsLastInLoopRule"
 		  message="Avoid using a branching statement as the last in a loop."
           externalInfoUrl="${pmd.website.baseurl}/rules/java/basic.html#AvoidBranchingStatementAsLastInLoop">

pmd

@@ -0,0 +1,9 @@
+#!/usr/bin/env sh
+
+libs() {
+  find $GROOVY_HOME/lib -name "*.jar" | tr "\n" ":"
+}
+
+SRC_DIR=/usr/src/app/src
+
+java -cp $SRC_DIR:$(libs) groovy.ui.GroovyMain $SRC_DIR/main.groovy $@

pmd.groovy renamed to src/Config.groovy

@@ -1,18 +1,16 @@
-#!/usr/bin/env groovy
-
 import groovy.json.JsonSlurper
 import groovy.util.FileNameFinder
 
 class Config {
+  static String DEFAULT_RULES = "/usr/src/app/ruleset.xml"
   def args
   def appContext
   def parsedConfig
   def filesToAnalyze
   def filesList
 
-  Config(args) {
-    this.args = args
-    this.appContext = setupContext()
+  Config(appContext) {
+    this.appContext = appContext
     this.parsedConfig = new JsonSlurper().parse(new File(appContext.configFile), "UTF-8")
     this.filesToAnalyze = filesToAnalyze()
     this.filesList = createTempFile()
@@ -27,25 +25,22 @@ class Config {
     if(parsedConfig.config) {
       def configFile = parsedConfig.config instanceof String ? parsedConfig.config : parsedConfig.config.file
 
-      if(fileExists(configFile)) {
-        return configFile
+      def specifiedRules = new File(appContext.codeFolder, configFile)
+      if(specifiedRules.exists()) {
+        return specifiedRules.absolutePath
       } else {
         System.err.println "Config file ${configFile} not found"
         System.exit(1)
       }
     }
 
-    "/usr/src/app/ruleset.xml"
+    return DEFAULT_RULES
   }
 
   def filesListPath() {
     filesList.absolutePath
   }
 
-  private def fileExists(file) {
-    new File(file).exists()
-  }
-
   private def filesToAnalyze() {
     def includePaths = parsedConfig.include_paths?.join(" ")
     def codeFolder = new File(appContext.codeFolder)
@@ -69,30 +64,4 @@ class Config {
     tmp.deleteOnExit()
     tmp
   }
-
-  private def setupContext() {
-    def cli = new CliBuilder(usage:"${this.class.name}")
-    cli._(longOpt: "configFile", required: true, args: 1, "Path to config.json file")
-    cli._(longOpt: "codeFolder", required: true, args: 1, "Path to code folder")
-    cli.parse(args)
-  }
 }
-
-def execute(command) {
-  ProcessBuilder builder = new ProcessBuilder(command.split(' '))
-  def env = builder.environment()
-  env.put("JAVA_OPTS", "-XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=30")
-  Process process = builder.start()
-  process.consumeProcessOutput(System.out, System.err)
-  process.waitFor()
-  System.exit(process.exitValue())
-}
-
-/* ********** MAIN ********** */
-
-def config = new Config(args)
-if (config.noFiles()) {
-  System.exit(0)
-}
-
-execute("/usr/src/app/lib/pmd/bin/run.sh pmd -filelist ${config.filesListPath()} -f codeclimate -R ${config.ruleSet()} -failOnViolation false")

src/main.groovy

@@ -0,0 +1,29 @@
+import groovy.util.*
+
+class Main {
+  static def execute(command) {
+    ProcessBuilder builder = new ProcessBuilder(command.split(' '))
+    def env = builder.environment()
+    env.put("JAVA_OPTS", "-XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=30")
+    Process process = builder.start()
+    process.consumeProcessOutput(System.out, System.err)
+    process.waitFor()
+    System.exit(process.exitValue())
+  }
+
+  static def appContext(args) {
+    def cli = new CliBuilder(usage:"${this.class.name}")
+    cli._(longOpt: "configFile", required: true, args: 1, "Path to config.json file")
+    cli._(longOpt: "codeFolder", required: true, args: 1, "Path to code folder")
+    cli.parse(args)
+  }
+
+  public static void main(args) {
+    def config = new Config(appContext(args))
+    if (config.noFiles()) {
+      System.exit(0)
+    }
+
+    execute("/usr/src/app/lib/pmd/bin/run.sh pmd -filelist ${config.filesListPath()} -f codeclimate -R ${config.ruleSet()} -failOnViolation false")
+  }
+}

test.sh

@@ -2,9 +2,10 @@
 set -ex
 
 BUILD_DIR=build
-GROOVY="${GROOVY_HOME}/embeddable/groovy-all-${GROOVY_VERSION}.jar"
-JUNIT=$(ls ${GROOVY_HOME}/lib/junit*.jar)
-HAMCREST=$(ls ${GROOVY_HOME}/lib/hamcrest*.jar)
+
+libs() {
+  find $GROOVY_HOME/lib -name "*.jar" | tr "\n" ":"
+}
 
 test_classes() {
   find test -name "*.groovy" | sed -E 's#test/(.*).groovy#\1#' | xargs
@@ -16,11 +17,11 @@ clean() {
 }
 
 build() {
-  groovyc test/**.groovy -d $BUILD_DIR
+  groovyc src/**.groovy test/**.groovy -d $BUILD_DIR
 }
 
 run() {
-  java -cp build:$JUNIT:$HAMCREST:$GROOVY org.junit.runner.JUnitCore $(test_classes)
+  java -cp build:$(libs) org.junit.runner.JUnitCore $(test_classes)
 }
 
 clean

test/SanityCheckTest.groovy

@@ -17,7 +17,7 @@ class SanityCheckTest {
 
   @Test
   void sanityCheck() {
-    def (proc, out, err) = execute("/usr/src/app/pmd.groovy --codeFolder=/usr/src/app/fixtures --configFile=/usr/src/app/fixtures/config.json")
+    def (proc, out, err) = execute("/usr/src/app/pmd --codeFolder=/usr/src/app/fixtures --configFile=/usr/src/app/fixtures/config.json")
 
     assert !out.toString().isEmpty()
     assert err.toString().isEmpty()
@@ -26,8 +26,8 @@ class SanityCheckTest {
 
   @Test
   void checkConfigBackwardCompatibility() {
-    def (proc, out, _err) = execute("/usr/src/app/pmd.groovy --codeFolder=/usr/src/app/fixtures --configFile=/usr/src/app/fixtures/config.new.json")
-    def (procOld, outOld, _errOld) = execute("/usr/src/app/pmd.groovy --codeFolder=/usr/src/app/fixtures --configFile=/usr/src/app/fixtures/config.old.json")
+    def (proc, out, _err) = execute("/usr/src/app/pmd --codeFolder=/usr/src/app/fixtures --configFile=/usr/src/app/fixtures/config.new.json")
+    def (procOld, outOld, _errOld) = execute("/usr/src/app/pmd --codeFolder=/usr/src/app/fixtures --configFile=/usr/src/app/fixtures/config.old.json")
 
     assert proc.exitValue() == procOld.exitValue()
     assert out.toString().equals(outOld.toString())
@@ -36,7 +36,7 @@ class SanityCheckTest {
 
   @Test
   void abortOnBadConfig() {
-    def (proc, out, err) = execute("/usr/src/app/pmd.groovy --codeFolder=/usr/src/app/fixtures --configFile=/usr/src/app/fixtures/config.bad.json")
+    def (proc, out, err) = execute("/usr/src/app/pmd --codeFolder=/usr/src/app/fixtures --configFile=/usr/src/app/fixtures/config.bad.json")
 
     assert !err.toString().isEmpty()
     assert proc.exitValue() != 0