Merge branch 'pr-62'

Violation descriptions parsed incompletely #62

Author: adangel

.hoerc

@@ -1 +1 @@
-exclude: !ruby/regexp /tmp$|\.(git|idea)|target|test\/|Gemfile\.lock|\.bundle\/|install-jdk.sh|vendor\/cache/
+exclude: !ruby/regexp /tmp$|\.(git|idea|project)|target|test\/|Gemfile\.lock|\.bundle\/|install-jdk.sh|vendor\/cache/

History.md

@@ -4,6 +4,8 @@
 
 ## Fixed Issues
 
+*   [#62](https://github.com/pmd/pmd-regression-tester/pull/62): Violation descriptions parsed incompletely
+
 ## External Contributions
 
 # 1.0.0 / 2020-04-25

README.rdoc

@@ -122,6 +122,12 @@ The tool creates the following folders:
   bundle install # once
   bundle exec rake verify # run this command before commit your changes
   bundle exec pmdtester ... # run this to directly execute pmdtester from source
+  
+  Run a single test class, e.g.:
+  bundle exec ruby -I test test/test_diff_report_builder.rb
+  
+  Run a single test, e.g.:
+  bundle exec ruby -I test test/test_diff_report_builder.rb -n test_diff_report_builder
 
 === Releasing
 

Rakefile

@@ -14,7 +14,7 @@ Hoe.plugin :git
 hoe = Hoe.spec 'pmdtester' do
   self.version = PmdTester::VERSION
 
-  developer 'Andreas Dangel', 'andreas.dangel@adangel.org'
+  developer 'Andreas Dangel', 'andreas.dangel@pmd-code.org'
   developer 'Binguo Bao', '[email protected]'
 
   self.clean_globs = %w[target/reports/**/* target/test/**/* Gemfile.lock]

lib/pmdtester/builders/diff_report/violations.rb

@@ -51,7 +51,7 @@ def build_violation_table_row(doc, key, pmd_violation)
       end
 
       # The violation message
-      doc.td pmd_violation.text
+      doc.td "\n" + pmd_violation.text + "\n"
 
       # The begin line of the violation
       line = violation['beginline']

lib/pmdtester/parsers/pmd_report_document.rb

@@ -47,7 +47,7 @@ def remove_work_dir!(str)
     end
 
     def characters(string)
-      @current_violation&.text = string
+      @current_violation&.text += string
     end
 
     def end_element(name)
@@ -56,6 +56,7 @@ def end_element(name)
         @violations.add_violations_by_filename(@current_filename, @current_violations)
         @current_filename = nil
       when 'violation'
+        @current_violation.text.strip!
         @current_violations.push(@current_violation) if match_filter_set?(@current_violation)
         @current_violation = nil
       when 'error'

pmdtester.gemspec

@@ -11,9 +11,9 @@ Gem::Specification.new do |s|
   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]
-  s.date = "2020-04-25"
+  s.date = "2020-07-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@adangel.org".freeze, "[email protected]".freeze]
+  s.email = ["andreas.dangel@pmd-code.org".freeze, "[email protected]".freeze]
   s.executables = ["pmdtester".freeze]
   s.extra_rdoc_files = ["History.md".freeze, "Manifest.txt".freeze, "README.rdoc".freeze]
   s.files = [".hoerc".freeze, ".rubocop.yml".freeze, ".rubocop_todo.yml".freeze, ".travis.yml".freeze, "Gemfile".freeze, "History.md".freeze, "LICENSE".freeze, "Manifest.txt".freeze, "README.rdoc".freeze, "Rakefile".freeze, "bin/pmdtester".freeze, "config/all-java.xml".freeze, "config/design.xml".freeze, "config/project-list.xml".freeze, "config/projectlist_1_0_0.xsd".freeze, "lib/pmdtester.rb".freeze, "lib/pmdtester/builders/diff_builder.rb".freeze, "lib/pmdtester/builders/diff_report/configerrors.rb".freeze, "lib/pmdtester/builders/diff_report/errors.rb".freeze, "lib/pmdtester/builders/diff_report/violations.rb".freeze, "lib/pmdtester/builders/diff_report_builder.rb".freeze, "lib/pmdtester/builders/html_report_builder.rb".freeze, "lib/pmdtester/builders/pmd_report_builder.rb".freeze, "lib/pmdtester/builders/rule_set_builder.rb".freeze, "lib/pmdtester/builders/simple_progress_logger.rb".freeze, "lib/pmdtester/builders/summary_report_builder.rb".freeze, "lib/pmdtester/cmd.rb".freeze, "lib/pmdtester/parsers/options.rb".freeze, "lib/pmdtester/parsers/pmd_report_document.rb".freeze, "lib/pmdtester/parsers/projects_parser.rb".freeze, "lib/pmdtester/pmd_branch_detail.rb".freeze, "lib/pmdtester/pmd_configerror.rb".freeze, "lib/pmdtester/pmd_error.rb".freeze, "lib/pmdtester/pmd_report_detail.rb".freeze, "lib/pmdtester/pmd_violation.rb".freeze, "lib/pmdtester/project.rb".freeze, "lib/pmdtester/report_diff.rb".freeze, "lib/pmdtester/resource_locator.rb".freeze, "lib/pmdtester/runner.rb".freeze, "pmdtester.gemspec".freeze, "resources/css/maven-base.css".freeze, "resources/css/maven-theme.css".freeze]

test/resources/pmd_report_document/test_document.xml

@@ -5,7 +5,7 @@
     version="6.3.0-SNAPSHOT" timestamp="2018-04-16T22:41:45.065">
 <file name="SHOULD_BE_REPLACED/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 empty constructor
+Document &apos;empty&apos; constructor
 </violation>
 </file>
 <file name="SHOULD_BE_REPLACED/target/repositories/spring-framework/spring-aop/src/main/java/org/springframework/aop/ClassFilter.java">

test/test_pmd_report_document.rb

@@ -4,11 +4,15 @@
 
 class TestPmdReportDocument < Test::Unit::TestCase
   include PmdTester
+
+  FIRST_FILE = '/target/repositories/spring-framework/gradle/jdiff/Null.java'
+
   def test_document
     doc = PmdReportDocument.new('base', 'SHOULD_BE_REPLACED')
     parser = Nokogiri::XML::SAX::Parser.new(doc)
     parser.parse(File.open('test/resources/pmd_report_document/test_document.xml'))
     assert_equal(8, doc.violations.violations_size)
+    assert_equal('Document \'empty\' constructor', doc.violations.violations[FIRST_FILE][0].text)
     assert_equal(2, doc.errors.errors_size)
     pmd_errors = doc.errors.errors.values
     assert_not_nil(pmd_errors[0])