pmdtester 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d00209411d45b04f8ebcfb34d4289b682a9c3d044998b1f82e15c1d08e184ed
-  data.tar.gz: d6d6a48c4a2c558b9058c91dc57e2043e304addc90b8e7cc7441f07c50dac624
+  metadata.gz: '09f77b85a868975ac9f52380870bff0daf2d9467f15fe5e8ff02d68399a865a2'
+  data.tar.gz: c5a650a352d4fcab5efaf7588bc3774a37a8ddb845031453288527877ad12892
 SHA512:
-  metadata.gz: 82c0d9bce215128d2fb56f44116c7c6f5394b8a34ff8b26918974a89e2c6e67b4d76c14b3a920b372e345ffbe33e114cdacfbcdd962f1c76f5fddc24595d8998
-  data.tar.gz: effbb41f97137a0b6a93bc200cd8ebb3b7323dabaeef1eca50bfee3dd97b00e0418987b28661328902b1f66942843acad32bc397f1dc04590cbc9d0a19d1c4b7
+  metadata.gz: c45f72e96a6dd7132dd8f207c75c11a7403e6acca9cfa5a345e628d7bc4122f3d4fbc044bca385a63e1360309b452651525a59e3f0afcd5924af5342b92d835a
+  data.tar.gz: 595759d8592b99b0264332528df6257ec35ebce98f206c92b08fca7d89935a70f8223cc5d206e5f0e91f48a5b31ca355b4a37c301c53b3877362b9b84a5d8746

data/.github/workflows/build.yml

@@ -20,8 +20,8 @@ jobs:
     continue-on-error: false
     if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/cache@v2
+    - uses: actions/checkout@v3
+    - uses: actions/cache@v3
       with:
         path: |
           ~/.m2/repository

data/.github/workflows/manual-integration-tests.yml

@@ -12,8 +12,8 @@ jobs:
     runs-on: ubuntu-latest
     continue-on-error: false
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/cache@v2
+    - uses: actions/checkout@v3
+    - uses: actions/cache@v3
       with:
         path: |
           ~/.m2/repository

data/.rubocop.yml

@@ -30,3 +30,6 @@ Metrics/BlockLength:
 
 Metrics/ModuleLength:
   CountAsOne: ['array', 'hash']
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false

data/History.md

@@ -1,3 +1,15 @@
+# 1.5.2 / 2022-10-20
+
+## Enhancements
+
+* [#114](https://github.com/pmd/pmd-regression-tester/pull/114): Support new PMD 7 CLI interface
+
+# 1.5.1 / 2022-05-12
+
+## Fixed Issues
+
+* [#106](https://github.com/pmd/pmd-regression-tester/issues/106): git clone/checkout fails when using commit sha1 as tag
+
 # 1.5.0 / 2022-05-06
 
 ## Enhancements

data/README.rdoc

@@ -155,3 +155,4 @@ The tool creates the following folders:
 * Push the tag. Github Actions will build and publish the new gem
 * A github release is automatically created, verify it on https://github.com/pmd/pmd-regression-tester/releases
 * To make pmd's main CI use the new version (in [pmd/pmd](https://github.com/pmd/pmd/)), go to the root directory and run `bundle lock --update`. Commit these changes. 
+* Rename milestone to version, close it and create a new "Next" milestone: https://github.com/pmd/pmd-regression-tester/milestones

data/lib/pmdtester/builders/pmd_report_builder.rb

@@ -96,11 +96,10 @@ module PmdTester
 
     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/run.sh"
-      fail_on_violation = should_use_long_cli_options ? '--fail-on-violation false' : '-failOnViolation false'
+      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} pmd -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} " \
@@ -149,7 +148,7 @@ module PmdTester
 
         PmdReportDetail.create(execution_time: execution_time, timestamp: end_time,
                                exit_code: exit_code, report_info_path: project.get_report_info_path(@pmd_branch_name))
-        logger.info "#{project.name}'s PMD report was generated successfully"
+        logger.info "#{project.name}'s PMD report was generated successfully (exit code: #{exit_code})"
       end
 
       @pmd_branch_details.execution_time = sum_time
@@ -200,7 +199,7 @@ module PmdTester
       !Cmd.execute_successfully('git status --porcelain').empty?
     end
 
-    def should_use_long_cli_options
+    def should_use_long_cli_options?
       logger.debug "PMD Version: #{@pmd_version}"
       Semver.compare(@pmd_version, '6.41.0') >= 0
     end
@@ -208,7 +207,7 @@ module PmdTester
     def create_auxclasspath_option(project)
       auxclasspath_option = ''
       unless project.auxclasspath.empty?
-        auxclasspath_option = should_use_long_cli_options ? '--aux-classpath ' : '-auxclasspath '
+        auxclasspath_option = should_use_long_cli_options? ? '--aux-classpath ' : '-auxclasspath '
         auxclasspath_option += project.auxclasspath
       end
       auxclasspath_option
@@ -217,5 +216,16 @@ module PmdTester
     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 check"
+                 else
+                   "#{run_path}/run.sh pmd"
+                 end
+      run_path
+    end
   end
 end

data/lib/pmdtester/builders/project_builder.rb

@@ -19,22 +19,28 @@ module PmdTester
         logger.info "Start cloning #{project.name} repository"
         path = project.clone_root_path
 
+        raise "Unsupported project type '#{project.type}' - only git is supported" unless project.type == 'git'
+
         if File.exist?(path)
           logger.warn "Skipping clone, project path #{path} already exists"
         else
-          raise "Unsupported project type '#{project.type}' - only git is supported" unless project.type == 'git'
-
-          # git:
-          # Don't download whole history
-          # Note we don't use --single-branch, because the repo is downloaded
-          # once but may be used with several tags.
-          clone_cmd = "git clone --no-single-branch --depth 1 #{project.connection} #{path}"
-
+          # Don't download whole history. This just fetches HEAD, the correct ref is fetched below.
+          clone_cmd = "git clone --single-branch --depth 1 #{project.connection} #{path}"
           Cmd.execute_successfully(clone_cmd)
         end
 
         Dir.chdir(path) do
-          execute_reset_cmd(project.type, project.tag)
+          # this works with tags, branch names and (full-length) hashes
+          # first move to a different (temporary) branch, in case we are already on the branch that we want to update
+          Cmd.execute_successfully('git checkout -b fetched/temp')
+          # fetches any new commits. Could also be a tag.
+          Cmd.execute_successfully("git fetch --depth 1 origin #{project.tag}")
+          # update the branch to work on based on the new fetch. Creates a new branch if it doesn't exist already
+          Cmd.execute_successfully("git branch --force fetched/#{project.tag} FETCH_HEAD")
+          # checkout the updated branch
+          Cmd.execute_successfully("git checkout fetched/#{project.tag}")
+          # remove the temporary branch
+          Cmd.execute_successfully('git branch -D fetched/temp')
         end
         logger.info "Cloning #{project.name} completed"
       end
@@ -93,13 +99,5 @@ module PmdTester
       end
       stdout
     end
-
-    def execute_reset_cmd(type, tag)
-      raise "Unsupported project type '#{type}' - only git is supported" unless type == 'git'
-
-      reset_cmd = "git checkout #{tag}; git reset --hard #{tag}"
-
-      Cmd.execute_successfully(reset_cmd)
-    end
   end
 end

data/lib/pmdtester/pmd_violation.rb

@@ -30,8 +30,6 @@ module PmdTester
     attr_reader :fname, :info_url, :line, :old_line, :old_message, :rule_name, :ruleset_name, :language
     attr_accessor :message
 
-    # rubocop:disable Metrics/ParameterLists
-    # Disable it: how is replacing a long parameter list with a single hash helping?
     def initialize(branch:, fname:, info_url:, bline:, rule_name:, ruleset_name:)
       @branch = branch
       @fname = fname
@@ -49,7 +47,6 @@ module PmdTester
       @old_message = nil
       @old_line = nil
     end
-    # rubocop:enable Metrics/ParameterLists
 
     def line_move?(other)
       message.eql?(other.message) && (line - other.line).abs <= 5

data/lib/pmdtester.rb

@@ -33,7 +33,7 @@ require_relative 'pmdtester/parsers/projects_parser'
 # and unexpected behaviors will not be introduced to PMD project
 # after fixing an issue and new rules can work as expected.
 module PmdTester
-  VERSION = '1.5.0'
+  VERSION = '1.5.2'
   BASE = 'base'
   PATCH = 'patch'
   PR_NUM_ENV_VAR = 'PMD_CI_PULL_REQUEST_NUMBER' # see PmdBranchDetail

data/pmdtester.gemspec

@@ -1,17 +1,17 @@
 # DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake hoe:spec`.
 
 # -*- encoding: utf-8 -*-
-# stub: pmdtester 1.5.0 ruby lib
+# stub: pmdtester 1.5.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.5.0"
+  s.version = "1.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   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-05-06"
+  s.date = "2022-10-20"
   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 = ["andreas.dangel@pmd-code.org".freeze, "djydewang@gmail.com".freeze, "clement.fournier76@gmail.com".freeze]
   s.executables = ["pmdtester".freeze]
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency(%q<rubocop>.freeze, ["~> 0.93"])
     s.add_development_dependency(%q<test-unit>.freeze, ["~> 3.5"])
     s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.4"])
-    s.add_development_dependency(%q<hoe>.freeze, ["~> 3.23"])
+    s.add_development_dependency(%q<hoe>.freeze, ["~> 3.25"])
   else
     s.add_dependency(%q<nokogiri>.freeze, ["~> 1.13"])
     s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
@@ -57,7 +57,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rubocop>.freeze, ["~> 0.93"])
     s.add_dependency(%q<test-unit>.freeze, ["~> 3.5"])
     s.add_dependency(%q<rdoc>.freeze, ["~> 6.4"])
-    s.add_dependency(%q<hoe>.freeze, ["~> 3.23"])
+    s.add_dependency(%q<hoe>.freeze, ["~> 3.25"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pmdtester
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Andreas Dangel
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -200,14 +200,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '3.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '3.25'
 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.