pmdtester 1.0.0.pre.beta2 → 1.1.1

data/lib/pmdtester/parsers/projects_parser.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require_relative '../project'
-require_relative '../resource_locator'
 
 module PmdTester
   # The ProjectsParser is a class responsible of parsing
@@ -13,9 +11,7 @@ module PmdTester
       document = Nokogiri::XML(File.read(list_file))
 
       errors = schema.validate(document)
-      unless errors.empty?
-        raise ProjectsParserException.new(errors), "Schema validate failed: In #{list_file}"
-      end
+      raise ProjectsParserException.new(errors), "Schema validate failed: In #{list_file}" unless errors.empty?
 
       projects = []
       document.xpath('//project').each do |project|
@@ -25,7 +21,7 @@ module PmdTester
     end
 
     def schema_file_path
-      ResourceLocator.locate('config/projectlist_1_0_0.xsd')
+      ResourceLocator.locate('config/projectlist_1_1_0.xsd')
     end
   end
 

data/lib/pmdtester/pmd_branch_detail.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
 require 'json'
-require_relative './pmd_report_detail'
 
 module PmdTester
   # This class represents all details about branch of pmd
   class PmdBranchDetail
+    include PmdTester
+
     attr_accessor :branch_last_sha
     attr_accessor :branch_last_message
     attr_accessor :branch_name
     # The branch's execution time on all standard projects
     attr_accessor :execution_time
+    attr_accessor :jdk_version
+    attr_accessor :language
+    attr_accessor :pull_request
 
     def self.branch_filename(branch_name)
       branch_name&.tr('/', '_')
@@ -23,32 +27,51 @@ module PmdTester
       branch_filename = PmdBranchDetail.branch_filename(branch_name)
       @base_branch_dir = "target/reports/#{branch_filename}" unless @branch_name.nil?
       @execution_time = 0
+      # the result of command 'java -version' is going to stderr
+      @jdk_version = Cmd.stderr_of('java -version')
+      @language = ENV['LANG'] # the locale
+
+      prnum = ENV[PR_NUM_ENV_VAR]
+      @pull_request = prnum == 'false' ? nil : prnum
     end
 
-    def load
-      if File.exist?(branch_details_path)
-        hash = JSON.parse(File.read(branch_details_path))
-        @branch_last_sha = hash['branch_last_sha']
-        @branch_last_message = hash['branch_last_message']
-        @branch_name = hash['branch_name']
-        @execution_time = hash['execution_time']
-        hash
+    def self.load(branch_name, logger)
+      details = PmdBranchDetail.new(branch_name)
+      if File.exist?(details.path_to_save_file)
+        hash = JSON.parse(File.read(details.path_to_save_file))
+        details.branch_last_sha = hash['branch_last_sha']
+        details.branch_last_message = hash['branch_last_message']
+        details.branch_name = hash['branch_name']
+        details.execution_time = hash['execution_time']
+        details.jdk_version = hash['jdk_version']
+        details.language = hash['language']
+        details.pull_request = hash['pull_request']
       else
-        {}
+        details.jdk_version = ''
+        details.language = ''
+        logger&.warn "#{details.path_to_save_file} doesn't exist!"
       end
+      details
     end
 
     def save
       hash = { branch_last_sha: @branch_last_sha,
                branch_last_message: @branch_last_message,
                branch_name: @branch_name,
-               execution_time: @execution_time }
-      file = File.new(branch_details_path, 'w')
+               execution_time: @execution_time,
+               jdk_version: @jdk_version,
+               language: @language,
+               pull_request: @pull_request }
+
+      FileUtils.mkdir_p(@base_branch_dir) unless File.directory?(@base_branch_dir)
+
+      file = File.new(path_to_save_file, 'w')
       file.puts JSON.generate(hash)
       file.close
+      self
     end
 
-    def branch_details_path
+    def path_to_save_file
       "#{@base_branch_dir}/branch_info.json"
     end
 

data/lib/pmdtester/pmd_configerror.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module PmdTester
+  # This class represents a 'configerror' element of Pmd xml report
+  # and which Pmd branch the 'configerror' is from
+  class PmdConfigError
+    # The pmd branch type, 'base' or 'patch'
+    attr_reader :branch
+
+    # The schema of 'configerror' node:
+    # <xs:complexType name="configerror">
+    #   <xs:attribute name="rule" type="xs:string" use="required" />
+    #   <xs:attribute name="msg" type="xs:string" use="required" />
+    # </xs:complexType>
+    attr_reader :attrs
+    attr_accessor :old_error
+
+    def initialize(attrs, branch)
+      @attrs = attrs
+
+      @changed = false
+      @branch = branch
+    end
+
+    def rulename
+      @attrs['rule']
+    end
+
+    def msg
+      @attrs['msg']
+    end
+
+    def sort_key
+      rulename
+    end
+
+    def changed?
+      @changed
+    end
+
+    def eql?(other)
+      rulename.eql?(other.rulename) && msg.eql?(other.msg)
+    end
+
+    def try_merge?(other)
+      if branch != BASE &&
+         branch != other.branch &&
+         rulename == other.rulename &&
+         !changed? # not already changed
+        @changed = true
+        @old_error = other
+        true
+      end
+
+      false
+    end
+
+    def hash
+      [rulename, msg].hash
+    end
+  end
+end

data/lib/pmdtester/pmd_error.rb

@@ -1,30 +1,10 @@
 # frozen_string_literal: true
 
 module PmdTester
-  # This class is used to store pmd errors and its size.
-  class PmdErrors
-    attr_reader :errors
-    attr_reader :errors_size
-
-    def initialize
-      # key:filename as String => value:PmdError Array
-      @errors = {}
-      @errors_size = 0
-    end
-
-    def add_error_by_filename(filename, error)
-      if @errors.key?(filename)
-        @errors[filename].push(error)
-      else
-        @errors.store(filename, [error])
-      end
-      @errors_size += 1
-    end
-  end
-
   # This class represents a 'error' element of Pmd xml report
   # and which Pmd branch the 'error' is from
   class PmdError
+    include PmdTester
     # The pmd branch type, 'base' or 'patch'
     attr_reader :branch
 
@@ -37,31 +17,51 @@ module PmdTester
     #       </xs:extension>
     #     </xs:simpleContent>
     #  </xs:complexType>
-    attr_reader :attrs
-    attr_accessor :text
-
-    def initialize(attrs, branch)
-      @attrs = attrs
+    attr_accessor :stack_trace
+    attr_accessor :old_error
+    attr_reader :filename, :short_message
 
+    def initialize(branch:, filename:, short_message:)
       @branch = branch
-      @text = ''
+      @stack_trace = ''
+      @changed = false
+      @short_message = short_message
+      @filename = filename
     end
 
-    def filename
-      @attrs['filename']
+    def short_filename
+      filename.gsub(%r{([^/]*+/)+}, '')
     end
 
-    def msg
-      @attrs['msg']
+    def changed?
+      @changed
     end
 
     def eql?(other)
-      filename.eql?(other.filename) && msg.eql?(other.msg) &&
-        @text.eql?(other.text)
+      filename.eql?(other.filename) &&
+        short_message.eql?(other.short_message) &&
+        stack_trace.eql?(other.stack_trace)
     end
 
     def hash
-      [filename, msg, @text].hash
+      [filename, stack_trace].hash
+    end
+
+    def sort_key
+      filename
+    end
+
+    def try_merge?(other)
+      if branch != BASE &&
+         branch != other.branch &&
+         filename == other.filename &&
+         !changed? # not already changed
+        @changed = true
+        @old_error = other
+        true
+      else
+        false
+      end
     end
   end
 end

data/lib/pmdtester/pmd_report_detail.rb

@@ -7,12 +7,12 @@ module PmdTester
   class PmdReportDetail
     attr_accessor :execution_time
     attr_accessor :timestamp
-    attr_reader :working_dir
+    attr_accessor :working_dir
 
-    def initialize
-      @execution_time = 0
-      @timestamp = ''
-      @working_dir = Dir.getwd
+    def initialize(execution_time: 0, timestamp: '', working_dir: Dir.getwd)
+      @execution_time = execution_time
+      @timestamp = timestamp
+      @working_dir = working_dir
     end
 
     def save(report_info_path)
@@ -22,16 +22,13 @@ module PmdTester
       file.close
     end
 
-    def load(report_info_path)
+    def self.load(report_info_path)
       if File.exist?(report_info_path)
-        hash = JSON.parse(File.read(report_info_path))
-        @execution_time = hash['execution_time']
-        @timestamp = hash['timestamp']
-        @working_dir = hash['working_dir']
-        hash
+        hash = JSON.parse(File.read(report_info_path), symbolize_names: true)
+        PmdReportDetail.new(**hash)
       else
-        puts "#{report_info_path} doesn't exist"
-        {}
+        PmdTester.logger.warn("#{report_info_path} doesn't exist")
+        PmdReportDetail.new
       end
     end
 

data/lib/pmdtester/pmd_tester_utils.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module PmdTester
+  # Some functions that that don't belong in a specific class,
+  module PmdTesterUtils
+    include PmdTester
+
+    # Parse the base and the patch report, compute their diff
+    # Returns a +ReportDiff+
+    def build_report_diff(base_report_file, patch_report_file, base_info, patch_info, filter_set = nil)
+      base_details = PmdReportDetail.load(base_info)
+      patch_details = PmdReportDetail.load(patch_info)
+
+      base_report = parse_pmd_report(base_report_file, BASE, base_details, filter_set)
+      patch_report = parse_pmd_report(patch_report_file, PATCH, patch_details)
+
+      logger.info 'Calculating diffs'
+      ReportDiff.new(base_report: base_report, patch_report: patch_report)
+    end
+
+    # Parse the +report_file+ to produce a +Report+.
+    # For the schema of xml reports, refer to http://pmd.sourceforge.net/report_2_0_0.xsd
+    def parse_pmd_report(report_file, branch, report_details, filter_set = nil)
+      require 'nokogiri'
+
+      logger.info "Parsing #{report_file}"
+      doc = PmdReportDocument.new(branch, report_details.working_dir, filter_set)
+      parser = Nokogiri::XML::SAX::Parser.new(doc)
+      parser.parse_file(report_file) if File.exist?(report_file)
+      Report.new(
+        report_document: doc,
+
+        timestamp: report_details.timestamp,
+        exec_time: report_details.execution_time
+      )
+    end
+
+    # Fill the report_diff field of every project
+    def compute_project_diffs(projects, base_branch, patch_branch, filter_set = nil)
+      projects.each do |project|
+        logger.info "Preparing report for #{project.name}"
+        logger.info "  with filter #{filter_set}" unless filter_set.nil?
+        project.compute_report_diff(base_branch, patch_branch, filter_set)
+      end
+    end
+
+    # Build the diff reports and write them all
+    def build_html_reports(projects, base_branch_details, patch_branch_details, filter_set = nil)
+      compute_project_diffs(projects, base_branch_details.branch_name, patch_branch_details.branch_name,
+                            filter_set)
+
+      SummaryReportBuilder.new.write_all_projects(projects,
+                                                  base_branch_details,
+                                                  patch_branch_details)
+    end
+  end
+end

data/lib/pmdtester/pmd_violation.rb

@@ -1,23 +1,6 @@
 # frozen_string_literal: true
 
 module PmdTester
-  # This class is used to store pmd violations and its size.
-  class PmdViolations
-    attr_reader :violations
-    attr_reader :violations_size
-
-    def initialize
-      # key:filename as String => value:PmdViolation Array
-      @violations = {}
-      @violations_size = 0
-    end
-
-    def add_violations_by_filename(filename, violations)
-      @violations.store(filename, violations)
-      @violations_size += violations.size
-    end
-  end
-
   # This class represents a 'violation' element of Pmd xml report
   # and which pmd branch the 'violation' is from
   class PmdViolation
@@ -44,23 +27,80 @@ module PmdTester
     #   </xs:simpleContent>
     # </xs:complexType>
 
-    attr_reader :attrs
-    attr_accessor :text
+    attr_reader :fname, :info_url, :line, :old_line, :old_message, :rule_name, :ruleset_name
+    attr_accessor :message
 
-    def initialize(attrs, branch)
-      @attrs = attrs
+    # 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
-      @text = ''
+      @fname = fname
+      @message = ''
+
+      @info_url = info_url
+      @line = bline
+      @rule_name = rule_name
+
+      @ruleset_name = ruleset_name
+
+      @changed = false
+      @old_message = nil
+      @old_line = nil
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    def line_move?(other)
+      message.eql?(other.message) && (line - other.line).abs <= 5
+    end
+
+    def try_merge?(other)
+      if branch != BASE && branch != other.branch && rule_name == other.rule_name &&
+         !changed? && # not already changed
+         (line == other.line || line_move?(other))
+        @changed = true
+        @old_message = other.message
+        @old_line = other.line
+        true
+      else
+        false
+      end
+    end
+
+    # only makes sense if this is a diff
+    def added?
+      branch != BASE && !changed?
+    end
+
+    # only makes sense if this is a diff
+    def changed?
+      @changed
+    end
+
+    # only makes sense if this is a diff
+    def removed?
+      branch == BASE
+    end
+
+    def sort_key
+      line
     end
 
     def eql?(other)
-      @attrs['beginline'].eql?(other.attrs['beginline']) &&
-        @attrs['rule'].eql?(other.attrs['rule']) &&
-        @text.eql?(other.text)
+      rule_name.eql?(other.rule_name) &&
+        line.eql?(other.line) &&
+        fname.eql?(other.fname) &&
+        message.eql?(other.message)
     end
 
     def hash
-      [@attrs['beginline'], @attrs['rule'], @text].hash
+      [line, rule_name, message].hash
+    end
+
+    def to_liquid
+      {
+        'branch' => branch,
+        'changed' => changed?
+      }
     end
   end
 end