pmdtester 1.1.2 → 1.2.0

data/lib/pmdtester/report_diff.rb

@@ -57,28 +57,45 @@ module PmdTester
                 :configerrors_by_rule,
                 :exec_time,
                 :timestamp,
-                :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
       new
     end
 
+    def rule_summaries
+      summary = {}
+      @violations_by_file.each_value do |violation|
+        unless summary.key?(violation.rule_name)
+          summary[violation.rule_name] = {
+            'name' => violation.rule_name,
+            'info_url' => violation.info_url,
+            'count' => 0
+          }
+        end
+        summary[violation.rule_name]['count'] += 1
+      end
+
+      summary.values
+    end
+
     private
 
     def initialize_with_report_document(report_document)
       @violations_by_file = report_document.violations
       @errors_by_file = report_document.errors
       @configerrors_by_rule = report_document.configerrors
-      @infos_by_rule = report_document.infos_by_rules
 
       PmdTester.logger.debug("Loaded #{@violations_by_file.total_size} violations " \
                              "in #{@violations_by_file.num_files} files")
@@ -91,7 +108,6 @@ module PmdTester
       @violations_by_file = CollectionByFile.new
       @errors_by_file = CollectionByFile.new
       @configerrors_by_rule = {}
-      @infos_by_rule = {}
     end
   end
 
@@ -122,7 +138,7 @@ module PmdTester
       @error_diffs_by_file = {}
       @configerror_diffs_by_rule = {}
 
-      @rule_infos_union = base_report.infos_by_rule.dup
+      @rule_infos_union = {}
       @base_report = base_report
       @patch_report = patch_report
 

data/lib/pmdtester/runner.rb

@@ -59,6 +59,7 @@ module PmdTester
         @options.patch_config = "#{baseline_path}/config.xml"
       else
         logger.info "Using config #{@options.patch_config} which might differ from baseline"
+        RuleSetBuilder.new(@options).calculate_filter_set if @options.filter_with_patch_config
       end
 
       patch_branch_details = create_pmd_report(config: @options.patch_config, branch: @options.patch_branch)

data/pmdtester.gemspec

@@ -1,22 +1,22 @@
 # DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake hoe:spec`.
 
 # -*- encoding: utf-8 -*-
-# stub: pmdtester 1.1.2 ruby lib
+# stub: pmdtester 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.1.2"
+  s.version = "1.2.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, "Cl\u00E9ment Fournier".freeze]
-  s.date = "2021-04-20"
+  s.date = "2021-06-20"
   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@pmd-code.org".freeze, "djydewang@gmail.com".freeze, "clement.fournier76@gmail.com".freeze]
   s.executables = ["pmdtester".freeze]
   s.extra_rdoc_files = ["History.md".freeze, "Manifest.txt".freeze, "README.rdoc".freeze]
-  s.files = [".ci/build.sh".freeze, ".ci/files/env.gpg".freeze, ".ci/inc/install-openjdk.inc".freeze, ".ci/manual-integration-tests.sh".freeze, ".github/workflows/build.yml".freeze, ".github/workflows/manual-integration-tests.yml".freeze, ".gitignore".freeze, ".hoerc".freeze, ".rubocop.yml".freeze, ".rubocop_todo.yml".freeze, ".ruby-version".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, "config/projectlist_1_1_0.xsd".freeze, "lib/pmdtester.rb".freeze, "lib/pmdtester/builders/liquid_renderer.rb".freeze, "lib/pmdtester/builders/pmd_report_builder.rb".freeze, "lib/pmdtester/builders/project_builder.rb".freeze, "lib/pmdtester/builders/project_hasher.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/collection_by_file.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_tester_utils.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/_includes/diff_pill_row.html".freeze, "resources/css/bootstrap.min.css".freeze, "resources/css/datatables.min.css".freeze, "resources/css/pmd-tester.css".freeze, "resources/js/bootstrap.min.js".freeze, "resources/js/code-snippets.js".freeze, "resources/js/datatables.min.js".freeze, "resources/js/jquery-3.2.1.slim.min.js".freeze, "resources/js/jquery.min.js".freeze, "resources/js/popper.min.js".freeze, "resources/js/project-report.js".freeze, "resources/project_diff_report.html".freeze, "resources/project_index.html".freeze]
+  s.files = [".ci/build.sh".freeze, ".ci/inc/fetch_ci_scripts.bash".freeze, ".ci/manual-integration-tests.sh".freeze, ".github/workflows/build.yml".freeze, ".github/workflows/manual-integration-tests.yml".freeze, ".gitignore".freeze, ".hoerc".freeze, ".rubocop.yml".freeze, ".rubocop_todo.yml".freeze, ".ruby-version".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, "config/projectlist_1_1_0.xsd".freeze, "config/projectlist_1_2_0.xsd".freeze, "lib/pmdtester.rb".freeze, "lib/pmdtester/builders/liquid_renderer.rb".freeze, "lib/pmdtester/builders/pmd_report_builder.rb".freeze, "lib/pmdtester/builders/project_builder.rb".freeze, "lib/pmdtester/builders/project_hasher.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/collection_by_file.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_tester_utils.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/_includes/diff_pill_row.html".freeze, "resources/css/bootstrap.min.css".freeze, "resources/css/datatables.min.css".freeze, "resources/css/pmd-tester.css".freeze, "resources/js/bootstrap.min.js".freeze, "resources/js/code-snippets.js".freeze, "resources/js/datatables.min.js".freeze, "resources/js/jquery-3.2.1.slim.min.js".freeze, "resources/js/jquery.min.js".freeze, "resources/js/popper.min.js".freeze, "resources/js/project-report.js".freeze, "resources/project_diff_report.html".freeze, "resources/project_index.html".freeze, "resources/project_pmd_report.html".freeze]
   s.homepage = "https://pmd.github.io".freeze
   s.licenses = ["BSD-2-Clause".freeze]
   s.rdoc_options = ["--main".freeze, "README.rdoc".freeze]

data/resources/js/project-report.js

@@ -57,7 +57,8 @@ $(document).ready(function () {
             viewTotal: true,
             cascadePanes: true,
             columns: [0, 1, 3],
-            order: ['Rule', 'Location (click row to expand)', 'Type']
+            order: ['Rule', 'Location (click row to expand)', 'Type'],
+            threshold: 1 // always show filters in search pane (default: 0.6)
         },
         // scrollCollapse: true,
         // paging: false,

data/resources/project_diff_report.html

@@ -18,6 +18,9 @@
 
 </head>
 <body>
+<div class="section">
+    <h1>PMD Regression Tester Diff Report for {{project_name}}</h1>
+</div>
 <div class="section">
     <h2>Summary</h2>
     <div class="section-content">
@@ -68,6 +71,12 @@
                 <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.html">Base PMD Report</a></td>
+                <td class="patch"><a href="patch_pmd_report.html">Patch PMD Report</a></td>
+                <td class="diff"></td>
+            </tr>
             </tbody>
         </table>
     </div>

data/resources/project_index.html

@@ -13,6 +13,12 @@
     <link rel="stylesheet" href="css/pmd-tester.css">
 </head>
 <body>
+<div class="section">
+    <h1>PMD Regression Tester Report</h1>
+    <p>
+        <a href="https://github.com/pmd/pmd-regression-tester">github.com/pmd/pmd-regression-tester</a>
+    </p>
+</div>
 <div class="section">
     <h2>Branch details</h2>
     <div class="section-content">
@@ -37,6 +43,11 @@
                         <span class="external-link-secondary"><a href="{{ comparison_url }}">[Compare]</a></span>
                     </td>
                 </tr>
+                <tr>
+                    <td class="item">Timestamp</td>
+                    <td class="base">{{base.timestamp}}</td>
+                    <td class="patch">{{patch.timestamp}}</td>
+                </tr>
                 <tr>
                     <td class="item">Total PMD runtime</td>
                     <td class="base">{{base.execution_time}}</td>

data/resources/project_pmd_report.html

@@ -0,0 +1,186 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>PMD Report for {{project_name}}</title>
+
+    <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
+    <link rel="stylesheet" type="text/css" href="../css/datatables.min.css"/>
+    <link rel="stylesheet" type="text/css" href="../css/pmd-tester.css">
+
+    <script src="../js/jquery-3.2.1.slim.min.js"></script>
+    <script src="../js/popper.min.js"></script>
+    <script src="../js/bootstrap.min.js"></script>
+    <script src="../js/datatables.min.js"></script>
+    <script src="../js/code-snippets.js"></script>
+    <!-- This is generated -->
+    <script src="./{{branch}}_data.js"></script>
+
+</head>
+<body>
+<div class="section">
+    <h1>PMD Report for {{project_name}}</h1>
+</div>
+<div class="section">
+    <h2>Summary</h2>
+    <div class="section-content">
+        <table id="table-summary" class="table">
+            <thead>
+            <tr>
+                <th></th>
+                <th>{{branch | capitalize}}</th>
+            </tr>
+            </thead>
+            <tbody>
+            <tr>
+                <td class="item"><a href="#section-violations">Violations</a>
+                </td>
+                <td class="{{branch}}">{{report.violation_counts}}</td>
+            </tr>
+            <tr>
+                <td class="item"><a href="#section-errors">Errors</a></td>
+                <td class="{{branch}}">{{report.error_counts}}</td>
+            </tr>
+            <tr>
+                <td class="item"><a href="#section-configerrors">ConfigErrors</a></td>
+                <td class="{{branch}}">{{report.configerror_counts}}</td>
+            </tr>
+            <tr>
+                <td class="item">Execution time</td>
+                <td class="{{branch}}">{{report.execution_time}}</td>
+            </tr>
+            <tr>
+                <td class="item">Timestamp</td>
+                <td class="{{branch}}">{{report.timestamp}}</td>
+            </tr>
+            <tr>
+                <td class="item">Full Report</td>
+                <td class="{{branch}}"><a href="{{branch}}_pmd_report.xml">{{branch}}_pmd_report.xml</a></td>
+            </tr>
+            </tbody>
+        </table>
+    </div>
+</div>
+
+<div class="section" id="section-rule-summary">
+
+    <h2>Summary by rule</h2>
+
+    <div class="section-content">
+
+        <div class="table-responsive">
+            <table id="rule-summary" class="table">
+                <thead>
+                <tr>
+                    <th>Rule</th>
+                    <th>{{branch | capitalize}}</th>
+                </tr>
+                </thead>
+                <tbody>
+
+                {% assign sorted_rules = report.rules | sort: 'name' %}
+
+                {% for rule in sorted_rules %}
+                <tr id="rule-summary-{{rule.name}}">
+                    <td class="rulename">
+                        {{ rule.name }}
+                        <span class="external-link-secondary"><a class="rulelink" href="{{rule.info_url}}" target="_blank" rel="noopener noreferrer">[doc]</a></span>
+                    </td>
+                    <td class="{{branch}}count">{{ rule.count }}</td>
+                </tr>
+                {% endfor %}
+                </tbody>
+            </table>
+        </div>
+    </div>
+</div>
+<div class="section" id="section-violations">
+
+    <h2>Violations</h2>
+
+    <div class="section-content">
+
+        <table id="violationsTable" width="100%" class="table">
+            <thead>
+            <tr>
+                <th>Location (click row to expand)</th>
+                <th>Rule</th>
+                <th>Message</th>
+                <th>Type</th>
+            </tr>
+            </thead>
+        </table>
+
+    </div>
+</div>
+
+<div class="section" id="section-errors">
+
+    <h2>Errors</h2>
+
+    <div class="section-content">
+
+        <div class="table-responsive">
+            <table id="error-table" class="table">
+                <thead>
+                 <tr>
+                     <th>File</th>
+                     <th>Description (click to expand)</th>
+                 </tr>
+                </thead>
+                <tbody>
+                {% for error in report.errors %}
+                <tr id="error-{{forloop.index}}" class="accordion-toggle error-row" data-toggle="collapse" data-target="#error-{{forloop.index}}-expanded">
+                    <td><a href="{{error.file_url}}"  target="_blank" rel="noopener noreferrer">{{error.short_filename}}</a></td>
+                    <td>{{error.short_message | escape | replace: error.filename, "<span class='meta-var'>$FILE</span>" }}</td>
+                </tr>
+                <tr>
+                    <td class="row-hidden" colspan="2">
+                        <div class="accordion-body collapse" id="error-{{forloop.index}}-expanded">
+                            <div class="collapsed-content-padder">
+                                <pre>
+{{ error.stack_trace_html }}
+                                </pre>
+                            </div>
+                        </div>
+                    </td>
+                </tr>
+                {% endfor %}
+                </tbody>
+            </table>
+        </div>
+
+    </div>
+</div>
+
+<div class="section" id="section-configerrors">
+
+    <h2>ConfigErrors</h2>
+
+    <div class="section-content">
+
+        <div class="table-responsive">
+            <table id="configerror-table" class="table">
+                <thead>
+                 <tr>
+                     <th>Rule</th>
+                     <th>Message</th>
+                 </tr>
+                </thead>
+                <tbody>
+                {% for configerror in report.configerrors %}
+                <tr class="configerror-row">
+                    <td>{{configerror.rule}}</td>
+                    <td>{{configerror.message}}</td>
+                </tr>
+                {% endfor %}
+                </tbody>
+            </table>
+        </div>
+    </div>
+</div>
+
+<script src="../js/project-report.js"></script>
+
+</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pmdtester
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Andreas Dangel
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -230,8 +230,7 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - ".ci/build.sh"
-- ".ci/files/env.gpg"
-- ".ci/inc/install-openjdk.inc"
+- ".ci/inc/fetch_ci_scripts.bash"
 - ".ci/manual-integration-tests.sh"
 - ".github/workflows/build.yml"
 - ".github/workflows/manual-integration-tests.yml"
@@ -252,6 +251,7 @@ files:
 - config/project-list.xml
 - config/projectlist_1_0_0.xsd
 - config/projectlist_1_1_0.xsd
+- config/projectlist_1_2_0.xsd
 - lib/pmdtester.rb
 - lib/pmdtester/builders/liquid_renderer.rb
 - lib/pmdtester/builders/pmd_report_builder.rb
@@ -289,6 +289,7 @@ files:
 - resources/js/project-report.js
 - resources/project_diff_report.html
 - resources/project_index.html
+- resources/project_pmd_report.html
 homepage: https://pmd.github.io
 licenses:
 - BSD-2-Clause

data/.ci/files/env.gpg

@@ -1 +0,0 @@
-�

data/.ci/inc/install-openjdk.inc

@@ -1,26 +0,0 @@
-
-function install_openjdk() {
-    OPENJDK_VERSION=$1
-    echo "Installing OpenJDK ${OPENJDK_VERSION}"
-    JDK_OS=linux
-    COMPONENTS_TO_STRIP=1 # e.g. openjdk-11.0.3+7/bin/java
-    DOWNLOAD_URL=$(curl --silent -X GET "https://api.adoptopenjdk.net/v3/assets/feature_releases/${OPENJDK_VERSION}/ga?architecture=x64&heap_size=normal&image_type=jdk&jvm_impl=hotspot&os=${JDK_OS}&page=0&page_size=1&project=jdk&sort_method=DEFAULT&sort_order=DESC&vendor=adoptopenjdk" \
-        -H "accept: application/json" \
-        | jq -r ".[0].binaries[0].package.link")
-    OPENJDK_ARCHIVE=$(basename ${DOWNLOAD_URL})
-    CACHE_DIR=${HOME}/.cache/openjdk
-    TARGET_DIR=${HOME}/openjdk${OPENJDK_VERSION}
-    mkdir -p ${CACHE_DIR}
-    mkdir -p ${TARGET_DIR}
-    if [ ! -e ${CACHE_DIR}/${OPENJDK_ARCHIVE} ]; then
-        echo "Downloading from ${DOWNLOAD_URL} to ${CACHE_DIR}"
-        curl --location --output ${CACHE_DIR}/${OPENJDK_ARCHIVE} "${DOWNLOAD_URL}"
-    else
-        echo "Skipped download, file ${CACHE_DIR}/${OPENJDK_ARCHIVE} already exists"
-    fi
-    tar --extract --file ${CACHE_DIR}/${OPENJDK_ARCHIVE} -C ${TARGET_DIR} --strip-components=${COMPONENTS_TO_STRIP}
-    export JAVA_HOME="${TARGET_DIR}"
-    export PATH="${TARGET_DIR}/bin:${PATH}"
-    java -version
-    echo "Java is available at ${TARGET_DIR}"
-}