Support new PMD 7 binary dist filename

Refs pmd/pmd#4460

Author: adangel

History.md

@@ -3,6 +3,7 @@
 ## New and Noteworthy
 
 ## Enhancements
+* [#120](https://github.com/pmd/pmd-regression-tester/pull/120): Support new PMD 7 binary dist filename
 
 ## Fixed Issues
 

lib/pmdtester/builders/pmd_report_builder.rb

@@ -53,9 +53,7 @@ def get_pmd_binary_file
     def build_pmd(into_dir:)
       # in CI there might have been a build performed already. In that case
       # we reuse the build result, otherwise we build PMD freshly
-      pmd_dist_target = "pmd-dist/target/pmd-bin-#{@pmd_version}.zip"
-      binary_exists = File.exist?(pmd_dist_target)
-      logger.debug "#{@pmd_branch_name}: Does the file #{pmd_dist_target} exist? #{binary_exists} (cwd: #{Dir.getwd})"
+      pmd_dist_target, binary_exists = find_pmd_dist_target
       if binary_exists
         # that's a warning, because we don't know, whether this build really
         # belongs to the current branch or whether it's from a previous branch.
@@ -71,6 +69,13 @@ def build_pmd(into_dir:)
                       ' -Dpmd.skip=true' \
                       ' -T1C -B'
         Cmd.execute_successfully(package_cmd)
+
+        pmd_dist_target, binary_exists = find_pmd_dist_target
+        unless binary_exists
+          logger.error "#{@pmd_branch_name}: Dist zip not found at #{pmd_dist_target}!"
+          raise "No Dist zip found at #{pmd_dist_target}"
+        end
+
       end
 
       logger.info "#{@pmd_branch_name}: Extracting the zip"
@@ -227,5 +232,17 @@ def determine_run_path
                  end
       run_path
     end
+
+    def find_pmd_dist_target
+      pmd_dist_target = "pmd-dist/target/pmd-bin-#{@pmd_version}.zip"
+      binary_exists = File.exist?(pmd_dist_target)
+      logger.debug "#{@pmd_branch_name}: Does the file #{pmd_dist_target} exist? #{binary_exists} (cwd: #{Dir.getwd})"
+      unless binary_exists
+        pmd_dist_target = "pmd-dist/target/pmd-dist-#{@pmd_version}-bin.zip"
+        binary_exists = File.exist?(pmd_dist_target)
+        logger.debug "#{@pmd_branch_name}: Does the file #{pmd_dist_target} exist? #{binary_exists} (cwd: #{Dir.getwd})"
+      end
+      [pmd_dist_target, binary_exists]
+    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-11-25"
+  s.date = "2023-05-26"
   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]
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.licenses = ["BSD-2-Clause".freeze]
   s.rdoc_options = ["--main".freeze, "README.rdoc".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 2.7".freeze)
-  s.rubygems_version = "3.1.4".freeze
+  s.rubygems_version = "3.1.6".freeze
   s.summary = "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
 
   if s.respond_to? :specification_version then

test/test_pmd_report_builder.rb

@@ -14,8 +14,10 @@ def setup
   def teardown
     pmd_repo = 'target/repositories/pmd'
     # pre-built PMD binary
-    pmd_binary = "#{pmd_repo}/pmd-dist/target/pmd-bin-#{@pmd_version}.zip"
-    File.unlink pmd_binary if File.exist? pmd_binary
+    ["#{pmd_repo}/pmd-dist/target/pmd-bin-#{@pmd_version}.zip",
+     "#{pmd_repo}/pmd-dist/target/pmd-dist-#{@pmd_version}-bin.zip"].each do |pmd_binary|
+      File.unlink pmd_binary if File.exist? pmd_binary
+    end
 
     # only deleting empty directories in order to leave pmd_repo intact
     # for local dev environment, where a local pmd clone might already exist
@@ -30,7 +32,7 @@ def test_build_skip
               -c config/design.xml -l test/resources/pmd_report_builder/project-test.xml]
     options = PmdTester::Options.new(argv)
 
-    record_expectations('sha1abc', 'sha1abc', true)
+    record_expectations(sha1_head: 'sha1abc', sha1_base: 'sha1abc', zip_file_exists: true)
     record_expectations_after_build
 
     PmdTester::PmdReportBuilder
@@ -51,7 +53,7 @@ def test_build_skip_ci
     FileUtils.mkdir_p 'target/repositories/pmd/pmd-dist/target'
     FileUtils.touch "target/repositories/pmd/pmd-dist/target/pmd-bin-#{@pmd_version}.zip"
 
-    record_expectations('sha1abc', 'sha1abc', false)
+    record_expectations(sha1_head: 'sha1abc', sha1_base: 'sha1abc', zip_file_exists: false)
     PmdTester::Cmd.stubs(:execute_successfully).with("unzip -qo pmd-dist/target/pmd-bin-#{@pmd_version}.zip" \
       ' -d pmd-dist/target/exploded').once
     PmdTester::Cmd.stubs(:execute_successfully).with("mv pmd-dist/target/exploded/pmd-bin-#{@pmd_version}" \
@@ -63,17 +65,37 @@ def test_build_skip_ci
       .build
   end
 
+  # with PMD7, the dist bin file is called pmd-dist/target/pmd-dist-7.0.0-bin-SNAPSHOT.zip
+  def test_build_skip_ci_pmd7
+    projects = []
+    argv = %w[-r target/repositories/pmd -b master -p pmd_releases/6.55.0
+              -c config/design.xml -l test/resources/pmd_report_builder/project-test.xml]
+    options = PmdTester::Options.new(argv)
+
+    FileUtils.mkdir_p 'target/repositories/pmd/pmd-dist/target'
+    FileUtils.touch "target/repositories/pmd/pmd-dist/target/pmd-dist-#{@pmd_version}-bin.zip"
+
+    record_expectations(sha1_head: 'sha1abc', sha1_base: 'sha1abc', zip_file_exists: false)
+    PmdTester::Cmd.stubs(:execute_successfully).with("unzip -qo pmd-dist/target/pmd-dist-#{@pmd_version}-bin.zip" \
+      ' -d pmd-dist/target/exploded').once
+    PmdTester::Cmd.stubs(:execute_successfully).with("mv pmd-dist/target/exploded/pmd-bin-#{@pmd_version}" \
+      " #{Dir.getwd}/target/pmd-bin-#{@pmd_version}-master-sha1abc").once
+    record_expectations_after_build
+
+    PmdTester::PmdReportBuilder
+      .new(projects, options, options.base_config, options.base_branch)
+      .build
+  end
+
   def test_build_normal
     projects = []
     argv = %w[-r target/repositories/pmd -b master -p pmd_releases/6.1.0
               -c config/design.xml -l test/resources/pmd_report_builder/project-test.xml]
     options = PmdTester::Options.new(argv)
 
     # PMD binary does not exist yet this time...
-    record_expectations('sha1abc', 'sha1abc', false)
-    PmdTester::Cmd.stubs(:execute_successfully).with('./mvnw clean package -Dmaven.test.skip=true' \
-                  ' -Dmaven.javadoc.skip=true -Dmaven.source.skip=true' \
-                  ' -Dcheckstyle.skip=true -Dpmd.skip=true -T1C -B').once
+    record_expectations(sha1_head: 'sha1abc', sha1_base: 'sha1abc', zip_file_exists: false)
+    stub_pmd_build_maven(binary_name: "pmd-bin-#{@pmd_version}.zip")
     PmdTester::Cmd.stubs(:execute_successfully).with("unzip -qo pmd-dist/target/pmd-bin-#{@pmd_version}.zip" \
                   ' -d pmd-dist/target/exploded').once
     PmdTester::Cmd.stubs(:execute_successfully).with("mv pmd-dist/target/exploded/pmd-bin-#{@pmd_version}" \
@@ -85,6 +107,26 @@ def test_build_normal
       .build
   end
 
+  def test_build_normal_pmd7
+    projects = []
+    argv = %w[-r target/repositories/pmd -b master -p pmd_releases/6.1.0
+              -c config/design.xml -l test/resources/pmd_report_builder/project-test.xml]
+    options = PmdTester::Options.new(argv)
+
+    # PMD binary does not exist yet this time...
+    record_expectations(sha1_head: 'sha1abc', sha1_base: 'sha1abc', zip_file_exists: false)
+    stub_pmd_build_maven(binary_name: "pmd-dist-#{@pmd_version}-bin.zip")
+    PmdTester::Cmd.stubs(:execute_successfully).with("unzip -qo pmd-dist/target/pmd-dist-#{@pmd_version}-bin.zip" \
+                  ' -d pmd-dist/target/exploded').once
+    PmdTester::Cmd.stubs(:execute_successfully).with("mv pmd-dist/target/exploded/pmd-bin-#{@pmd_version}" \
+                  " #{Dir.getwd}/target/pmd-bin-#{@pmd_version}-master-sha1abc").once
+    record_expectations_after_build
+
+    PmdTester::PmdReportBuilder
+      .new(projects, options, options.base_config, options.base_branch)
+      .build
+  end
+
   def test_build_with_projects
     project_list = 'test/resources/pmd_report_builder/project-list.xml'
     projects = PmdTester::ProjectsParser.new.parse(project_list)
@@ -95,7 +137,7 @@ def test_build_with_projects
     options = PmdTester::Options.new(argv)
 
     projects[0].auxclasspath = 'extra:dirs'
-    record_expectations('sha1abc', 'sha1abc', true)
+    record_expectations(sha1_head: 'sha1abc', sha1_base: 'sha1abc', zip_file_exists: true)
     record_expectations_after_build
     record_expectations_project_build(sha1: 'sha1abc')
 
@@ -118,7 +160,7 @@ def test_build_error_recovery
     options = PmdTester::Options.new(argv)
 
     projects[0].auxclasspath = 'extra:dirs'
-    record_expectations('sha1abc', 'sha1abc', true)
+    record_expectations(sha1_head: 'sha1abc', sha1_base: 'sha1abc', zip_file_exists: true)
     record_expectations_after_build
     record_expectations_project_build(sha1: 'sha1abc', error: true)
 
@@ -138,7 +180,7 @@ def test_build_long_cli_options
     options = PmdTester::Options.new(argv)
 
     projects[0].auxclasspath = 'extra:dirs'
-    record_expectations('sha1abc', 'sha1abc', true)
+    record_expectations(sha1_head: 'sha1abc', sha1_base: 'sha1abc', zip_file_exists: true)
     record_expectations_after_build
     record_expectations_project_build(sha1: 'sha1abc', error: true, long_cli_options: true)
 
@@ -159,7 +201,7 @@ def test_build_pmd7
     options = PmdTester::Options.new(argv)
 
     projects[0].auxclasspath = 'extra:dirs'
-    record_expectations(sha1, sha1, true)
+    record_expectations(sha1_head: sha1, sha1_base: sha1, zip_file_exists: true)
     record_expectations_after_build
     record_expectations_project_build(sha1: sha1, error: true, long_cli_options: true,
                                       no_progress_bar: true, base_cmd: 'pmd check')
@@ -188,7 +230,7 @@ def test_build_failing
     options = PmdTester::Options.new(argv)
 
     projects[0].auxclasspath = 'extra:dirs'
-    record_expectations('sha1abc', 'sha1abc', true)
+    record_expectations(sha1_head: 'sha1abc', sha1_base: 'sha1abc', zip_file_exists: true)
     record_expectations_after_build
     record_expectations_project_build(sha1: 'sha1abc', error: true, exit_status: 1)
 
@@ -224,7 +266,7 @@ def record_expectations_project_build(sha1:, error: false, long_cli_options: fal
     PmdTester::PmdReportDetail.stubs(:create).once.with { |params| params[:exit_code] == exit_status }
   end
 
-  def record_expectations(sha1_head, sha1_base, zip_file_exists)
+  def record_expectations(sha1_head:, sha1_base:, zip_file_exists:)
     PmdTester::Cmd.stubs(:execute_successfully).with('git rev-parse master^{commit}').returns(sha1_base).once
     # inside checkout_build_branch
     PmdTester::Cmd.stubs(:execute_successfully).with('git checkout master')
@@ -265,4 +307,18 @@ def cleanup_pmd_dist_dir(base_dir:)
     File.unlink("#{base_dir}/pmd")
     Dir.rmdir(base_dir)
   end
+
+  def stub_pmd_build_maven(binary_name:)
+    PmdTester::Cmd.stubs(:execute_successfully).with do |cmd|
+      if cmd == './mvnw clean package -Dmaven.test.skip=true' \
+                  ' -Dmaven.javadoc.skip=true -Dmaven.source.skip=true' \
+                  ' -Dcheckstyle.skip=true -Dpmd.skip=true -T1C -B'
+        FileUtils.mkdir_p 'pmd-dist/target'
+        FileUtils.touch "pmd-dist/target/#{binary_name}"
+        true
+      else
+        false
+      end
+    end.once
+  end
 end