[CASSANDRA-18077] Add SpotBugs to the build

• Type: Improvement
• Status: Open
• Priority: Normal
• Resolution: Unresolved
• Fix Version/s: 5.x
• Component/s: Build, CI
• Epic Link: Code Style & Static Analysis
• Change Category: Quality Assurance
• Complexity: Low Hanging Fruit
• Platform: All

Test and Documentation Plan

added new task

• Assignee: Unassigned
• Reporter: David Capwell
• Created: 28/Nov/22 22:03
• Updated: 08/Jun/23 01:06

Description

When working on CASSANDRA-17178 I found that several classes were being reported by the Simulator for not defining serializer version when they are Serializable; this may cause issues for the Simulator so felt it would be best to detect these earlier on before merging new ones.

SpotBugs has a large set of checks, some more valuable than others for the project; so we should maintain a curated list of issues to fail the build on, and others to warn on.

This topic was discussed in the following mail threads:

• Should we add?: https://lists.apache.org/thread/1ro1mvkpvt4vr24nw7dbpdlxo82mq3hz
• Should we fix UTF-8 issues? https://lists.apache.org/thread/sokxf46s7hyoxr9q4wm7dv3q2nm19nt3

Issue Links

• is superceded by: CASSANDRA-18239 Replace eclipse warnings based static code analysis with something better (CheckerFramework)
• links to: GH: trunk
• links to: GitHub Pull Request #2031