pmdtester 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d45c31e2cf8ad4eaba391c13fa0523ade4a84394bc07a908e6a49806a12ebf6
-  data.tar.gz: fdf6c23a45dc0fd6738e272e564c3c29322dea2285269c1a869608bd77494d8a
+  metadata.gz: db98cbb787ccaa595c939ddee83316347edbf0daf746ca38daea53d3dab3fb77
+  data.tar.gz: 158cc9f948c7e680725dc2596e4d65dabac35f9f06188c8c4670d060f9889dff
 SHA512:
-  metadata.gz: 249c6a07412a2b74405e84fe1780d5cdb8fe4173d32438c7c0fab4f78b5852ec1a63654e3a1219b4889c43e931d00451a361d27924dc0978061035abd7d03322
-  data.tar.gz: 3f4f7e4bf61f827ff475d9f302f1b73cf1e43c9807ac5b6aaf364d27bbb774db066f7a7af28586aa29ea2365e2664c915944afcedc2d0a112587f1e1cf0efb8a
+  metadata.gz: 28ea491ac20cddb4b51f0c418c479ce7394d5839d05dfacd04cb5c128590b7d8100b232a60d4cfafc0110249ccbe001b1e9426632679df4dcf2f6dcdc9415121
+  data.tar.gz: 2f12577c68058fb20bbc10e64de84ce574d45e6d7c0c766907b4e4342054bc95f992a654b620ced49130379db66aa5b21425114d327a9332021f04b6544e094a

data/.ci/build.sh

@@ -1,67 +1,99 @@
 #!/usr/bin/env bash
 
-source $(dirname $0)/inc/install-openjdk.inc
-
+# Exit this script immediately if a command/function exits with a non-zero status.
 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
+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
 
-    # 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::"
+    # 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
-
 }
 
-## 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}
-}
+function isReleaseBuild() {
+    local version="$1"
 
+    if [[ "${version}" != *-SNAPSHOT && "${PMD_CI_TAG}" != "" ]]; then
+        return 0
+    fi
+
+    return 1
+}
 
-build_regression_tester
+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

@@ -1,20 +1,37 @@
 #!/usr/bin/env bash
 
-source $(dirname $0)/inc/install-openjdk.inc
-
+# Exit this script immediately if a command/function exits with a non-zero status.
 set -e
 
-echo "::group::Install OpenJDK 8+11"
-install_openjdk 8
-install_openjdk 11 # last one is the default
-echo "::endgroup::"
+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
 
-echo "::group::Install dependencies"
-gem install bundler
-bundle config set --local path vendor/bundle
-bundle install
-echo "::endgroup::"
+    pmd_ci_log_group_start "Run Manual Integration Tests"
+        bundle exec ruby -I test test/manual_integration_tests.rb
+    pmd_ci_log_group_end
+}
 
-echo "::group::Run Manual Integration Tests"
-bundle exec ruby -I test test/manual_integration_tests.rb
-echo "::endgroup::"
+build

data/.github/workflows/build.yml

@@ -2,11 +2,16 @@ name: build
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - main
+      - master
     tags:
       - '**'
   pull_request:
-    branches: [ master ]
+  schedule:
+    # build it monthly: At 04:30 on day-of-month 1.
+    - cron:  '30 4 1 * *'
+  workflow_dispatch:
 
 jobs:
   build:
@@ -21,19 +26,30 @@ jobs:
           ~/.m2/repository
           ~/.cache
           vendor/bundle
+          target/repositories
         key: ${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
         restore-keys: |
           ${{ runner.os }}-
-    - name: Set up Ruby
+    - 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:
-        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

@@ -14,19 +14,30 @@ jobs:
           ~/.m2/repository
           ~/.cache
           vendor/bundle
+          target/repositories
         key: ${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
         restore-keys: |
           ${{ runner.os }}-
-    - name: Set up Ruby
+    - 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:
-        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/.hoerc

@@ -1 +1 @@
-exclude: !ruby/regexp /tmp$|\.(git|idea)\/|\.project|target|test\/|Gemfile\.lock|\.bundle\/|vendor\/bundle|localtests/
+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

@@ -27,3 +27,6 @@ Metrics/ClassLength:
 Metrics/BlockLength:
   Exclude:
     - 'lib/pmdtester/parsers/options.rb'
+
+Metrics/ModuleLength:
+  CountAsOne: ['array', 'hash']

data/History.md

@@ -1,3 +1,15 @@
+# 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.

data/Manifest.txt

@@ -1,6 +1,5 @@
 .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
@@ -21,6 +20,7 @@ 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/liquid_renderer.rb
 lib/pmdtester/builders/pmd_report_builder.rb
@@ -58,3 +58,4 @@ resources/js/popper.min.js
 resources/js/project-report.js
 resources/project_diff_report.html
 resources/project_index.html
+resources/project_pmd_report.html

data/README.rdoc

@@ -20,29 +20,30 @@ 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
+    -pc, --patch-config         path to the patch PMD configuration file
+    -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
+    -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
-    --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
+    -t, --threads               Sets the number of threads used by PMD. Set threads to 0 to disable multi-threading processing.
+    -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
+    --filter-with-patch-config  whether to use patch config to filter baseline result as if --auto-gen-config has been used. This option only works in online 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
+    -v, --version               
+    -h, --help                  
 
 === Quick start
 
@@ -153,4 +154,5 @@ The tool creates the following folders:
 * Commit ("Prepare next development version x.y.z-SNAPSHOT").
 * Push to master.
 * Push the tag. Github Actions will build and publish the new gem
-* Update the release notes on https://github.com/pmd/pmd-regression-tester/releases
+* A github release is automatically created, verify it on https://github.com/pmd/pmd-regression-tester/releases
+* To make pmd's main CI use the new version (in [pmd/pmd](https://github.com/pmd/pmd/)), go to the root directory and run `bundle lock --update`. Commit these changes. 

data/config/project-list.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 
 <projectlist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-xsi:noNamespaceSchemaLocation="projectlist_1_0_0.xsd">
+xsi:noNamespaceSchemaLocation="projectlist_1_2_0.xsd">
   <description>Standard Projects</description>
 
   <project>
@@ -20,10 +20,11 @@ xsi:noNamespaceSchemaLocation="projectlist_1_0_0.xsd">
     <tag>v5.0.6.RELEASE</tag>
   </project>
 
-  <!---<project>
-    <name>openjdk10</name>
-    <type>hg</type>
-    <connection>http://hg.openjdk.java.net/jdk10/jdk10/jdk</connection>
-    <webview-url>http://hg.openjdk.java.net/jdk10/jdk10/jdk/file/777356696811</webview-url>
-  </project> -->
+  <project>
+    <name>openjdk-11</name>
+    <type>git</type>
+    <connection>https://github.com/openjdk/jdk</connection>
+    <tag>jdk-11+28</tag>
+    <src-subpath>src/java.base</src-subpath>
+  </project>
 </projectlist>