pmdtester 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ab10c148f66f7b8d8942096da3c67260b0a50bc6f0a7671993f86035186c228
-  data.tar.gz: 11175641f5912e24ea5a623fe105392a9507ec0ad43156e223f8cefeea92bd7f
+  metadata.gz: 1d00209411d45b04f8ebcfb34d4289b682a9c3d044998b1f82e15c1d08e184ed
+  data.tar.gz: d6d6a48c4a2c558b9058c91dc57e2043e304addc90b8e7cc7441f07c50dac624
 SHA512:
-  metadata.gz: 543126b2c957bfefdd5d5985e0e6bbca6c7442fb8bb826abda65b86c9dd6956f4d704afb66f9b4fb2080acff72fbc6619bc76f6202919c70b99a55a98dd3a644
-  data.tar.gz: f10d380a93eb631fa5e2c4a60fc73795cfeb3a589002da0655c19900daea6445a2cf5f0ecc449c043594d0dd0fb3b27f4203c5ac442d7539b19b4ab63bd915ea
+  metadata.gz: 82c0d9bce215128d2fb56f44116c7c6f5394b8a34ff8b26918974a89e2c6e67b4d76c14b3a920b372e345ffbe33e114cdacfbcdd962f1c76f5fddc24595d8998
+  data.tar.gz: effbb41f97137a0b6a93bc200cd8ebb3b7323dabaeef1eca50bfee3dd97b00e0418987b28661328902b1f66942843acad32bc397f1dc04590cbc9d0a19d1c4b7

data/.github/workflows/build.yml

@@ -15,6 +15,7 @@ on:
 
 jobs:
   build:
+    timeout-minutes: 120
     runs-on: ubuntu-latest
     continue-on-error: false
     if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
@@ -27,9 +28,9 @@ jobs:
           ~/.cache
           vendor/bundle
           target/repositories
-        key: v1-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
+        key: v3-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
         restore-keys: |
-          v1-${{ runner.os }}-
+          v3-${{ runner.os }}-
     - name: Set up Ruby 2.7
       uses: ruby/setup-ruby@v1
       with:

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

@@ -8,6 +8,7 @@ on:
 
 jobs:
   build:
+    timeout-minutes: 120
     runs-on: ubuntu-latest
     continue-on-error: false
     steps:
@@ -19,9 +20,9 @@ jobs:
           ~/.cache
           vendor/bundle
           target/repositories
-        key: v1-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
+        key: v3-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
         restore-keys: |
-          v1-${{ runner.os }}-
+          v3-${{ runner.os }}-
     - name: Set up Ruby 2.7
       uses: ruby/setup-ruby@v1
       with:

data/History.md

@@ -1,3 +1,26 @@
+# 1.5.0 / 2022-05-06
+
+## Enhancements
+
+* [#108](https://github.com/pmd/pmd-regression-tester/issues/108): Disable progress bar for PMD 7
+* [#109](https://github.com/pmd/pmd-regression-tester/issues/109): Make stdout/stderr and exit code available
+
+## Fixed Issues
+
+* [#107](https://github.com/pmd/pmd-regression-tester/issues/107): Deprecated command line options is used: `-auxclasspath`
+
+# 1.4.1 / 2022-04-12
+
+## Fixed Issues
+
+* [#104](https://github.com/pmd/pmd-regression-tester/issues/104): Baseline filtering is not working anymore
+
+# 1.4.0 / 2022-03-24
+
+## Enhancements
+
+*   [#103](https://github.com/pmd/pmd-regression-tester/pull/103): Support other languages besides java
+
 # 1.3.0 / 2021-12-17
 
 ## Enhancements

data/README.rdoc

@@ -105,23 +105,22 @@ The tool creates the following folders:
 
 === Runtime dependency
 
-  nokogiri >= 1.11.0.rc4
+  nokogiri ~> 1.13
   slop ~> 4.6
   differ ~> 0.1
-  rufus-scheduler ~> 3.5
+  rufus-scheduler ~> 3.8
   logger-colors ~> 1.0
-  liquid >= 4.0
+  liquid ~> 5.2
 
 === Development dependency
 
-  hoe ~> 3.22
   hoe-bundler ~> 1.5
   hoe-git ~> 1.6
   minitest ~> 5.10
   mocha ~> 1.5
-  rdoc < 7, >= 4.0
-  rubocop ~> 0.81
-  test-unit ~> 3.2
+  rubocop ~> 0.93
+  test-unit ~> 3.5
+  rdoc ~> 6.4
 
 == INSTALL:
 

data/Rakefile

@@ -19,18 +19,23 @@ hoe = Hoe.spec 'pmdtester' do
   developer 'Clément Fournier', 'clement.fournier76@gmail.com'
 
   self.clean_globs = %w[target/reports/**/* target/test/**/* target/dynamic-config.xml Gemfile.lock]
-  self.extra_deps += [['nokogiri', '>= 1.11.0.rc4'], ['slop', '~> 4.6'], ['differ', '~> 0.1'],
-                      ['rufus-scheduler', '~> 3.5'], ['logger-colors', '~> 1.0'],
-                      ['liquid', '>= 4.0']]
+  self.extra_deps += [
+    ['nokogiri',        '~> 1.13'],
+    ['slop',            '~> 4.6'],
+    ['differ',          '~> 0.1'],
+    ['rufus-scheduler', '~> 3.8'],
+    ['logger-colors',   '~> 1.0'],
+    ['liquid',          '~> 5.2']
+  ]
   self.extra_dev_deps += [
     ['hoe-bundler',   '~> 1.5'],
     ['hoe-git',       '~> 1.6'],
     ['minitest',      '~> 5.10'],
     ['mocha',         '~> 1.5'],
     # use the same version of rubocop as codacy
-    ['rubocop',       '~> 0.81'],
-    ['test-unit',     '~> 3.2'],
-    ['rdoc',          ['>= 4.0', '< 7']]
+    ['rubocop',       '~> 0.93'],
+    ['test-unit',     '~> 3.5'],
+    ['rdoc',          '~> 6.4']
   ]
   spec_extras[:required_ruby_version] = '>= 2.7'
 

data/lib/pmdtester/builders/liquid_renderer.rb

@@ -60,6 +60,11 @@ module PmdTester
       # copy original pmd reports
       copy_file("#{root}/base_pmd_report.xml", project.report_diff.base_report.file)
       copy_file("#{root}/patch_pmd_report.xml", project.report_diff.patch_report.file)
+      # copy stdout and stderr outputs
+      copy_file("#{root}/base_stdout.txt", "#{project.report_diff.base_report.report_folder}/stdout.txt")
+      copy_file("#{root}/base_stderr.txt", "#{project.report_diff.base_report.report_folder}/stderr.txt")
+      copy_file("#{root}/patch_stdout.txt", "#{project.report_diff.patch_report.report_folder}/stdout.txt")
+      copy_file("#{root}/patch_stderr.txt", "#{project.report_diff.patch_report.report_folder}/stderr.txt")
       # render full pmd reports
       write_file("#{root}/base_pmd_report.html",
                  render_liquid('project_pmd_report.html', pmd_report_liquid_env(project, BASE)))
@@ -120,6 +125,7 @@ module PmdTester
 
         'execution_time' => PmdReportDetail.convert_seconds(report.exec_time),
         'timestamp' => report.timestamp,
+        'exit_code' => report.exit_code,
 
         'rules' => report.rule_summaries,
         'errors' => report.errors_by_file.all_values.map { |e| error_to_hash(e, project) },

data/lib/pmdtester/builders/pmd_report_builder.rb

@@ -25,7 +25,7 @@ module PmdTester
     def get_pmd_binary_file
       logger.info "#{@pmd_branch_name}: Start packaging PMD"
       Dir.chdir(@local_git_repo) do
-        build_branch_sha = Cmd.execute("git rev-parse #{@pmd_branch_name}^{commit}")
+        build_branch_sha = Cmd.execute_successfully("git rev-parse #{@pmd_branch_name}^{commit}")
 
         checkout_build_branch # needs a clean working tree, otherwise fails
 
@@ -70,49 +70,53 @@ module PmdTester
                       ' -Dcheckstyle.skip=true' \
                       ' -Dpmd.skip=true' \
                       ' -T1C -B'
-        Cmd.execute(package_cmd)
+        Cmd.execute_successfully(package_cmd)
       end
 
       logger.info "#{@pmd_branch_name}: Extracting the zip"
-      Cmd.execute("unzip -qo #{pmd_dist_target} -d pmd-dist/target/exploded")
-      Cmd.execute("mv pmd-dist/target/exploded/pmd-bin-#{@pmd_version} #{into_dir}")
+      Cmd.execute_successfully("unzip -qo #{pmd_dist_target} -d pmd-dist/target/exploded")
+      Cmd.execute_successfully("mv pmd-dist/target/exploded/pmd-bin-#{@pmd_version} #{into_dir}")
     end
 
     def determine_pmd_version
       version_cmd = "./mvnw -q -Dexec.executable=\"echo\" -Dexec.args='${project.version}' " \
                     '--non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec'
-      Cmd.execute(version_cmd)
+      Cmd.execute_successfully(version_cmd)
     end
 
     def get_last_commit_sha
       get_last_commit_sha_cmd = 'git rev-parse HEAD^{commit}'
-      Cmd.execute(get_last_commit_sha_cmd)
+      Cmd.execute_successfully(get_last_commit_sha_cmd)
     end
 
     def get_last_commit_message
       get_last_commit_message_cmd = 'git log -1 --pretty=%B'
-      Cmd.execute(get_last_commit_message_cmd)
+      Cmd.execute_successfully(get_last_commit_message_cmd)
     end
 
     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'
+      auxclasspath_option = create_auxclasspath_option(project)
       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)} " \
                 "#{fail_on_violation} -t #{@threads} " \
-                "#{project.auxclasspath}"
+                "#{auxclasspath_option}" \
+                "#{pmd7? ? ' --no-progress' : ''}"
       start_time = Time.now
+      exit_code = nil
       if File.exist?(project.get_pmd_report_path(@pmd_branch_name))
         logger.warn "#{@pmd_branch_name}: Skipping PMD run - report " \
                     "#{project.get_pmd_report_path(@pmd_branch_name)} already exists"
       else
-        Cmd.execute(pmd_cmd)
+        status = Cmd.execute(pmd_cmd, project.get_project_target_dir(@pmd_branch_name))
+        exit_code = status.exitstatus
       end
       end_time = Time.now
-      [end_time - start_time, end_time]
+      [end_time - start_time, end_time, exit_code]
     end
 
     def generate_config_for(project)
@@ -139,12 +143,12 @@ module PmdTester
         progress_logger = SimpleProgressLogger.new("generating #{project.name}'s PMD report")
         progress_logger.start
         generate_config_for(project)
-        execution_time, end_time = generate_pmd_report(project)
+        execution_time, end_time, exit_code = generate_pmd_report(project)
         progress_logger.stop
         sum_time += execution_time
 
-        report_details = PmdReportDetail.new(execution_time: execution_time, timestamp: end_time)
-        report_details.save(project.get_report_info_path(@pmd_branch_name))
+        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"
       end
 
@@ -167,7 +171,7 @@ module PmdTester
     def checkout_build_branch
       logger.info "#{@pmd_branch_name}: Checking out the branch"
       # note that this would fail if the tree is dirty
-      Cmd.execute("git checkout #{@pmd_branch_name}")
+      Cmd.execute_successfully("git checkout #{@pmd_branch_name}")
 
       # determine the version
       @pmd_version = determine_pmd_version
@@ -193,12 +197,25 @@ module PmdTester
     end
 
     def wd_has_dirty_git_changes
-      !Cmd.execute('git status --porcelain').empty?
+      !Cmd.execute_successfully('git status --porcelain').empty?
     end
 
     def should_use_long_cli_options
       logger.debug "PMD Version: #{@pmd_version}"
       Semver.compare(@pmd_version, '6.41.0') >= 0
     end
+
+    def create_auxclasspath_option(project)
+      auxclasspath_option = ''
+      unless project.auxclasspath.empty?
+        auxclasspath_option = should_use_long_cli_options ? '--aux-classpath ' : '-auxclasspath '
+        auxclasspath_option += project.auxclasspath
+      end
+      auxclasspath_option
+    end
+
+    def pmd7?
+      Semver.compare(@pmd_version, '7.0.0-SNAPSHOT') >= 0
+    end
   end
 end

data/lib/pmdtester/builders/project_builder.rb

@@ -30,7 +30,7 @@ module PmdTester
           # once but may be used with several tags.
           clone_cmd = "git clone --no-single-branch --depth 1 #{project.connection} #{path}"
 
-          Cmd.execute(clone_cmd)
+          Cmd.execute_successfully(clone_cmd)
         end
 
         Dir.chdir(path) do
@@ -71,7 +71,7 @@ module PmdTester
       if project.auxclasspath_command
         logger.debug "Executing auxclasspath-command: #{project.auxclasspath_command}"
         auxclasspath = run_as_script(Dir.getwd, project.auxclasspath_command)
-        project.auxclasspath = "-auxclasspath #{auxclasspath}"
+        project.auxclasspath = auxclasspath
       else
         project.auxclasspath = ''
       end
@@ -87,7 +87,7 @@ module PmdTester
         if command.start_with?('#!')
           shell = command.lines[0].chomp[2..] # remove leading "#!"
         end
-        stdout = Cmd.execute("#{shell} #{script.path}")
+        stdout = Cmd.execute_successfully("#{shell} #{script.path}")
       ensure
         script.unlink
       end
@@ -99,7 +99,7 @@ module PmdTester
 
       reset_cmd = "git checkout #{tag}; git reset --hard #{tag}"
 
-      Cmd.execute(reset_cmd)
+      Cmd.execute_successfully(reset_cmd)
     end
   end
 end

data/lib/pmdtester/builders/project_hasher.rb

@@ -21,6 +21,9 @@ module PmdTester
         'base_timestamp' => rdiff.base_report.timestamp,
         'patch_timestamp' => rdiff.patch_report.timestamp,
 
+        'base_exit_code' => rdiff.base_report.exit_code,
+        'patch_exit_code' => rdiff.patch_report.exit_code,
+
         'rule_diffs' => rdiff.rule_summaries
       }
     end

data/lib/pmdtester/builders/rule_set_builder.rb

@@ -9,73 +9,70 @@ module PmdTester
   # Attention: we only consider java rulesets now.
   class RuleSetBuilder
     include PmdTester
-    ALL_CATEGORIES = Set['bestpractices.xml', 'codestyle.xml', 'design.xml', 'documentation.xml',
-                         'errorprone.xml', 'multithreading.xml', 'performance.xml',
-                         'security.xml'].freeze
-    PATH_TO_PMD_JAVA_BASED_RULES =
-      'pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule'
-    PATH_TO_PMD_XPATH_BASED_RULES = 'pmd-java/src/main/resources/category/java'
-    PATH_TO_ALL_JAVA_RULES =
-      ResourceLocator.locate('config/all-java.xml')
     PATH_TO_DYNAMIC_CONFIG = 'target/dynamic-config.xml'
-    NO_JAVA_RULES_CHANGED_MESSAGE = 'No java rules have been changed!'
+    NO_RULES_CHANGED_MESSAGE = 'No regression tested rules have been changed!'
 
     def initialize(options)
       @options = options
     end
 
-    def build
-      filenames = diff_filenames
-      rule_refs = get_rule_refs(filenames)
-      output_filter_set(rule_refs)
-      build_config_file(rule_refs)
-      logger.debug "Dynamic configuration: #{[rule_refs]}"
-      rule_refs
+    #
+    # Creates a dynamic ruleset based on the changed sources.
+    # Returns true, when rules are affected by the changed sources.
+    # Returns false, when no rules are affected and regression tester can be skipped.
+    #
+    def build?
+      languages = determine_languages
+      filenames = diff_filenames(languages)
+      run_required, rule_refs = get_rule_refs(filenames)
+      if run_required
+        output_filter_set(rule_refs)
+        build_config_file(rule_refs)
+        logger.debug "Dynamic configuration: #{[rule_refs]}"
+      else
+        logger.info NO_RULES_CHANGED_MESSAGE
+      end
+      run_required
     end
 
     def calculate_filter_set
-      output_filter_set(ALL_CATEGORIES)
+      output_filter_set([])
     end
 
     def output_filter_set(rule_refs)
-      if rule_refs == ALL_CATEGORIES
-        if @options.mode == Options::ONLINE
+      if rule_refs.empty?
+        if @options.mode == Options::ONLINE && @options.filter_with_patch_config
           @options.filter_set = Set[]
           doc = File.open(@options.patch_config) { |f| Nokogiri::XML(f) }
           rules = doc.css('ruleset rule')
           rules.each do |r|
             ref = r.attributes['ref'].content
-            ref.delete_prefix!('category/java/')
+            ref.delete_prefix!('category/')
             @options.filter_set.add(ref)
           end
 
-          logger.debug "Using filter based on patch config #{@options.patch_config}: " \
+          logger.info "Using filter based on patch config #{@options.patch_config}: " \
                        "#{@options.filter_set}"
         else
-          # if `rule_refs` contains all categories, then no need to filter the baseline
-          logger.debug 'No filter when comparing patch to baseline'
+          # if `rule_refs` is empty, then no filter can be used when comparing to the baseline
+          logger.info 'No filter when comparing patch to baseline'
           @options.filter_set = nil
         end
       else
-        logger.debug "Filter is now #{rule_refs}"
+        logger.info "Filter is now #{rule_refs}"
         @options.filter_set = rule_refs
       end
     end
 
-    def diff_filenames
-      filenames = nil
-      Dir.chdir(@options.local_git_repo) do
-        base = @options.base_branch
-        patch = @options.patch_branch
-        # We only need to support git here, since PMD's repo is using git.
-        diff_cmd = "git diff --name-only #{base}..#{patch} -- pmd-core/src/main pmd-java/src/main"
-        filenames = Cmd.execute(diff_cmd)
-      end
-      filenames.split("\n")
-    end
-
+    #
+    # Determines the rules or category rulesets, that are potentially affected by the change.
+    # Returns an empty set, if all rules are affected and there is no
+    # 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)
-      categories, rules = determine_categories_rules(filenames)
+      run_required, categories, rules = determine_categories_rules(filenames)
+      logger.debug "Regression test required: #{run_required}"
       logger.debug "Categories: #{categories}"
       logger.debug "Rules: #{rules}"
 
@@ -87,48 +84,11 @@ module PmdTester
       refs = Set[]
       refs.merge(categories)
       refs.merge(rules)
-      refs
-    end
-
-    def determine_categories_rules(filenames)
-      categories = Set[]
-      rules = Set[]
-      filenames.each do |filename|
-        match_data = check_single_filename(filename)
-
-        unless match_data.nil?
-          if match_data.size == 2
-            categories.add("#{match_data[1]}.xml")
-          else
-            rules.add("#{match_data[1]}.xml/#{match_data[2]}")
-          end
-        end
-
-        next unless match_data.nil?
-
-        logger.debug "Change doesn't match specific rule/category - enable all rules"
-        categories = ALL_CATEGORIES
-        rules.clear
-        break
-      end
-      [categories, rules]
-    end
-
-    def check_single_filename(filename)
-      logger.debug "Checking #{filename}"
-      match_data = %r{#{PATH_TO_PMD_JAVA_BASED_RULES}/([^/]+)/([^/]+)Rule.java}.match(filename)
-      match_data = %r{#{PATH_TO_PMD_XPATH_BASED_RULES}/([^/]+).xml}.match(filename) if match_data.nil?
-      logger.debug "Matches: #{match_data.inspect}"
-      match_data
+      [run_required, refs]
     end
 
     def build_config_file(rule_refs)
       if rule_refs.empty?
-        logger.info NO_JAVA_RULES_CHANGED_MESSAGE
-        return
-      end
-
-      if rule_refs == ALL_CATEGORIES
         logger.debug 'All rules are used. Not generating a dynamic ruleset.'
         logger.debug "Using the configured/default ruleset base_config=#{@options.base_config} "\
                      "patch_config=#{@options.patch_config}"
@@ -147,7 +107,7 @@ module PmdTester
                     'name' => 'Dynamic PmdTester Ruleset') do
           xml.description 'The ruleset generated by PmdTester dynamically'
           rule_refs.each do |entry|
-            xml.rule('ref' => "category/java/#{entry}")
+            xml.rule('ref' => "category/#{entry}")
           end
         end
       end
@@ -158,5 +118,82 @@ module PmdTester
       @options.base_config = PATH_TO_DYNAMIC_CONFIG
       @options.patch_config = PATH_TO_DYNAMIC_CONFIG
     end
+
+    private
+
+    def determine_categories_rules(filenames)
+      regression_test_required = false
+      categories = Set[]
+      rules = Set[]
+      filenames.each do |filename|
+        matched = check_single_filename(filename, categories, rules)
+        regression_test_required = true if matched
+
+        next if matched
+
+        logger.info "Change in file #{filename} doesn't match specific rule/category - enable all rules"
+        regression_test_required = true
+        categories.clear
+        rules.clear
+        break
+      end
+      [regression_test_required, categories, rules]
+    end
+
+    def check_single_filename(filename, 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]}")
+        return true
+      end
+
+      # matches xpath rules
+      match_data = %r{.+/src/main/resources/category/([^/]+)/([^/]+).xml}.match(filename)
+      unless match_data.nil?
+        logger.debug "Matches: #{match_data.inspect}"
+        categories.add("#{match_data[1]}/#{match_data[2]}.xml")
+        return true
+      end
+
+      false
+    end
+
+    def diff_filenames(languages)
+      filenames = nil
+      Dir.chdir(@options.local_git_repo) do
+        base = @options.base_branch
+        patch = @options.patch_branch
+
+        filepath_filter = ''
+        unless languages.empty?
+          filepath_filter = '-- pmd-core/src/main'
+          languages.each { |l| filepath_filter = "#{filepath_filter} pmd-#{l}/src/main" }
+        end
+
+        # We only need to support git here, since PMD's repo is using git.
+        diff_cmd = "git diff --name-only #{base}..#{patch} #{filepath_filter}"
+        filenames = Cmd.execute_successfully(diff_cmd)
+      end
+      filenames.split("\n")
+    end
+
+    #
+    # Determines all languages, that are part of the regression test.
+    # This is based on the configured rules/rulesets.
+    #
+    def determine_languages
+      languages = Set[]
+      doc = File.open(@options.patch_config) { |f| Nokogiri::XML(f) }
+      rules = doc.css('ruleset rule')
+      rules.each do |r|
+        ref = r.attributes['ref'].content
+        languages.add(ref.split('/')[1])
+      end
+      languages
+    end
   end
 end

data/lib/pmdtester/cmd.rb

@@ -6,9 +6,35 @@ module PmdTester
   # Containing the common method for executing shell command
   class Cmd
     extend PmdTester
-    def self.execute(cmd)
-      stdout, _stderr, _status = internal_execute(cmd)
-      stdout&.chomp!
+
+    #
+    # Executes the given command and returns the process status.
+    # stdout and stderr are written to the files "stdout.txt" and "stderr.txt"
+    # in path.
+    #
+    def self.execute(cmd, path)
+      stdout, stderr, status = internal_execute(cmd)
+
+      file = File.new("#{path}/stdout.txt", 'w')
+      file.puts stdout
+      file.close
+
+      file = File.new("#{path}/stderr.txt", 'w')
+      file.puts stderr
+      file.close
+
+      status
+    end
+
+    def self.execute_successfully(cmd)
+      stdout, stderr, status = internal_execute(cmd)
+
+      unless status.success?
+        logger.error stdout
+        logger.error stderr
+        raise CmdException.new(cmd, stdout, stderr, status)
+      end
+
       stdout
     end
 
@@ -22,14 +48,12 @@ module PmdTester
 
       stdout, stderr, status = Open3.capture3("#{cmd};")
 
-      logger.debug stdout
-      unless status.success?
-        logger.error stdout
-        logger.error stderr
-        raise CmdException.new(cmd, stderr)
-      end
+      logger.debug "status: #{status}"
+      logger.debug "stdout: #{stdout}"
+      logger.debug "stderr: #{stderr}"
 
       stdout&.chomp!
+      stderr&.chomp!
 
       [stdout, stderr, status]
     end
@@ -40,15 +64,19 @@ module PmdTester
   # The exception should be raised when the shell command failed.
   class CmdException < StandardError
     attr_reader :cmd
+    attr_reader :stdout
     attr_reader :error
+    attr_reader :status
     attr_reader :message
 
     COMMON_MSG = 'An error occurred while executing the shell command'
 
-    def initialize(cmd, error)
+    def initialize(cmd, stdout, error, status)
       @cmd = cmd
+      @stdout = stdout
       @error = error
-      @message = "#{COMMON_MSG} '#{cmd}'"
+      @status = status
+      @message = "#{COMMON_MSG} '#{cmd}' #{status}"
     end
   end
 end

data/lib/pmdtester/parsers/pmd_report_document.rb

@@ -89,11 +89,10 @@ module PmdTester
     def match_filter_set?(violation)
       return true if @filter_set.nil?
 
-      ruleset_attr = violation.ruleset_name.delete(' ').downcase! << '.xml'
-      return true if @filter_set.include?(ruleset_attr)
-
-      rule_ref = "#{ruleset_attr}/#{violation.rule_name}"
+      ruleset_filter = violation.language << '/' << violation.ruleset_name.delete(' ').downcase! << '.xml'
+      return true if @filter_set.include?(ruleset_filter)
 
+      rule_ref = "#{ruleset_filter}/#{violation.rule_name}"
       @filter_set.include?(rule_ref)
     end
 

data/lib/pmdtester/pmd_report_detail.rb

@@ -8,15 +8,22 @@ module PmdTester
     attr_accessor :execution_time
     attr_accessor :timestamp
     attr_accessor :working_dir
+    attr_accessor :exit_code
 
-    def initialize(execution_time: 0, timestamp: '', working_dir: Dir.getwd)
+    def initialize(execution_time: 0, timestamp: '', working_dir: Dir.getwd, exit_code: nil)
       @execution_time = execution_time
       @timestamp = timestamp
       @working_dir = working_dir
+      @exit_code = exit_code.nil? ? '?' : exit_code.to_s
     end
 
     def save(report_info_path)
-      hash = { execution_time: @execution_time, timestamp: @timestamp, working_dir: @working_dir }
+      hash = {
+        execution_time: @execution_time,
+        timestamp: @timestamp,
+        working_dir: @working_dir,
+        exit_code: @exit_code
+      }
       file = File.new(report_info_path, 'w')
       file.puts JSON.generate(hash)
       file.close
@@ -36,6 +43,13 @@ module PmdTester
       self.class.convert_seconds(@execution_time)
     end
 
+    def self.create(execution_time: 0, timestamp: '', working_dir: Dir.getwd, exit_code: nil, report_info_path:)
+      detail = PmdReportDetail.new(execution_time: execution_time, timestamp: timestamp,
+                                   working_dir: working_dir, exit_code: exit_code)
+      detail.save(report_info_path)
+      detail
+    end
+
     # convert seconds into HH::MM::SS
     def self.convert_seconds(seconds)
       Time.at(seconds.abs).utc.strftime('%H:%M:%S')

data/lib/pmdtester/pmd_tester_utils.rb

@@ -32,7 +32,8 @@ module PmdTester
         file: report_file,
 
         timestamp: report_details.timestamp,
-        exec_time: report_details.execution_time
+        exec_time: report_details.execution_time,
+        exit_code: report_details.exit_code
       )
     end
 

data/lib/pmdtester/pmd_violation.rb

@@ -27,7 +27,7 @@ module PmdTester
     #   </xs:simpleContent>
     # </xs:complexType>
 
-    attr_reader :fname, :info_url, :line, :old_line, :old_message, :rule_name, :ruleset_name
+    attr_reader :fname, :info_url, :line, :old_line, :old_message, :rule_name, :ruleset_name, :language
     attr_accessor :message
 
     # rubocop:disable Metrics/ParameterLists
@@ -43,6 +43,8 @@ module PmdTester
 
       @ruleset_name = ruleset_name
 
+      @language = determine_language_from_info_url
+
       @changed = false
       @old_message = nil
       @old_line = nil
@@ -102,5 +104,13 @@ module PmdTester
         'changed' => changed?
       }
     end
+
+    private
+
+    def determine_language_from_info_url
+      # @info_url is e.g. http://pmd.sourceforge.net/snapshot/pmd_rules_java_codestyle.html#fielddeclarationsshouldbeatstartofclass
+      m = @info_url.match(/pmd_rules_(\w+)_/)
+      m[1]
+    end
   end
 end

data/lib/pmdtester/project.rb

@@ -123,6 +123,9 @@ module PmdTester
                                            get_report_info_path(base_branch),
                                            get_report_info_path(patch_branch),
                                            filter_set)
+
+      report_diff.base_report.report_folder = get_project_target_dir(base_branch)
+      report_diff.patch_report.report_folder = get_project_target_dir(patch_branch)
     end
   end
 end

data/lib/pmdtester/report_diff.rb

@@ -57,17 +57,22 @@ module PmdTester
                 :configerrors_by_rule,
                 :exec_time,
                 :timestamp,
+                :exit_code,
                 :file
 
+    attr_accessor :report_folder
+
     def initialize(report_document: nil,
                    file: '',
                    exec_time: 0,
-                   timestamp: '0')
+                   timestamp: '0',
+                   exit_code: '?')
       initialize_empty
       initialize_with_report_document report_document unless report_document.nil?
       @exec_time = exec_time
       @timestamp = timestamp
       @file = file
+      @exit_code = exit_code
     end
 
     def self.empty
@@ -108,6 +113,7 @@ module PmdTester
       @violations_by_file = CollectionByFile.new
       @errors_by_file = CollectionByFile.new
       @configerrors_by_rule = {}
+      @report_folder = ''
     end
   end
 

data/lib/pmdtester/runner.rb

@@ -33,8 +33,11 @@ module PmdTester
     def run_local_mode
       logger.info "Mode: #{@options.mode}"
       get_projects(@options.project_list) unless @options.nil?
-      rule_sets = RuleSetBuilder.new(@options).build if @options.auto_config_flag
-      return if rule_sets&.empty?
+      if @options.auto_config_flag
+        run_required = RuleSetBuilder.new(@options).build?
+        logger.debug "Run required: #{run_required}"
+        return unless run_required
+      end
 
       base_branch_details = create_pmd_report(config: @options.base_config, branch: @options.base_branch)
       patch_branch_details = create_pmd_report(config: @options.patch_config, branch: @options.patch_branch)
@@ -51,7 +54,8 @@ module PmdTester
       get_projects(project_list)
 
       if @options.auto_config_flag
-        return if RuleSetBuilder.new(@options).build.empty?
+        logger.info 'Autogenerating a dynamic ruleset based on source changes'
+        return unless RuleSetBuilder.new(@options).build?
       elsif @options.patch_config == Options::DEFAULT_CONFIG_PATH
         # patch branch build pmd reports with same configuration as base branch
         # if not specified otherwise. This allows to use a different config (e.g. less rules)
@@ -93,8 +97,8 @@ module PmdTester
       unzip_cmd = "unzip -qo #{zip_filename}"
 
       Dir.chdir(target_path) do
-        Cmd.execute(wget_cmd) unless File.exist?(zip_filename)
-        Cmd.execute(unzip_cmd)
+        Cmd.execute_successfully(wget_cmd) unless File.exist?(zip_filename)
+        Cmd.execute_successfully(unzip_cmd)
       end
 
       "#{target_path}/#{branch_filename}"

data/lib/pmdtester/semver.rb

@@ -4,6 +4,12 @@ module PmdTester
   # Utility to deal with semantic versions
   class Semver
     def self.compare(version_a, version_b)
+      result = internal_compare(version_a, version_b)
+      PmdTester.logger.debug "  result: #{result}"
+      result
+    end
+
+    private_class_method def self.internal_compare(version_a, version_b)
       PmdTester.logger.debug "Comparing #{version_a} <=> #{version_b}"
       m = /(\d+)\.(\d+)\.(\d+)(.*)/.match(version_a)
       a_major = m[1].to_i

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.3.0'
+  VERSION = '1.5.0'
   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.3.0 ruby lib
+# stub: pmdtester 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.3.0"
+  s.version = "1.5.0"
 
   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 = "2021-12-17"
+  s.date = "2022-05-06"
   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]
@@ -29,34 +29,34 @@ Gem::Specification.new do |s|
   end
 
   if s.respond_to? :add_runtime_dependency then
-    s.add_runtime_dependency(%q<nokogiri>.freeze, [">= 1.11.0.rc4"])
+    s.add_runtime_dependency(%q<nokogiri>.freeze, ["~> 1.13"])
     s.add_runtime_dependency(%q<slop>.freeze, ["~> 4.6"])
     s.add_runtime_dependency(%q<differ>.freeze, ["~> 0.1"])
-    s.add_runtime_dependency(%q<rufus-scheduler>.freeze, ["~> 3.5"])
+    s.add_runtime_dependency(%q<rufus-scheduler>.freeze, ["~> 3.8"])
     s.add_runtime_dependency(%q<logger-colors>.freeze, ["~> 1.0"])
-    s.add_runtime_dependency(%q<liquid>.freeze, [">= 4.0"])
+    s.add_runtime_dependency(%q<liquid>.freeze, ["~> 5.2"])
     s.add_development_dependency(%q<hoe-bundler>.freeze, ["~> 1.5"])
     s.add_development_dependency(%q<hoe-git>.freeze, ["~> 1.6"])
     s.add_development_dependency(%q<minitest>.freeze, ["~> 5.10"])
     s.add_development_dependency(%q<mocha>.freeze, ["~> 1.5"])
-    s.add_development_dependency(%q<rubocop>.freeze, ["~> 0.81"])
-    s.add_development_dependency(%q<test-unit>.freeze, ["~> 3.2"])
-    s.add_development_dependency(%q<rdoc>.freeze, [">= 4.0", "< 7"])
+    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"])
   else
-    s.add_dependency(%q<nokogiri>.freeze, [">= 1.11.0.rc4"])
+    s.add_dependency(%q<nokogiri>.freeze, ["~> 1.13"])
     s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
     s.add_dependency(%q<differ>.freeze, ["~> 0.1"])
-    s.add_dependency(%q<rufus-scheduler>.freeze, ["~> 3.5"])
+    s.add_dependency(%q<rufus-scheduler>.freeze, ["~> 3.8"])
     s.add_dependency(%q<logger-colors>.freeze, ["~> 1.0"])
-    s.add_dependency(%q<liquid>.freeze, [">= 4.0"])
+    s.add_dependency(%q<liquid>.freeze, ["~> 5.2"])
     s.add_dependency(%q<hoe-bundler>.freeze, ["~> 1.5"])
     s.add_dependency(%q<hoe-git>.freeze, ["~> 1.6"])
     s.add_dependency(%q<minitest>.freeze, ["~> 5.10"])
     s.add_dependency(%q<mocha>.freeze, ["~> 1.5"])
-    s.add_dependency(%q<rubocop>.freeze, ["~> 0.81"])
-    s.add_dependency(%q<test-unit>.freeze, ["~> 3.2"])
-    s.add_dependency(%q<rdoc>.freeze, [">= 4.0", "< 7"])
+    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"])
   end
 end

data/resources/project_diff_report.html

@@ -71,6 +71,12 @@
                 <td class="patch">{{diff.patch_timestamp}}</td>
                 <td class="diff"></td>
             </tr>
+            <tr>
+                <td class="item">Exit Code</td>
+                <td class="base">{{diff.base_exit_code}} <a href="base_stdout.txt">stdout</a> | <a href="base_stderr.txt">stderr</a></td>
+                <td class="patch">{{diff.patch_exit_code}} <a href="patch_stdout.txt">stdout</a> | <a href="patch_stderr.txt">stderr</a></td>
+                <td class="diff"></td>
+            </tr>
             <tr>
                 <td class="item">Full Report</td>
                 <td class="base"><a href="base_pmd_report.html">Base PMD Report</a></td>

data/resources/project_pmd_report.html

@@ -53,6 +53,10 @@
                 <td class="item">Timestamp</td>
                 <td class="{{branch}}">{{report.timestamp}}</td>
             </tr>
+            <tr>
+                <td class="item">Exit Code</td>
+                <td class="{{branch}}">{{report.exit_code}} <a href="{{branch}}_stdout.txt">stdout</a> | <a href="{{branch}}_stderr.txt">stderr</a></td>
+            </tr>
             <tr>
                 <td class="item">Full Report</td>
                 <td class="{{branch}}"><a href="{{branch}}_pmd_report.xml">{{branch}}_pmd_report.xml</a></td>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pmdtester
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Andreas Dangel
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0.rc4
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0.rc4
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: logger-colors
   requirement: !ruby/object:Gem::Requirement
@@ -86,16 +86,16 @@ dependencies:
   name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: hoe-bundler
   requirement: !ruby/object:Gem::Requirement
@@ -158,48 +158,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.81'
+        version: '0.93'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.81'
+        version: '0.93'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '6.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement