pmdtester 1.0.0.pre.beta3 → 1.0.0

data/lib/pmdtester/builders/diff_builder.rb

@@ -5,17 +5,18 @@ require 'nokogiri'
 module PmdTester
   # Building difference between two pmd xml files
   class DiffBuilder
+    include PmdTester
     # The schema of pmd xml report refers to
     # http://pmd.sourceforge.net/report_2_0_0.xsd
     def build(base_report_filename, patch_report_filename, base_info, patch_info, filter_set = nil)
       report_diffs = ReportDiff.new
       base_details, patch_details = report_diffs.calculate_details(base_info, patch_info)
-      base_violations, base_errors = parse_pmd_report(base_report_filename, 'base',
-                                                      base_details.working_dir, filter_set)
-      patch_violations, patch_errors = parse_pmd_report(patch_report_filename, 'patch',
-                                                        patch_details.working_dir)
-      report_diffs.calculate_violations(base_violations, patch_violations)
-      report_diffs.calculate_errors(base_errors, patch_errors)
+      base_report = parse_pmd_report(base_report_filename, BASE, base_details.working_dir,
+                                     filter_set)
+      patch_report = parse_pmd_report(patch_report_filename, PATCH, patch_details.working_dir)
+      report_diffs.calculate_violations(base_report.violations, patch_report.violations)
+      report_diffs.calculate_errors(base_report.errors, patch_report.errors)
+      report_diffs.calculate_configerrors(base_report.configerrors, patch_report.configerrors)
 
       report_diffs
     end
@@ -24,7 +25,7 @@ module PmdTester
       doc = PmdReportDocument.new(branch, working_dir, filter_set)
       parser = Nokogiri::XML::SAX::Parser.new(doc)
       parser.parse_file(report_filename) unless report_filename.nil?
-      [doc.violations, doc.errors]
+      doc
     end
   end
 end

data/lib/pmdtester/builders/diff_report/configerrors.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Contains methods to write out html for the configuration errors.
+# This mixin is used by DiffReportBuilder.
+module DiffReportBuilderConfigErrors
+  def build_configerrors_section(doc, configerrors_diffs)
+    doc.div(class: 'section', id: 'configerrors') do
+      doc.h2 'Configuration Errors:'
+
+      doc.h3 PmdTester::HtmlReportBuilder::NO_DIFFERENCES_MESSAGE if configerrors_diffs.empty?
+      configerrors_diffs.each do |key, value|
+        doc.div(class: 'section') do
+          doc.h3 key
+          build_configerrors_table(doc, value)
+        end
+      end
+    end
+  end
+
+  def build_configerrors_table(doc, errors)
+    doc.table(class: 'bodyTable', border: '0') do
+      build_configerrors_table_head(doc)
+      build_configerrors_table_body(doc, errors)
+    end
+  end
+
+  def build_configerrors_table_head(doc)
+    build_table_head(doc, '', 'Rule', 'Message')
+  end
+
+  def build_configerrors_table_body(doc, errors)
+    doc.tbody do
+      errors.each { |pmd_configerror| build_configerrors_table_row(doc, pmd_configerror) }
+    end
+  end
+
+  def build_configerrors_table_row(doc, pmd_configerror)
+    doc.tr(class: pmd_configerror.branch == PmdTester::BASE ? 'b' : 'a') do
+      build_table_anchor_column(doc, 'C', increment_configerror_index)
+
+      doc.td pmd_configerror.rulename
+      doc.td pmd_configerror.msg
+    end
+  end
+
+  def increment_configerror_index
+    @configerror_index ||= 0 # init with 0
+    @configerror_index += 1
+  end
+end

data/lib/pmdtester/builders/diff_report/errors.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Contains methods to write out html for the errors.
+# This mixin is used by DiffReportBuilder.
+module DiffReportBuilderErrors
+  def build_errors_section(doc, error_diffs)
+    doc.div(class: 'section', id: 'Errors') do
+      doc.h2 'Errors:'
+
+      doc.h3 PmdTester::HtmlReportBuilder::NO_DIFFERENCES_MESSAGE if error_diffs.empty?
+      error_diffs.each do |key, value|
+        doc.div(class: 'section') do
+          build_filename_h3(doc, key)
+          build_errors_table(doc, value)
+        end
+      end
+    end
+  end
+
+  def build_errors_table(doc, errors)
+    doc.table(class: 'bodyTable', border: '0') do
+      build_errors_table_head(doc)
+      build_errors_table_body(doc, errors)
+    end
+  end
+
+  def build_errors_table_head(doc)
+    build_table_head(doc, '', 'Message', 'Details')
+  end
+
+  def build_errors_table_body(doc, errors)
+    if PmdTester::ReportDiff.comparable?(errors)
+      # we have only two errors and those are from base and patch, so we
+      # can compare them and display a nice diff
+      pmd_error_a = errors[0]
+      pmd_error_b = errors[1]
+      diff_a = Differ.diff_by_line(pmd_error_a.text, pmd_error_b.text).format_as(:html)
+      diff_b = Differ.diff_by_line(pmd_error_b.text, pmd_error_a.text).format_as(:html)
+      doc.tbody do
+        build_errors_table_row(doc, pmd_error_a, diff_a)
+        build_errors_table_row(doc, pmd_error_b, diff_b)
+      end
+    else
+      # many errors, just report them one by one
+      doc.tbody do
+        errors.each { |pmd_error| build_errors_table_row(doc, pmd_error) }
+      end
+    end
+  end
+
+  def build_errors_table_row(doc, pmd_error, text = nil)
+    doc.tr(class: pmd_error.branch == PmdTester::BASE ? 'b' : 'a') do
+      build_table_anchor_column(doc, 'B', increment_error_index)
+
+      text = pmd_error.text if text.nil?
+
+      # The error message
+      doc.td pmd_error.msg
+      doc.td do
+        doc.pre do
+          doc << text
+        end
+      end
+    end
+  end
+
+  def increment_error_index
+    @error_index ||= 0 # init with 0
+    @error_index += 1
+  end
+end

data/lib/pmdtester/builders/diff_report/violations.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Contains methods to write out html for the violations.
+# This mixin is used by DiffReportBuilder.
+module DiffReportBuilderViolations
+  def build_violations_section(doc, violation_diffs)
+    doc.div(class: 'section', id: 'Violations') do
+      doc.h2 'Violations:'
+
+      doc.h3 PmdTester::HtmlReportBuilder::NO_DIFFERENCES_MESSAGE if violation_diffs.empty?
+      violation_diffs.each do |key, value|
+        doc.div(class: 'section') do
+          build_filename_h3(doc, key)
+          build_violation_table(doc, key, value)
+        end
+      end
+    end
+  end
+
+  def build_violation_table(doc, key, value)
+    doc.table(class: 'bodyTable', border: '0') do
+      build_violation_table_head(doc)
+      build_violation_table_body(doc, key, value)
+    end
+  end
+
+  def build_violation_table_head(doc)
+    build_table_head(doc, '', 'Priority', 'Rule', 'Message', 'Line')
+  end
+
+  def build_violation_table_body(doc, key, value)
+    doc.tbody do
+      value.each do |pmd_violation|
+        build_violation_table_row(doc, key, pmd_violation)
+      end
+    end
+  end
+
+  def build_violation_table_row(doc, key, pmd_violation)
+    doc.tr(class: pmd_violation.branch == PmdTester::BASE ? 'b' : 'a') do
+      build_table_anchor_column(doc, 'A', increment_violation_index)
+
+      violation = pmd_violation.attrs
+
+      # The priority of the rule
+      doc.td violation['priority']
+
+      # The rule that trigger the violation
+      doc.td do
+        doc.a(href: (violation['externalInfoUrl']).to_s) { doc.text violation['rule'] }
+      end
+
+      # The violation message
+      doc.td pmd_violation.text
+
+      # The begin line of the violation
+      line = violation['beginline']
+
+      # The link to the source file
+      doc.td do
+        link = get_link_to_source(violation, key)
+        doc.a(href: link.to_s) { doc.text line }
+      end
+    end
+  end
+
+  def get_link_to_source(violation, key)
+    l_str = @project.type == 'git' ? 'L' : 'l'
+    line_str = "##{l_str}#{violation['beginline']}"
+    @project.get_webview_url(key) + line_str
+  end
+
+  def increment_violation_index
+    @violation_index ||= 0 # init with 0
+    @violation_index += 1
+  end
+end

data/lib/pmdtester/builders/diff_report_builder.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
+require 'differ'
 
 module PmdTester
   # Building diff report for a single project
   class DiffReportBuilder < HtmlReportBuilder
     include PmdTester
-    NO_DIFFERENCES_MESSAGE = 'No differences found!'
+    include DiffReportBuilderViolations
+    include DiffReportBuilderErrors
+    include DiffReportBuilderConfigErrors
 
     def build(project)
       @project = project
@@ -26,11 +29,13 @@ module PmdTester
     def build_body(doc)
       violation_diffs = @report_diff.violation_diffs
       error_diffs = @report_diff.error_diffs
+      configerrors_diffs = @report_diff.configerrors_diffs
       doc.body(class: 'composite') do
         doc.div(id: 'contentBox') do
           build_summary_section(doc)
           build_violations_section(doc, violation_diffs)
           build_errors_section(doc, error_diffs)
+          build_configerrors_section(doc, configerrors_diffs)
         end
       end
     end
@@ -44,15 +49,7 @@ module PmdTester
 
     def build_summary_table(doc)
       doc.table(class: 'bodyTable', border: '0') do
-        doc.thead do
-          doc.tr do
-            doc.th 'Item'
-            doc.th 'Base'
-            doc.th 'Patch'
-            doc.th 'Difference'
-          end
-        end
-
+        build_table_head(doc, 'Item', 'Base', 'Patch', 'Difference')
         build_summary_table_body(doc)
       end
     end
@@ -60,9 +57,15 @@ module PmdTester
     def build_summary_table_body(doc)
       doc.tbody do
         build_summary_row(doc, 'number of errors', @report_diff.base_errors_size,
-                          @report_diff.patch_errors_size, @report_diff.error_diffs_size)
+                          @report_diff.patch_errors_size, @report_diff.removed_errors_size,
+                          @report_diff.new_errors_size)
         build_summary_row(doc, 'number of violations', @report_diff.base_violations_size,
-                          @report_diff.patch_violations_size, @report_diff.violation_diffs_size)
+                          @report_diff.patch_violations_size, @report_diff.removed_violations_size,
+                          @report_diff.new_violations_size)
+        build_summary_row(doc, 'number of config errors', @report_diff.base_configerrors_size,
+                          @report_diff.patch_configerrors_size,
+                          @report_diff.removed_configerrors_size,
+                          @report_diff.new_configerrors_size)
         build_summary_row(doc, 'execution time', @report_diff.base_execution_time,
                           @report_diff.patch_execution_time, @report_diff.diff_execution_time)
         build_summary_row(doc, 'timestamp', @report_diff.base_timestamp,
@@ -70,12 +73,18 @@ module PmdTester
       end
     end
 
-    def build_summary_row(doc, item, base, patch, diff)
+    def build_summary_row(doc, item, base, patch, *diff)
       doc.tr do
         doc.td(class: 'c') { doc.text item }
         doc.td(class: 'b') { doc.text base }
         doc.td(class: 'a') { doc.text patch }
-        doc.td(class: 'c') { doc.text diff }
+        doc.td(class: 'c') do
+          if diff.size == 1
+            doc.text diff[0]
+          else
+            build_table_content_for(doc, diff[0], diff[1])
+          end
+        end
       end
     end
 
@@ -86,140 +95,5 @@ module PmdTester
         end
       end
     end
-
-    def build_violations_section(doc, violation_diffs)
-      doc.div(class: 'section', id: 'Violations') do
-        doc.h2 'Violations:'
-
-        doc.h3 NO_DIFFERENCES_MESSAGE if violation_diffs.empty?
-        violation_diffs.each do |key, value|
-          doc.div(class: 'section') do
-            build_filename_h3(doc, key)
-            build_violation_table(doc, key, value)
-          end
-        end
-      end
-    end
-
-    def build_violation_table(doc, key, value)
-      doc.table(class: 'bodyTable', border: '0') do
-        build_violation_table_head(doc)
-        build_violation_table_body(doc, key, value)
-      end
-    end
-
-    def build_violation_table_head(doc)
-      doc.thead do
-        doc.tr do
-          doc.th
-          doc.th 'priority'
-          doc.th 'Rule'
-          doc.th 'Message'
-          doc.th 'Line'
-        end
-      end
-    end
-
-    def build_violation_table_body(doc, key, value)
-      doc.tbody do
-        a_index = 1
-        value.each do |pmd_violation|
-          build_violation_table_row(doc, key, pmd_violation, a_index)
-          a_index += 1
-        end
-      end
-    end
-
-    def build_violation_table_row(doc, key, pmd_violation, a_index)
-      doc.tr(class: pmd_violation.branch == 'base' ? 'b' : 'a') do
-        # The anchor
-        doc.td do
-          doc.a(id: "A#{a_index}", href: "#A#{a_index}") { doc.text '#' }
-        end
-
-        violation = pmd_violation.attrs
-
-        # The priority of the rule
-        doc.td violation['priority']
-
-        # The rule that trigger the violation
-        doc.td do
-          doc.a(href: (violation['externalInfoUrl']).to_s) { doc.text violation['rule'] }
-        end
-
-        # The violation message
-        doc.td pmd_violation.text
-
-        # The begin line of the violation
-        line = violation['beginline']
-
-        # The link to the source file
-        doc.td do
-          link = get_link_to_source(violation, key)
-          doc.a(href: link.to_s) { doc.text line }
-        end
-      end
-    end
-
-    def get_link_to_source(violation, key)
-      l_str = @project.type == 'git' ? 'L' : 'l'
-      line_str = "##{l_str}#{violation['beginline']}"
-      @project.get_webview_url(key) + line_str
-    end
-
-    def build_errors_section(doc, error_diffs)
-      doc.div(class: 'section', id: 'Errors') do
-        doc.h2 do
-          doc.text 'Errors:'
-        end
-
-        doc.h3 NO_DIFFERENCES_MESSAGE if error_diffs.empty?
-        error_diffs.each do |key, value|
-          doc.div(class: 'section') do
-            build_filename_h3(doc, key)
-            build_errors_table(doc, value)
-          end
-        end
-      end
-    end
-
-    def build_errors_table(doc, errors)
-      doc.table(class: 'bodyTable', border: '0') do
-        build_errors_table_head(doc)
-        build_errors_table_body(doc, errors)
-      end
-    end
-
-    def build_errors_table_head(doc)
-      doc.thead do
-        doc.tr do
-          doc.th
-          doc.th 'Message'
-          doc.th 'Details'
-        end
-      end
-    end
-
-    def build_errors_table_body(doc, errors)
-      doc.tbody do
-        b_index = 1
-        errors.each do |pmd_error|
-          doc.tr(class: pmd_error.branch == 'base' ? 'b' : 'a') do
-            # The anchor
-            doc.td do
-              doc.a(id: "B#{b_index}", href: "#B#{b_index}") { doc.text '#' }
-            end
-
-            # The error message
-            doc.td pmd_error.msg
-
-            # Details of error
-            doc.td pmd_error.text
-
-            b_index += 1
-          end
-        end
-      end
-    end
   end
 end