pmdtester 1.0.0.pre.beta3 → 1.0.0

data/lib/pmdtester/pmd_configerror.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module PmdTester
+  # This class is used to store pmd config errors and its size.
+  class PmdConfigErrors
+    attr_reader :errors
+    attr_reader :size
+
+    def initialize
+      # key:rulename as String => value:PmdConfigError Array
+      @errors = {}
+      @size = 0
+    end
+
+    def add_error(error)
+      rulename = error.rulename
+      if @errors.key?(rulename)
+        @errors[rulename].push(error)
+      else
+        @errors.store(rulename, [error])
+      end
+      @size += 1
+    end
+  end
+
+  # 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 :text
+
+    def initialize(attrs, branch)
+      @attrs = attrs
+
+      @branch = branch
+      @text = ''
+    end
+
+    def rulename
+      @attrs['rule']
+    end
+
+    def msg
+      @attrs['msg']
+    end
+
+    def eql?(other)
+      rulename.eql?(other.rulename) && msg.eql?(other.msg)
+    end
+
+    def hash
+      [rulename, msg].hash
+    end
+  end
+end

data/lib/pmdtester/pmd_violation.rb

@@ -13,6 +13,8 @@ module PmdTester
     end
 
     def add_violations_by_filename(filename, violations)
+      return if violations.empty?
+
       @violations.store(filename, violations)
       @violations_size += violations.size
     end

data/lib/pmdtester/project.rb

@@ -32,7 +32,7 @@ module PmdTester
         @exclude_pattern.push(ep.text)
       end
 
-      @report_diff = nil
+      @report_diff = ReportDiff.new
     end
 
     # Generate the default webview url for the projects
@@ -74,6 +74,14 @@ module PmdTester
       end
     end
 
+    def get_config_path(branch_name)
+      if branch_name.nil?
+        nil
+      else
+        "#{get_project_target_dir(branch_name)}/config.xml"
+      end
+    end
+
     def get_project_target_dir(branch_name)
       branch_filename = PmdBranchDetail.branch_filename(branch_name)
       dir = "target/reports/#{branch_filename}/#{@name}"
@@ -100,11 +108,35 @@ module PmdTester
     end
 
     def diffs_exist?
-      @report_diff.diffs_exist?
+      @report_diff.nil? ? false : @report_diff.diffs_exist?
     end
 
     def introduce_new_errors?
-      @report_diff.introduce_new_errors?
+      @report_diff.nil? ? false : @report_diff.introduce_new_errors?
+    end
+
+    def removed_errors_size
+      @report_diff.removed_errors_size
+    end
+
+    def new_errors_size
+      @report_diff.new_errors_size
+    end
+
+    def removed_violations_size
+      @report_diff.removed_violations_size
+    end
+
+    def new_violations_size
+      @report_diff.new_violations_size
+    end
+
+    def removed_configerrors_size
+      @report_diff.removed_configerrors_size
+    end
+
+    def new_configerrors_size
+      @report_diff.new_configerrors_size
     end
   end
 end

data/lib/pmdtester/report_diff.rb

@@ -5,14 +5,26 @@ module PmdTester
   # including the summary information of the original pmd reports,
   # as well as the specific information of the diff report.
   class ReportDiff
+    include PmdTester
+
     attr_accessor :base_violations_size
     attr_accessor :patch_violations_size
+    attr_accessor :new_violations_size
+    attr_accessor :removed_violations_size
     attr_accessor :violation_diffs_size
 
     attr_accessor :base_errors_size
     attr_accessor :patch_errors_size
+    attr_accessor :new_errors_size
+    attr_accessor :removed_errors_size
     attr_accessor :error_diffs_size
 
+    attr_accessor :base_configerrors_size
+    attr_accessor :patch_configerrors_size
+    attr_accessor :new_configerrors_size
+    attr_accessor :removed_configerrors_size
+    attr_accessor :configerrors_diffs_size
+
     attr_accessor :base_execution_time
     attr_accessor :patch_execution_time
     attr_accessor :diff_execution_time
@@ -22,15 +34,12 @@ module PmdTester
 
     attr_accessor :violation_diffs
     attr_accessor :error_diffs
+    attr_accessor :configerrors_diffs
 
     def initialize
-      @base_violations_size = 0
-      @patch_violations_size = 0
-      @violation_diffs_size = 0
-
-      @base_errors_size = 0
-      @patch_errors_size = 0
-      @error_diffs_size = 0
+      init_violations
+      init_errors
+      init_configerrors
 
       @base_execution_time = 0
       @patch_execution_time = 0
@@ -41,10 +50,39 @@ module PmdTester
 
       @violation_diffs = {}
       @error_diffs = {}
+      @configerrors_diffs = {}
+    end
+
+    def init_violations
+      @base_violations_size = 0
+      @patch_violations_size = 0
+      @new_violations_size = 0
+      @removed_violations_size = 0
+      @violation_diffs_size = 0
+    end
+
+    def init_errors
+      @base_errors_size = 0
+      @patch_errors_size = 0
+      @new_errors_size = 0
+      @removed_errors_size = 0
+      @error_diffs_size = 0
+    end
+
+    def init_configerrors
+      @base_configerrors_size = 0
+      @patch_configerrors_size = 0
+      @new_configerrors_size = 0
+      @removed_configerrors_size = 0
+      @configerrors_diffs_size = 0
+    end
+
+    def self.comparable?(errors)
+      errors.size == 2 && errors[0].branch != errors[1].branch
     end
 
     def diffs_exist?
-      !error_diffs_size.zero? || !violation_diffs_size.zero?
+      !error_diffs_size.zero? || !violation_diffs_size.zero? || !configerrors_diffs_size.zero?
     end
 
     def calculate_violations(base_violations, patch_violations)
@@ -52,7 +90,8 @@ module PmdTester
       @patch_violations_size = patch_violations.violations_size
       violation_diffs = build_diffs(base_violations.violations, patch_violations.violations)
       @violation_diffs = violation_diffs
-      @violation_diffs_size = get_diffs_size(violation_diffs)
+      @new_violations_size, @removed_violations_size = get_diffs_size(violation_diffs)
+      @violation_diffs_size = @new_violations_size + @removed_violations_size
     end
 
     def calculate_errors(base_errors, patch_errors)
@@ -60,7 +99,17 @@ module PmdTester
       @patch_errors_size = patch_errors.errors_size
       error_diffs = build_diffs(base_errors.errors, patch_errors.errors)
       @error_diffs = error_diffs
-      @error_diffs_size = get_diffs_size(error_diffs)
+      @new_errors_size, @removed_errors_size = get_diffs_size(error_diffs)
+      @error_diffs_size = @new_errors_size + @removed_errors_size
+    end
+
+    def calculate_configerrors(base_configerrors, patch_configerrors)
+      @base_configerrors_size = base_configerrors.size
+      @patch_configerrors_size = patch_configerrors.size
+      configerrors_diffs = build_diffs(base_configerrors.errors, patch_configerrors.errors)
+      @configerrors_diffs = configerrors_diffs
+      @new_configerrors_size, @removed_configerrors_size = get_diffs_size(configerrors_diffs)
+      @configerrors_diffs_size = @new_configerrors_size + @removed_configerrors_size
     end
 
     def calculate_details(base_info, patch_info)
@@ -91,21 +140,18 @@ module PmdTester
     end
 
     def get_diffs_size(diffs_hash)
-      size = 0
-      diffs_hash.keys.each do |key|
-        size += diffs_hash[key].size
+      new_size = 0
+      removed_size = 0
+      diffs_hash.each_value do |value|
+        value.each do |item|
+          item.branch.eql?(BASE) ? removed_size += 1 : new_size += 1
+        end
       end
-      size
+      [new_size, removed_size]
     end
 
     def introduce_new_errors?
-      @error_diffs.values.each do |pmd_errors|
-        pmd_errors.each do |pmd_error|
-          return true if pmd_error.branch.eql?('patch')
-        end
-      end
-
-      false
+      !@new_errors_size.zero? || !@new_configerrors_size.zero?
     end
   end
 end

data/lib/pmdtester/runner.rb

@@ -10,6 +10,7 @@ module PmdTester
     end
 
     def run
+      clean
       case @options.mode
       when Options::LOCAL
         run_local_mode
@@ -18,19 +19,28 @@ module PmdTester
       when Options::SINGLE
         run_single_mode
       end
-      introduce_new_pmd_error?
+
+      summarize_diffs
+    end
+
+    def clean
+      clean_target = 'target/reports'
+      FileUtils.remove_dir(clean_target) if Dir.exist?(clean_target)
     end
 
     def run_local_mode
       logger.info "Mode: #{@options.mode}"
-      RuleSetBuilder.new(@options).build if @options.auto_config_flag
-
       get_projects(@options.project_list) unless @options.nil?
+      rule_sets = RuleSetBuilder.new(@options).build if @options.auto_config_flag
+      return if rule_sets&.empty?
+
       PmdReportBuilder
-        .new(@options.base_config, @projects, @options.local_git_repo, @options.base_branch)
+        .new(@options.base_config, @projects, @options.local_git_repo, @options.base_branch,
+             @options.threads)
         .build
       PmdReportBuilder
-        .new(@options.patch_config, @projects, @options.local_git_repo, @options.patch_branch)
+        .new(@options.patch_config, @projects, @options.local_git_repo, @options.patch_branch,
+             @options.threads)
         .build
 
       build_html_reports
@@ -41,19 +51,20 @@ module PmdTester
 
       baseline_path = download_baseline(@options.base_branch)
 
+      # patch branch build pmd report with same list of projects as base branch
+      project_list = "#{baseline_path}/project-list.xml"
+      get_projects(project_list)
+
       if @options.auto_config_flag
-        RuleSetBuilder.new(@options).build
+        return if RuleSetBuilder.new(@options).build.empty?
       else
         # patch branch build pmd reports with same configuration as base branch
         @options.patch_config = "#{baseline_path}/config.xml"
       end
 
-      # patch branch build pmd report with same list of projects as base branch
-      project_list = "#{baseline_path}/project-list.xml"
-      get_projects(project_list)
-
       PmdReportBuilder
-        .new(@options.patch_config, @projects, @options.local_git_repo, @options.patch_branch)
+        .new(@options.patch_config, @projects,
+             @options.local_git_repo, @options.patch_branch, @options.threads)
         .build
 
       build_html_reports
@@ -87,7 +98,8 @@ module PmdTester
       get_projects(@options.project_list) unless @options.nil?
       branch_details = PmdReportBuilder
                        .new(@options.patch_config, @projects,
-                            @options.local_git_repo, @options.patch_branch)
+                            @options.local_git_repo, @options.patch_branch,
+                            @options.threads)
                        .build
       # copy list of projects file to the patch baseline
       FileUtils.cp(@options.project_list, branch_details.target_branch_project_list_path)
@@ -118,11 +130,24 @@ module PmdTester
       @projects = ProjectsParser.new.parse(file_path)
     end
 
-    def introduce_new_pmd_error?
+    def summarize_diffs
+      new_errors_size = 0
+      removed_errors_size = 0
+      new_violations_size = 0
+      removed_violations_size = 0
+      new_configerrors_size = 0
+      removed_configerrors_size = 0
       @projects.each do |project|
-        return true if project.introduce_new_errors?
+        new_errors_size += project.new_errors_size
+        removed_errors_size += project.removed_errors_size
+        new_violations_size += project.new_violations_size
+        removed_violations_size += project.removed_violations_size
+        new_configerrors_size += project.new_configerrors_size
+        removed_configerrors_size += project.removed_configerrors_size
       end
-      false
+
+      [new_errors_size, removed_errors_size, new_violations_size, removed_violations_size,
+       new_configerrors_size, removed_configerrors_size]
     end
   end
 end

data/pmdtester.gemspec

@@ -0,0 +1,73 @@
+# DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake hoe:spec`.
+
+# -*- encoding: utf-8 -*-
+# stub: pmdtester 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "pmdtester".freeze
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  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.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, "djydewang@gmail.com".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]
+  s.homepage = "https://pmd.github.io".freeze
+  s.licenses = ["BSD-2-Clause".freeze]
+  s.rdoc_options = ["--main".freeze, "README.rdoc".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.2".freeze)
+  s.rubygems_version = "2.7.7".freeze
+  s.summary = "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
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>.freeze, ["~> 1.8"])
+      s.add_runtime_dependency(%q<slop>.freeze, ["~> 4.6"])
+      s.add_runtime_dependency(%q<differ>.freeze, ["~> 0.1"])
+      s.add_runtime_dependency(%q<rufus-scheduler>.freeze, ["~> 3.5"])
+      s.add_development_dependency(%q<hoe-bundler>.freeze, ["~> 1.5"])
+      s.add_development_dependency(%q<hoe-git>.freeze, ["~> 1.6"])
+      s.add_development_dependency(%q<minitest>.freeze, ["~> 5.10"])
+      s.add_development_dependency(%q<mocha>.freeze, ["~> 1.5"])
+      s.add_development_dependency(%q<rubocop>.freeze, ["~> 0.81"])
+      s.add_development_dependency(%q<test-unit>.freeze, ["~> 3.2"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["< 7", ">= 4.0"])
+      s.add_development_dependency(%q<hoe>.freeze, ["~> 3.22"])
+    else
+      s.add_dependency(%q<nokogiri>.freeze, ["~> 1.8"])
+      s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
+      s.add_dependency(%q<differ>.freeze, ["~> 0.1"])
+      s.add_dependency(%q<rufus-scheduler>.freeze, ["~> 3.5"])
+      s.add_dependency(%q<hoe-bundler>.freeze, ["~> 1.5"])
+      s.add_dependency(%q<hoe-git>.freeze, ["~> 1.6"])
+      s.add_dependency(%q<minitest>.freeze, ["~> 5.10"])
+      s.add_dependency(%q<mocha>.freeze, ["~> 1.5"])
+      s.add_dependency(%q<rubocop>.freeze, ["~> 0.81"])
+      s.add_dependency(%q<test-unit>.freeze, ["~> 3.2"])
+      s.add_dependency(%q<rdoc>.freeze, ["< 7", ">= 4.0"])
+      s.add_dependency(%q<hoe>.freeze, ["~> 3.22"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>.freeze, ["~> 1.8"])
+    s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
+    s.add_dependency(%q<differ>.freeze, ["~> 0.1"])
+    s.add_dependency(%q<rufus-scheduler>.freeze, ["~> 3.5"])
+    s.add_dependency(%q<hoe-bundler>.freeze, ["~> 1.5"])
+    s.add_dependency(%q<hoe-git>.freeze, ["~> 1.6"])
+    s.add_dependency(%q<minitest>.freeze, ["~> 5.10"])
+    s.add_dependency(%q<mocha>.freeze, ["~> 1.5"])
+    s.add_dependency(%q<rubocop>.freeze, ["~> 0.81"])
+    s.add_dependency(%q<test-unit>.freeze, ["~> 3.2"])
+    s.add_dependency(%q<rdoc>.freeze, ["< 7", ">= 4.0"])
+    s.add_dependency(%q<hoe>.freeze, ["~> 3.22"])
+  end
+end
+
+# DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake hoe:spec`.