spring-projects / spring-projects/spring-security

allSerializableClassesShouldHaveSerialVersionOrSuppressWarnings should correctly check for SuppressWarnings

Open
#17,729 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

in: config type: bug
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

Since @SuppressWarnings uses RetentionPolicy.SOURCE, we cannot use it as a criteria for determining whether something in the codebase is correctly serialized, leading to, for example, #17622.

It would be nice to improve this test. It's possible that ArchUnit may be an option to inspect the source code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the allSerializableClassesShouldHaveSerialVersionOrSuppressWarnings test and review how it currently checks @SuppressWarnings, along with issue #17622. Investigate whether ArchUnit can inspect the source-level annotation; done means the test correctly recognizes valid suppression without relying on a SOURCE-retained annotation at runtime.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
testing
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.