Add new option "--error-recovery"

Enabling this option sets PMD_JAVA_OPTS before executing PMD.

Author: adangel

README.rdoc

@@ -37,6 +37,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/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)

pmdtester.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.metadata = { "bug_tracker_uri" => "https://github.com/pmd/pmd-regression-tester/issues", "homepage_uri" => "https://pmd.github.io", "source_code_uri" => "https://github.com/pmd/pmd-regression-tester" } if s.respond_to? :metadata=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andreas Dangel".freeze, "Binguo Bao".freeze]
-  s.date = "2020-10-28"
+  s.date = "2020-11-05"
   s.description = "A regression testing tool ensure that new problems and unexpected behaviors will not be introduced to PMD project after fixing an issue , and new rules can work as expected.".freeze
   s.email = ["[email protected]".freeze, "[email protected]".freeze]
   s.executables = ["pmdtester".freeze]

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

test/test_pmd_report_builder.rb

@@ -14,7 +14,7 @@ def test_build_skip
     record_expecations_after_build
 
     PmdTester::PmdReportBuilder
-      .new(options.base_config, projects, options.local_git_repo, options.base_branch)
+      .new(projects, options, options.base_config, options.base_branch)
       .build
   end
 
@@ -33,7 +33,7 @@ def test_build_normal
     record_expecations_after_build
 
     PmdTester::PmdReportBuilder
-      .new(options.base_config, projects, options.local_git_repo, options.base_branch)
+      .new(projects, options, options.base_config, options.base_branch)
       .build
   end
 
@@ -52,24 +52,45 @@ def test_build_with_projects
     record_expectations_project_build
 
     PmdTester::PmdReportBuilder
-      .new(options.base_config, projects, options.local_git_repo, options.base_branch)
+      .new(projects, options, options.base_config, options.base_branch)
       .build
 
     expected = File.read('test/resources/pmd_report_builder/expected-config.xml')
     actual = File.read('target/reports/master/checkstyle/config.xml')
     assert_equal(expected, actual)
   end
 
+  def test_build_error_recovery
+    project_list = 'test/resources/pmd_report_builder/project-list.xml'
+    projects = PmdTester::ProjectsParser.new.parse(project_list)
+    assert_equal(1, projects.size)
+    argv = %w[-r target/repositories/pmd -b master -p pmd_releases/6.1.0
+              -c config/design.xml --debug --error-recovery -l]
+    argv.push project_list
+    options = PmdTester::Options.new(argv)
+
+    projects[0].auxclasspath = '-auxclasspath extra:dirs'
+    record_expectations('sha1abc', 'sha1abc', true)
+    record_expecations_after_build
+    record_expectations_project_build(true)
+
+    PmdTester::PmdReportBuilder
+      .new(projects, options, options.base_config, options.base_branch)
+      .build
+  end
+
   private
 
-  def record_expectations_project_build
+  def record_expectations_project_build(error = false)
     PmdTester::ProjectBuilder.any_instance.stubs(:clone_projects).once
     PmdTester::ProjectBuilder.any_instance.stubs(:build_projects).once
     PmdTester::SimpleProgressLogger.any_instance.stubs(:start).once
     PmdTester::SimpleProgressLogger.any_instance.stubs(:stop).once
     File.stubs(:exist?).with('target/reports/master/checkstyle/pmd_report.xml').returns(false).once
+    error_prefix = error ? 'PMD_JAVA_OPTS="-Dpmd.error_recovery -ea" ' : ''
     PmdTester::Cmd.stubs(:execute)
-                  .with('target/pmd-bin-6.10.0-SNAPSHOT/bin/run.sh ' \
+                  .with("#{error_prefix}" \
+                        'target/pmd-bin-6.10.0-SNAPSHOT/bin/run.sh ' \
                         'pmd -d target/repositories/checkstyle -f xml ' \
                         '-R target/reports/master/checkstyle/config.xml ' \
                         '-r target/reports/master/checkstyle/pmd_report.xml ' \

test/test_runner.rb

@@ -34,7 +34,9 @@ def test_single_mode
   def test_single_mode_multithreading
     report_builder_mock = mock
     PmdReportBuilder.stubs(:new)
-                    .with(anything, anything, anything, anything, 4)
+                    .with do |_, options, _, _|
+                      options.threads == 4
+                    end
                     .returns(report_builder_mock)
                     .once
     report_builder_mock.stubs(:build).returns(PmdBranchDetail.new('test_branch')).once
@@ -62,7 +64,9 @@ def test_local_mode
   def test_local_mode_multithreading
     report_builder_mock = mock
     PmdReportBuilder.stubs(:new)
-                    .with(anything, anything, anything, anything, 4)
+                    .with do |_, options, _, _|
+                      options.threads == 5
+                    end
                     .returns(report_builder_mock)
                     .twice
     report_builder_mock.stubs(:build).twice
@@ -71,7 +75,7 @@ def test_local_mode_multithreading
     SummaryReportBuilder.any_instance.stubs(:build).once
 
     argv = %w[-r target/repositories/pmd -b master -bc config/design.xml -p pmd_releases/6.1.0
-              -pc config/design.xml -l test/resources/project-test.xml -t 4]
+              -pc config/design.xml -l test/resources/project-test.xml -t 5]
     run_runner(argv)
   end
 
@@ -101,13 +105,15 @@ def test_online_mode_multithreading
 
     report_builder_mock = mock
     PmdReportBuilder.stubs(:new)
-                    .with(anything, anything, anything, anything, 4)
+                    .with do |_, options, _, _|
+                      options.threads == 3
+                    end
                     .returns(report_builder_mock)
                     .once
     report_builder_mock.stubs(:build).once
     SummaryReportBuilder.any_instance.stubs(:build).once
 
-    argv = %w[-r target/repositories/pmd -m online -b master -p pmd_releases/6.7.0 -t 4]
+    argv = %w[-r target/repositories/pmd -m online -b master -p pmd_releases/6.7.0 -t 3]
     run_runner(argv)
   end
 end