pmdtester 1.6.0 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b44aeb9d29dbe2fe0f366e51fb5694be4c37c395e8390e8c4a95ef5b7a60a2e
-  data.tar.gz: ccc0f0d978c99a613d7c1172aad826f4373a4dc6c28b4f6043bc5f8553130984
+  metadata.gz: 97a93382c7d803e84a0e16c80f21e65a112d9b841e445063269d8844c9a513f1
+  data.tar.gz: c01aba1ed03f3cc16ea901eaabebc41de8a0990edc480acc6c4edc3469bd06ce
 SHA512:
-  metadata.gz: f51981a21381f416629d5653864a6baeb6fe5d0af40d72f711d39a332471a4f117325399ac7895d3bd837cc23387c75d2613380481ecb3f45c9db30021e236f8
-  data.tar.gz: c5d40c071579c0b5335d6cea19c796b0f80cb3709fa46caad2f07ce99b623f2d108712a43dc8348e3e3e05a14027103ac356d49de1f82fe219cf41b3d987f557
+  metadata.gz: e9c9d95b9cc5f0e03e7414aa63c919c28d3399f9fb771d6a60fd3be36500dbeac547cc52dd9ca130d9d4a826e12888056c4a4b57fdb6fbc8373a4abf66c3f960
+  data.tar.gz: 03b0d43189d7c462b50fde0be99aa7959d44717fe9b3248d366a430047d1dac7c2365c47469e242ed25951853e62e4d4ce588b84f99e0e9cec1991cb635517d8

data/.github/workflows/build.yml

@@ -23,14 +23,16 @@ jobs:
       run:
         shell: bash
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-java@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
+      - uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 #v4.7.1
         with:
           distribution: 'temurin'
-          java-version: '11'
+          java-version: |
+            11
+            17
       - name: Prepare HOME/openjdk11
         run: ln -sfn "${JAVA_HOME_11_X64}" "${HOME}/openjdk11"
-      - uses: actions/cache@v4
+      - uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 #v4.2.4
         with:
           path: |
             ~/.m2/repository
@@ -42,7 +44,7 @@ jobs:
           restore-keys: |
             v4-${{ runner.os }}-
       - name: Set up Ruby 3.3
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@2a7b30092b0caf9c046252510f9273b4875f3db9 #v1.254.0
         with:
           ruby-version: 3.3
       - name: Install dependencies (bundler)

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

@@ -18,14 +18,16 @@ jobs:
     runs-on: ubuntu-latest
     continue-on-error: false
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-java@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
+      - uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 #v4.7.1
         with:
           distribution: 'temurin'
-          java-version: '11'
+          java-version: |
+            11
+            17
       - name: Prepare HOME/openjdk11
         run: ln -sfn "${JAVA_HOME_11_X64}" "${HOME}/openjdk11"
-      - uses: actions/cache@v4
+      - uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 #v4.2.4
         with:
           path: |
             ~/.m2/repository
@@ -37,7 +39,7 @@ jobs:
           restore-keys: |
             v4-${{ runner.os }}-
       - name: Set up Ruby 3.3
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@2a7b30092b0caf9c046252510f9273b4875f3db9 #v1.254.0
         with:
           ruby-version: 3.3
       - name: Install dependencies (bundler)

data/.github/workflows/publish-release.yml

@@ -30,11 +30,11 @@ jobs:
     outputs:
       VERSION: ${{ steps.version.outputs.VERSION }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
         with:
           ref: ${{ github.event.workflow_run.head_branch }}
       - name: Set up Ruby 3.3
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@2a7b30092b0caf9c046252510f9273b4875f3db9 #v1.254.0
         with:
           ruby-version: 3.3
       - name: Install dependencies (bundler)
@@ -91,8 +91,11 @@ jobs:
       run:
         shell: bash
     steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.workflow_run.head_branch }}
       - name: Set up Ruby 3.3
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@2a7b30092b0caf9c046252510f9273b4875f3db9 #v1.254.0
         with:
           ruby-version: 3.3
       - name: Install dependencies (bundler)
@@ -116,10 +119,18 @@ jobs:
           gem build pmdtester.gemspec
           gempkgfile="$(echo pmdtester-*.gem)"
           gem push "${gempkgfile}"
+      - uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e #v2.0.6
+        id: pmd-actions-helper-app-token
+        with:
+          app-id: ${{ secrets.PMD_ACTIONS_HELPER_ID }}
+          private-key: ${{ secrets.PMD_ACTIONS_HELPER_PRIVATE_KEY }}
+          owner: pmd
+          repositories: pmd-regression-tester
+          permission-contents: write # create a release
       - name: Create GitHub Release
         env:
           # Token required for GH CLI:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_TOKEN: ${{ steps.pmd-actions-helper-app-token.outputs.token }}
           TAG_NAME: ${{ github.event.workflow_run.head_branch }}
           VERSION: ${{ needs.check-version.outputs.VERSION }}
         run: |
@@ -135,6 +146,7 @@ jobs:
           gempkgfile="$(echo pmdtester-*.gem)"
 
           gh release create "$TAG_NAME" "${gempkgfile}" \
+              --repo pmd/pmd-regression-tester \
               --verify-tag \
               --notes-file release_notes.md \
               --title "$RELEASE_NAME"

data/History.md

@@ -1,3 +1,22 @@
+# 1.6.2 / 2025-10-24
+## Fixed Issues
+* [#142](https://github.com/pmd/pmd-regression-tester/pull/142): Support `--auto-gen-config` for rules which start with "Abstract"
+## Merged pull requests
+* [#142](https://github.com/pmd/pmd-regression-tester/pull/142): Support `--auto-gen-config` for rules which start with "Abstract" - [Andreas Dangel](https://github.com/adangel) (@adangel)
+* [#143](https://github.com/pmd/pmd-regression-tester/pull/143): chore(ci): Use java 17 as default - [Andreas Dangel](https://github.com/adangel) (@adangel)
+
+# 1.6.1 / 2025-09-19
+
+## Fixed Issues
+* [#124](https://github.com/pmd/pmd-regression-tester/issues/124): With `--auto-gen-config` invalid rule references might be generated
+* [#138](https://github.com/pmd/pmd-regression-tester/issues/138): chore(ci): Fix public-release workflow
+* [#139](https://github.com/pmd/pmd-regression-tester/issues/139): chore(ci): CI Improvements
+
+## Merged pull requests
+* [#138](https://github.com/pmd/pmd-regression-tester/pull/138): chore(ci): Fix public-release workflow - [Andreas Dangel](https://github.com/adangel) (@adangel)
+* [#139](https://github.com/pmd/pmd-regression-tester/pull/139): chore(ci): CI Improvements - [Andreas Dangel](https://github.com/adangel) (@adangel)
+* [#141](https://github.com/pmd/pmd-regression-tester/pull/141): Fix #124: If an abstract rule is changed, run all rules - [UncleOwen](https://github.com/UncleOwen) (@UncleOwen)
+
 # 1.6.0 / 2025-07-25
 
 ## New and Noteworthy

data/README.rdoc

@@ -167,5 +167,6 @@ The tool creates the following folders:
 * Push to main.
 * 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. 
+* To make pmd's main CI use the new version (in [pmd/pmd](https://github.com/pmd/pmd/)),
+  go to the directory ".ci/files" 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

@@ -250,16 +250,18 @@ module PmdTester
 
     def build_pmd_with_maven
       logger.info "#{@pmd_branch_name}: Building PMD #{@pmd_version}..."
+      extra_java_home = nil
 
       package_cmd = if Semver.compare(@pmd_version, '7.14.0') >= 0
                       # build command since PMD migrated to central portal
-                      './mvnw clean package ' \
+                      './mvnw clean package -V ' \
                         '-PfastSkip ' \
                         '-DskipTests ' \
                         '-T1C -B'
                     else
+                      extra_java_home = "#{Dir.home}/openjdk11"
                       # build command for older PMD versions
-                      './mvnw clean package ' \
+                      './mvnw clean package -V ' \
                         "-s #{ResourceLocator.resource('maven-settings.xml')} " \
                         '-Pfor-dokka-maven-plugin ' \
                         '-Dmaven.test.skip=true ' \
@@ -270,8 +272,8 @@ module PmdTester
                         '-T1C -B'
                     end
 
-      logger.debug "#{@pmd_branch_name}: maven command: #{package_cmd}"
-      Cmd.execute_successfully(package_cmd)
+      logger.debug "#{@pmd_branch_name}: maven command: #{package_cmd} java_home: #{extra_java_home}"
+      Cmd.execute_successfully(package_cmd, extra_java_home)
     end
   end
 end

data/lib/pmdtester/builders/rule_set_builder.rb

@@ -25,7 +25,8 @@ module PmdTester
     def build?
       languages = determine_languages
       filenames = diff_filenames(languages)
-      run_required, rule_refs = get_rule_refs(filenames)
+      all_rules_hash = determine_all_rules
+      run_required, rule_refs = get_rule_refs(filenames, all_rules_hash)
       if run_required
         output_filter_set(rule_refs)
         build_config_file(rule_refs)
@@ -71,8 +72,8 @@ module PmdTester
     # filtering possible or if no rules are affected.
     # Whether to run the regression test is returned as an additional boolean flag.
     #
-    def get_rule_refs(filenames)
-      run_required, categories, rules = determine_categories_rules(filenames)
+    def get_rule_refs(filenames, all_rules_hash)
+      run_required, categories, rules = determine_categories_rules(filenames, all_rules_hash)
       logger.debug "Regression test required: #{run_required}"
       logger.debug "Categories: #{categories}"
       logger.debug "Rules: #{rules}"
@@ -122,12 +123,12 @@ module PmdTester
 
     private
 
-    def determine_categories_rules(filenames)
+    def determine_categories_rules(filenames, all_rules_hash)
       regression_test_required = false
       categories = Set[]
       rules = Set[]
       filenames.each do |filename|
-        matched = check_single_filename?(filename, categories, rules)
+        matched = check_single_filename?(filename, all_rules_hash, categories, rules)
         regression_test_required = true if matched
 
         next if matched
@@ -141,14 +142,13 @@ module PmdTester
       [regression_test_required, categories, rules]
     end
 
-    def check_single_filename?(filename, categories, rules)
+    def check_single_filename?(filename, all_rules_hash, categories, rules)
       logger.debug "Checking #{filename}"
 
-      # matches Java-based rule implementations
-      match_data = %r{.+/src/main/java/.+/lang/([^/]+)/rule/([^/]+)/([^/]+)Rule.java}.match(filename)
-      unless match_data.nil?
-        logger.debug "Matches: #{match_data.inspect}"
-        rules.add("#{match_data[1]}/#{match_data[2]}.xml/#{match_data[3]}")
+      # direct match of a Java-based rule implementation
+      if all_rules_hash.key?(filename)
+        logger.debug "Direct match: #{all_rules_hash[filename]}"
+        rules.add(all_rules_hash[filename])
         return true
       end
 
@@ -196,5 +196,35 @@ module PmdTester
       end
       languages
     end
+
+    # Creates a mapping between java source files and the rule reference
+    # in the ruleset, e.g.:
+    # 'pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/NcssCountRule.java'
+    #   => 'java/design.xml/NcssCount'
+    def determine_all_rules
+      all_rules_hash = {}
+      Dir.chdir(@options.local_git_repo) do
+        Dir.glob('**/src/main/resources/category/*/*.xml').each do |rulesetfile|
+          match_data = %r{.+/src/main/resources/category/([^/]+)/([^/.]+\.xml)}.match(rulesetfile)
+          ref_prefix = "#{match_data[1]}/#{match_data[2]}"
+          java_base_path = rulesetfile.gsub(%r{src/main/resources/category/.+/.+\.xml}, 'src/main/java')
+
+          doc = File.open(rulesetfile) { |f| Nokogiri::XML(f) }
+          rules = doc.css('ruleset rule')
+          rules.each do |r|
+            next if r.attributes['class'].nil? # skip rule references
+
+            ref = "#{ref_prefix}/#{r.attributes['name'].content}"
+            clazz = r.attributes['class'].content
+
+            # guess java file name at standard location src/main/java relative to the category ruleset
+            java_filename = "#{java_base_path}/#{clazz.gsub('.', '/')}.java"
+
+            all_rules_hash[java_filename] = ref
+          end
+        end
+      end
+      all_rules_hash
+    end
   end
 end

data/lib/pmdtester/cmd.rb

@@ -13,7 +13,7 @@ module PmdTester
     # in path.
     #
     def self.execute(cmd, path)
-      stdout, stderr, status = internal_execute(cmd)
+      stdout, stderr, status = internal_execute(cmd, nil)
 
       file = File.new("#{path}/stdout.txt", 'w')
       file.puts stdout
@@ -26,8 +26,8 @@ module PmdTester
       status
     end
 
-    def self.execute_successfully(cmd)
-      stdout, stderr, status = internal_execute(cmd)
+    def self.execute_successfully(cmd, extra_java_home = nil)
+      stdout, stderr, status = internal_execute(cmd, extra_java_home)
 
       unless status.success?
         logger.error "Command failed: #{cmd}"
@@ -40,14 +40,20 @@ module PmdTester
     end
 
     def self.stderr_of(cmd)
-      _stdout, stderr, _status = internal_execute(cmd)
+      _stdout, stderr, _status = internal_execute(cmd, nil)
       stderr
     end
 
-    def self.internal_execute(cmd)
-      logger.debug "execute command '#{cmd}'"
+    def self.internal_execute(cmd, extra_java_home)
+      logger.debug "execute command '#{cmd}' (extra_java_home: #{extra_java_home})"
 
-      stdout, stderr, status = Open3.capture3("#{cmd};")
+      new_env = ENV.to_h
+      unless extra_java_home.nil?
+        new_env['JAVA_HOME'] = extra_java_home
+        new_env['PATH'] = "#{extra_java_home}/bin:#{new_env['PATH']}"
+      end
+
+      stdout, stderr, status = Open3.capture3(new_env, "#{cmd};")
 
       logger.debug "status: #{status}"
       logger.debug "stdout: #{stdout}"

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.6.0'
+  VERSION = '1.6.2'
   BASE = 'base'
   PATCH = 'patch'
   PR_NUM_ENV_VAR = 'PMD_CI_PULL_REQUEST_NUMBER' # see PmdBranchDetail

data/pmdtester.gemspec

@@ -1,11 +1,11 @@
 # DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake hoe:spec`.
 
 # -*- encoding: utf-8 -*-
-# stub: pmdtester 1.6.0 ruby lib
+# stub: pmdtester 1.6.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.6.0".freeze
+  s.version = "1.6.2".freeze
 
   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=

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pmdtester
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.2
 platform: ruby
 authors:
 - Andreas Dangel
 - Binguo Bao
 - Clément Fournier
+autorequire:
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -349,6 +350,7 @@ 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
+post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -365,7 +367,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 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