pmdtester 1.0.0.pre.beta2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc98cf9ced82209cfacc2752160229c5eb067c9604c8639d3ec5d9663134d8fc
-  data.tar.gz: 2c5a013fe96a5e60614f7d932837434a42e15ba19ae5a5e7096934ae4b7692f7
+  metadata.gz: 4d0d2deb3eea885db1ea9fd273fc2330f93be694a4a7f804f6ffc03811b67280
+  data.tar.gz: 1cd1d39bdfd34a113a88275c9662a180c352b425d2ab06278fdd4530ce2bf8d5
 SHA512:
-  metadata.gz: eb72595523c73e2a2a9adfe560f653baf0c35581ee803d3381ef9f400c90aeec9f92ef262f19f6f56323a848a5b4a98fb898af811577c815429a6ac93c619e7e
-  data.tar.gz: 93d11d0f0943378987968434a6f0a36391830826a70dc6a8ce09a9706aef6cd5cfe87bf31671e7bba031ac52f34c2d26e4edc96f096a5c02f9be19dfd2ce4a82
+  metadata.gz: 4fea894ba2fe827517f09a54cef4f729f7a2a3340318479422a3d4f5ca064d3ef7fefc7474a174b2b0a0de8644b8985d83da3663828ee2bb1e37b4b2f33faf39
+  data.tar.gz: d3057fde3a18df5ba4fcad91ed1159de018ae2b3732eb867fc546ac4e8f819547765bdbb3acb20787e126a09edc2b929f9dab6c9e2f5bf946e1acc58677a2c1e

data/.ci/build.sh

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+
+source $(dirname $0)/inc/install-openjdk.inc
+
+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 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/.ci/inc/install-openjdk.inc

@@ -0,0 +1,26 @@
+
+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}"
+}

data/.ci/manual-integration-tests.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+source $(dirname $0)/inc/install-openjdk.inc
+
+set -e
+
+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::Run Manual Integration Tests"
+bundle exec ruby -I test test/manual_integration_tests.rb
+echo "::endgroup::"

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/.github/workflows/manual-integration-tests.yml

@@ -0,0 +1,32 @@
+name: manual-integration-tests
+
+on: workflow_dispatch
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    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/manual-integration-tests.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

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

data/.rubocop.yml

@@ -1,10 +1,29 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
+  Include:
+    - 'lib/**/*'
+    - 'test/**/*'
   Exclude:
+    # pmdtester.gemspec and Gemfile are generated
+    - 'pmdtester.gemspec'
+    - 'Gemfile'
     - 'target/**/*'
     - 'test/resources/**/*'
+    - '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/.rubocop_todo.yml

@@ -1,27 +1,26 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-07-12 16:57:46 +0800 using RuboCop version 0.56.0.
+# on 2018-11-25 11:00:37 +0100 using RuboCop version 0.51.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 22
+# Offense count: 30
 Metrics/AbcSize:
   Max: 47
 
-# Offense count: 3
+# Offense count: 6
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 174
+  Max: 135
 
-# Offense count: 33
+# Offense count: 38
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 35
+  Max: 22
 
-# Offense count: 5
+# Offense count: 3
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/pmdtester/builders/pmd_report_builder.rb'
-    - 'lib/pmdtester/parsers/projects_parser.rb'

data/.ruby-version

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

data/Gemfile

@@ -3,18 +3,6 @@
 # DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake bundler:gemfile`.
 
 source "https://rubygems.org/"
-
-gem "nokogiri", "~>1.8.2"
-gem "slop", "~>4.6.2"
-
-gem "hoe-bundler", "~>1.2", :group => [:development, :test]
-gem "hoe-gemspec", "~>1.0", :group => [:development, :test]
-gem "hoe-git", "~>1.6", :group => [:development, :test]
-gem "minitest", "~>5.10.1", :group => [:development, :test]
-gem "mocha", "~>1.5.0", :group => [:development, :test]
-gem "rubocop", "~>0.56.0", :group => [:development, :test]
-gem "test-unit", "~>3.2.3", :group => [:development, :test]
-gem "rdoc", ">=4.0", "<6", :group => [:development, :test]
-gem "hoe", "~>3.17", :group => [:development, :test]
+gemspec
 
 # vim: syntax=ruby

data/History.md

@@ -1,3 +1,111 @@
+# 1.1.1 / 2021-01-15
+
+This is a bugfix release.
+
+## Fixed Issues
+
+*   [#81](https://github.com/pmd/pmd-regression-tester/pull/81): Dynamically generated rulesets are not applied on diffs
+*   [#82](https://github.com/pmd/pmd-regression-tester/pull/82): Summary hash uses wrong key names
+*   An already built PMD binary was not reused in CI
+
+# 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.
+
+## Fixed Issues
+
+*   [#62](https://github.com/pmd/pmd-regression-tester/pull/62): Violation descriptions parsed incompletely
+
+# 1.0.0 / 2020-04-25
+
+## New and Noteworthy
+
+First stable release.
+
+## Fixed Issues
+
+*   [#35](https://github.com/pmd/pmd-regression-tester/issues/35): exclude-pattern hasn't been implemented
+*   [#37](https://github.com/pmd/pmd-regression-tester/issues/37): Render stack traces properly
+*   [#38](https://github.com/pmd/pmd-regression-tester/issues/38): Improve Danger messages
+*   [#40](https://github.com/pmd/pmd-regression-tester/issues/40): NoMethodError on beta3
+*   [#42](https://github.com/pmd/pmd-regression-tester/issues/42): Installing the snapshot version of pmdtester locally from github
+*   [#46](https://github.com/pmd/pmd-regression-tester/issues/46): Support multithreaded execution of PMD
+*   [#47](https://github.com/pmd/pmd-regression-tester/issues/47): Reuse the already built PMD binary for PR checks
+*   [#49](https://github.com/pmd/pmd-regression-tester/issues/49): Support comparing two error stacktraces
+*   [#50](https://github.com/pmd/pmd-regression-tester/issues/50): Differences due to different locale settings
+*   [#57](https://github.com/pmd/pmd-regression-tester/issues/57): Support configuration errors in the report
+*   [#60](https://github.com/pmd/pmd-regression-tester/issues/60): Display a simple progress report
+
+## External Contributions
+
+*   [#33](https://github.com/pmd/pmd-regression-tester/pull/33): Ignore changes to test code of PMD when generating dynamic rule sets - [BBG](https://github.com/djydewang)
+*   [#34](https://github.com/pmd/pmd-regression-tester/pull/34): Clear old reports before generating new differences regression reports - [BBG](https://github.com/djydewang)
+*   [#36](https://github.com/pmd/pmd-regression-tester/pull/36): Implements exclude-pattern - [BBG](https://github.com/djydewang)
+*   [#39](https://github.com/pmd/pmd-regression-tester/pull/39): Render stacktraces properly - [BBG](https://github.com/djydewang)
+*   [#41](https://github.com/pmd/pmd-regression-tester/pull/41): Fixes NoMethodError in Project class - [BBG](https://github.com/djydewang)
+*   [#43](https://github.com/pmd/pmd-regression-tester/pull/43): Adds pmdtester.gemspec file - [BBG](https://github.com/djydewang)
+*   [#44](https://github.com/pmd/pmd-regression-tester/pull/44): Improve Danger messages & Increase the readability of the summary report - [BBG](https://github.com/djydewang)
+*   [#45](https://github.com/pmd/pmd-regression-tester/pull/45): Removes the exit statement in RuleSetBuilder Class - [BBG](https://github.com/djydewang)
+*   [#51](https://github.com/pmd/pmd-regression-tester/pull/51): Add the JDK version and locale info to the summary table of the diff report - [BBG](https://github.com/djydewang)
+*   [#52](https://github.com/pmd/pmd-regression-tester/pull/52): Get the result of command 'java -version' from stderr rather than stdout - [BBG](https://github.com/djydewang)
+*   [#53](https://github.com/pmd/pmd-regression-tester/pull/53): Support comparing the two error stacktraces - [BBG](https://github.com/djydewang)
+*   [#54](https://github.com/pmd/pmd-regression-tester/pull/54): Support multithreaded execution of PMD - [BBG](https://github.com/djydewang)
+*   [#61](https://github.com/pmd/pmd-regression-tester/pull/61): Display a simple progress report every 2 minutes - [BBG](https://github.com/djydewang)
+
+# 1.0.0.beta3 / 2018-08-01
+
+Note: This is a beta release. The pmdtester is feature complete,
+but might contain bugs.
+
+## External Contributions
+
+*   [#28](https://github.com/pmd/pmd-regression-tester/pull/28): Refactor require statements - [BBG](https://github.com/djydewang)
+*   [#29](https://github.com/pmd/pmd-regression-tester/pull/29): Add 'verify' rake task to verify code quality before committing changes - [BBG](https://github.com/djydewang)
+*   [#30](https://github.com/pmd/pmd-regression-tester/pull/30): Fix diff_cmd in RuleSetBuilder - [BBG](https://github.com/djydewang)
+*   [#31](https://github.com/pmd/pmd-regression-tester/pull/31): Fix color scheme for diff report, add default values for various options - [BBG](https://github.com/djydewang)
+*   [#32](https://github.com/pmd/pmd-regression-tester/pull/32): Update Readme.rdoc - [BBG](https://github.com/djydewang)
+
+
 # 1.0.0.beta2 / 2018-07-17
 
 *   First release of pmdtester

data/Manifest.txt

@@ -0,0 +1,60 @@
+.ci/build.sh
+.ci/files/env.gpg
+.ci/inc/install-openjdk.inc
+.ci/manual-integration-tests.sh
+.github/workflows/build.yml
+.github/workflows/manual-integration-tests.yml
+.gitignore
+.hoerc
+.rubocop.yml
+.rubocop_todo.yml
+.ruby-version
+Gemfile
+History.md
+LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+bin/pmdtester
+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/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
+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/_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