pmdtester 1.5.2 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09f77b85a868975ac9f52380870bff0daf2d9467f15fe5e8ff02d68399a865a2'
-  data.tar.gz: c5a650a352d4fcab5efaf7588bc3774a37a8ddb845031453288527877ad12892
+  metadata.gz: 0c6c579178746a76cc77dc88dccb3465e0f5aba7133a17f238653497ebfdb037
+  data.tar.gz: cdba630126e5e216582dca8b5f7f4e59017e63f573009887fc6e4f51d6a18755
 SHA512:
-  metadata.gz: c45f72e96a6dd7132dd8f207c75c11a7403e6acca9cfa5a345e628d7bc4122f3d4fbc044bca385a63e1360309b452651525a59e3f0afcd5924af5342b92d835a
-  data.tar.gz: 595759d8592b99b0264332528df6257ec35ebce98f206c92b08fca7d89935a70f8223cc5d206e5f0e91f48a5b31ca355b4a37c301c53b3877362b9b84a5d8746
+  metadata.gz: 129e21d2eb726a05ed2dc1bed919f4557d169356ad7c734fbc5c9be01c15b939381e6bd0aae655f53e3d2beca837bf55b35cf414eee5573fa641d5641d823dca
+  data.tar.gz: 312ce6f7d5b28b412b376ce3251739d7c5eacab038f9db3850050e709790087a654dd071421a80d150b2d513337e5c0bc46dad466f57a360c62f3201b54a7db9

data/History.md

@@ -1,3 +1,18 @@
+# 1.5.4 / 2023-05-27
+
+## Enhancements
+
+* [#118](https://github.com/pmd/pmd-regression-tester/pull/118): Update js libraries
+* [#119](https://github.com/pmd/pmd-regression-tester/pull/119): Update manual integration test for PMD 7
+* [#120](https://github.com/pmd/pmd-regression-tester/pull/120): Support new PMD 7 binary dist filename
+
+# 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

data/Manifest.txt

@@ -47,15 +47,15 @@ lib/pmdtester/runner.rb
 lib/pmdtester/semver.rb
 pmdtester.gemspec
 resources/_includes/diff_pill_row.html
-resources/css/bootstrap.min.css
+resources/css/bootstrap-5.3.0-alpha3.min.css
 resources/css/datatables.min.css
 resources/css/pmd-tester.css
-resources/js/bootstrap.min.js
+resources/js/README.md
+resources/js/bootstrap-5.3.0-alpha3.min.js
 resources/js/code-snippets.js
 resources/js/datatables.min.js
-resources/js/jquery-3.2.1.slim.min.js
-resources/js/jquery.min.js
-resources/js/popper.min.js
+resources/js/jquery-3.6.4.slim.min.js
+resources/js/popper-2.11.7.min.js
 resources/js/project-report.js
 resources/project_diff_report.html
 resources/project_index.html

data/README.rdoc

@@ -136,10 +136,10 @@ The tool creates the following folders:
   bundle exec pmdtester ... # run this to directly execute pmdtester from source
   
   Run a single test class, e.g.:
-  bundle exec ruby -I test test/test_diff_report_builder.rb
+  bundle exec ruby -I test test/test_project_diff_report.rb
   
   Run a single test, e.g.:
-  bundle exec ruby -I test test/test_diff_report_builder.rb -n test_diff_report_builder
+  bundle exec ruby -I test test/test_project_diff_report.rb -n test_diff_report_builder
 
 === Releasing
 

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

@@ -53,24 +53,19 @@ module PmdTester
     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.
         # In CI, that's not a problem, because the workspace is always fresh.
         logger.warn "#{@pmd_branch_name}: Reusing already existing #{pmd_dist_target}"
       else
-        logger.info "#{@pmd_branch_name}: Building PMD #{@pmd_version}..."
-        package_cmd = './mvnw clean package' \
-                      ' -Dmaven.test.skip=true' \
-                      ' -Dmaven.javadoc.skip=true' \
-                      ' -Dmaven.source.skip=true' \
-                      ' -Dcheckstyle.skip=true' \
-                      ' -Dpmd.skip=true' \
-                      ' -T1C -B'
-        Cmd.execute_successfully(package_cmd)
+        build_pmd_with_maven
+        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"
@@ -96,7 +91,7 @@ module PmdTester
 
     def generate_pmd_report(project)
       error_recovery_options = @error_recovery ? 'PMD_JAVA_OPTS="-Dpmd.error_recovery -ea" ' : ''
-      fail_on_violation = should_use_long_cli_options? ? '--fail-on-violation false' : '-failOnViolation false'
+      fail_on_violation = create_failonviolation_option
       auxclasspath_option = create_auxclasspath_option(project)
       pmd_cmd = "#{error_recovery_options}" \
                 "#{determine_run_path} -d #{project.local_source_path} -f xml " \
@@ -213,6 +208,16 @@ module PmdTester
       auxclasspath_option
     end
 
+    def create_failonviolation_option
+      if pmd7?
+        '--no-fail-on-violation'
+      elsif should_use_long_cli_options?
+        '--fail-on-violation false'
+      else
+        '-failOnViolation false'
+      end
+    end
+
     def pmd7?
       Semver.compare(@pmd_version, '7.0.0-SNAPSHOT') >= 0
     end
@@ -227,5 +232,30 @@ module PmdTester
                  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
+
+    def build_pmd_with_maven
+      logger.info "#{@pmd_branch_name}: Building PMD #{@pmd_version}..."
+      package_cmd = './mvnw clean package' \
+                    ' -Dmaven.test.skip=true' \
+                    ' -Dmaven.javadoc.skip=true' \
+                    ' -Dmaven.source.skip=true' \
+                    ' -Dcheckstyle.skip=true' \
+                    ' -Dpmd.skip=true' \
+                    ' -T1C -B'
+      logger.debug "#{@pmd_branch_name}: maven command: #{package_cmd}"
+      Cmd.execute_successfully(package_cmd)
+    end
   end
 end

data/lib/pmdtester/cmd.rb

@@ -30,6 +30,7 @@ module PmdTester
       stdout, stderr, status = internal_execute(cmd)
 
       unless status.success?
+        logger.error "Command failed: #{cmd}"
         logger.error stdout
         logger.error stderr
         raise CmdException.new(cmd, stdout, stderr, status)

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

data/pmdtester.gemspec

@@ -1,27 +1,27 @@
 # DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake hoe:spec`.
 
 # -*- encoding: utf-8 -*-
-# stub: pmdtester 1.5.2 ruby lib
+# stub: pmdtester 1.5.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.5.2"
+  s.version = "1.5.4"
 
   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-10-20"
+  s.date = "2023-05-27"
   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]
-  s.extra_rdoc_files = ["History.md".freeze, "Manifest.txt".freeze, "README.rdoc".freeze]
-  s.files = [".ci/build.sh".freeze, ".ci/inc/fetch_ci_scripts.bash".freeze, ".ci/manual-integration-tests.sh".freeze, ".github/workflows/build.yml".freeze, ".github/workflows/manual-integration-tests.yml".freeze, ".gitignore".freeze, ".hoerc".freeze, ".rubocop.yml".freeze, ".rubocop_todo.yml".freeze, ".ruby-version".freeze, "Gemfile".freeze, "History.md".freeze, "LICENSE".freeze, "Manifest.txt".freeze, "README.rdoc".freeze, "Rakefile".freeze, "bin/pmdtester".freeze, "config/all-java.xml".freeze, "config/design.xml".freeze, "config/project-list.xml".freeze, "config/projectlist_1_0_0.xsd".freeze, "config/projectlist_1_1_0.xsd".freeze, "config/projectlist_1_2_0.xsd".freeze, "lib/pmdtester.rb".freeze, "lib/pmdtester/builders/liquid_renderer.rb".freeze, "lib/pmdtester/builders/pmd_report_builder.rb".freeze, "lib/pmdtester/builders/project_builder.rb".freeze, "lib/pmdtester/builders/project_hasher.rb".freeze, "lib/pmdtester/builders/rule_set_builder.rb".freeze, "lib/pmdtester/builders/simple_progress_logger.rb".freeze, "lib/pmdtester/builders/summary_report_builder.rb".freeze, "lib/pmdtester/cmd.rb".freeze, "lib/pmdtester/collection_by_file.rb".freeze, "lib/pmdtester/parsers/options.rb".freeze, "lib/pmdtester/parsers/pmd_report_document.rb".freeze, "lib/pmdtester/parsers/projects_parser.rb".freeze, "lib/pmdtester/pmd_branch_detail.rb".freeze, "lib/pmdtester/pmd_configerror.rb".freeze, "lib/pmdtester/pmd_error.rb".freeze, "lib/pmdtester/pmd_report_detail.rb".freeze, "lib/pmdtester/pmd_tester_utils.rb".freeze, "lib/pmdtester/pmd_violation.rb".freeze, "lib/pmdtester/project.rb".freeze, "lib/pmdtester/report_diff.rb".freeze, "lib/pmdtester/resource_locator.rb".freeze, "lib/pmdtester/runner.rb".freeze, "lib/pmdtester/semver.rb".freeze, "pmdtester.gemspec".freeze, "resources/_includes/diff_pill_row.html".freeze, "resources/css/bootstrap.min.css".freeze, "resources/css/datatables.min.css".freeze, "resources/css/pmd-tester.css".freeze, "resources/js/bootstrap.min.js".freeze, "resources/js/code-snippets.js".freeze, "resources/js/datatables.min.js".freeze, "resources/js/jquery-3.2.1.slim.min.js".freeze, "resources/js/jquery.min.js".freeze, "resources/js/popper.min.js".freeze, "resources/js/project-report.js".freeze, "resources/project_diff_report.html".freeze, "resources/project_index.html".freeze, "resources/project_pmd_report.html".freeze]
+  s.extra_rdoc_files = ["History.md".freeze, "Manifest.txt".freeze, "README.rdoc".freeze, "resources/js/README.md".freeze]
+  s.files = [".ci/build.sh".freeze, ".ci/inc/fetch_ci_scripts.bash".freeze, ".ci/manual-integration-tests.sh".freeze, ".github/workflows/build.yml".freeze, ".github/workflows/manual-integration-tests.yml".freeze, ".gitignore".freeze, ".hoerc".freeze, ".rubocop.yml".freeze, ".rubocop_todo.yml".freeze, ".ruby-version".freeze, "Gemfile".freeze, "History.md".freeze, "LICENSE".freeze, "Manifest.txt".freeze, "README.rdoc".freeze, "Rakefile".freeze, "bin/pmdtester".freeze, "config/all-java.xml".freeze, "config/design.xml".freeze, "config/project-list.xml".freeze, "config/projectlist_1_0_0.xsd".freeze, "config/projectlist_1_1_0.xsd".freeze, "config/projectlist_1_2_0.xsd".freeze, "lib/pmdtester.rb".freeze, "lib/pmdtester/builders/liquid_renderer.rb".freeze, "lib/pmdtester/builders/pmd_report_builder.rb".freeze, "lib/pmdtester/builders/project_builder.rb".freeze, "lib/pmdtester/builders/project_hasher.rb".freeze, "lib/pmdtester/builders/rule_set_builder.rb".freeze, "lib/pmdtester/builders/simple_progress_logger.rb".freeze, "lib/pmdtester/builders/summary_report_builder.rb".freeze, "lib/pmdtester/cmd.rb".freeze, "lib/pmdtester/collection_by_file.rb".freeze, "lib/pmdtester/parsers/options.rb".freeze, "lib/pmdtester/parsers/pmd_report_document.rb".freeze, "lib/pmdtester/parsers/projects_parser.rb".freeze, "lib/pmdtester/pmd_branch_detail.rb".freeze, "lib/pmdtester/pmd_configerror.rb".freeze, "lib/pmdtester/pmd_error.rb".freeze, "lib/pmdtester/pmd_report_detail.rb".freeze, "lib/pmdtester/pmd_tester_utils.rb".freeze, "lib/pmdtester/pmd_violation.rb".freeze, "lib/pmdtester/project.rb".freeze, "lib/pmdtester/report_diff.rb".freeze, "lib/pmdtester/resource_locator.rb".freeze, "lib/pmdtester/runner.rb".freeze, "lib/pmdtester/semver.rb".freeze, "pmdtester.gemspec".freeze, "resources/_includes/diff_pill_row.html".freeze, "resources/css/bootstrap-5.3.0-alpha3.min.css".freeze, "resources/css/datatables.min.css".freeze, "resources/css/pmd-tester.css".freeze, "resources/js/README.md".freeze, "resources/js/bootstrap-5.3.0-alpha3.min.js".freeze, "resources/js/code-snippets.js".freeze, "resources/js/datatables.min.js".freeze, "resources/js/jquery-3.6.4.slim.min.js".freeze, "resources/js/popper-2.11.7.min.js".freeze, "resources/js/project-report.js".freeze, "resources/project_diff_report.html".freeze, "resources/project_index.html".freeze, "resources/project_pmd_report.html".freeze]
   s.homepage = "https://pmd.github.io".freeze
   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
@@ -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.25"])
+    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.25"])
+    s.add_dependency(%q<hoe>.freeze, ["~> 3.26"])
   end
 end
 

data/resources/_includes/diff_pill_row.html

@@ -1,6 +1,6 @@
 
-<span class="pill badge-pill badge-secondary added">+{{h.new}}</span>
-<span class="pill badge-pill badge-secondary removed">-{{h.removed}}</span>
+<span class="badge rounded-pill badge-secondary added">+{{h.new}}</span>
+<span class="badge rounded-pill badge-secondary removed">-{{h.removed}}</span>
 {% if h.changed %}
-<span class="pill badge-pill badge-secondary changed">~{{h.changed}}</span>
+<span class="badge rounded-pill badge-secondary changed">~{{h.changed}}</span>
 {% endif %}