Test whether the new PMD start script is available

Don't check the version. That way, the regression
tester is forward compatible.

Author: adangel

lib/pmdtester/builders/pmd_report_builder.rb

@@ -96,11 +96,10 @@ def get_last_commit_message
 
     def generate_pmd_report(project)
       error_recovery_options = @error_recovery ? 'PMD_JAVA_OPTS="-Dpmd.error_recovery -ea" ' : ''
-      run_path = "#{saved_distro_path(@pmd_branch_details.branch_last_sha)}/bin/#{pmd7? ? 'pmd analyze' : 'run.sh pmd'}"
       fail_on_violation = should_use_long_cli_options? ? '--fail-on-violation false' : '-failOnViolation false'
       auxclasspath_option = create_auxclasspath_option(project)
       pmd_cmd = "#{error_recovery_options}" \
-                "#{run_path} -d #{project.local_source_path} -f xml " \
+                "#{determine_run_path} -d #{project.local_source_path} -f xml " \
                 "-R #{project.get_config_path(@pmd_branch_name)} " \
                 "-r #{project.get_pmd_report_path(@pmd_branch_name)} " \
                 "#{fail_on_violation} -t #{@threads} " \
@@ -217,5 +216,16 @@ def create_auxclasspath_option(project)
     def pmd7?
       Semver.compare(@pmd_version, '7.0.0-SNAPSHOT') >= 0
     end
+
+    def determine_run_path
+      run_path = "#{saved_distro_path(@pmd_branch_details.branch_last_sha)}/bin"
+      run_path = if File.exist?("#{run_path}/pmd")
+                   # New PMD 7 CLI script (pmd/pmd#4059)
+                   "#{run_path}/pmd analyze"
+                 else
+                   "#{run_path}/run.sh pmd"
+                 end
+      run_path
+    end
   end
 end

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, "Cl\u00E9ment Fournier".freeze]
-  s.date = "2022-10-07"
+  s.date = "2022-10-13"
   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, "[email protected]".freeze]
   s.executables = ["pmdtester".freeze]

test/test_pmd_report_builder.rb

@@ -149,6 +149,7 @@ def test_build_long_cli_options
 
   def test_build_pmd7
     @pmd_version = '7.0.0-SNAPSHOT'
+    sha1 = 'sha1abc'
     project_list = 'test/resources/pmd_report_builder/project-list.xml'
     projects = PmdTester::ProjectsParser.new.parse(project_list)
     assert_equal(1, projects.size)
@@ -158,14 +159,19 @@ def test_build_pmd7
     options = PmdTester::Options.new(argv)
 
     projects[0].auxclasspath = 'extra:dirs'
-    record_expectations('sha1abc', 'sha1abc', true)
+    record_expectations(sha1, sha1, true)
     record_expectations_after_build
-    record_expectations_project_build(sha1: 'sha1abc', error: true, long_cli_options: true,
+    record_expectations_project_build(sha1: sha1, error: true, long_cli_options: true,
                                       no_progress_bar: true, base_cmd: 'pmd analyze')
 
-    PmdTester::PmdReportBuilder
-      .new(projects, options, options.base_config, options.base_branch)
-      .build
+    pmd_cli_cmd = prepare_pmd_dist_dir(version: @pmd_version, sha1: sha1)
+    begin
+      PmdTester::PmdReportBuilder
+        .new(projects, options, options.base_config, options.base_branch)
+        .build
+    ensure
+      cleanup_pmd_dist_dir(base_dir: pmd_cli_cmd)
+    end
   end
 
   #
@@ -245,4 +251,18 @@ def record_expectations_after_build
     PmdTester::PmdBranchDetail.any_instance.stubs(:save).once
     FileUtils.stubs(:cp).with('config/design.xml', 'target/reports/master/config.xml').once
   end
+
+  # Creates a fake pmd script file as .../bin/pmd.
+  # This is used in the new PMD 7 CLI interface
+  def prepare_pmd_dist_dir(version:, sha1:)
+    pmd_cli_cmd = "#{Dir.getwd}/target/pmd-bin-#{version}-master-#{sha1}/bin"
+    FileUtils.mkdir_p(pmd_cli_cmd)
+    File.new("#{pmd_cli_cmd}/pmd", 'w')
+    pmd_cli_cmd
+  end
+
+  def cleanup_pmd_dist_dir(base_dir:)
+    File.unlink("#{base_dir}/pmd")
+    Dir.rmdir(base_dir)
+  end
 end