pmdtester 1.5.5 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05486a80b029d8a896b789ebb894077c36d6a0f99a651c0b1885a808f6219b8a'
-  data.tar.gz: b9a98daf20b7c036a26bea412563a9df771252b338cb7f805c4d42351627b458
+  metadata.gz: 8b44aeb9d29dbe2fe0f366e51fb5694be4c37c395e8390e8c4a95ef5b7a60a2e
+  data.tar.gz: ccc0f0d978c99a613d7c1172aad826f4373a4dc6c28b4f6043bc5f8553130984
 SHA512:
-  metadata.gz: efce54ae5e36f7853427a7ccc203346335f7811d3dddbe3ae5d0f558bff3eb7b1748952fbdd31046c251ea6cb55fac5b1a261fd674c4989b5a6d11e251c1872f
-  data.tar.gz: fc72dbd2b79ca40655eea0587f0cb6df1293b6634a9252e428af2dddbe0209f5e74dc2497dadca99687e6e332e495979d42288b100cd55f6b293096645e2f5f5
+  metadata.gz: f51981a21381f416629d5653864a6baeb6fe5d0af40d72f711d39a332471a4f117325399ac7895d3bd837cc23387c75d2613380481ecb3f45c9db30021e236f8
+  data.tar.gz: c5d40c071579c0b5335d6cea19c796b0f80cb3709fa46caad2f07ce99b623f2d108712a43dc8348e3e3e05a14027103ac356d49de1f82fe219cf41b3d987f557

data/.github/workflows/build-pr.yml

@@ -0,0 +1,11 @@
+name: Build Pull Request
+
+on:
+  pull_request:
+  merge_group:
+    types: [checks_requested]
+
+jobs:
+  build:
+    name: Build Pull Request
+    uses: ./.github/workflows/build.yml

data/.github/workflows/build-release.yml

@@ -0,0 +1,12 @@
+name: Build Release
+
+on:
+  push:
+    tags:
+      - '**'
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build Release
+    uses: ./.github/workflows/build.yml

data/.github/workflows/build-snapshot.yml

@@ -0,0 +1,17 @@
+name: Build Snapshot
+
+on:
+  push:
+    branches:
+      - '**'
+      # don't run on dependabot branches. Dependabot will create pull requests, which will then be run instead
+      - '!dependabot/**'
+  workflow_dispatch:
+  schedule:
+    # build it monthly: At 04:30 on day-of-month 1.
+    - cron:  '30 4 1 * *'
+
+jobs:
+  build:
+    name: Build Snapshot
+    uses: ./.github/workflows/build.yml

data/.github/workflows/build.yml

@@ -1,57 +1,65 @@
-name: build
+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:
+  workflow_call:
+
+# if another commit is added to the same branch or PR (same github.ref),
+# then cancel already running jobs and start a new build.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
+env:
+  LANG: 'en_US.UTF-8'
 
 jobs:
-  build:
-    timeout-minutes: 120
+  compile:
     runs-on: ubuntu-latest
-    continue-on-error: false
-    if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
+    timeout-minutes: 120
+    defaults:
+      run:
+        shell: bash
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/cache@v3
-      with:
-        path: |
-          ~/.m2/repository
-          ~/.cache
-          vendor/bundle
-          target/repositories
-        key: v3-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
-        restore-keys: |
-          v3-${{ 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/17/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 }}
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+      - name: Prepare HOME/openjdk11
+        run: ln -sfn "${JAVA_HOME_11_X64}" "${HOME}/openjdk11"
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.m2/repository
+            ~/.cache
+            ~/.gradle
+            vendor/bundle
+            target/repositories
+          key: v4-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
+          restore-keys: |
+            v4-${{ runner.os }}-
+      - name: Set up Ruby 3.3
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+      - name: Install dependencies (bundler)
+        run: |
+          # bundler should already be installed
+          bundle --version
+          bundle config set --local path vendor/bundle
+          bundle install
+      - name: Build with rake
+        run: |
+          bundle exec rake check_manifest
+          bundle exec rake rubocop
+          bundle exec rake clean test
+      - name: Run Integration Tests
+        run: |
+          bundle exec rake clean integration-test
+      - name: Build Package
+        run: |
+          bundle exec rake install_gem
+          bundle exec pmdtester -h

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

@@ -6,44 +6,46 @@ on:
     - cron:  '30 8 1 * *'
   workflow_dispatch:
 
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
+env:
+  LANG: 'en_US.UTF-8'
+
 jobs:
   build:
     timeout-minutes: 120
     runs-on: ubuntu-latest
     continue-on-error: false
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/cache@v3
-      with:
-        path: |
-          ~/.m2/repository
-          ~/.cache
-          vendor/bundle
-          target/repositories
-        key: v3-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
-        restore-keys: |
-          v3-${{ 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/17/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 }}
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+      - name: Prepare HOME/openjdk11
+        run: ln -sfn "${JAVA_HOME_11_X64}" "${HOME}/openjdk11"
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.m2/repository
+            ~/.cache
+            ~/.gradle
+            vendor/bundle
+            target/repositories
+          key: v4-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
+          restore-keys: |
+            v4-${{ runner.os }}-
+      - name: Set up Ruby 3.3
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+      - name: Install dependencies (bundler)
+        run: |
+          # bundler should already be installed
+          bundle --version
+          bundle config set --local path vendor/bundle
+          bundle install
+      - name: Run Manual Integration Tests
+        run: |
+          bundle exec ruby -I test test/manual_integration_tests.rb

data/.github/workflows/publish-release.yml

@@ -0,0 +1,140 @@
+name: Publish Release
+
+on:
+  workflow_run:
+    workflows: [Build Release]
+    types:
+      - completed
+    branches:
+      - '**'
+
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
+env:
+  LANG: 'en_US.UTF-8'
+
+jobs:
+  check-version:
+    # only run in the official pmd/pmd-regression-tester repo, where we have access to the secrets and not on forks
+    # and only run for _successful_ push workflow runs on tags "releases/**".
+    if: ${{ github.repository == 'pmd/pmd-regression-tester'
+      && contains(fromJSON('["push", "workflow_dispatch"]'), github.event.workflow_run.event)
+      && github.event.workflow_run.head_branch != 'main'
+      && github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    defaults:
+      run:
+        shell: bash
+    outputs:
+      VERSION: ${{ steps.version.outputs.VERSION }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.workflow_run.head_branch }}
+      - name: Set up Ruby 3.3
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+      - name: Install dependencies (bundler)
+        run: |
+          # bundler should already be installed
+          bundle --version
+          bundle config set --local path vendor/bundle
+          bundle install
+      - name: Determine Version
+        id: version
+        env:
+          REF: ${{ github.event.workflow_run.head_branch }}
+        run: |
+          if ! git show-ref --exists "refs/tags/$REF"; then
+            echo "::error ::Tag $REF does not exist, aborting."
+            exit 1
+          fi
+          
+          VERSION="$(bundle exec ruby -I. -e 'require "lib/pmdtester"; print PmdTester::VERSION;')"
+          echo "Determined VERSION=$VERSION"
+          if [[ "$VERSION" = *-SNAPSHOT ]]; then
+            echo "::error ::VERSION=$VERSION is a snapshot version, aborting."
+            exit 1
+          fi
+          echo "VERSION=$VERSION" >> "$GITHUB_OUTPUT"
+      - name: Add Job Summary
+        env:
+          WORKFLOW_RUN_DISPLAY_TITLE: ${{ github.event.workflow_run.display_title }}
+          WORKFLOW_RUN_NAME: ${{ github.event.workflow_run.name }}
+          WORKFLOW_RUN_NUMBER: ${{ github.event.workflow_run.run_number }}
+          WORKFLOW_RUN_HTML_URL: ${{ github.event.workflow_run.html_url }}
+          VERSION: ${{ steps.version.outputs.VERSION }}
+          TAG: ${{ github.event.workflow_run.head_branch }}
+        run: |
+          echo "### Run Info" >> "${GITHUB_STEP_SUMMARY}"
+          echo "Building Version: ${VERSION}" >> "${GITHUB_STEP_SUMMARY}"
+          echo "" >> "${GITHUB_STEP_SUMMARY}"
+          echo "Tag: ${TAG}" >> "${GITHUB_STEP_SUMMARY}"
+          echo "" >> "${GITHUB_STEP_SUMMARY}"
+          echo "Called by [${WORKFLOW_RUN_DISPLAY_TITLE} (${WORKFLOW_RUN_NAME} #${WORKFLOW_RUN_NUMBER})](${WORKFLOW_RUN_HTML_URL})" >> "${GITHUB_STEP_SUMMARY}"
+          echo "" >> "${GITHUB_STEP_SUMMARY}"
+
+  publish-to-rubygems:
+    needs: check-version
+    # use environment rubygems, where secrets are configured for GEM_HOST_API_KEY
+    environment:
+      name: rubygems
+      url: https://rubygems.org/gems/pmdtester
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to create a release (via gh cli)
+    timeout-minutes: 20
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Set up Ruby 3.3
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+      - name: Install dependencies (bundler)
+        run: |
+          # bundler should already be installed
+          bundle --version
+          bundle config set --local path vendor/bundle
+          bundle install
+      - name: Build with rake
+        run: |
+          bundle exec rake check_manifest
+          bundle exec rake rubocop
+          bundle exec rake clean test
+      - name: Build Package
+        run: |
+          bundle exec rake install_gem
+      - name: Publish to rubygems
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+        run: |
+          gem build pmdtester.gemspec
+          gempkgfile="$(echo pmdtester-*.gem)"
+          gem push "${gempkgfile}"
+      - name: Create GitHub Release
+        env:
+          # Token required for GH CLI:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TAG_NAME: ${{ github.event.workflow_run.head_branch }}
+          VERSION: ${{ needs.check-version.outputs.VERSION }}
+        run: |
+          # 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)))"
+          echo "${RELEASE_BODY}" > release_notes.md
+
+          gempkgfile="$(echo pmdtester-*.gem)"
+
+          gh release create "$TAG_NAME" "${gempkgfile}" \
+              --verify-tag \
+              --notes-file release_notes.md \
+              --title "$RELEASE_NAME"

data/.rubocop.yml

@@ -2,6 +2,7 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   TargetRubyVersion: 2.7
+  NewCops: enable
   Include:
     - 'lib/**/*'
     - 'test/**/*'
@@ -13,7 +14,7 @@ AllCops:
     - 'test/resources/**/*'
     - 'vendor/**/*'
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:

data/.rubocop_todo.yml

@@ -1,22 +1,26 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-11-25 11:00:37 +0100 using RuboCop version 0.51.0.
+# on 2024-02-14 19:42:22 UTC using RuboCop version 1.60.2.
 # 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: 30
-Metrics/AbcSize:
-  Max: 47
+# Offense count: 3
+# Configuration parameters: AllowedParentClasses.
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/pmdtester/cmd.rb'
+    - 'lib/pmdtester/parsers/pmd_report_document.rb'
+    - 'lib/pmdtester/parsers/projects_parser.rb'
 
-# Offense count: 6
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 135
+# Offense count: 47
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 44
 
-# Offense count: 38
-# Configuration parameters: CountComments.
+# Offense count: 93
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 22
 
@@ -24,3 +28,61 @@ Metrics/MethodLength:
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/pmdtester/builders/pmd_report_builder.rb'
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
+Naming/VariableNumber:
+  Exclude:
+    - 'test/test_cmd.rb'
+
+# Offense count: 52
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: separated, grouped
+Style/AccessorGrouping:
+  Exclude:
+    - 'lib/pmdtester/cmd.rb'
+    - 'lib/pmdtester/parsers/options.rb'
+    - 'lib/pmdtester/parsers/pmd_report_document.rb'
+    - 'lib/pmdtester/pmd_branch_detail.rb'
+    - 'lib/pmdtester/pmd_report_detail.rb'
+    - 'lib/pmdtester/project.rb'
+    - 'lib/pmdtester/report_diff.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Keywords, RequireColon.
+# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW, NOTE
+Style/CommentAnnotation:
+  Exclude:
+    - 'lib/pmdtester/builders/pmd_report_builder.rb'
+    - 'lib/pmdtester/builders/project_builder.rb'
+    - 'test/test_pmd_report_document.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/GlobalStdStream:
+  Exclude:
+    - 'lib/pmdtester.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowedReceivers.
+# AllowedReceivers: Thread.current
+Style/HashEachMethods:
+  Exclude:
+    - 'lib/pmdtester/report_diff.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+Style/KeywordParametersOrder:
+  Exclude:
+    - 'lib/pmdtester/pmd_report_detail.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantAssignment:
+  Exclude:
+    - 'lib/pmdtester/builders/pmd_report_builder.rb'

data/History.md

@@ -1,3 +1,42 @@
+# 1.6.0 / 2025-07-25
+
+## New and Noteworthy
+
+### New Git default branch - "main"
+
+We are joining the Git community and updating "master" to "main". Using the term "master" for the main
+development branch can be offensive to some people. Existing versions of Git have been always capable of
+working with any branch name and since 2.28.0 (July 2020) the default initial branch is configurable
+(`init.defaultBranch`). Since October 2020, the default branch for new repositories on GitHub
+is "main". Finally, PMD will also use this new name for the main branch in all our own repositories.
+
+Note: The regression tester will also use branch `main` by default now for fetching repositories from the list of
+projects. You might need to add `<tag>master</tag>` for some projects.
+
+### Required Ruby version
+
+With this version, Ruby 3.3 or higher is required.
+
+## Enhancements
+* [#123](https://github.com/pmd/pmd-regression-tester/pull/123): Support ruby 3.3.0
+* [#125](https://github.com/pmd/pmd-regression-tester/pull/125): Update rubocop configuration
+
+## Fixed Issues
+* [#126](https://github.com/pmd/pmd-regression-tester/pull/126): Fix integration tests
+* [#127](https://github.com/pmd/pmd-regression-tester/pull/127): Fix manual integration tests
+* [#129](https://github.com/pmd/pmd-regression-tester/pull/129): Update manual integration tests
+* [#131](https://github.com/pmd/pmd-regression-tester/pull/131): Refactor GitHub Actions Workflows
+* [#132](https://github.com/pmd/pmd-regression-tester/pull/132): Fix manual integration test - Update expected_patch_config_3.xml: no more plsql exclusion
+* [#133](https://github.com/pmd/pmd-regression-tester/pull/133): \[ci] Make build a reuseable workflow
+* [#134](https://github.com/pmd/pmd-regression-tester/pull/134): Fix missing violations in diff report
+* [#136](https://github.com/pmd/pmd-regression-tester/pull/136): Fix integration tests - missing pmd-core:jar:tests
+
+## Dependency Updates
+* [#130](https://github.com/pmd/pmd-regression-tester/pull/130): Update gems and required ruby version
+* [#135](https://github.com/pmd/pmd-regression-tester/pull/135): Bump rubocop 1.79
+
+## External Contributions
+
 # 1.5.5 / 2023-11-16
 
 ## Fixed Issues

data/Manifest.txt

@@ -1,13 +1,13 @@
-.ci/build.sh
-.ci/inc/fetch_ci_scripts.bash
-.ci/manual-integration-tests.sh
+.github/workflows/build-pr.yml
+.github/workflows/build-release.yml
+.github/workflows/build-snapshot.yml
 .github/workflows/build.yml
 .github/workflows/manual-integration-tests.yml
+.github/workflows/publish-release.yml
 .gitignore
 .hoerc
 .rubocop.yml
 .rubocop_todo.yml
-.ruby-version
 Gemfile
 History.md
 LICENSE
@@ -57,6 +57,7 @@ resources/js/datatables.min.js
 resources/js/jquery-3.6.4.slim.min.js
 resources/js/popper-2.11.7.min.js
 resources/js/project-report.js
+resources/maven-settings.xml
 resources/project_diff_report.html
 resources/project_index.html
 resources/project_pmd_report.html