Merge pull request #75 from adangel/pmd-regression-tester

Add new option "--error-recovery" #75

Author: adangel

History.md

@@ -15,6 +15,7 @@ Typeresolution is now supported by two new tags in the project-list.xml file:
 *   [#69](https://github.com/pmd/pmd-regression-tester/pull/69): Detect single rules with auto-gen-config
 *   [#70](https://github.com/pmd/pmd-regression-tester/pull/70): Add link to PR on github in HTML report
 *   [#74](https://github.com/pmd/pmd-regression-tester/pull/74): Merge violations that have just changed messages
+*   [#75](https://github.com/pmd/pmd-regression-tester/pull/75): Add new option "--error-recovery"
 
 ## External Contributions
 

README.rdoc

@@ -39,6 +39,7 @@ on a list of standard projects(Spring Framework, Hibernate, Solr, etc.)
     -a, --auto-gen-config  whether to generate configurations automatically based on branch differences,this option only works in online and local mode
     --keep-reports         whether to keep old reports and skip running PMD again if possible
     -d, --debug            whether change log level to DEBUG to see more information
+    --error-recovery       enable error recovery mode when executing PMD. Might help to analyze errors.
     -v, --version
     -h, --help
 

lib/pmdtester/builders/pmd_report_builder.rb

@@ -8,16 +8,17 @@ module PmdTester
   # projects and branch of pmd source code
   class PmdReportBuilder
     include PmdTester
-    def initialize(branch_config, projects, local_git_repo, pmd_branch_name, threads = 1)
-      @branch_config = branch_config
+    def initialize(projects, options, branch_config, branch_name)
       @projects = projects
-      @local_git_repo = local_git_repo
-      @pmd_branch_name = pmd_branch_name
-      @threads = threads
+      @local_git_repo = options.local_git_repo
+      @threads = options.threads
+      @error_recovery = options.error_recovery
+      @branch_config = branch_config
+      @pmd_branch_name = branch_name
       @pwd = Dir.getwd
 
-      @pmd_branch_details = PmdBranchDetail.new(pmd_branch_name)
-      @project_builder = ProjectBuilder.new(projects)
+      @pmd_branch_details = PmdBranchDetail.new(@pmd_branch_name)
+      @project_builder = ProjectBuilder.new(@projects)
     end
 
     def get_pmd_binary_file
@@ -82,8 +83,10 @@ def get_last_commit_message
     end
 
     def generate_pmd_report(project)
+      error_recovery_options = @error_recovery ? 'PMD_JAVA_OPTS="-Dpmd.error_recovery -ea" ' : ''
       run_path = "target/pmd-bin-#{@pmd_version}/bin/run.sh"
-      pmd_cmd = "#{run_path} pmd -d #{project.local_source_path} -f xml " \
+      pmd_cmd = "#{error_recovery_options}" \
+                "#{run_path} pmd -d #{project.local_source_path} -f xml " \
                 "-R #{project.get_config_path(@pmd_branch_name)} " \
                 "-r #{project.get_pmd_report_path(@pmd_branch_name)} " \
                 "-failOnViolation false -t #{@threads} " \

lib/pmdtester/builders/project_builder.rb

@@ -89,7 +89,7 @@ def run_as_script(path, command)
     def execute_reset_cmd(type, tag)
       case type
       when 'git'
-        reset_cmd = "git reset --hard #{tag}"
+        reset_cmd = "git checkout #{tag}; git reset --hard #{tag}"
       when 'hg'
         reset_cmd = "hg up #{tag}"
       end

lib/pmdtester/parsers/options.rb

@@ -31,6 +31,7 @@ class Options
     attr_reader :debug_flag
     attr_accessor :filter_set
     attr_reader :keep_reports
+    attr_reader :error_recovery
 
     def initialize(argv)
       options = parse(argv)
@@ -48,6 +49,7 @@ def initialize(argv)
       @debug_flag = options[:d]
       @filter_set = nil
       @keep_reports = options.keep_reports?
+      @error_recovery = options.error_recovery?
 
       # if the 'config' option is selected then `config` overrides `base_config` and `patch_config`
       @base_config = @config if !@config.nil? && @mode == 'local'
@@ -94,6 +96,8 @@ def parse(argv)
                'whether to keep old reports and skip running PMD again if possible'
         o.bool '-d', '--debug',
                'whether change log level to DEBUG to see more information'
+        o.bool '--error-recovery',
+               'enable error recovery mode when executing PMD. Might help to analyze errors.'
         o.on '-v', '--version' do
           puts VERSION
           exit

lib/pmdtester/runner.rb

@@ -35,12 +35,10 @@ def run_local_mode
       return if rule_sets&.empty?
 
       PmdReportBuilder
-        .new(@options.base_config, @projects, @options.local_git_repo, @options.base_branch,
-             @options.threads)
+        .new(@projects, @options, @options.base_config, @options.base_branch)
         .build
       PmdReportBuilder
-        .new(@options.patch_config, @projects, @options.local_git_repo, @options.patch_branch,
-             @options.threads)
+        .new(@projects, @options, @options.patch_config, @options.patch_branch)
         .build
 
       build_html_reports
@@ -66,8 +64,7 @@ def run_online_mode
       end
 
       PmdReportBuilder
-        .new(@options.patch_config, @projects,
-             @options.local_git_repo, @options.patch_branch, @options.threads)
+        .new(@projects, @options, @options.patch_config, @options.patch_branch)
         .build
 
       build_html_reports
@@ -113,9 +110,8 @@ def run_single_mode
 
       get_projects(@options.project_list) unless @options.nil?
       branch_details = PmdReportBuilder
-                       .new(@options.patch_config, @projects,
-                            @options.local_git_repo, @options.patch_branch,
-                            @options.threads)
+                       .new(@projects, @options,
+                            @options.patch_config, @options.patch_branch)
                        .build
       # copy list of projects file to the patch baseline
       FileUtils.cp(@options.project_list, branch_details.target_branch_project_list_path)

test/integration_test_pmd_report_builder.rb

@@ -10,12 +10,16 @@ def setup
   end
 
   def test_build
-    logger.level = Logger::INFO
-    projects = ProjectsParser.new.parse('test/resources/project-test.xml')
-    builder = PmdReportBuilder.new('config/design.xml', projects,
-                                   'target/repositories/pmd', 'pmd_releases/6.7.0')
+    argv = %w[-r target/repositories/pmd -b master -p origin/pmd/7.0.x
+              -c test/resources/pmd7-config.xml -l test/resources/project-test.xml
+              --error-recovery --debug]
+    options = PmdTester::Options.new(argv)
+    projects = ProjectsParser.new.parse(options.project_list)
+
+    builder = PmdReportBuilder.new(projects, options, options.config, options.patch_branch)
     builder.build
 
     assert_equal(0, $CHILD_STATUS.exitstatus)
+    assert_path_exist('target/reports/origin_pmd_7.0.x/checkstyle/pmd_report.xml')
   end
 end

test/resources/pmd7-config.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+
+<ruleset name="Java Rules for PMD7 integration test" 
+    xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+    <description>Java Rules for PMD7 integration test</description>
+
+    <rule ref="category/java/bestpractices.xml/MissingOverride"/>
+    <rule ref="category/java/bestpractices.xml/UnusedAssignment"/>
+</ruleset>

test/resources/project-test.xml

@@ -9,8 +9,8 @@ xsi:noNamespaceSchemaLocation="projectlist_1_1_0.xsd">
     <type>git</type>
     <connection>https://github.com/checkstyle/checkstyle</connection>
     <tag>checkstyle-8.0</tag>
-    <exclude-pattern>.*/src/test/resources-noncompilable/.*</exclude-pattern>
-    <exclude-pattern>.*/src/test/resources/.*</exclude-pattern>
+    <exclude-pattern>.*/target/test-classes/com/puppycrawl/tools/checkstyle/.*</exclude-pattern>
+    <exclude-pattern>.*/target/generated-sources/.*</exclude-pattern>
 
     <build-command><![CDATA[#!/usr/bin/env bash
 if test -e classpath.txt; then
@@ -23,6 +23,7 @@ mvn dependency:build-classpath -DincludeScope=test -Dmdep.outputFile=classpath.t
     <auxclasspath-command>echo -n "$(pwd)/target/classes:$(pwd)/target/test-classes:"; cat classpath.txt</auxclasspath-command>
   </project>
 
+  <!-- this project configuration is here, so that PMD's repo is cloned into target/repositories for integration tests -->
   <project>
     <name>pmd</name>
     <type>git</type>

test/test_options.rb

@@ -38,6 +38,13 @@ def test_default_value
     assert_equal(Options::DEFAULT_CONFIG_PATH, opts.base_config)
     assert_equal(Options::DEFAULT_CONFIG_PATH, opts.patch_config)
     assert_equal(Options::DEFAULT_LIST_PATH, opts.project_list)
+    assert_false(opts.error_recovery)
+  end
+
+  def test_enable_error_recovery
+    command_line = %w[-r /path/to/repo -b pmd_releases/6.2.0 -p master --error-recovery]
+    opts = Options.new(command_line)
+    assert_true(opts.error_recovery)
   end
 
   def test_single_mode