Issue #529: Deprecate launch.groovy and merge functionality into diff…

….groovy

.ci/travis.sh

@@ -34,9 +34,11 @@ patch-diff-report-tool)
 checkstyle-tester-launch-groovy)
   checkout_from https://github.com/checkstyle/checkstyle
   cd .ci-temp/checkstyle
+  LOCAL_GIT_REPO=$(pwd)
   mvn --batch-mode clean install -Passembly
   cd ../../checkstyle-tester
-  groovy launch.groovy -l projects-for-travis.properties -c my_check.xml -i
+  groovy diff.groovy -r "$LOCAL_GIT_REPO" -l projects-for-travis.properties --patchConfig my_check.xml \
+        --patchBranch master --mode single --allowExcludes
   ;;
 
 checkstyle-tester-diff-groovy-patch)
@@ -69,6 +71,37 @@ checkstyle-tester-diff-groovy-patch-only)
     -pc my_check.xml -p patch-branch -r ../.ci-temp/checkstyle -m single
   ;;
 
+checkstyle-tester-diff-groovy-regression-single)
+  # Check out lateset checkstyle from master
+  rm -rf .ci-temp
+  checkout_from https://github.com/checkstyle/checkstyle
+
+  # Run report from master branch of contribution
+  checkout_from https://github.com/checkstyle/contribution
+  cd .ci-temp/contribution/checkstyle-tester
+  sed -i'' 's/^guava/#guava/' projects-to-test-on.properties
+  sed -i'' 's/#checkstyle|/checkstyle|/' projects-to-test-on.properties
+  export MAVEN_OPTS="-Xmx2048m"
+  groovy ./diff.groovy --listOfProjects projects-to-test-on.properties \
+    -pc ../../../checkstyle-tester/diff-groovy-regression-config.xml \
+    -r ../../checkstyle -xm "-Dcheckstyle.failsOnError=false" \
+    -m single -p master
+
+  # Run report with current branch
+  cd ../../../checkstyle-tester/
+  sed -i'' 's/^guava/#guava/' projects-to-test-on.properties
+  sed -i'' 's/#checkstyle|/checkstyle|/' projects-to-test-on.properties
+  rm -rf reports repositories
+  groovy ./diff.groovy --listOfProjects projects-to-test-on.properties \
+    -pc diff-groovy-regression-config.xml -r ../.ci-temp/checkstyle/ \
+    -m single -p master -xm "-Dcheckstyle.failsOnError=false"
+
+  cd ..
+  # We need to ignore file paths below, since they will be different between reports
+  diff -I "contribution" checkstyle-tester/reports/diff/checkstyle/index.html \
+    .ci-temp/contribution/checkstyle-tester/reports/diff/checkstyle/index.html
+  ;;
+
 codenarc)
   cd checkstyle-tester
   ./codenarc.sh . diff.groovy > diff.log && cat diff.log && grep '(p1=0; p2=0; p3=0)' diff.log

.travis.yml

@@ -44,6 +44,16 @@ matrix:
         - DESC="checkstyle-tester (diff.groovy) on linux with enabled patchOnly"
         - CMD="./.ci/travis.sh checkstyle-tester-diff-groovy-patch-only"
 
+    - jdk: openjdk8
+      env:
+          - DESC="checkstyle-tester (diff.groovy) regression on linux in single mode"
+          - CMD="./.ci/travis.sh checkstyle-tester-diff-groovy-regression-single"
+
+    - jdk: openjdk8
+      env:
+          - DESC="checkstyle-tester (diff.groovy) regression on linux with master specified"
+          - CMD="./.ci/travis.sh checkstyle-tester-diff-groovy-regression"
+
     # disabled till https://github.com/checkstyle/contribution/issues/448
     # - jdk: openjdk8
     #   env:

appveyor.yml

@@ -83,15 +83,15 @@ environment:
       CMD3: " && cd checkstyle && git checkout -b patch-branch"
       CMD4: " "
       CMD5: " && cd ..\\checkstyle-tester "
-      CMD6: " && groovy diff.groovy -l projects-for-travis.properties -c my_check.xml -b master -p patch-branch -r C:\\projects\\contribution\\checkstyle -i -s"
+      CMD6: " && groovy diff.groovy -l projects-for-travis.properties -c my_check.xml -b master -p patch-branch -r C:\\projects\\contribution\\checkstyle -s"
     - JAVA_HOME: C:\Program Files\Java\jdk1.8.0
       DESC: "checkstyle-tester (diff.groovy with base and patch configs) on guava"
       CMD1: " git clone -q --depth=10 --branch=master "
       CMD2: "      https://github.com/checkstyle/checkstyle C:\\projects\\contribution\\checkstyle "
       CMD3: " && cd checkstyle && git checkout -b patch-branch"
       CMD4: " "
       CMD5: " && cd ..\\checkstyle-tester "
-      CMD6: " && groovy diff.groovy -l projects-for-travis.properties -bc my_check.xml -pc my_check.xml -b master -p patch-branch -r C:\\projects\\contribution\\checkstyle -i -s"
+      CMD6: " && groovy diff.groovy -l projects-for-travis.properties -bc my_check.xml -pc my_check.xml -b master -p patch-branch -r C:\\projects\\contribution\\checkstyle -s"
 
 build_script:
   - ps: >

checkstyle-tester/LAUNCH_GROOVY_README.md

@@ -1,3 +1,5 @@
+# _LAUNCH.GROOVY IS BEING DEPRECATED!!!_
+
 # launch.groovy
 
 Checkstyle report generation

checkstyle-tester/README.md

@@ -26,7 +26,7 @@ you may require other tools like Git or Mericural, for Git and HG repositories r
 
 `diff.groovy` supports the following command line arguments:
 
-**localGitRepo** (r) - path to the local Checkstyle repository (required);
+**localGitRepo** (r) - path to the local Checkstyle repository (required in diff mode);
 
 **baseBranch** (b) - name of the base branch in local Checkstyle repository
 (optional, if absent, then the tool will use only patchBranch in case the tool
@@ -42,7 +42,7 @@ will finish the execution with the error.
 You must specify 'patchBranch' and 'patchConfig' if the mode is 'single', and 'baseBranch',
 'baseConfig', 'patchBranch', and 'patchConfig' if the mode is 'diff');
 
-**patchBranch** (p) - name of the branch with your changes (required);
+**patchBranch** (p) - name of the branch with your changes (required in diff mode);
 
 **baseConfig** (bc) - path to the base checkstyle configuration file.
 It will be applied to base branch (required if patchConfig is specified);
@@ -65,6 +65,10 @@ This option is useful for Windows users where they are restricted to maximum dir
 to maven during the Checkstyle regression run.  For example, if you want to skip site generation, you
 would add `--extraMvnRegressionOptions "-Dmaven.site.skip=true"` to `diff.groovy` execution.
 
+**allowExcludes** (g) - this option tells `diff.groovy` to allow paths and files defined in the file specified for
+the `--listOfProjects (-l)` argument to be excluded from report generation (optional, default is false). This option is
+ used for files that are not compilable or that Checkstyle cannot parse.
+
 ## Outputs
 
 When the script finishes its work the following directory structure will be created