phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' into pr-4973

Browse Source
This commit is contained in:
Andreas Dangel
2024-05-02 10:20:28 +02:00
parent b70521874a 22a31c938d
commit c476f4c06c
100 changed files with 2163 additions and 1593 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
.all-contributorsrc
View File

@ -7462,6 +7462,78 @@
"contributions": [
"bug"
]
},
{
"login": "BurovnikovEvgeniy",
"name": "BurovnikovEvgeniy",
"avatar_url": "https://avatars.githubusercontent.com/u/71849985?v=4",
"profile": "https://github.com/BurovnikovEvgeniy",
"contributions": [
"bug"
]
},
{
"login": "kohlschuetter",
"name": "Dr. Christian Kohlschütter",
"avatar_url": "https://avatars.githubusercontent.com/u/822690?v=4",
"profile": "https://kohlschuetter.github.io/blog/",
"contributions": [
"bug"
]
},
{
"login": "Luro02",
"name": "Lucas",
"avatar_url": "https://avatars.githubusercontent.com/u/24826124?v=4",
"profile": "https://github.com/Luro02",
"contributions": [
"bug"
]
},
{
"login": "rs23",
"name": "Reinhard Schiedermeier",
"avatar_url": "https://avatars.githubusercontent.com/u/12321337?v=4",
"profile": "http://sol.cs.hm.edu/rs",
"contributions": [
"bug"
]
},
{
"login": "andygoossens",
"name": "Andy Goossens",
"avatar_url": "https://avatars.githubusercontent.com/u/2099087?v=4",
"profile": "https://github.com/andygoossens",
"contributions": [
"bug"
]
},
{
"login": "mitchspano",
"name": "Mitch Spano",
"avatar_url": "https://avatars.githubusercontent.com/u/18402464?v=4",
"profile": "https://github.com/mitchspano",
"contributions": [
"bug"
]
},
{
"login": "mfvanek",
"name": "Ivan Vakhrushev",
"avatar_url": "https://avatars.githubusercontent.com/u/37612014?v=4",
"profile": "https://www.linkedin.com/in/mfvanek/",
"contributions": [
"bug"
]
},
{
"login": "VishV-Android",
"name": "Vishv_Android",
"avatar_url": "https://avatars.githubusercontent.com/u/126696109?v=4",
"profile": "https://github.com/VishV-Android",
"contributions": [
"bug"
]
}
],
"contributorsPerLine": 7,

4
.github/workflows/build.yml vendored
View File

@ -48,6 +48,8 @@ jobs:
~/.cache
~/work/pmd/target/repositories
vendor/bundle
# avoid caching missed dependencies
!~/.m2/repository/**/*.lastUpdated
key: v3-${{ runner.os }}-${{ hashFiles('**/pom.xml') }}
restore-keys: |
v3-${{ runner.os }}-
@ -60,7 +62,7 @@ jobs:
run: |
echo "LANG=en_US.UTF-8" >> $GITHUB_ENV
echo "MAVEN_OPTS=-Daether.connector.http.connectionMaxTtl=180 -DautoReleaseAfterClose=true -DstagingProgressTimeoutMinutes=30" >> $GITHUB_ENV
echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/master/scripts" >> $GITHUB_ENV
echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/24/scripts" >> $GITHUB_ENV
- name: Check Environment
shell: bash
run: |

2
.github/workflows/git-repo-sync.yml vendored
View File

@ -24,7 +24,7 @@ jobs:
shell: bash
run: |
echo "LANG=en_US.UTF-8" >> $GITHUB_ENV
echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/master/scripts" >> $GITHUB_ENV
echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/24/scripts" >> $GITHUB_ENV
- name: Sync
run: .ci/git-repo-sync.sh
shell: bash

2
.github/workflows/troubleshooting.yml vendored
View File

@ -36,7 +36,7 @@ jobs:
run: |
echo "LANG=en_US.UTF-8" >> $GITHUB_ENV
echo "MAVEN_OPTS=-Daether.connector.http.connectionMaxTtl=180 -DstagingProgressTimeoutMinutes=30" >> $GITHUB_ENV
echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/master/scripts" >> $GITHUB_ENV
echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/24/scripts" >> $GITHUB_ENV
- name: Check Environment
shell: bash
run: |

6
Dangerfile
View File

@ -44,7 +44,7 @@ def run_pmdtester
@base_branch = 'master'
@logger.info "\n\n--------------------------------------"
@logger.info "Run against #{@base_branch}"
@summary = PmdTester::Runner.new(get_args(@base_branch, FALSE, 'target/diff1/patch_config.xml')).run
@summary = PmdTester::Runner.new(get_args(@base_branch, false, 'target/diff1/patch_config.xml')).run
# move the generated report out of the way
FileUtils.mv 'target/reports/diff', 'target/diff2'
@ -53,12 +53,12 @@ def run_pmdtester
tar_report
message1 += "[Download full report as build artifact](#{ENV['PMD_CI_JOB_URL']})"
message1 += "[Download full report as build artifact](#{ENV['PMD_CI_JOB_URL']}?pr=#{ENV['PMD_CI_PULL_REQUEST_NUMBER']})"
# set value of sticky to true and the message is kept after new commits are submitted to the PR
message(message1, sticky: true)
if message2
message2 += "[Download full report as build artifact](#{ENV['PMD_CI_JOB_URL']})"
message2 += "[Download full report as build artifact](#{ENV['PMD_CI_JOB_URL']}?pr=#{ENV['PMD_CI_PULL_REQUEST_NUMBER']})"
# set value of sticky to true and the message is kept after new commits are submitted to the PR
message(message2, sticky: true)
end

6
do-release.sh
View File

@ -204,6 +204,7 @@ echo
echo "Tag has been pushed.... now check github actions: <https://github.com/pmd/pmd/actions>"
echo
echo "Now wait, until first stage of the release is finished successfully..."
echo "You don't need to wait until artifacts are in maven central, just the github action must be successful."
echo
echo "If it is failing, you can fix the code/scripts and force push the tag via"
echo
@ -245,9 +246,6 @@ ${NEW_RELEASE_NOTES}
${OLD_RELEASE_NOTES}" > docs/pages/release_notes_old.md
# update release_notes_pmd7 with prerendered version (jdoc tags are replaced with released version)
echo "$RELEASE_NOTES_PMD7" > docs/pages/release_notes_pmd7.md
# reset release notes template
cat > docs/pages/release_notes.md <<EOF
---
@ -348,6 +346,8 @@ tweet="${tweet//$'\r'/}"
tweet="${tweet//$'\n'/%0A}"
echo "* Tweet about this release on https://twitter.com/pmd_analyzer:"
echo " <https://twitter.com/intent/tweet?text=$tweet>"
echo "* Post this also into <https://matrix.to/#/#pmd_pmd:gitter.im>:"
echo " PMD ${RELEASE_VERSION} released: https://github.com/pmd/pmd/releases/tag/pmd_releases/${RELEASE_VERSION} #PMD"
echo
echo
echo "Now waiting for the release to be finished..."

6
docs/_config.yml
View File

@ -1,9 +1,9 @@
repository: pmd/pmd
pmd:
version: 7.1.0-SNAPSHOT
previous_version: 7.0.0
date: 26-April-2024
version: 7.2.0-SNAPSHOT
previous_version: 7.1.0
date: 31-May-2024
release_type: minor
# release types: major, minor, bugfix

77
docs/pages/pmd/projectdocs/committers/releasing.md
View File

@ -2,7 +2,7 @@
title: Release process
permalink: pmd_projectdocs_committers_releasing.html
author: Romain Pelisse <rpelisse@users.sourceforge.net>, Andreas Dangel <andreas.dangel@pmd-code.org>
last_updated: April 2021
last_updated: April 2024
---
This page describes the current status of the release process.
@ -72,13 +72,13 @@ in order to release version "6.34.0", the configuration should look like this:
```yaml
pmd:
version: 6.34.0
previous_version: 6.33.0
date: 24-April-2021
version: 7.2.0
previous_version: 7.1.0
date: 31-May-2024
release_type: minor
```
The release type could be one of "bugfix" (e.g. 6.34.x), "minor" (6.x.0), or "major" (x.0.0).
The release type could be one of "bugfix" (e.g. 7.1.x), "minor" (7.x.0), or "major" (x.0.0).
The release notes usually mention any new rules that have been added since the last release.
@ -88,7 +88,7 @@ Add the new rules as comments to the quickstart rulesets:
The designer lives at [pmd/pmd-designer](https://github.com/pmd/pmd-designer).
Update property `pmd-designer.version` in **pom.xml** to reference the new version, that will be released
shortly. Note: This version does at the moment not exist. That means, that a full build of the sources
shortly. Note: This new version does at the moment not exist. That means, that a full build of the sources
will currently fail. That's why the first phase of the release will build only pmd-core and languages but
not pmd-cli and pmd-dist.
@ -97,13 +97,14 @@ Then we can skip the release of pmd-designer and immediately start the second ph
Starting with PMD 6.23.0 we'll provide small statistics for every release. This needs to be added
to the release notes as the last section. To count the closed issues and pull requests, the milestone
on GitHub with the title of the new release is searched. Make sure, there is a milestone
on <https://github.com/pmd/pmd/milestones>. The following snippet will
on GitHub with the title of the new release is searched. It is important, that the due date of the milestone
is correctly set, as the returned milestones in the API call are sorted by due date.
Make sure, there is such a milestone on <https://github.com/pmd/pmd/milestones>. The following snippet will
create the numbers, that can be attached to the release notes as a last section:
```shell
LAST_VERSION=6.33.0
NEW_VERSION=6.34.0
LAST_VERSION=7.1.0
NEW_VERSION=7.2.0
NEW_VERSION_COMMITISH=HEAD
echo "### Stats"
@ -129,14 +130,14 @@ The new version needs to be entered into `_config.yml`, e.g.:
```yaml
pmd:
latestVersion: 6.34.0
latestVersionDate: 24-April-2021
latestVersion: 7.2.0
latestVersionDate: 31-May-2024
```
Also move the previous version down into the "downloads" section. We usually keep only the last 3 versions
in this list, so remove the oldest version.
Then create a new page for the new release, e.g. `_posts/2021-04-24-PMD-6.34.0.md` and copy
Then create a new page for the new release, e.g. `_posts/2024-05-31-PMD-7.2.0.md` and copy
the release notes into this page. This will appear under the news section.
Note: The release notes typically contain some Jekyll macros for linking to the rule pages. These macros won't
@ -164,7 +165,7 @@ Check in all (version, blog post) changes to branch master:
The actual release is done by changing the versions, creating a tag and pushing this tag. Previously this was done
by calling _maven-release-plugin_, but these steps are done without the plugin to have more control. And since we
might reference a not yet released pmd-designer version, the test-build will fail.
might reference a not yet released pmd-designer version, the test-build would fail.
We first change the version of PMD and all modules by basically removing the "-SNAPSHOT" suffix, building the changed
project locally with tests (and with skipping pmd-cli and pmd-dist) in order to be sure, everything is in working
@ -176,8 +177,8 @@ next snapshot version after the release. Skipping the builds of pmd-cli and pmd-
the property `skip-cli-dist`.
```shell
RELEASE_VERSION=6.34.0
DEVELOPMENT_VERSION=6.35.0-SNAPSHOT
RELEASE_VERSION=7.2.0
DEVELOPMENT_VERSION=7.3.0-SNAPSHOT
# Change version in the POMs to ${RELEASE_VERSION} and update build timestamp
./mvnw --quiet versions:set -DnewVersion="${RELEASE_VERSION}" -DgenerateBackupPoms=false -DupdateBuildOutputTimestampPolicy=always
# Transform the SCM information in the POM
@ -218,18 +219,18 @@ Here is, what happens:
* Render the documentation in `docs/` with `bundle exec jekyll build` and create a zip file from it.
* Upload the doc zip file to the current (draft) GitHub Release under <https://github.com/pmd/pmd/releases> and
to <https://sourceforge.net/projects/pmd/files/pmd/>.
* Upload the documentation to <https://docs.pmd-code.org>, e.g. <https://docs.pmd-code.org/pmd-doc-6.34.0/> and
* Upload the documentation to <https://docs.pmd-code.org>, e.g. <https://docs.pmd-code.org/pmd-doc-7.2.0/> and
create a symlink, so that <https://docs.pmd-code.org/latest/> points to the new version.
* Remove the old snapshot documentation, e.g. so that <https://docs.pmd-code.org/pmd-doc-6.34.0-SNAPSHOT/> is gone.
Also create a symlink from pmd-doc-6.34.0-SNAPSHOT to pmd-doc-6.34.0, so that old references still work, e.g.
<https://docs.pmd-code.org/pmd-doc-6.34.0-SNAPSHOT/> points to the released version.
* Remove the old snapshot documentation, e.g. so that <https://docs.pmd-code.org/pmd-doc-7.2.0-SNAPSHOT/> is gone.
Also create a symlink from pmd-doc-7.2.0-SNAPSHOT to pmd-doc-7.2.0, so that old references still work, e.g.
<https://docs.pmd-code.org/pmd-doc-7.2.0-SNAPSHOT/> points to the released version.
* Deploy javadoc to "https://docs.pmd-code.org/apidocs/*/RELEASE_VERSION/", e.g.
<https://docs.pmd-code.org/apidocs/pmd-core/6.34.0/>. This is done for all modules.
* Remove old javadoc for the SNAPSHOT version, e.g. delete <https://docs.pmd-code.org/apidocs/pmd-core/6.34.0-SNAPSHOT/>.
<https://docs.pmd-code.org/apidocs/pmd-core/7.2.0/>. This is done for all modules.
* Remove old javadoc for the SNAPSHOT version, e.g. delete <https://docs.pmd-code.org/apidocs/pmd-core/7.2.0-SNAPSHOT/>.
* Create a draft news post on <https://sourceforge.net/p/pmd/news/> for the new release. This contains the
rendered release notes.
* Copy the documentation to sourceforge's web space, so that it is available as
<https://pmd.sourceforge.io/pmd-6.34.0/>. All previously copied versions are listed
<https://pmd.sourceforge.io/pmd-7.2.0/>. All previously copied versions are listed
under <https://pmd.sourceforge.io/archive.phtml>.
The release on GitHub Actions currently takes about 30-45 minutes. Once this is done, you
@ -271,6 +272,7 @@ Tweet on <https://twitter.com/pmd_analyzer>, eg.:
PMD 6.34.0 released: https://github.com/pmd/pmd/releases/tag/pmd_releases/6.34.0 #PMD
* Post the same twitter message into the gitter chat at <https://matrix.to/#/#pmd_pmd:gitter.im>
### Checklist
@ -289,6 +291,7 @@ Tweet on <https://twitter.com/pmd_analyzer>, eg.:
| regression-tester | New release baseline is uploaded | <https://pmd-code.org/pmd-regression-tester> | <input type="checkbox"> |
| mailing list | announcement on mailing list is sent | <https://sourceforge.net/p/pmd/mailman/pmd-devel/> | <input type="checkbox"> |
| twitter | tweet about the new release | <https://twitter.com/pmd_analyzer> | <input type="checkbox"> |
| gitter | message about the new release | <https://matrix.to/#/#pmd_pmd:gitter.im> | <input type="checkbox"> |
## Prepare the next release
@ -302,9 +305,9 @@ There are a couple of manual steps needed to prepare the current main branch for
```yaml
pmd:
version: 6.35.0-SNAPSHOT
previous_version: 6.34.0
date: ??-??-2021
version: 7.3.0-SNAPSHOT
previous_version: 7.2.0
date: ??-??-2024
release_type: minor
```
@ -329,13 +332,13 @@ This is a {{ site.pmd.release_type }} release.
{% tocmaker %}
### New and noteworthy
### 🚀 New and noteworthy
### Fixed Issues
### 🐛 Fixed Issues
### API Changes
### 🚨 API Changes
### External Contributions
### ✨ External Contributions
{% endtocmaker %}
@ -368,15 +371,11 @@ from there. Then merge into the `master` branch and release from there. This way
automatically the latest release on <https://docs.pmd-code.org/latest/> and on sourceforge.
### (Optional) Create a new release branch
### (Optional) Create a new maintenance branch
At some point, it might be time for a new maintenance branch. Such a branch is usually created from
the `master` branch. Here are the steps:
the tag. Here are the steps:
* Create a new branch: `git branch pmd/5.6.x master`
* Update the version in both the new branch and master, e.g. `mvn versions:set -DnewVersion=5.6.1-SNAPSHOT`
and `mvn versions:set -DnewVersion=5.7.0-SNAPSHOT`.
* Update the release notes on both the new branch and master
The maintenance or bugfix branch could also be created later when needed from the actual tag. Then only the version on
the maintenance branch needs to be set.
* Create a new branch: `git branch pmd/7.1.x pmd_releases/7.1.0`
* Update the version in both the new branch, e.g. `mvn versions:set -DnewVersion=7.1.1-SNAPSHOT`.
* Update the release notes on both the new branch

282
docs/pages/pmd/projectdocs/credits.md
View File

File diff suppressed because it is too large Load Diff

80
docs/pages/release_notes.md
View File

@ -14,87 +14,19 @@ This is a {{ site.pmd.release_type }} release.
### 🚀 New and noteworthy
#### More robust CPD reports
There were a number of circumstances, specially around (but not limited to) literal sequences, were CPD would report duplicate overlapping or partially overlapping matches. These have now been fixed, and CPD will report only the longest non-overlapping duplicate.
These improvements apply to all supported languages, irrespective of supported flags.
### ✨ New rules
- The new Java rule {%rule java/bestpractices/UnnecessaryVarargsArrayCreation %} reports explicit array creation
when a varargs is expected. This is more heavy to read and could be simplified.
- The new Java rule {% rule "java/codestyle/LambdaCanBeMethodReference" %} reports lambda expressions that can be replaced
with a method reference. Please read the documentation of the rule for more info. This rule is now part of the Quickstart
ruleset.
### 🌟 Rule Changes
* {%rule java/bestpractices/JUnitTestsShouldIncludeAssert %} and {% rule java/bestpractices/JUnitTestContainsTooManyAsserts %}
have a new property named `extraAssertMethodNames`. With this property, you can configure which additional static
methods should be considered as valid verification methods. This allows to use custom mocking or assertion libraries.
### 🐛 Fixed Issues
* core
* [#494](https://github.com/pmd/pmd/issues/494): \[core] Adopt JApiCmp to enforce control over API changes
* [#4942](https://github.com/pmd/pmd/issues/4942): \[core] CPD: `--skip-duplicate-files` has no effect (7.0.0 regression)
* [#4959](https://github.com/pmd/pmd/pull/4959): \[core] Upgrade saxon to 12.4
* cli
* [#4791](https://github.com/pmd/pmd/issues/4791): \[cli] Could not find or load main class
* [#4913](https://github.com/pmd/pmd/issues/4913): \[cli] cpd-gui closes immediately
* doc
* [#4901](https://github.com/pmd/pmd/issues/4901): \[doc] Improve documentation on usage of violationSuppressXPath
* apex
* [#4418](https://github.com/pmd/pmd/issues/4418): \[apex] ASTAnnotation.getImage() does not return value as written in the class
* apex-errorprone
* [#3953](https://github.com/pmd/pmd/issues/3953): \[apex] EmptyCatchBlock false positive with formal (doc) comments
* cpp
* [#2438](https://github.com/pmd/pmd/issues/2438): \[cpp] Repeated Duplication blocks
* java
* [#4899](https://github.com/pmd/pmd/issues/4899): \[java] Parsing failed in ParseLock#doParse() java.io.IOException: Stream closed
* [#4902](https://github.com/pmd/pmd/issues/4902): \[java] "Bad intersection, unrelated class types" for Constable\[] and Enum\[]
* [#4947](https://github.com/pmd/pmd/issues/4947): \[java] Broken TextBlock parser
* [#4978](https://github.com/pmd/pmd/issues/4978): \[core] Referenced Rulesets do not emit details on validation errors
* java-bestpractices
* [#1084](https://github.com/pmd/pmd/issues/1084): \[java] Allow JUnitTestsShouldIncludeAssert to configure verification methods
* [#3216](https://github.com/pmd/pmd/issues/3216): \[java] New rule: UnnecessaryVarargsArrayCreation
* [#4435](https://github.com/pmd/pmd/issues/4435): \[java] \[7.0-rc1] UnusedAssignment for used field
* [#4569](https://github.com/pmd/pmd/issues/4569): \[java] ForLoopCanBeForeach reports on loop `for (int i = 0; i < list.size(); i += 2)`
* [#4618](https://github.com/pmd/pmd/issues/4618): \[java] UnusedAssignment false positive with conditional assignments of fields
* java-codestyle
* [#4602](https://github.com/pmd/pmd/issues/4602): \[java] UnnecessaryImport: false positives with static imports
* [#4785](https://github.com/pmd/pmd/issues/4785): \[java] False Positive: PMD Incorrectly report violation for UnnecessaryImport
* [#4779](https://github.com/pmd/pmd/issues/4779): \[java] Examples in documentation of MethodArgumentCanBeFinal do not trigger the rule
* [#4881](https://github.com/pmd/pmd/issues/4881): \[java] ClassNamingConventions: interfaces are identified as abstract classes (regression in 7.0.0)
* java-design
* [#2440](https://github.com/pmd/pmd/issues/2440): \[java] FinalFieldCouldBeStatic FN when the right side of the assignment is a constant expression
* [#3694](https://github.com/pmd/pmd/issues/3694): \[java] SingularField ignores static variables
* [#4873](https://github.com/pmd/pmd/issues/4873): \[java] AvoidCatchingGenericException: Can no longer suppress on the exception itself
* java-errorprone
* [#2056](https://github.com/pmd/pmd/issues/2056): \[java] CloseResource false-positive with URLClassLoader in cast expression
* [#4751](https://github.com/pmd/pmd/issues/4751): \[java] PMD crashes when analyzing CloseResource Rule
* [#4928](https://github.com/pmd/pmd/issues/4928): \[java] EmptyCatchBlock false negative when allowCommentedBlocks=true
* [#4948](https://github.com/pmd/pmd/issues/4948): \[java] ImplicitSwitchFallThrough: False-positive with nested switch statements
* java-performance
* [#3845](https://github.com/pmd/pmd/issues/3845): \[java] InsufficientStringBufferDeclaration should consider literal expression
* [#4874](https://github.com/pmd/pmd/issues/4874): \[java] StringInstantiation: False-positive when using `new String(charArray)`
* [#4886](https://github.com/pmd/pmd/issues/4886): \[java] BigIntegerInstantiation: False Positive with Java 17 and BigDecimal.TWO
* pom-errorprone
* [#4388](https://github.com/pmd/pmd/issues/4388): \[pom] InvalidDependencyTypes doesn't consider dependencies at all
* misc
* [#4967](https://github.com/pmd/pmd/pull/4967): Fix reproducible build issues with 7.0.0
* [#4278](https://github.com/pmd/pmd/issues/4278): \[java] UnusedPrivateMethod FP with Junit 5 @MethodSource and default factory method name
* [#4852](https://github.com/pmd/pmd/issues/4852): \[java] ReplaceVectorWithList false-positive (neither Vector nor List usage)
* [#4975](https://github.com/pmd/pmd/issues/4975): \[java] UnusedPrivateMethod false positive when using @MethodSource on a @Nested test
* [#4985](https://github.com/pmd/pmd/issues/4985): \[java] UnusedPrivateMethod false-positive / method reference in combination with custom object
### 🚨 API Changes
#### Deprecated methods
* {% jdoc java::lang.java.ast.ASTLambdaExpression#getBlock() %} and {% jdoc java::lang.java.ast.ASTLambdaExpression#getExpression() %}
* {%jdoc java::lang.java.rule.design.SingularFieldRule#mayBeSingular(java::lang.java.ast.ModifierOwner) %} has been deprecated for
removal. The method is only useful for the rule itself and shouldn't be used otherwise.
### ✨ External Contributions
* [#4864](https://github.com/pmd/pmd/pull/4864): Fix #1084 \[Java] add extra assert method names to Junit rules - [Erwan Moutymbo](https://github.com/emouty) (@emouty)
* [#4894](https://github.com/pmd/pmd/pull/4894): Fix #4791 Error caused by space in JDK path - [Scrates1](https://github.com/Scrates1) (@Scrates1)
{% endtocmaker %}

107
docs/pages/release_notes_old.md
View File

@ -5,6 +5,113 @@ permalink: pmd_release_notes_old.html
Previous versions of PMD can be downloaded here: [Releases - pmd/pmd (GitHub)](https://github.com/pmd/pmd/releases)
## 26-April-2024 - 7.1.0
The PMD team is pleased to announce PMD 7.1.0.
This is a minor release.
### Table Of Contents
* [🚀 New and noteworthy](#new-and-noteworthy)
* [More robust CPD reports](#more-robust-cpd-reports)
* [✨ New Rules](#new-rules)
* [🌟 Rule Changes](#rule-changes)
* [🐛 Fixed Issues](#fixed-issues)
* [🚨 API Changes](#api-changes)
* [Deprecated methods](#deprecated-methods)
* [✨ External Contributions](#external-contributions)
* [📈 Stats](#stats)
### 🚀 New and noteworthy
#### More robust CPD reports
There were a number of circumstances, specially around (but not limited to) literal sequences, were CPD would
report duplicate overlapping or partially overlapping matches. These have now been fixed, and CPD will report
only the longest non-overlapping duplicate.
These improvements apply to all supported languages, irrespective of supported flags.
#### ✨ New Rules
- The new Java rule [`UnnecessaryVarargsArrayCreation`](https://docs.pmd-code.org/pmd-doc-7.1.0/pmd_rules_java_bestpractices.html#unnecessaryvarargsarraycreation) reports explicit array creation
when a varargs is expected. This is more heavy to read and could be simplified.
- The new Java rule [`ConfusingArgumentToVarargsMethod`](https://docs.pmd-code.org/pmd-doc-7.1.0/pmd_rules_java_errorprone.html#confusingargumenttovarargsmethod) reports some confusing situations
where a varargs method is called with an inexact argument type. These may end up in a mismatch between the expected
parameter type and the actual value.
- The new Java rule [`LambdaCanBeMethodReference`](https://docs.pmd-code.org/pmd-doc-7.1.0/pmd_rules_java_codestyle.html#lambdacanbemethodreference) reports lambda expressions that can be replaced
with a method reference. Please read the documentation of the rule for more info. This rule is now part of the Quickstart
ruleset.
#### 🌟 Rule Changes
* [`JUnitTestsShouldIncludeAssert`](https://docs.pmd-code.org/pmd-doc-7.1.0/pmd_rules_java_bestpractices.html#junittestsshouldincludeassert) and [`JUnitTestContainsTooManyAsserts`](https://docs.pmd-code.org/pmd-doc-7.1.0/pmd_rules_java_bestpractices.html#junittestcontainstoomanyasserts)
have a new property named `extraAssertMethodNames`. With this property, you can configure which additional static
methods should be considered as valid verification methods. This allows to use custom mocking or assertion libraries.
### 🐛 Fixed Issues
* core
* [#494](https://github.com/pmd/pmd/issues/494): \[core] Adopt JApiCmp to enforce control over API changes
* [#4942](https://github.com/pmd/pmd/issues/4942): \[core] CPD: `--skip-duplicate-files` has no effect (7.0.0 regression)
* [#4959](https://github.com/pmd/pmd/pull/4959): \[core] Upgrade saxon to 12.4
* cli
* [#4791](https://github.com/pmd/pmd/issues/4791): \[cli] Could not find or load main class
* [#4913](https://github.com/pmd/pmd/issues/4913): \[cli] cpd-gui closes immediately
* doc
* [#4901](https://github.com/pmd/pmd/issues/4901): \[doc] Improve documentation on usage of violationSuppressXPath
* apex
* [#4418](https://github.com/pmd/pmd/issues/4418): \[apex] ASTAnnotation.getImage() does not return value as written in the class
* apex-errorprone
* [#3953](https://github.com/pmd/pmd/issues/3953): \[apex] EmptyCatchBlock false positive with formal (doc) comments
* cpp
* [#2438](https://github.com/pmd/pmd/issues/2438): \[cpp] Repeated Duplication blocks
* java
* [#4899](https://github.com/pmd/pmd/issues/4899): \[java] Parsing failed in ParseLock#doParse() java.io.IOException: Stream closed
* [#4902](https://github.com/pmd/pmd/issues/4902): \[java] "Bad intersection, unrelated class types" for Constable\[] and Enum\[]
* [#4947](https://github.com/pmd/pmd/issues/4947): \[java] Broken TextBlock parser
* java-bestpractices
* [#1084](https://github.com/pmd/pmd/issues/1084): \[java] Allow JUnitTestsShouldIncludeAssert to configure verification methods
* [#3216](https://github.com/pmd/pmd/issues/3216): \[java] New rule: UnnecessaryVarargsArrayCreation
* [#4435](https://github.com/pmd/pmd/issues/4435): \[java] \[7.0-rc1] UnusedAssignment for used field
* [#4569](https://github.com/pmd/pmd/issues/4569): \[java] ForLoopCanBeForeach reports on loop `for (int i = 0; i < list.size(); i += 2)`
* [#4618](https://github.com/pmd/pmd/issues/4618): \[java] UnusedAssignment false positive with conditional assignments of fields
* java-codestyle
* [#4602](https://github.com/pmd/pmd/issues/4602): \[java] UnnecessaryImport: false positives with static imports
* [#4785](https://github.com/pmd/pmd/issues/4785): \[java] False Positive: PMD Incorrectly report violation for UnnecessaryImport
* [#4779](https://github.com/pmd/pmd/issues/4779): \[java] Examples in documentation of MethodArgumentCanBeFinal do not trigger the rule
* [#4881](https://github.com/pmd/pmd/issues/4881): \[java] ClassNamingConventions: interfaces are identified as abstract classes (regression in 7.0.0)
* java-design
* [#2440](https://github.com/pmd/pmd/issues/2440): \[java] FinalFieldCouldBeStatic FN when the right side of the assignment is a constant expression
* [#3694](https://github.com/pmd/pmd/issues/3694): \[java] SingularField ignores static variables
* [#4873](https://github.com/pmd/pmd/issues/4873): \[java] AvoidCatchingGenericException: Can no longer suppress on the exception itself
* java-errorprone
* [#2056](https://github.com/pmd/pmd/issues/2056): \[java] CloseResource false-positive with URLClassLoader in cast expression
* [#4751](https://github.com/pmd/pmd/issues/4751): \[java] PMD crashes when analyzing CloseResource Rule
* [#4928](https://github.com/pmd/pmd/issues/4928): \[java] EmptyCatchBlock false negative when allowCommentedBlocks=true
* [#4948](https://github.com/pmd/pmd/issues/4948): \[java] ImplicitSwitchFallThrough: False-positive with nested switch statements
* java-performance
* [#3845](https://github.com/pmd/pmd/issues/3845): \[java] InsufficientStringBufferDeclaration should consider literal expression
* [#4874](https://github.com/pmd/pmd/issues/4874): \[java] StringInstantiation: False-positive when using `new String(charArray)`
* [#4886](https://github.com/pmd/pmd/issues/4886): \[java] BigIntegerInstantiation: False Positive with Java 17 and BigDecimal.TWO
* pom-errorprone
* [#4388](https://github.com/pmd/pmd/issues/4388): \[pom] InvalidDependencyTypes doesn't consider dependencies at all
* misc
* [#4967](https://github.com/pmd/pmd/pull/4967): Fix reproducible build issues with 7.0.0
### 🚨 API Changes
#### Deprecated methods
* pmd-java
* <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.1.0/net/sourceforge/pmd/lang/java/ast/ASTLambdaExpression.html#getBlock()"><code>ASTLambdaExpression#getBlock</code></a> and <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.1.0/net/sourceforge/pmd/lang/java/ast/ASTLambdaExpression.html#getExpression()"><code>ASTLambdaExpression#getExpression</code></a>
* <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.1.0/net/sourceforge/pmd/lang/java/rule/design/SingularFieldRule.html#mayBeSingular(net.sourceforge.pmd.lang.java.ast.ModifierOwner)"><code>SingularFieldRule#mayBeSingular</code></a> has been deprecated for
removal. The method is only useful for the rule itself and shouldn't be used otherwise.
### ✨ External Contributions
* [#4864](https://github.com/pmd/pmd/pull/4864): Fix #1084 \[Java] add extra assert method names to Junit rules - [Erwan Moutymbo](https://github.com/emouty) (@emouty)
* [#4894](https://github.com/pmd/pmd/pull/4894): Fix #4791 Error caused by space in JDK path - [Scrates1](https://github.com/Scrates1) (@Scrates1)
### 📈 Stats
* 205 commits
* 71 closed tickets & PRs
* Days since last release: 34
## 22-March-2024 - 7.0.0

2272
docs/pages/release_notes_pmd7.md
View File

File diff suppressed because it is too large Load Diff

2
pmd-ant/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<artifactId>pmd</artifactId>
<groupId>net.sourceforge.pmd</groupId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

2
pmd-apex/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

2
pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/CognitiveComplexityRule.java
View File

@ -75,7 +75,7 @@ public class CognitiveComplexityRule extends AbstractApexRule {
String.valueOf(classLevelThreshold),
};
asCtx(data).addViolation(node, messageParams);
asCtx(data).addViolation(node, (Object[]) messageParams);
}
}
return data;

2
pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/CyclomaticComplexityRule.java
View File

@ -78,7 +78,7 @@ public class CyclomaticComplexityRule extends AbstractApexRule {
" total",
classWmc + " (highest " + classHighest + ")", };
asCtx(data).addViolation(node, messageParams);
asCtx(data).addViolation(node, (Object[]) messageParams);
}
}
return data;

2
pmd-cli/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

2
pmd-coco/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

2
pmd-compat6/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
</parent>
<artifactId>pmd-compat6</artifactId>

2
pmd-core/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

4
pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/RuleSetFactory.java
View File

@ -658,7 +658,9 @@ final class RuleSetFactory {
return new RuleSetLoader().loadResourcesWith(resourceLoader)
.filterAbovePriority(minimumPriority)
.warnDeprecated(warnDeprecated)
.includeDeprecatedRuleReferences(includeDeprecatedRuleReferences);
.includeDeprecatedRuleReferences(includeDeprecatedRuleReferences)
.withReporter(reporter)
.withLanguages(languageRegistry);
}
private @NonNull XmlMessageHandler getXmlMessagePrinter() {

14
pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/internal/BaseNodeInfo.java
View File

@ -5,6 +5,7 @@
package net.sourceforge.pmd.lang.rule.xpath.internal;
import java.util.Collections;
import java.util.List;
import java.util.ListIterator;
@ -105,16 +106,15 @@ abstract class BaseNodeInfo extends AbstractNodeWrapper implements SiblingCounti
return iterateList(nodes, true);
}
@SuppressWarnings({"unchecked", "rawtypes"})
static AxisIterator iterateList(List<? extends NodeInfo> nodes, boolean forwards) {
return forwards ? new NodeListIterator((List<NodeInfo>) nodes)
: new RevListAxisIterator((List<NodeInfo>) nodes);
static <N extends NodeInfo> AxisIterator iterateList(List<N> nodes, boolean forwards) {
return forwards ? new NodeListIterator(Collections.unmodifiableList(nodes))
: new RevListAxisIterator<>(nodes);
}
private static class RevListAxisIterator implements AxisIterator {
private final ListIterator<NodeInfo> iter;
private static class RevListAxisIterator<N extends NodeInfo> implements AxisIterator {
private final ListIterator<N> iter;
RevListAxisIterator(List<NodeInfo> list) {
RevListAxisIterator(List<N> list) {
iter = list.listIterator(list.size());
}

36
pmd-core/src/test/java/net/sourceforge/pmd/lang/rule/RuleSetFactoryMessagesTest.java
View File

@ -9,7 +9,12 @@ import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import net.sourceforge.pmd.util.internal.xml.SchemaConstants;
import net.sourceforge.pmd.util.internal.xml.XmlErrorMessages;
@ -106,4 +111,35 @@ class RuleSetFactoryMessagesTest extends RulesetFactoryTestBase {
+ " ^^^^^^^^^ Delimiter attribute is not supported anymore, values are always comma-separated.\n"
));
}
/**
* @see <a href="https://github.com/pmd/pmd/issues/4978">[core] Referenced Rulesets do not emit details on validation errors #4978</a>
*/
@Test
void validationMessagesFromReferencedRulesets(@TempDir Path tempDir) throws Exception {
Path childRuleset = tempDir.resolve("invalid-ruleset.xml").toAbsolutePath();
Files.write(childRuleset,
rulesetXml(
dummyRule(
priority("not a priority")
)
).getBytes(StandardCharsets.UTF_8));
String log = SystemLambda.tapSystemErr(() -> {
RuleSetLoadException exception = assertCannotParse(
rulesetXml(
ruleRef(childRuleset.toString())
)
);
assertThat(exception.getMessage(), containsString("Cannot load ruleset " + childRuleset + ": An XML validation error occurred"));
});
assertThat(log, containsString(
"Error at " + childRuleset + ":9:1\n"
+ " 7| \n"
+ " 8| <rule name=\"MockRuleName\" language=\"dummy\" class=\"net.sourceforge.pmd.lang.rule.MockRuleWithNoProperties\" message=\"avoid the mock rule\">\n"
+ " 9| <priority>not a priority</priority></rule></ruleset>\n"
+ " ^^^^^^^^^ Not a valid priority: 'not a priority', expected a number in [1,5]"
));
}
}

4
pmd-core/src/test/java/net/sourceforge/pmd/lang/rule/RulesetFactoryTestBase.java
View File

@ -115,8 +115,8 @@ public class RulesetFactoryTestBase {
}
}
protected void assertCannotParse(String xmlContent) {
assertThrows(RuleSetLoadException.class, () -> loadFirstRule(xmlContent));
protected RuleSetLoadException assertCannotParse(String xmlContent) {
return assertThrows(RuleSetLoadException.class, () -> loadFirstRule(xmlContent));
}
/*
DSL to build a ruleset XML file with method calls.

2
pmd-cpp/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

2
pmd-cs/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

2
pmd-dart/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

2
pmd-dist/pom.xml
View File

@ -8,7 +8,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

2
pmd-doc/pom.xml
View File

@ -8,7 +8,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

2
pmd-fortran/pom.xml
View File

@ -7,7 +7,7 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
<version>7.1.0-SNAPSHOT</version>
<version>7.2.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

Some files were not shown because too many files have changed in this diff Show More