Support new config format. Fix #4

Author: filipesperandio

pmd.groovy

@@ -3,65 +3,100 @@
 import groovy.json.JsonSlurper
 import groovy.util.FileNameFinder
 
-def appContext = setupContext(args)
-def parsedConfig = new JsonSlurper().parse(new File(appContext.configFile), "UTF-8")
 
-def includePaths = parsedConfig.include_paths?.join(" ")
-def codeFolder = new File(appContext.codeFolder)
+class Config {
+  static final FILE_LIST = "/tmp/files"
+  def args
+  def appContext
+  def parsedConfig
+  def filesToAnalyze
+
+  Config(args) {
+    this.args = args
+    this.appContext = setupContext()
+    this.parsedConfig = new JsonSlurper().parse(new File(appContext.configFile), "UTF-8")
+    this.filesToAnalyze = filesToAnalyze()
+    saveFilesToAnalyze()
+  }
+
+  def ruleSet() {
+    def configFile = parsedConfig.config instanceof String ? parsedConfig.config : parsedConfig.config.file
+
+    if(fileExists(configFile)) {
+      return configFile
+    }
+
+    "/usr/src/app/ruleset.xml"
+  }
+
+  def fileExists(file) {
+    new File(file).exists()
+  }
+
+  def noFiles() {
+    filesToAnalyze.isEmpty()
+  }
+
+  def saveFilesToAnalyze() {
+    File analysisFilesTmp = createTempFile()
+    analysisFilesTmp << filesToAnalyze
+  }
 
-def filesToAnalyse = new FileNameFinder().getFileNames(appContext.codeFolder, includePaths)
+  def filesToAnalyze() {
+    def includePaths = parsedConfig.include_paths?.join(" ")
+    def codeFolder = new File(appContext.codeFolder)
 
-File analysisFilesTmp = new File("/tmp/files")
-analysisFilesTmp.createNewFile()
-analysisFilesTmp.deleteOnExit()
+    def files = new FileNameFinder().getFileNames(appContext.codeFolder, includePaths)
 
-def i = filesToAnalyse.iterator()
-while(i.hasNext()) {
-    string = i.next()
-    if( !string.endsWith(".java") ) {
+    def i = files.iterator()
+    while(i.hasNext()) {
+      def name = i.next()
+      if(!name.endsWith(".java")) {
         i.remove()
+      }
     }
-}
 
-filesToAnalyse = filesToAnalyse.toString()
-filesToAnalyse = filesToAnalyse.substring(1, filesToAnalyse.length()-1).replaceAll("\\s+","")
-if (filesToAnalyse.isEmpty()) {
-    System.exit(0)
-}
+    def fileNames = files.toString()
+    fileNames.substring(1, fileNames.length()-1).replaceAll("\\s+","")
+  }
 
-analysisFilesTmp << filesToAnalyse
+  def createTempFile() {
+    File tmp = new File(FILE_LIST)
+    tmp.createNewFile()
+    tmp.deleteOnExit()
+    tmp
+  }
 
-def ruleSetPath
-if ( parsedConfig.config && (new File(parsedConfig.config).exists()) ) {
-  ruleSetPath = parsedConfig.config
-} else {
-  ruleSetPath = "/usr/src/app/ruleset.xml"
+  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 pmdCommand = "/usr/src/app/lib/pmd/bin/run.sh pmd -filelist /tmp/files -f codeclimate -R ${ruleSetPath} -failOnViolation false"
+/* ********** MAIN ********** */
 
-ProcessBuilder builder = new ProcessBuilder( pmdCommand.split(' ') )
+def config = new Config(args)
+if (config.noFiles()) {
+  System.exit(0)
+}
 
-Process process = builder.start()
+def command = "/usr/src/app/lib/pmd/bin/run.sh pmd -filelist ${Config.FILE_LIST} -f codeclimate -R ${config.ruleSet()} -failOnViolation false"
 
-InputStream stdout = process.getInputStream ()
-BufferedReader reader = new BufferedReader (new InputStreamReader(stdout))
+ProcessBuilder builder = new ProcessBuilder(command.split(' '))
+Process process = builder.start()
 
-while ((line = reader.readLine ()) != null) {
-   System.out.println ( line )
+InputStream stdout = process.getInputStream()
+BufferedReader reader = new BufferedReader(new InputStreamReader(stdout))
+while ((line = reader.readLine()) != null) {
+  System.out.println(line)
 }
 
 process.waitForProcessOutput()
 
-if ( process.exitValue() != 0 ) {
-    System.exit(-1)
+if (process.exitValue() != 0) {
+  System.exit(-1)
 }
 
 System.exit(0)
-
-def setupContext(cmdArgs) {
-    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(cmdArgs)
-}

test.groovy

@@ -3,18 +3,31 @@
 import groovy.json.JsonSlurper
 import groovy.util.FileNameFinder
 
-def sanityCheck() {
-  def command = "/usr/src/app/pmd.groovy --codeFolder=/code/test --configFile=/code/test/config.json"
-
+def execute(command) {
   def proc = command.execute()
   def out = new StringBuffer()
   def err = new StringBuffer()
 
   proc.waitForProcessOutput(out, err)
 
-  assert proc.exitValue() == 0
+  return [proc, out, err]
+}
+
+def sanityCheck() {
+  def (proc, out, err) = execute("/usr/src/app/pmd.groovy --codeFolder=/code/test --configFile=/code/test/config.json")
+
   assert !out.toString().isEmpty()
   assert err.toString().isEmpty()
+  assert proc.exitValue() == 0
+}
+
+def checkConfigBackwardCompatibility() {
+  def (proc, out, _err) = execute("/usr/src/app/pmd.groovy --codeFolder=/code/test --configFile=/code/test/config.json")
+  def (procOld, outOld, _errOld) = execute("/usr/src/app/pmd.groovy --codeFolder=/code/test --configFile=/code/test/config.old.json")
+
+  assert proc.exitValue() == procOld.exitValue()
+  assert out.toString().equals(outOld.toString())
+  assert proc.exitValue() == 0
 }
 
 def engineCheckList() {
@@ -45,6 +58,7 @@ def dockerfileCheckList() {
 
 /** MAIN **/
 
-sanityCheck()
 engineCheckList()
 dockerfileCheckList()
+sanityCheck()
+checkConfigBackwardCompatibility()

test/config.json

@@ -1,6 +1,9 @@
 {
   "enabled": true,
   "channel": "beta",
+  "config": {
+    "file": "test/rules.xml",
+  },
   "include_paths": [
     "Main.java"
   ]

test/config.old.json

@@ -0,0 +1,9 @@
+{
+  "enabled": true,
+  "channel": "beta",
+  "config": "test/rules.xml",
+  "include_paths": [
+    "Main.java"
+  ]
+}
+