Merge pull request #117 from adangel:issue-116-relativize-paths

Use relative paths without leading slash #117

Author: adangel

History.md

@@ -7,6 +7,7 @@
 ## Fixed Issues
 
 * [#115](https://github.com/pmd/pmd-regression-tester/pull/115): Fix manual integration tests
+* [#116](https://github.com/pmd/pmd-regression-tester/issues/116): Relative paths in pmd report result in missing code snippets
 
 ## External Contributions
 

lib/pmdtester/parsers/pmd_report_document.rb

@@ -41,11 +41,11 @@ def start_element(name, attrs = [])
     end
 
     def characters(string)
-      @cur_text << remove_work_dir!(string)
+      @cur_text << string
     end
 
     def cdata_block(string)
-      @cur_text << remove_work_dir!(string)
+      @cur_text << string
     end
 
     def end_element(name)
@@ -76,11 +76,12 @@ def end_element(name)
     # Modifies the string in place and returns it
     # (this is what sub! does, except it returns nil if no replacement occurred)
     def remove_work_dir!(str)
-      str.sub!(/#{@working_dir}/, '')
+      str.sub!(%r{#{@working_dir}/}, '')
       str
     end
 
     def finish_text!
+      remove_work_dir!(@cur_text)
       res = @cur_text.strip!.dup.freeze
       @cur_text.clear
       res

lib/pmdtester/project.rb

@@ -60,17 +60,19 @@ def default_webview_url
     # Change the file path from 'LOCAL_DIR/SOURCE_CODE_PATH' to
     # 'WEB_VIEW_URL/SOURCE_CODE_PATH'
     def get_webview_url(file_path)
-      file_path.gsub(%r{/#{clone_root_path}}, @webview_url)
+      file_path.gsub(%r{^#{clone_root_path}/}, "#{@webview_url}/")
     end
 
     # Change the file path from 'LOCAL_DIR/SOURCE_CODE_PATH' to
     # 'PROJECT_NAME/SOURCE_CODE_PATH'
     def get_path_inside_project(file_path)
-      file_path.gsub(%r{/#{clone_root_path}}, @name)
+      file_path.gsub(%r{^#{clone_root_path}/}, "#{@name}/")
     end
 
+    # Change the file path from 'LOCAL_DIR/SOURCE_CODE_PATH' to
+    # 'SOURCE_CODE_PATH'
     def get_local_path(file_path)
-      file_path.sub(%r{/#{clone_root_path}/}, '')
+      file_path.sub(%r{^#{clone_root_path}/}, '')
     end
 
     def get_pmd_report_path(branch_name)

test/resources/pmd_report_document/sample_report_relativized_paths.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<pmd xmlns="http://pmd.sourceforge.net/report/2.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://pmd.sourceforge.net/report/2.0.0 http://pmd.sourceforge.net/report_2_0_0.xsd"
+    version="6.3.0-SNAPSHOT" timestamp="2018-04-16T22:41:45.065">
+<file name="/home/runner/work/pmd/target/repositories/spring-framework/gradle/jdiff/Null.java">
+<violation beginline="7" endline="8" begincolumn="12" endcolumn="5" rule="UncommentedEmptyConstructor" ruleset="Documentation" class="Null" method="Null" externalInfoUrl="http://pmd.sourceforge.net/snapshot/pmd_rules_java_documentation.html#uncommentedemptyconstructor" priority="3">
+Document &apos;empty&apos; constructor
+</violation>
+</file>
+<!-- the same file, but already relativized -->
+<file name="target/repositories/spring-framework/gradle/jdiff/Null.java">
+<violation beginline="8" endline="9" begincolumn="12" endcolumn="5" rule="UncommentedEmptyConstructor" ruleset="Documentation" class="Null" method="Null" externalInfoUrl="http://pmd.sourceforge.net/snapshot/pmd_rules_java_documentation.html#uncommentedemptyconstructor" priority="3">
+Document &apos;empty&apos; constructor
+</violation>
+</file>
+</pmd>

test/test_pmd_report_document.rb

@@ -5,7 +5,7 @@
 class TestPmdReportDocument < Test::Unit::TestCase
   include PmdTester
 
-  FIRST_FILE = '/target/repositories/spring-framework/gradle/jdiff/Null.java'
+  FIRST_FILE = 'target/repositories/spring-framework/gradle/jdiff/Null.java'
 
   def test_document
     doc = PmdReportDocument.new('base', 'SHOULD_BE_REPLACED')
@@ -36,7 +36,7 @@ def test_filter_set_single_rule
     parser.parse(File.open('test/resources/pmd_report_document/test_document.xml'))
     assert_equal(4, doc.violations.total_size, 'wrong number of violations')
     assert_equal(3, doc.violations.num_files, 'wrong number of files')
-    first_file = '/target/repositories/spring-framework/spring-aop/src/main/java/'\
+    first_file = 'target/repositories/spring-framework/spring-aop/src/main/java/'\
                  'org/springframework/aop/ClassFilter.java'
     assert_equal(44, doc.violations[first_file][0].line)
   end
@@ -50,4 +50,16 @@ def test_error_filename_without_path
     assert_equal(1, filenames.length)
     assert_equal('InputXpathQueryGeneratorTabWidth.java', filenames[0])
   end
+
+  def test_relativized_filenames
+    doc = PmdReportDocument.new('base', '/home/runner/work/pmd')
+    parser = Nokogiri::XML::SAX::Parser.new(doc)
+    parser.parse(File.open('test/resources/pmd_report_document/sample_report_relativized_paths.xml'))
+
+    assert_equal(2, doc.violations.total_size, 'wrong number of violations')
+    assert_equal(1, doc.violations.num_files, 'wrong number of files')
+    first_file = 'target/repositories/spring-framework/gradle/jdiff/Null.java'
+    assert_equal(7, doc.violations[first_file][0].line)
+    assert_equal(8, doc.violations[first_file][1].line)
+  end
 end

test/test_project.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+# Unit test for PmdTester::Project
+class TestProject < Test::Unit::TestCase
+  FILE_PATH = 'src/java.base/aix/classes/sun/nio/ch/AixAsynchronousChannelProvider.java'
+
+  def setup
+    @projects = PmdTester::ProjectsParser.new.parse('test/resources/projects_parser/project-list.xml')
+    assert_equal(3, @projects.size)
+    @project = @projects[1]
+    assert_equal('openjdk-11', @project.name)
+    assert_equal('target/repositories/openjdk-11', @project.clone_root_path)
+  end
+
+  def test_get_webview_url
+    assert_equal("https://github.com/openjdk/jdk/tree/jdk-11+28/#{FILE_PATH}",
+                 @project.get_webview_url("target/repositories/openjdk-11/#{FILE_PATH}"))
+  end
+
+  def test_get_path_inside_project
+    assert_equal("openjdk-11/#{FILE_PATH}",
+                 @project.get_path_inside_project("target/repositories/openjdk-11/#{FILE_PATH}"))
+  end
+
+  def test_get_local_path
+    assert_equal(FILE_PATH, @project.get_local_path("target/repositories/openjdk-11/#{FILE_PATH}"))
+  end
+end