pmdtester 1.0.0.pre.beta2

data/lib/pmdtester/report_diff.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module PmdTester
+  # This class represents all the diff report information,
+  # including the summary information of the original pmd reports,
+  # as well as the specific information of the diff report.
+  class ReportDiff
+    attr_accessor :base_violations_size
+    attr_accessor :patch_violations_size
+    attr_accessor :violation_diffs_size
+
+    attr_accessor :base_errors_size
+    attr_accessor :patch_errors_size
+    attr_accessor :error_diffs_size
+
+    attr_accessor :base_execution_time
+    attr_accessor :patch_execution_time
+    attr_accessor :diff_execution_time
+
+    attr_accessor :base_timestamp
+    attr_accessor :patch_timestamp
+
+    attr_accessor :violation_diffs
+    attr_accessor :error_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
+
+      @base_execution_time = 0
+      @patch_execution_time = 0
+      @diff_execution_time = 0
+
+      @base_timestamp = ''
+      @patch_timestamp = ''
+
+      @violation_diffs = {}
+      @error_diffs = {}
+    end
+
+    def diffs_exist?
+      !error_diffs_size.zero? || !violation_diffs_size.zero?
+    end
+
+    def calculate_violations(base_violations, patch_violations)
+      @base_violations_size = base_violations.violations_size
+      @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)
+    end
+
+    def calculate_errors(base_errors, patch_errors)
+      @base_errors_size = base_errors.errors_size
+      @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)
+    end
+
+    def calculate_details(base_info, patch_info)
+      base_details = PmdReportDetail.new
+      base_details.load(base_info) unless base_info.nil?
+      patch_details = PmdReportDetail.new
+      patch_details.load(patch_info) unless patch_info.nil?
+
+      @base_execution_time = base_details.format_execution_time
+      @patch_execution_time = patch_details.format_execution_time
+      @diff_execution_time =
+        PmdReportDetail.convert_seconds(base_details.execution_time -
+                                          patch_details.execution_time)
+
+      @base_timestamp = base_details.timestamp
+      @patch_timestamp = patch_details.timestamp
+      [base_details, patch_details]
+    end
+
+    def build_diffs(base_hash, patch_hash)
+      diffs = base_hash.merge(patch_hash) do |_key, base_value, patch_value|
+        (base_value | patch_value) - (base_value & patch_value)
+      end
+
+      diffs.delete_if do |_key, value|
+        value.empty?
+      end
+    end
+
+    def get_diffs_size(diffs_hash)
+      size = 0
+      diffs_hash.keys.each do |key|
+        size += diffs_hash[key].size
+      end
+      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
+    end
+  end
+end

data/lib/pmdtester/resource_locator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module PmdTester
+  # This class is responsible for locating the static resources of PmdTester.
+  class ResourceLocator
+    def self.locate(resource_path)
+      File.expand_path(File.dirname(__FILE__) + "/../../#{resource_path}")
+    end
+  end
+end

data/lib/pmdtester/runner.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require_relative './builders/diff_builder.rb'
+require_relative './builders/diff_report_builder.rb'
+require_relative './builders/rule_set_builder'
+require_relative './builders/summary_report_builder.rb'
+require_relative './builders/pmd_report_builder.rb'
+require_relative './parsers/options'
+require_relative './parsers/projects_parser'
+require_relative './pmdtester'
+require_relative './pmd_branch_detail'
+
+module PmdTester
+  # The Runner is a class responsible of organizing all PmdTester modules
+  # and running the PmdTester
+  class Runner
+    include PmdTester
+    def initialize(argv)
+      @options = Options.new(argv)
+    end
+
+    def run
+      case @options.mode
+      when Options::LOCAL
+        run_local_mode
+      when Options::ONLINE
+        run_online_mode
+      when Options::SINGLE
+        run_single_mode
+      end
+    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?
+      PmdReportBuilder
+        .new(@options.base_config, @projects, @options.local_git_repo, @options.base_branch)
+        .build
+      PmdReportBuilder
+        .new(@options.patch_config, @projects, @options.local_git_repo, @options.patch_branch)
+        .build
+
+      build_html_reports
+    end
+
+    def run_online_mode
+      logger.info "Mode: #{@options.mode}"
+
+      baseline_path = download_baseline(@options.base_branch)
+
+      if @options.auto_config_flag
+        RuleSetBuilder.new(@options).build
+      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)
+        .build
+
+      build_html_reports
+    end
+
+    def download_baseline(branch_name)
+      branch_filename = PmdBranchDetail.branch_filename(branch_name)
+      zip_filename = "#{branch_filename}-baseline.zip"
+      target_path = 'target/reports'
+      FileUtils.mkdir_p(target_path) unless File.directory?(target_path)
+
+      url = get_baseline_url(zip_filename)
+      wget_cmd = "wget #{url}"
+      unzip_cmd = "unzip -qo #{zip_filename}"
+
+      Dir.chdir(target_path) do
+        Cmd.execute(wget_cmd) unless File.exist?(zip_filename)
+        Cmd.execute(unzip_cmd)
+      end
+
+      "#{target_path}/#{branch_filename}"
+    end
+
+    def get_baseline_url(zip_filename)
+      "https://sourceforge.net/projects/pmd/files/pmd-regression-tester/#{zip_filename}"
+    end
+
+    def run_single_mode
+      logger.info "Mode: #{@options.mode}"
+
+      get_projects(@options.project_list) unless @options.nil?
+      branch_details = PmdReportBuilder
+                       .new(@options.patch_config, @projects,
+                            @options.local_git_repo, @options.patch_branch)
+                       .build
+      # copy list of projects file to the patch baseline
+      FileUtils.cp(@options.project_list, branch_details.target_branch_project_list_path)
+
+      build_html_reports unless @options.html_flag
+    end
+
+    def build_html_reports
+      build_diff_html_reports
+      SummaryReportBuilder.new.build(@projects, @options.base_branch, @options.patch_branch)
+    end
+
+    def build_diff_html_reports
+      @projects.each do |project|
+        logger.info "Preparing report for #{project.name}"
+        report_diffs = DiffBuilder.new.build(project.get_pmd_report_path(@options.base_branch),
+                                             project.get_pmd_report_path(@options.patch_branch),
+                                             project.get_report_info_path(@options.base_branch),
+                                             project.get_report_info_path(@options.patch_branch),
+                                             @options.filter_set)
+        project.report_diff = report_diffs
+        DiffReportBuilder.new.build(project)
+      end
+      logger.info 'Built all difference reports successfully!'
+    end
+
+    def get_projects(file_path)
+      @projects = ProjectsParser.new.parse(file_path)
+    end
+  end
+end

data/resources/css/maven-base.css

@@ -0,0 +1,155 @@
+body {
+  margin: 0px;
+  padding: 0px;
+}
+img {
+  border:none;
+}
+table {
+  padding:0px;
+  width: 100%;
+  margin-left: -2px;
+  margin-right: -2px;
+}
+acronym {
+  cursor: help;
+  border-bottom: 1px dotted #feb;
+}
+table.bodyTable th, table.bodyTable td {
+  padding: 2px 4px 2px 4px;
+  vertical-align: top;
+}
+div.clear{
+  clear:both;
+  visibility: hidden;
+}
+div.clear hr{
+  display: none;
+}
+#bannerLeft, #bannerRight {
+  font-size: xx-large;
+  font-weight: bold;
+}
+#bannerLeft img, #bannerRight img {
+  margin: 0px;
+}
+.xleft, #bannerLeft img {
+  float:left;
+}
+.xright, #bannerRight {
+  float:right;
+}
+#banner {
+  padding: 0px;
+}
+#banner img {
+  border: none;
+}
+#breadcrumbs {
+  padding: 3px 10px 3px 10px;
+}
+#leftColumn {
+ width: 170px;
+ float:left;
+ overflow: auto;
+}
+#bodyColumn {
+  margin-right: 1.5em;
+  margin-left: 197px;
+}
+#legend {
+  padding: 8px 0 8px 0;
+}
+#navcolumn {
+  padding: 8px 4px 0 8px;
+}
+#navcolumn h5 {
+  margin: 0;
+  padding: 0;
+  font-size: small;
+}
+#navcolumn ul {
+  margin: 0;
+  padding: 0;
+  font-size: small;
+}
+#navcolumn li {
+  list-style-type: none;
+  background-image: none;
+  background-repeat: no-repeat;
+  background-position: 0 0.4em;
+  padding-left: 16px;
+  list-style-position: outside;
+  line-height: 1.2em;
+  font-size: smaller;
+}
+#navcolumn li.expanded {
+  background-image: url(../images/expanded.gif);
+}
+#navcolumn li.collapsed {
+  background-image: url(../images/collapsed.gif);
+}
+#navcolumn li.none {
+  text-indent: -1em;
+  margin-left: 1em;
+}
+#poweredBy {
+  text-align: center;
+}
+#navcolumn img {
+  margin-top: 10px;
+  margin-bottom: 3px;
+}
+#poweredBy img {
+  display:block;
+  margin: 20px 0 20px 17px;
+}
+#search img {
+    margin: 0px;
+    display: block;
+}
+#search #q, #search #btnG {
+    border: 1px solid #999;
+    margin-bottom:10px;
+}
+#search form {
+    margin: 0px;
+}
+#lastPublished {
+  font-size: x-small;
+}
+.navSection {
+  margin-bottom: 2px;
+  padding: 8px;
+}
+.navSectionHead {
+  font-weight: bold;
+  font-size: x-small;
+}
+.section {
+  padding: 4px;
+}
+#footer {
+  padding: 3px 10px 3px 10px;
+  font-size: x-small;
+}
+#breadcrumbs {
+  font-size: x-small;
+  margin: 0pt;
+}
+.source {
+  padding: 12px;
+  margin: 1em 7px 1em 7px;
+}
+.source pre {
+  margin: 0px;
+  padding: 0px;
+}
+#navcolumn img.imageLink, .imageLink {
+  padding-left: 0px;
+  padding-bottom: 0px;
+  padding-top: 0px;
+  padding-right: 2px;
+  border: 0px;
+  margin: 0px;
+}

data/resources/css/maven-theme.css

@@ -0,0 +1,171 @@
+body {
+  padding: 0px 0px 10px 0px;
+}
+body, td, select, input, li{
+  font-family: Verdana, Helvetica, Arial, sans-serif;
+  font-size: 13px;
+}
+code{
+  font-family: Courier, monospace;
+  font-size: 13px;
+}
+a {
+  text-decoration: none;
+}
+a:link {
+  color:#36a;
+}
+a:visited  {
+  color:#47a;
+}
+a:active, a:hover {
+  color:#69c;
+}
+#legend li.externalLink {
+  background: url(../images/external.png) left top no-repeat;
+  padding-left: 18px;
+}
+a.externalLink, a.externalLink:link, a.externalLink:visited, a.externalLink:active, a.externalLink:hover {
+  background: url(../images/external.png) right center no-repeat;
+  padding-right: 18px;
+}
+#legend li.newWindow {
+  background: url(../images/newwindow.png) left top no-repeat;
+  padding-left: 18px;
+}
+a.newWindow, a.newWindow:link, a.newWindow:visited, a.newWindow:active, a.newWindow:hover {
+  background: url(../images/newwindow.png) right center no-repeat;
+  padding-right: 18px;
+}
+h2 {
+  padding: 4px 4px 4px 6px;
+  border: 1px solid #999;
+  color: #900;
+  background-color: #ddd;
+  font-weight:900;
+  font-size: x-large;
+}
+h3 {
+  padding: 4px 4px 4px 6px;
+  border: 1px solid #aaa;
+  color: #900;
+  background-color: #eee;
+  font-weight: normal;
+  font-size: large;
+}
+h4 {
+  font-weight: normal;
+  font-size: large;
+}
+h5 {
+  padding: 4px 4px 4px 6px;
+  color: #900;
+  font-size: normal;
+}
+p {
+  line-height: 1.3em;
+  font-size: small;
+}
+#breadcrumbs {
+  border-top: 1px solid #aaa;
+  border-bottom: 1px solid #aaa;
+  background-color: #ccc;
+}
+#leftColumn {
+  margin: 10px 0 0 5px;
+  border: 1px solid #999;
+  background-color: #eee;
+}
+#navcolumn h5 {
+  font-size: smaller;
+  border-bottom: 1px solid #aaaaaa;
+  padding-top: 2px;
+  color: #000;
+}
+
+table.bodyTable th {
+  color: white;
+  background-color: #bbb;
+  text-align: left;
+  font-weight: bold;
+}
+
+table.bodyTable th, table.bodyTable td {
+  font-size: 1em;
+}
+
+table.bodyTable tr.a {
+  background-color: #af8;
+}
+
+table.bodyTable tr.b {
+  background-color: #fca;
+}
+
+table.bodyTable tr.c {
+  background-color: #eee;
+}
+
+table.bodyTable tr.d {
+  background-color: #fef7bc;
+}
+
+table.bodyTable td.a {
+  background-color: #af8;
+}
+
+table.bodyTable td.b {
+  background-color: #fca;
+}
+
+table.bodyTable td.c {
+  background-color: #eee;
+}
+
+.source {
+  border: 1px solid #999;
+}
+dl {
+  padding: 4px 4px 4px 6px;
+  border: 1px solid #aaa;
+  background-color: #ffc;
+}
+dt {
+  color: #900;
+}
+
+#banner {
+  border-bottom: 1px solid #fff;
+}
+
+button {
+    background-color: #ddd;
+    border: none;
+    color: #900;
+    padding: 6px 12px;
+    text-align: center;
+    text-decoration: none;
+    display: inline-block;
+    font-size: 25px;
+    margin: 4px 2px;
+    cursor: pointer;
+}
+
+#example {
+  position: relative;
+}
+
+#example-checkbox {
+  display: none;
+}
+
+#example-checkbox:checked + #example:after {
+  content: attr(data-text);
+  position: absolute;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  background: white;
+}
+