pmdtester 1.5.1 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 733a4296c7168a518aa22c6fde568d2b3bf966ee99711e17a06dac851605f290
-  data.tar.gz: 5b900068f5483c479d6184600bcd78c20faf9b83bc9db2bbe12ec2c78d0328cd
+  metadata.gz: d64309fafec9b58208385b35297f4096da84511576ea23382e271b8bcf0bfcb0
+  data.tar.gz: d90d0ab024c076b3e6e13228d1fef303d63a34c1ce97ddb9169d798b94e63dde
 SHA512:
-  metadata.gz: '039f00d21c56f0ae4c59ff5343e40a9ee9361c6514b2ab62e276c81877a3f4a59506639c2ad7c0be2eb0d3e2011698e2e6e16711ee97928519ba685a4dc1d139'
-  data.tar.gz: 54cce64c7f1e995178a90d0a09da3b1afdf42a62e825fdc74827ef5b9ff453b102fc1e04e8c3ecf2fd797d7981b1079de72f883d849ba87fed1175db03b54e79
+  metadata.gz: 3201eaf56629cb6e859ded9c3522dc3907f50de3694ab1bdd11256f204e0c0fdd2e8bf5857ed0ee2291c02c257be091e6f36110c7c646d55281b0311ae7e9024
+  data.tar.gz: 7784defdc77b0c5d3f278232ed8f06e3326f3a17c2632e140b376dc1551640e0e0a35ed0d28770140cc6ed5d99ec96c8464dd92afc54f1a8b64421b15df47b72

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,16 @@
+# 1.5.3 / 2022-11-25
+
+## Fixed Issues
+
+* [#115](https://github.com/pmd/pmd-regression-tester/pull/115): Fix manual integration tests
+* [#116](https://github.com/pmd/pmd-regression-tester/issues/116): Relative paths in pmd report result in missing code snippets
+
+# 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

data/Rakefile

@@ -21,17 +21,17 @@ hoe = Hoe.spec 'pmdtester' do
   self.clean_globs = %w[target/reports/**/* target/test/**/* target/dynamic-config.xml Gemfile.lock]
   self.extra_deps += [
     ['nokogiri',        '~> 1.13'],
-    ['slop',            '~> 4.6'],
+    ['slop',            '~> 4.9'],
     ['differ',          '~> 0.1'],
     ['rufus-scheduler', '~> 3.8'],
     ['logger-colors',   '~> 1.0'],
-    ['liquid',          '~> 5.2']
+    ['liquid',          '~> 5.4']
   ]
   self.extra_dev_deps += [
     ['hoe-bundler',   '~> 1.5'],
     ['hoe-git',       '~> 1.6'],
-    ['minitest',      '~> 5.10'],
-    ['mocha',         '~> 1.5'],
+    ['minitest',      '~> 5.16'],
+    ['mocha',         '~> 1.16'],
     # use the same version of rubocop as codacy
     ['rubocop',       '~> 0.93'],
     ['test-unit',     '~> 3.5'],

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/parsers/pmd_report_document.rb

@@ -41,11 +41,11 @@ module PmdTester
     end
 
     def characters(string)
-      @cur_text << remove_work_dir!(string)
+      @cur_text << string
     end
 
     def cdata_block(string)
-      @cur_text << remove_work_dir!(string)
+      @cur_text << string
     end
 
     def end_element(name)
@@ -76,11 +76,12 @@ module PmdTester
     # Modifies the string in place and returns it
     # (this is what sub! does, except it returns nil if no replacement occurred)
     def remove_work_dir!(str)
-      str.sub!(/#{@working_dir}/, '')
+      str.sub!(%r{#{@working_dir}/}, '')
       str
     end
 
     def finish_text!
+      remove_work_dir!(@cur_text)
       res = @cur_text.strip!.dup.freeze
       @cur_text.clear
       res

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/project.rb

@@ -60,17 +60,19 @@ module PmdTester
     # Change the file path from 'LOCAL_DIR/SOURCE_CODE_PATH' to
     # 'WEB_VIEW_URL/SOURCE_CODE_PATH'
     def get_webview_url(file_path)
-      file_path.gsub(%r{/#{clone_root_path}}, @webview_url)
+      file_path.gsub(%r{^#{clone_root_path}/}, "#{@webview_url}/")
     end
 
     # Change the file path from 'LOCAL_DIR/SOURCE_CODE_PATH' to
     # 'PROJECT_NAME/SOURCE_CODE_PATH'
     def get_path_inside_project(file_path)
-      file_path.gsub(%r{/#{clone_root_path}}, @name)
+      file_path.gsub(%r{^#{clone_root_path}/}, "#{@name}/")
     end
 
+    # Change the file path from 'LOCAL_DIR/SOURCE_CODE_PATH' to
+    # 'SOURCE_CODE_PATH'
     def get_local_path(file_path)
-      file_path.sub(%r{/#{clone_root_path}/}, '')
+      file_path.sub(%r{^#{clone_root_path}/}, '')
     end
 
     def get_pmd_report_path(branch_name)

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.1'
+  VERSION = '1.5.3'
   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.1 ruby lib
+# stub: pmdtester 1.5.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.5.1"
+  s.version = "1.5.3"
 
   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-12"
+  s.date = "2022-11-25"
   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]
@@ -30,34 +30,34 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :add_runtime_dependency then
     s.add_runtime_dependency(%q<nokogiri>.freeze, ["~> 1.13"])
-    s.add_runtime_dependency(%q<slop>.freeze, ["~> 4.6"])
+    s.add_runtime_dependency(%q<slop>.freeze, ["~> 4.9"])
     s.add_runtime_dependency(%q<differ>.freeze, ["~> 0.1"])
     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, ["~> 5.2"])
+    s.add_runtime_dependency(%q<liquid>.freeze, ["~> 5.4"])
     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<minitest>.freeze, ["~> 5.16"])
+    s.add_development_dependency(%q<mocha>.freeze, ["~> 1.16"])
     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.26"])
   else
     s.add_dependency(%q<nokogiri>.freeze, ["~> 1.13"])
-    s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
+    s.add_dependency(%q<slop>.freeze, ["~> 4.9"])
     s.add_dependency(%q<differ>.freeze, ["~> 0.1"])
     s.add_dependency(%q<rufus-scheduler>.freeze, ["~> 3.8"])
     s.add_dependency(%q<logger-colors>.freeze, ["~> 1.0"])
-    s.add_dependency(%q<liquid>.freeze, ["~> 5.2"])
+    s.add_dependency(%q<liquid>.freeze, ["~> 5.4"])
     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<minitest>.freeze, ["~> 5.16"])
+    s.add_dependency(%q<mocha>.freeze, ["~> 1.16"])
     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.26"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pmdtester
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.3
 platform: ruby
 authors:
 - Andreas Dangel
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.9'
 - !ruby/object:Gem::Dependency
   name: differ
   requirement: !ruby/object:Gem::Requirement
@@ -88,14 +88,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
   name: hoe-bundler
   requirement: !ruby/object:Gem::Requirement
@@ -130,28 +130,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -200,14 +200,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '3.26'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '3.26'
 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.