pmdtester 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a01837c60abe0048b0e65aaec642e970e3bf2fa6f126f2e33c5429a33dce5aaa
-  data.tar.gz: 776503e819fa70e809de9f2633cb464cf40f4758449679edc967649b08716e31
+  metadata.gz: db98cbb787ccaa595c939ddee83316347edbf0daf746ca38daea53d3dab3fb77
+  data.tar.gz: 158cc9f948c7e680725dc2596e4d65dabac35f9f06188c8c4670d060f9889dff
 SHA512:
-  metadata.gz: f411366e6cfae2693955512010ea9bec3431ff085df45de372526250a044beb82163b8f78be7920551b41e0ae9f543f93a068030429ebbcc846c45969946f65e
-  data.tar.gz: '0569c7bcb84fa271eff1b32b3836db2efb6209a17462c3e39de97f3cf7d0a69455b710fe4e810d32717732ba615c05211f462af0019b2c01190796a8c9861576'
+  metadata.gz: 28ea491ac20cddb4b51f0c418c479ce7394d5839d05dfacd04cb5c128590b7d8100b232a60d4cfafc0110249ccbe001b1e9426632679df4dcf2f6dcdc9415121
+  data.tar.gz: 2f12577c68058fb20bbc10e64de84ce574d45e6d7c0c766907b4e4342054bc95f992a654b620ced49130379db66aa5b21425114d327a9332021f04b6544e094a

data/.ci/build.sh

@@ -0,0 +1,99 @@
+#!/usr/bin/env bash
+
+# Exit this script immediately if a command/function exits with a non-zero status.
+set -e
+
+SCRIPT_INCLUDES="log.bash utils.bash setup-secrets.bash openjdk.bash github-releases-api.bash"
+# shellcheck source=inc/fetch_ci_scripts.bash
+source "$(dirname "$0")/inc/fetch_ci_scripts.bash" && fetch_ci_scripts
+
+function build() {
+    pmd_ci_log_group_start "Install OpenJDK 8+11"
+        pmd_ci_openjdk_install_adoptopenjdk 11
+        pmd_ci_openjdk_install_adoptopenjdk 8
+        pmd_ci_openjdk_setdefault 11
+    pmd_ci_log_group_end
+
+    pmd_ci_log_group_start "Install dependencies"
+        gem install --user-install bundler
+        bundle config set --local path vendor/bundle
+        bundle install
+    pmd_ci_log_group_end
+
+    echo
+    local version
+    version="$(bundle exec ruby -I. -e 'require "lib/pmdtester"; print PmdTester::VERSION;')"
+    pmd_ci_log_info "======================================================================="
+    pmd_ci_log_info "Building pmd-regression-tester ${version}"
+    pmd_ci_log_info "======================================================================="
+    pmd_ci_utils_determine_build_env pmd/pmd-regression-tester
+    echo
+
+    pmd_ci_log_group_start "Build with rake"
+        bundle exec rake check_manifest
+        bundle exec rake rubocop
+        bundle exec rake clean test
+    pmd_ci_log_group_end
+
+    pmd_ci_log_group_start "Run Integration Tests"
+        bundle exec rake clean integration-test
+    pmd_ci_log_group_end
+
+    pmd_ci_log_group_start "Build Package"
+        bundle exec rake install_gem
+        bundle exec pmdtester -h
+    pmd_ci_log_group_end
+
+    if pmd_ci_utils_is_fork_or_pull_request; then
+        # builds on forks or builds for pull requests stop here
+        exit 0
+    fi
+
+    # only builds on pmd/pmd-regression-tester continue here
+    pmd_ci_log_group_start "Setup environment"
+        pmd_ci_setup_secrets_private_env
+    pmd_ci_log_group_end
+
+    if isReleaseBuild "$version"; then
+        pmd_ci_log_group_start "Publish to rubygems"
+            gem build pmdtester.gemspec
+            local gempkgfile
+            gempkgfile="$(echo pmdtester-*.gem)"
+            gem push "${gempkgfile}"
+        pmd_ci_log_group_end
+
+        pmd_ci_log_group_start "Update Github Releases"
+            # create a draft github release
+            pmd_ci_gh_releases_createDraftRelease "${PMD_CI_TAG}" "$(git rev-list -n 1 "${PMD_CI_TAG}")"
+            GH_RELEASE="$RESULT"
+
+            # Deploy to github releases
+            pmd_ci_gh_releases_uploadAsset "$GH_RELEASE" "${gempkgfile}"
+
+            # extract the release notes
+            RELEASE_NAME="${version}"
+            BEGIN_LINE=$(grep -n "^# " History.md|head -1|cut -d ":" -f 1)
+            BEGIN_LINE=$((BEGIN_LINE + 1))
+            END_LINE=$(grep -n "^# " History.md|head -2|tail -1|cut -d ":" -f 1)
+            END_LINE=$((END_LINE - 1))
+            RELEASE_BODY="$(head -$END_LINE History.md | tail -$((END_LINE - BEGIN_LINE)))"
+
+            pmd_ci_gh_releases_updateRelease "$GH_RELEASE" "$RELEASE_NAME" "$RELEASE_BODY"
+
+            # Publish release - this sends out notifications on github
+            pmd_ci_gh_releases_publishRelease "$GH_RELEASE"
+        pmd_ci_log_group_end
+    fi
+}
+
+function isReleaseBuild() {
+    local version="$1"
+
+    if [[ "${version}" != *-SNAPSHOT && "${PMD_CI_TAG}" != "" ]]; then
+        return 0
+    fi
+
+    return 1
+}
+
+build

data/.ci/inc/fetch_ci_scripts.bash

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+function fetch_ci_scripts() {
+    local inc_dir
+    local inc_url
+    inc_dir="$(dirname "$0")/inc"
+    inc_url="${PMD_CI_SCRIPTS_URL:-https://raw.githubusercontent.com/pmd/build-tools/master/scripts}/inc"
+
+    mkdir -p "${inc_dir}"
+
+    for f in ${SCRIPT_INCLUDES}; do
+        if [ ! -e "${inc_dir}/$f" ]; then
+            curl -sSL "${inc_url}/$f" > "${inc_dir}/$f"
+        fi
+        [ "$PMD_CI_DEBUG" = "true" ] && echo "loading ${inc_dir}/$f in ${MODULE:-$0}"
+        # shellcheck source=/dev/null
+        source "${inc_dir}/$f" || exit 1
+    done
+}

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

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+# Exit this script immediately if a command/function exits with a non-zero status.
+set -e
+
+SCRIPT_INCLUDES="log.bash utils.bash openjdk.bash"
+# shellcheck source=inc/fetch_ci_scripts.bash
+source "$(dirname "$0")/inc/fetch_ci_scripts.bash" && fetch_ci_scripts
+
+function build() {
+    pmd_ci_log_group_start "Install OpenJDK 8+11"
+        pmd_ci_openjdk_install_adoptopenjdk 11
+        pmd_ci_openjdk_install_adoptopenjdk 8
+        pmd_ci_openjdk_setdefault 11
+    pmd_ci_log_group_end
+
+    pmd_ci_log_group_start "Install dependencies"
+        gem install --user-install bundler
+        bundle config set --local path vendor/bundle
+        bundle install
+    pmd_ci_log_group_end
+
+    echo
+    local version
+    version="$(bundle exec ruby -I. -e 'require "lib/pmdtester"; print PmdTester::VERSION;')"
+    pmd_ci_log_info "======================================================================="
+    pmd_ci_log_info "Building pmd-regression-tester ${version}"
+    pmd_ci_log_info "======================================================================="
+    pmd_ci_utils_determine_build_env pmd/pmd-regression-tester
+    echo
+
+    pmd_ci_log_group_start "Run Manual Integration Tests"
+        bundle exec ruby -I test test/manual_integration_tests.rb
+    pmd_ci_log_group_end
+}
+
+build

data/.github/workflows/build.yml

@@ -0,0 +1,55 @@
+name: build
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - '**'
+  pull_request:
+  schedule:
+    # build it monthly: At 04:30 on day-of-month 1.
+    - cron:  '30 4 1 * *'
+  workflow_dispatch:
+
+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
+          target/repositories
+        key: ${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
+        restore-keys: |
+          ${{ runner.os }}-
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Setup Environment
+      shell: bash
+      run: |
+        echo "LANG=en_US.UTF-8" >> $GITHUB_ENV
+        echo "MAVEN_OPTS=-Dmaven.wagon.httpconnectionManager.ttlSeconds=180 -Dmaven.wagon.http.retryHandler.count=3" >> $GITHUB_ENV
+        echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/14/scripts" >> $GITHUB_ENV
+    - name: Check Environment
+      shell: bash
+      run: |
+        f=check-environment.sh; \
+        mkdir -p .ci && \
+        ( [ -e .ci/$f ] || curl -sSL "${PMD_CI_SCRIPTS_URL}/$f" > ".ci/$f" ) && \
+        chmod 755 .ci/$f && \
+        .ci/$f
+    - name: Build
+      run: .ci/build.sh
+      shell: bash
+      env:
+        PMD_CI_SECRET_PASSPHRASE: ${{ secrets.PMD_CI_SECRET_PASSPHRASE }}

data/.github/workflows/manual-integration-tests.yml

@@ -0,0 +1,43 @@
+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
+          target/repositories
+        key: ${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
+        restore-keys: |
+          ${{ runner.os }}-
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Setup Environment
+      shell: bash
+      run: |
+        echo "LANG=en_US.UTF-8" >> $GITHUB_ENV
+        echo "MAVEN_OPTS=-Dmaven.wagon.httpconnectionManager.ttlSeconds=180 -Dmaven.wagon.http.retryHandler.count=3" >> $GITHUB_ENV
+        echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/14/scripts" >> $GITHUB_ENV
+    - name: Check Environment
+      shell: bash
+      run: |
+        f=check-environment.sh; \
+        mkdir -p .ci && \
+        ( [ -e .ci/$f ] || curl -sSL "${PMD_CI_SCRIPTS_URL}/$f" > ".ci/$f" ) && \
+        chmod 755 .ci/$f && \
+        .ci/$f
+    - name: Build
+      run: .ci/manual-integration-tests.sh
+      shell: bash
+      env:
+        PMD_CI_SECRET_PASSPHRASE: ${{ secrets.PMD_CI_SECRET_PASSPHRASE }}

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)|target|test\/|Gemfile\.lock|\.bundle\/|install-jdk.sh|vendor\/cache/
+exclude: !ruby/regexp /tmp$|\.git\/|\.idea|\.project|target\/|test\/|Gemfile\.lock|\.bundle\/|vendor\/|localtests\/|\.ci\/inc\/(log|utils|setup-secrets|openjdk|github-releases-api)\.bash|\.ci\/files\/|\.ci\/check-environment\.sh/

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,19 @@ 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'
+
+Metrics/ModuleLength:
+  CountAsOne: ['array', 'hash']

data/.ruby-version

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

data/History.md

@@ -1,3 +1,82 @@
+# 1.2.0 / 2021-06-20
+
+## New and Noteworthy
+
+*   Support for Mercurial is removed. The only SCM supported in the project-list.xml is "git".
+
+## Fixed Issues
+
+*   [#71](https://github.com/pmd/pmd-regression-tester/issues/71): Include full PMD report
+*   [#89](https://github.com/pmd/pmd-regression-tester/pull/89): Make it possible to select a subpath of cloned directory
+*   [#91](https://github.com/pmd/pmd-regression-tester/pull/91): Filter baseline based on patch config
+
+# 1.1.2 / 2021-04-20
+
+This is a bugfix release.
+
+## Fixed Issues
+
+*   [#85](https://github.com/pmd/pmd-regression-tester/issues/85): HTML is not escaped in snippet preview
+*   [#84](https://github.com/pmd/pmd-regression-tester/issues/84): Leading spaces are missing in code snippet preview
+
+# 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

data/Manifest.txt

@@ -1,7 +1,13 @@
+.ci/build.sh
+.ci/inc/fetch_ci_scripts.bash
+.ci/manual-integration-tests.sh
+.github/workflows/build.yml
+.github/workflows/manual-integration-tests.yml
+.gitignore
 .hoerc
 .rubocop.yml
 .rubocop_todo.yml
-.travis.yml
+.ruby-version
 Gemfile
 History.md
 LICENSE
@@ -13,18 +19,18 @@ config/all-java.xml
 config/design.xml
 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/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 +38,24 @@ 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
+resources/project_pmd_report.html