pmdtester 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7fc01c7d15cd3aa78253be622bbd569540e04527d01856685ab89ab0cf2e443
-  data.tar.gz: ad1dcb50bf17bcc75aa93ae74d2e912f79a3c3b9e9e11ba5241f224d79c554d8
+  metadata.gz: e64c3cfe9a13d470c09fee954176bda926c290cf1c518f889cac6ed8581a2ccd
+  data.tar.gz: '091269caea70c24b02b138a6eb1b5292896c7fd7fffe3f3c38c8811dfa951db9'
 SHA512:
-  metadata.gz: 5eb5982c5253d95de53b3ed214ce82c88a94a98dce6b346e95bac0a0c21ae9ac58f79347c4a10399b4d1e07909787ccd8fa1314c0cab7b8bd5b41fdadf2183cd
-  data.tar.gz: fc74eb7bd0e530fc9504f80f10e02df95b9c9ef76ea364ef6d9fef3825e0da4ebb95d9611741f80a1021ca09cba5ad60d26dc021c6e46f0ad8e26bbe8bff81a2
+  metadata.gz: 744b359c60b9ac0f8349c0b94ebbd8923f09fdd06aea2ad5d88f8d983ea86f33f9a9105385efc9f553b35690c30dbac8533577a68301ef1ef5700e01964212a1
+  data.tar.gz: 6ee40e8927802f6e70e299629bec1b950feb0c388ced3e74a8982a014d4895f3dd76c04c055e91d4ef9881c037c189c9cfbbafe9cfc252c9a760cf9aaf0c17b0

data/.ci/build.sh

@@ -0,0 +1,91 @@
+#!/usr/bin/env bash
+
+set -e
+
+
+function build_regression_tester() {
+    echo "::group::Install OpenJDK 8+11"
+    install_openjdk 8
+    install_openjdk 11 # last one is the default
+    echo "::endgroup::"
+
+    echo "::group::Install dependencies"
+    gem install bundler
+    bundle config set --local path vendor/bundle
+    bundle install
+    echo "::endgroup::"
+
+    echo "::group::Build with rake"
+    bundle exec rake check_manifest
+    bundle exec rake rubocop
+    bundle exec rake clean test
+    echo "::endgroup::"
+
+    echo "::group::Run Integration Tests"
+    bundle exec rake clean integration-test
+    echo "::endgroup::"
+
+    echo "::group::Build Package"
+    bundle exec rake install_gem
+    bundle exec pmdtester -h
+    echo "::endgroup::"
+
+    # builds on forks or builds for pull requests stop here
+    if [[ "${PMD_CI_REPO}" != "pmd/pmd-regression-tester" || -n "${PMD_CI_PULL_REQUEST_NUMBER}" ]]; then
+        exit 0
+    fi
+
+    # if this is a release build from a tag...
+    if [[ "${PMD_CI_REPO}" == "pmd/pmd-regression-tester" && "${PMD_CI_GIT_REF}" == refs/tags/* ]]; then
+        echo "::group::Publish to rubygems"
+        setup_secrets
+
+        git stash --all
+        gem build pmdtester.gemspec
+        gem push pmdtester-*.gem
+        echo "::endgroup::"
+    fi
+
+}
+
+## helper functions
+
+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}"
+}
+
+function setup_secrets() {
+    echo "Setting up secrets..."
+    # Required secrets are: GEM_HOST_API_KEY
+    local -r env_file=".ci/files/env"
+    printenv PMD_CI_SECRET_PASSPHRASE | gpg --batch --yes --decrypt \
+        --passphrase-fd 0 \
+        --output ${env_file} ${env_file}.gpg
+    source ${env_file} >/dev/null 2>&1
+    rm ${env_file}
+}
+
+
+build_regression_tester

data/.ci/files/env.gpg

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

data/.github/workflows/build.yml

@@ -0,0 +1,39 @@
+name: build
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '**'
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/cache@v2
+      with:
+        path: |
+          ~/.m2/repository
+          ~/.cache
+          vendor/bundle
+        key: ${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
+        restore-keys: |
+          ${{ runner.os }}-
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Build
+      run: .ci/build.sh
+      shell: bash
+      env:
+        MAVEN_OPTS: -Dmaven.wagon.httpconnectionManager.ttlSeconds=180 -Dmaven.wagon.http.retryHandler.count=3
+        PMD_CI_SECRET_PASSPHRASE: ${{ secrets.PMD_CI_SECRET_PASSPHRASE }}
+        PMD_CI_REPO: ${{ github.repository }}
+        PMD_CI_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}
+        PMD_CI_GIT_REF: ${{ github.ref }}

data/.gitignore

@@ -0,0 +1,9 @@
+pkg/
+doc/
+Gemfile.lock
+.project
+.idea
+.bundle
+target/
+vendor/
+localtests/

data/.hoerc

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

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
   Include:
     - 'lib/**/*'
     - 'test/**/*'
@@ -14,12 +14,16 @@ AllCops:
     - 'vendor/**/*'
 
 Metrics/LineLength:
-  Max: 100
+  Max: 120
 
 Metrics/MethodLength:
   Exclude:
     - 'lib/pmdtester/parsers/options.rb'
 
+Metrics/ClassLength:
+  Exclude:
+    - '**/*'
+
 Metrics/BlockLength:
   Exclude:
     - 'lib/pmdtester/parsers/options.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/History.md

@@ -1,3 +1,43 @@
+# 1.1.0 / 2020-12-05
+
+## New and Noteworthy
+
+* At least ruby 2.7 is required.
+
+* Typeresolution is now supported by two new tags in the project-list.xml file:
+`build-command` and `auxclasspath-command`. For details, see pull request [#72](https://github.com/pmd/pmd-regression-tester/pull/72).
+
+* As part of [#74](https://github.com/pmd/pmd-regression-tester/pull/74) runner now returns a single hash
+  with the summarized values instead of multiple numbers:
+
+```
+summary = PmdTester::Runner.new(argv).run
+puts summary
+# {:errors=>{:new=>0, :removed=>0}, :violations=>{:new=>0, :removed=>0, :changed=>0}, :configerrors=>{:new=>0, :removed=>0}}
+```
+
+* As part of [#73](https://github.com/pmd/pmd-regression-tester/issues/73) and [#78](https://github.com/pmd/pmd-regression-tester/pull/78)
+  a improved HTML report is now generated with the following features:
+  * searchable table for violations with filters by rule/file/kind (added, removed, changed)
+  * summary of changes by rule
+  * code snippets for the violations
+
+## Fixed Issues
+
+*   [#48](https://github.com/pmd/pmd-regression-tester/issues/48): Support auxclasspath / typeresolution
+*   [#67](https://github.com/pmd/pmd-regression-tester/pull/67): Report contains errors having nil filename
+*   [#68](https://github.com/pmd/pmd-regression-tester/pull/68): Don't generate a dynamic ruleset if not needed
+*   [#69](https://github.com/pmd/pmd-regression-tester/pull/69): Detect single rules with auto-gen-config
+*   [#70](https://github.com/pmd/pmd-regression-tester/pull/70): Add link to PR on github in HTML report
+*   [#73](https://github.com/pmd/pmd-regression-tester/issues/73): Better HTML presentation for diff report
+*   [#74](https://github.com/pmd/pmd-regression-tester/pull/74): Merge violations that have just changed messages
+*   [#75](https://github.com/pmd/pmd-regression-tester/pull/75): Add new option "--error-recovery"
+*   [#76](https://github.com/pmd/pmd-regression-tester/pull/76): Speedup XML parsing
+*   [#79](https://github.com/pmd/pmd-regression-tester/pull/79): Add new configuration option "--baseline-download-url"
+*   [#80](https://github.com/pmd/pmd-regression-tester/pull/80): Cache and reuse pmd builds
+
+## External Contributions
+
 # 1.0.1 / 2020-07-08
 
 This is a bugfix release.

data/Manifest.txt

@@ -1,7 +1,11 @@
+.ci/build.sh
+.ci/files/env.gpg
+.github/workflows/build.yml
+.gitignore
 .hoerc
 .rubocop.yml
 .rubocop_todo.yml
-.travis.yml
+.ruby-version
 Gemfile
 History.md
 LICENSE
@@ -13,18 +17,17 @@ config/all-java.xml
 config/design.xml
 config/project-list.xml
 config/projectlist_1_0_0.xsd
+config/projectlist_1_1_0.xsd
 lib/pmdtester.rb
-lib/pmdtester/builders/diff_builder.rb
-lib/pmdtester/builders/diff_report/configerrors.rb
-lib/pmdtester/builders/diff_report/errors.rb
-lib/pmdtester/builders/diff_report/violations.rb
-lib/pmdtester/builders/diff_report_builder.rb
-lib/pmdtester/builders/html_report_builder.rb
+lib/pmdtester/builders/liquid_renderer.rb
 lib/pmdtester/builders/pmd_report_builder.rb
+lib/pmdtester/builders/project_builder.rb
+lib/pmdtester/builders/project_hasher.rb
 lib/pmdtester/builders/rule_set_builder.rb
 lib/pmdtester/builders/simple_progress_logger.rb
 lib/pmdtester/builders/summary_report_builder.rb
 lib/pmdtester/cmd.rb
+lib/pmdtester/collection_by_file.rb
 lib/pmdtester/parsers/options.rb
 lib/pmdtester/parsers/pmd_report_document.rb
 lib/pmdtester/parsers/projects_parser.rb
@@ -32,11 +35,23 @@ lib/pmdtester/pmd_branch_detail.rb
 lib/pmdtester/pmd_configerror.rb
 lib/pmdtester/pmd_error.rb
 lib/pmdtester/pmd_report_detail.rb
+lib/pmdtester/pmd_tester_utils.rb
 lib/pmdtester/pmd_violation.rb
 lib/pmdtester/project.rb
 lib/pmdtester/report_diff.rb
 lib/pmdtester/resource_locator.rb
 lib/pmdtester/runner.rb
 pmdtester.gemspec
-resources/css/maven-base.css
-resources/css/maven-theme.css
+resources/_includes/diff_pill_row.html
+resources/css/bootstrap.min.css
+resources/css/datatables.min.css
+resources/css/pmd-tester.css
+resources/js/bootstrap.min.js
+resources/js/code-snippets.js
+resources/js/datatables.min.js
+resources/js/jquery-3.2.1.slim.min.js
+resources/js/jquery.min.js
+resources/js/popper.min.js
+resources/js/project-report.js
+resources/project_diff_report.html
+resources/project_index.html

data/README.rdoc

@@ -4,7 +4,9 @@ home  :: https://pmd.github.io
 code  :: https://github.com/pmd/pmd-regression-tester
 bugs  :: https://github.com/pmd/pmd-regression-tester/issues
 
-build-status :: {<img src="https://travis-ci.com/pmd/pmd-regression-tester.svg?branch=master" alt="Build Status" />}[https://travis-ci.com/pmd/pmd-regression-tester]
+build-status :: {<img src="https://github.com/pmd/pmd-regression-tester/workflows/build/badge.svg?branch=master" alt="Build Status" />}[https://github.com/pmd/pmd-regression-tester/actions?query=workflow%3Abuild]
+
+gem-version :: {<img src="https://badge.fury.io/rb/pmdtester.svg" alt="Gem Version" />}[https://rubygems.org/gems/pmdtester]
 
 == DESCRIPTION:
 
@@ -18,24 +20,27 @@ on a list of standard projects(Spring Framework, Hibernate, Solr, etc.)
 == SYNOPSIS:
 
 === Options:
-    -r, --local-git-repo   path to the local PMD repository
-    -b, --base-branch      name of the base branch in local PMD repository
-    -p, --patch-branch     name of the patch branch in local PMD repository
-    -bc, --base-config     path to the base PMD configuration file default:PMDTESTER_INSTALLED_DIR/config/all-java.xml
-    -pc, --patch-config    path to the patch PMD configuration file default:PMDTESTER_INSTALLED_DIR/config/all-java.xml
-    -c, --config           path to the base and patch PMD configuration file
-    -l, --list-of-project  path to the file which contains the list of standard projects default:PMDTESTER_INSTALLED_DIR/config/project-list.xml
-    -m, --mode             the mode of the tool: 'local', 'online' or 'single'
+    -r, --local-git-repo     path to the local PMD repository
+    -b, --base-branch        name of the base branch in local PMD repository
+    -p, --patch-branch       name of the patch branch in local PMD repository
+    -bc, --base-config       path to the base PMD configuration file default:PMDTESTER_INSTALLED_DIR/config/all-java.xml
+    -pc, --patch-config      path to the patch PMD configuration file default:PMDTESTER_INSTALLED_DIR/config/all-java.xml
+    -c, --config             path to the base and patch PMD configuration file
+    -l, --list-of-project    path to the file which contains the list of standard projects default:PMDTESTER_INSTALLED_DIR/config/project-list.xml
+    -m, --mode               the mode of the tool: 'local', 'online' or 'single'
           single: Set this option to 'single' if your patch branch contains changes
             for any option that can't work on master/base branch
           online: Set this option to 'online' if you want to download
             the PMD report of master/base branch rather than generating it locally
           local: Default option is 'local', PMD reports for the base and patch branches are generated locally.
 
-    -t, --threads          Sets the number of threads used by PMD. Set threads to 0 to disable multi-threading processing. default:1
-    -f, --html-flag        whether to not generate the html diff report in single mode
-    -a, --auto-gen-config  whether to generate configurations automatically based on branch differences,this option only works in online and local mode
-    -d, --debug            whether change log level to DEBUG to see more information
+    -t, --threads            Sets the number of threads used by PMD. Set threads to 0 to disable multi-threading processing. default:1
+    -f, --html-flag          whether to not generate the html diff report in single mode
+    -a, --auto-gen-config    whether to generate configurations automatically based on branch differences,this option only works in online and local mode
+    --keep-reports           whether to keep old reports and skip running PMD again if possible
+    -d, --debug              whether change log level to DEBUG to see more information
+    --error-recovery         enable error recovery mode when executing PMD. Might help to analyze errors.
+    --baseline-download-url  download url prefix from where to download the baseline in online mode default:https://sourceforge.net/projects/pmd/files/pmd-regression-tester/
     -v, --version
     -h, --help
 
@@ -60,19 +65,24 @@ The tool creates the following folders:
   │   ├── PROJECT_NAME_1
   │   ├── ......
   │   └── PROJECT_NAME_n
-  └── reports
-      ├── BASE_BRANCH_NAME      <- the base baseline is placed here
-      ├── PATCH_BRANCH_NAME      <- the patch baseline is placed here
-      └── diff
-          ├── index.xml <- the summary report of diff reports
-          ├── base_config.xml  <- the resources of the summary report
-          ├── patch_config.xml  <- the resources fo the summary report
-          ├── css  <- css reources are placed here
-          ├── PROJECT_NAME_1
-              └── index.xml   <- the diff report of PROJECT_1
-          ├── .......
-          └── PROJECT_NAME_n
-              └── index.xml   <- the diff report of PROJECT_N
+  ├── reports
+  │   ├── BASE_BRANCH_NAME        <- the base baseline is placed here
+  │   ├── PATCH_BRANCH_NAME       <- the patch baseline is placed here
+  │   └── diff
+  │       ├── index.html          <- the summary report of diff reports
+  │       ├── base_config.xml     <- pmd config from the base branch
+  │       ├── patch_config.xml    <- pmd config from the patch branch
+  │       ├── css  <- css resources are placed here
+  │       ├── js   <- js resources
+  │       ├── PROJECT_NAME_1
+  │       │   ├── project_data.js <- contains the violations as js/json
+  │       │   └── index.html      <- the diff report of PROJECT_1
+  │       ├── .......
+  │       └── PROJECT_NAME_n
+  │           ├── project_data.js <- contains the violations as js/json
+  │           └── index.xml       <- the diff report of PROJECT_N
+  ├── pmd-bin-<version>-<branch_name>-<sha1>  <- cached pmd builds that are reused
+  └── pmd-bin-....
 
 ==== The baseline format
   branch_name
@@ -90,7 +100,7 @@ The tool creates the following folders:
 
 == REQUIREMENTS:
 
-* Ruby 2.4.1 or higher
+* Ruby 2.7 or higher
 
 === Runtime dependency
 
@@ -133,6 +143,11 @@ The tool creates the following folders:
 
 * Update +History.md+ (version and date)
 * Update +lib/pmdtester.rb+ (version)
-* Commit ("Prepare release x.y.z"), tag, push. Travis will build and publish the new gem.
-* Update History.md and lib/pmdtester.rb for the next development version
-  ("Prepare next development version x.y.z-SNAPSHOT").
+* Run "bundle exec rake verify" and add new +pmdtester.gemspec+ (new version)
+* Commit ("Prepare release x.y.z").
+* Tag this commit ("git tag vx.y.z").
+* Update History.md and lib/pmdtester.rb for the next development version,
+  run again "bundle exec rake verify"
+* Commit ("Prepare next development version x.y.z-SNAPSHOT").
+* Push to master.
+* Push the tag. Github Actions will build and publish the new gem

data/Rakefile

@@ -16,10 +16,12 @@ hoe = Hoe.spec 'pmdtester' do
 
   developer 'Andreas Dangel', 'andreas.dangel@pmd-code.org'
   developer 'Binguo Bao', 'djydewang@gmail.com'
+  developer 'Clément Fournier', 'clement.fournier76@gmail.com'
 
-  self.clean_globs = %w[target/reports/**/* target/test/**/* Gemfile.lock]
+  self.clean_globs = %w[target/reports/**/* target/test/**/* target/dynamic-config.xml Gemfile.lock]
   self.extra_deps += [['nokogiri', '~> 1.8'], ['slop', '~> 4.6'], ['differ', '~> 0.1'],
-                      ['rufus-scheduler', '~> 3.5']]
+                      ['rufus-scheduler', '~> 3.5'], ['logger-colors', '~> 1.0'],
+                      ['liquid', '>= 4.0']]
   self.extra_dev_deps += [
     ['hoe-bundler',   '~> 1.5'],
     ['hoe-git',       '~> 1.6'],
@@ -30,7 +32,7 @@ hoe = Hoe.spec 'pmdtester' do
     ['test-unit',     '~> 3.2'],
     ['rdoc',          ['>= 4.0', '< 7']]
   ]
-  spec_extras[:required_ruby_version] = '>= 2.2'
+  spec_extras[:required_ruby_version] = '>= 2.7'
 
   license 'BSD-2-Clause'
 end

data/config/all-java.xml

@@ -3,7 +3,7 @@
 <ruleset name="All Java Rules" 
     xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
     <description>Every Java Rule in PMD</description>
 
     <rule ref="category/java/bestpractices.xml" />

data/config/design.xml

@@ -3,7 +3,7 @@
 <ruleset name="Design"
     xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
 
     <description>
 The Design ruleset contains rules that flag suboptimal code implementations. Alternate approaches