pmdtester 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0002a7305089264a200552384fff3179d706c2a89b39ef28cec2f2c184e84331
-  data.tar.gz: b59758aa8ece040b8d90c3577fcdc05000615e5efb32504b6e96599686d0ee6a
+  metadata.gz: 1d00209411d45b04f8ebcfb34d4289b682a9c3d044998b1f82e15c1d08e184ed
+  data.tar.gz: d6d6a48c4a2c558b9058c91dc57e2043e304addc90b8e7cc7441f07c50dac624
 SHA512:
-  metadata.gz: d18602b80cad2306aba780a338c90831aeaff5b17ebce880384a2e1b94405c7e45ae40e9842f878fe3ee514e8651b1bb856bfea35bab130f0f67606690ac53a7
-  data.tar.gz: 36c0c70dada772cfe44d595eeefd2cf131925db7a884dbd092bc4490cbf2ea948df23449c2dcdc78f39b75c4863b4c41b84d73a0346874c78c8aa5dee03a5ad4
+  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,14 @@
+# 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

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

@@ -176,7 +176,7 @@ module PmdTester
 
         # 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(diff_cmd)
+        filenames = Cmd.execute_successfully(diff_cmd)
       end
       filenames.split("\n")
     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/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/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

@@ -97,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.4.1'
+  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.4.1 ruby lib
+# stub: pmdtester 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.4.1"
+  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 = "2022-04-12"
+  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]

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.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Andreas Dangel
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri