Add Spotbugs (#7894)

* Add Spotbugs

Exclude all the issues for now, so we can add them one by one.

(cherry picked from commit ceda4754dc8c703d1e0de85b48cd5f5409cfd5b7)

* Add additional rules to the list

* More rules

* More rules

* Add comments to the xml

* Move the spotbugs-exclude.xml to codestyle/
This commit is contained in:
Fokko Driesprong 2019-06-20 20:06:52 +02:00 committed by Roman Leventov
parent 494b8ebe56
commit 48f20fe754
3 changed files with 117 additions and 1 deletions

View File

@ -45,7 +45,7 @@ matrix:
- NAME="strict compilation" - NAME="strict compilation"
install: true install: true
# Strict compilation requires more than 2 GB # Strict compilation requires more than 2 GB
script: MAVEN_OPTS='-Xmx3000m' mvn clean -Pstrict -pl '!benchmarks' compile test-compile -B --fail-at-end script: MAVEN_OPTS='-Xmx3000m' mvn clean -Pstrict -pl '!benchmarks' compile test-compile spotbugs:check -B --fail-at-end
# packaging check # packaging check
- env: - env:

View File

@ -0,0 +1,100 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
~ distributed with this work for additional information
~ regarding copyright ownership. The ASF licenses this file
~ to you under the Apache License, Version 2.0 (the
~ "License"); you may not use this file except in compliance
~ with the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing,
~ software distributed under the License is distributed on an
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~ KIND, either express or implied. See the License for the
~ specific language governing permissions and limitations
~ under the License.
-->
<!--
To enforce Spotbugs into the codebase, first, all the errors are
ignored, so we can add them one by one.
Some of the bugs will only occur once or twice on the codebase,
while others will occur potentially a lot.
Reference: https://github.com/apache/incubator-druid/pull/7894/files
-->
<FindBugsFilter>
<Bug pattern="AT_OPERATION_SEQUENCE_ON_CONCURRENT_ABSTRACTION"/>
<Bug pattern="BC_IMPOSSIBLE_INSTANCEOF"/>
<Bug pattern="BC_UNCONFIRMED_CAST"/>
<Bug pattern="BIT_SIGNED_CHECK_HIGH_BIT"/>
<Bug pattern="BX_UNBOXING_IMMEDIATELY_REBOXED"/>
<Bug pattern="CN_IDIOM_NO_SUPER_CALL"/>
<Bug pattern="CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE"/>
<Bug pattern="DC_DOUBLECHECK"/>
<Bug pattern="DLS_DEAD_LOCAL_STORE"/>
<Bug pattern="DM_BOXED_PRIMITIVE_FOR_PARSING"/>
<Bug pattern="DM_EXIT"/>
<Bug pattern="DM_NUMBER_CTOR"/>
<Bug pattern="DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED"/>
<Bug pattern="EI_EXPOSE_REP"/>
<Bug pattern="EI_EXPOSE_REP2"/>
<Bug pattern="EQ_COMPARETO_USE_OBJECT_EQUALS"/>
<Bug pattern="EQ_DOESNT_OVERRIDE_EQUALS"/>
<Bug pattern="EQ_UNUSUAL"/>
<Bug pattern="ES_COMPARING_PARAMETER_STRING_WITH_EQ"/>
<Bug pattern="FE_FLOATING_POINT_EQUALITY"/>
<Bug pattern="HE_EQUALS_USE_HASHCODE"/>
<Bug pattern="IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD"/>
<Bug pattern="ICAST_IDIV_CAST_TO_DOUBLE"/>
<Bug pattern="ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL"/>
<Bug pattern="ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT"/>
<Bug pattern="IS2_INCONSISTENT_SYNC"/>
<Bug pattern="JLM_JSR166_UTILCONCURRENT_MONITORENTER"/>
<Bug pattern="JLM_JSR166_UTILCONCURRENT_MONITORENTER"/>
<Bug pattern="MS_FINAL_PKGPROTECT"/>
<Bug pattern="MS_MUTABLE_COLLECTION_PKGPROTECT"/>
<Bug pattern="MS_OOI_PKGPROTECT"/>
<Bug pattern="MS_PKGPROTECT"/>
<Bug pattern="MS_SHOULD_BE_FINAL"/>
<Bug pattern="NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT"/>
<Bug pattern="NP_GUARANTEED_DEREF"/>
<Bug pattern="NP_LOAD_OF_KNOWN_NULL_VALUE"/>
<Bug pattern="NP_METHOD_PARAMETER_TIGHTENS_ANNOTATION"/>
<Bug pattern="NP_NONNULL_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
<Bug pattern="NP_NONNULL_PARAM_VIOLATION"/>
<Bug pattern="NP_NONNULL_PARAM_VIOLATION"/>
<Bug pattern="NP_NONNULL_RETURN_VIOLATION"/>
<Bug pattern="NP_NULL_ON_SOME_PATH"/>
<Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
<Bug pattern="NP_NULL_ON_SOME_PATH_MIGHT_BE_INFEASIBLE"/>
<Bug pattern="NP_NULL_PARAM_DEREF"/>
<Bug pattern="NP_NULL_PARAM_DEREF_NONVIRTUAL"/>
<Bug pattern="NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE"/>
<Bug pattern="NP_STORE_INTO_NONNULL_FIELD"/>
<Bug pattern="NS_DANGEROUS_NON_SHORT_CIRCUIT"/>
<Bug pattern="OBL_UNSATISFIED_OBLIGATION"/>
<Bug pattern="OS_OPEN_STREAM"/>
<Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
<Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"/>
<Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
<Bug pattern="RC_REF_COMPARISON_BAD_PRACTICE_BOOLEAN"/>
<Bug pattern="REC_CATCH_EXCEPTION"/>
<Bug pattern="RV_RETURN_VALUE_IGNORED_BAD_PRACTICE"/>
<Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
<Bug pattern="SBSC_USE_STRINGBUFFER_CONCATENATION"/>
<Bug pattern="SE_BAD_FIELD"/>
<Bug pattern="SE_COMPARATOR_SHOULD_BE_SERIALIZABLE"/>
<Bug pattern="SF_SWITCH_FALLTHROUGH"/>
<Bug pattern="SF_SWITCH_NO_DEFAULT"/>
<Bug pattern="SR_NOT_CHECKED"/>
<Bug pattern="SS_SHOULD_BE_STATIC"/>
<Bug pattern="SWL_SLEEP_WITH_LOCK_HELD"/>
<Bug pattern="UL_UNRELEASED_LOCK_EXCEPTION_PATH"/>
<Bug pattern="URF_UNREAD_FIELD"/>
<Bug pattern="WMI_WRONG_MAP_ITERATOR"/>
</FindBugsFilter>

16
pom.xml
View File

@ -1009,6 +1009,22 @@
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<version>3.1.12</version>
<dependencies>
<!-- overwrite dependency on spotbugs if you want to specify the version of spotbugs -->
<dependency>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs</artifactId>
<version>3.1.12</version>
</dependency>
</dependencies>
<configuration>
<excludeFilterFile>codestyle/spotbugs-exclude.xml</excludeFilterFile>
</configuration>
</plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId> <artifactId>maven-pmd-plugin</artifactId>