Copy full pmd report for download

Author: adangel

lib/pmdtester/builders/liquid_renderer.rb

@@ -57,6 +57,9 @@ def write_project_index(project, root)
       write_file("#{root}/index.html", render_liquid('project_diff_report.html', liquid_env))
       # generate array of violations in json
       write_file("#{root}/project_data.js", dump_violations_json(project))
+      # 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)
     end
 
     def dump_violations_json(project)
@@ -69,5 +72,16 @@ def dump_violations_json(project)
       project_data = JSON.fast_generate(h)
       "let project = #{project_data}"
     end
+
+    private
+
+    def copy_file(target_file, source_file)
+      if File.exist? source_file
+        FileUtils.cp(source_file, target_file)
+        logger&.info "Written #{target_file}"
+      else
+        logger&.warn "File #{source_file} not found"
+      end
+    end
   end
 end

lib/pmdtester/pmd_tester_utils.rb

@@ -29,6 +29,7 @@ def parse_pmd_report(report_file, branch, report_details, filter_set = nil)
       parser.parse_file(report_file) if File.exist?(report_file)
       Report.new(
         report_document: doc,
+        file: report_file,
 
         timestamp: report_details.timestamp,
         exec_time: report_details.execution_time

lib/pmdtester/report_diff.rb

@@ -57,15 +57,18 @@ class Report
                 :configerrors_by_rule,
                 :exec_time,
                 :timestamp,
-                :infos_by_rule
+                :infos_by_rule,
+                :file
 
     def initialize(report_document: nil,
+                   file: '',
                    exec_time: 0,
                    timestamp: '0')
       initialize_empty
       initialize_with_report_document report_document unless report_document.nil?
       @exec_time = exec_time
       @timestamp = timestamp
+      @file = file
     end
 
     def self.empty

resources/project_diff_report.html

@@ -71,6 +71,12 @@ <h2>Summary</h2>
                 <td class="patch">{{diff.patch_timestamp}}</td>
                 <td class="diff"></td>
             </tr>
+            <tr>
+                <td class="item">Full Report</td>
+                <td class="base"><a href="base_pmd_report.xml">Base pmd_report.xml</a></td>
+                <td class="patch"><a href="patch_pmd_report.xml">Patch pmd_report.xml</a></td>
+                <td class="diff"></td>
+            </tr>
             </tbody>
         </table>
     </div>

test/resources/html_report_builder/expected_diff_report_index.html

@@ -89,6 +89,12 @@ <h2>Summary</h2>
                 <td class="patch">patch time stamp</td>
                 <td class="diff"></td>
             </tr>
+            <tr>
+                <td class="item">Full Report</td>
+                <td class="base"><a href="base_pmd_report.xml">Base pmd_report.xml</a></td>
+                <td class="patch"><a href="patch_pmd_report.xml">Patch pmd_report.xml</a></td>
+                <td class="diff"></td>
+            </tr>
             </tbody>
         </table>
     </div>

test/resources/html_report_builder/expected_empty_diff_report.html

@@ -89,6 +89,12 @@ <h2>Summary</h2>
                 <td class="patch">0</td>
                 <td class="diff"></td>
             </tr>
+            <tr>
+                <td class="item">Full Report</td>
+                <td class="base"><a href="base_pmd_report.xml">Base pmd_report.xml</a></td>
+                <td class="patch"><a href="patch_pmd_report.xml">Patch pmd_report.xml</a></td>
+                <td class="diff"></td>
+            </tr>
             </tbody>
         </table>
     </div>

test/test_helper.rb

@@ -16,4 +16,8 @@ def assert_file_equals(expected_path, actual_path)
     actual_file = normalize_text(File.open(actual_path).read)
     assert_equal(expected_file, actual_file, actual_path)
   end
+
+  def assert_file_exists(path)
+    assert File.exist?(path)
+  end
 end

test/test_project_diff_report.rb

@@ -36,6 +36,9 @@ def test_diff_report_builder
 
     # Checking the content of diff report is expected.
     assert_file_equals(EXPECTED_REPORT_PATH, "#{actual_report_path}/index.html")
+    assert_file_exists("#{actual_report_path}/project_data.js")
+    assert_file_exists("#{actual_report_path}/base_pmd_report.xml")
+    assert_file_exists("#{actual_report_path}/patch_pmd_report.xml")
   end
 
   def test_report_diffs_empty