pmdtester 1.5.3 → 1.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d64309fafec9b58208385b35297f4096da84511576ea23382e271b8bcf0bfcb0
-  data.tar.gz: d90d0ab024c076b3e6e13228d1fef303d63a34c1ce97ddb9169d798b94e63dde
+  metadata.gz: '05486a80b029d8a896b789ebb894077c36d6a0f99a651c0b1885a808f6219b8a'
+  data.tar.gz: b9a98daf20b7c036a26bea412563a9df771252b338cb7f805c4d42351627b458
 SHA512:
-  metadata.gz: 3201eaf56629cb6e859ded9c3522dc3907f50de3694ab1bdd11256f204e0c0fdd2e8bf5857ed0ee2291c02c257be091e6f36110c7c646d55281b0311ae7e9024
-  data.tar.gz: 7784defdc77b0c5d3f278232ed8f06e3326f3a17c2632e140b376dc1551640e0e0a35ed0d28770140cc6ed5d99ec96c8464dd92afc54f1a8b64421b15df47b72
+  metadata.gz: efce54ae5e36f7853427a7ccc203346335f7811d3dddbe3ae5d0f558bff3eb7b1748952fbdd31046c251ea6cb55fac5b1a261fd674c4989b5a6d11e251c1872f
+  data.tar.gz: fc72dbd2b79ca40655eea0587f0cb6df1293b6634a9252e428af2dddbe0209f5e74dc2497dadca99687e6e332e495979d42288b100cd55f6b293096645e2f5f5

data/History.md

@@ -1,3 +1,16 @@
+# 1.5.5 / 2023-11-16
+
+## Fixed Issues
+* [#121](https://github.com/pmd/pmd-regression-tester/issues/121): Violation messages should be escaped for html
+
+# 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

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

@@ -127,6 +127,7 @@ The tool creates the following folders:
   gem install pmdtester --pre
 
 == DEVELOPERS:
+
   git clone https://github.com/pmd/pmd-regression-tester.git
   cd pmd-regression-tester
   gem install bundler
@@ -136,10 +137,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/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/builders/project_hasher.rb

@@ -117,15 +117,22 @@ module PmdTester
         'l' => violation.line,
         'f' => file_ref,
         'r' => violation.rule_name,
-        'm' => is_diff && violation.changed? ? diff_fragments(violation) : violation.message
+        'm' => create_violation_message(violation, is_diff && violation.changed?)
       }
       h['ol'] = violation.old_line if is_diff && violation.changed? && violation.line != violation.old_line
       h
     end
 
-    def diff_fragments(violation)
-      diff = Differ.diff_by_word(violation.message, violation.old_message)
+    def create_violation_message(violation, is_diff)
+      return escape_html(violation.message) unless is_diff
+
+      diff = Differ.diff_by_word(escape_html(violation.message),
+                                 escape_html(violation.old_message))
       diff.format_as(:html)
     end
+
+    def escape_html(string)
+      CGI.escapeHTML(string)
+    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.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.3'
+  VERSION = '1.5.5'
   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.3 ruby lib
+# stub: pmdtester 1.5.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.5.3"
+  s.version = "1.5.5"
 
   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-11-25"
+  s.date = "2023-11-16"
   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

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 %}