dev-support/spotbugs-exclude.xml

   1 <!--
   2    Licensed to the Apache Software Foundation (ASF) under one or more
   3    contributor license agreements.  See the NOTICE file distributed with
   4    this work for additional information regarding copyright ownership.
   5    The ASF licenses this file to You under the Apache License, Version 2.0
   6    (the "License"); you may not use this file except in compliance with
   7    the License.  You may obtain a copy of the License at
   8
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11    Unless required by applicable law or agreed to in writing, software
  12    distributed under the License is distributed on an "AS IS" BASIS,
  13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14    See the License for the specific language governing permissions and
  15    limitations under the License.
  16 -->
  17
  18 <FindBugsFilter>
  19   <!-- Nested packages are not included by the Package filter, so we need a regexp... -->
  20   <Match>
  21     <Class name="~.*\.generated\..*"/>
  22   </Match>
  23
  24   <Match>
  25     <Package name="~org\.apache\.hadoop\.hbase\.tmpl\..*"/>
  26   </Match>
  27
  28   <Match>
  29     <Class name="org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost"/>
  30     <Or>
  31       <Method name="preExists"/>
  32       <Method name="preCheckAndPut"/>
  33       <Method name="preCheckAndDelete"/>
  34       <Method name="preScannerNext"/>
  35     </Or>
  36     <Bug pattern="NP_BOOLEAN_RETURN_NULL"/>
  37   </Match>
  38
  39   <!-- This is read by a thread from hadoop and findbugs never finds it -->
  40   <Match>
  41     <Bug code="UrF"/>
  42     <Class name="org.apache.hadoop.hbase.metrics.BaseSourceImpl"/>
  43   </Match>
  44
  45   <Match>
  46     <Class name="org.apache.hadoop.hbase.regionserver.StoreFile$Writer"/>
  47     <Bug pattern="NP_NULL_PARAM_DEREF"/>
  48   </Match>
  49
  50   <Match>
  51     <Class name="org.apache.hadoop.hbase.regionserver.wal.SequenceFileLogReader"/>
  52     <Or>
  53       <Method name="addFileInfoToException"/>
  54     </Or>
  55     <Bug pattern="REC_CATCH_EXCEPTION"/>
  56   </Match>
  57
  58
  59   <Match>
  60     <Class name="org.apache.hadoop.hbase.KeyValue"/>
  61     <Or>
  62       <Method name="createEmptyByteArray"/>
  63       <Method name="createByteArray"/>
  64     </Or>
  65     <Bug pattern="INT_VACUOUS_COMPARISON"/>
  66   </Match>
  67
  68   <Match>
  69     <Class name="org.apache.hadoop.hbase.util.ByteBufferUtils"/>
  70     <Or>
  71       <Method name="putInt"/>
  72     </Or>
  73     <Bug pattern="ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT"/>
  74   </Match>
  75
  76   <Match>
  77     <Class name="org.apache.hadoop.hbase.mapreduce.MultithreadedTableMapper"/>
  78     <Or>
  79       <Method name="MapRunner"/>
  80     </Or>
  81     <Bug pattern="REC_CATCH_EXCEPTION"/>
  82   </Match>
  83
  84   <Match>
  85     <Class name="org.apache.hadoop.hbase.util.PoolMap$RoundRobinPool"/>
  86     <Bug pattern="EQ_DOESNT_OVERRIDE_EQUALS"/>
  87   </Match>
  88
  89   <Match>
  90     <Class name="org.apache.hadoop.hbase.ipc.RpcClient$Connection"/>
  91     <Or>
  92       <Bug pattern="IS2_INCONSISTENT_SYNC"/>
  93       <Bug pattern="NN_NAKED_NOTIFY"/>
  94     </Or>
  95   </Match>
  96
  97   <Match>
  98     <Class name="org.apache.hadoop.hbase.regionserver.HRegion"/>
  99     <Or>
 100       <Method name="startRegionOperation"/>
 101       <Method name="startBulkRegionOperation"/>
 102     </Or>
 103     <Bug pattern="UL_UNRELEASED_LOCK"/>
 104   </Match>
 105
 106   <Match>
 107     <!--
 108     A mutable static field could be changed by malicious code or by accident. The field could be
 109     made package protected to avoid this vulnerability.
 110
 111     We have a set of stuff like:
 112     public static final byte [] SKIP_ARRAY = new byte [ ] {'S', 'K', 'I', 'P'};
 113
 114     Warning is not wrong, but difficult to avoid...
 115     !-->
 116     <Bug pattern="MS_PKGPROTECT"/>
 117   </Match>
 118   <Match>
 119     <Bug pattern="MS_OOI_PKGPROTECT"/>
 120   </Match>
 121
 122
 123   <Match>
 124     <!--
 125     Returning a reference to a mutable object value stored in one of the object's fields exposes
 126     the internal representation of the object.  If instances are accessed by untrusted code,
 127     and unchecked changes to the mutable object would compromise security or other important
 128     properties, you will need to do something different. Returning a new copy of the object is
 129     better approach in many situations.
 130
 131     We have getters on our internal fields. Questionable, but out of findbugs scope. Returning a
 132     copy is not practical in most cases.
 133     !-->
 134     <Bug pattern="EI_EXPOSE_REP"/>
 135   </Match>
 136   <Match>
 137     <Bug pattern="EI_EXPOSE_REP2"/>
 138   </Match>
 139
 140
 141   <Match>
 142     <!--
 143     This class implements the Comparator interface. You should consider whether or not it should
 144     also implement the Serializable interface. If a comparator is used to construct an ordered
 145     collection such as a TreeMap, then the TreeMap will be serializable only if the comparator
 146     is also serializable. As most comparators have little or no state, making them serializable
 147     is generally easy and good defensive programming.
 148     !-->
 149     <Bug pattern="SE_COMPARATOR_SHOULD_BE_SERIALIZABLE"/>
 150   </Match>
 151
 152   <Match>
 153
 154     <!--
 155     This method performs synchronization an object that is an instance of a class from
 156     the java.util.concurrent package (or its subclasses). Instances of these classes have their own
 157     concurrency control mechanisms that are orthogonal to the synchronization provided by the Java
 158     keyword synchronized. For example, synchronizing on an AtomicBoolean will not prevent other
 159     threads from modifying the AtomicBoolean.
 160
 161     Such code may be correct, but should be carefully reviewed and documented, and may confuse people
 162     who have to maintain the code at a later date.
 163
 164     We do that all the time to save lock objects.
 165     !-->
 166     <Bug pattern="JLM_JSR166_UTILCONCURRENT_MONITORENTER"/>
 167   </Match>
 168
 169   <Match>
 170     <!--
 171     Found a call to a method which will perform a byte to String (or String to byte) conversion,
 172     and will assume that the default platform encoding is suitable. This will cause the
 173     application behaviour to vary between platforms. Use an alternative API and specify a
 174     charset name or Charset object explicitly.
 175     !-->
 176     <Bug pattern="DM_DEFAULT_ENCODING"/>
 177   </Match>
 178
 179   <Match>
 180     <!--
 181      Invoking System.exit shuts down the entire Java virtual machine. This should only been
 182      done when it is appropriate. Such calls make it hard or impossible for your code to be
 183      invoked by other code. Consider throwing a RuntimeException instead.
 184
 185      It's so bad that the reviews will catch all the wrong cases.
 186     !-->
 187     <Bug pattern="DM_EXIT"/>
 188   </Match>
 189
 190   <Match>
 191     <!--
 192      This method returns a value that is not checked. The return value should be checked since
 193      it can indicate an unusual or unexpected function execution. For example, the
 194      File.delete() method returns false if the file could not be successfully deleted
 195      (rather than throwing an Exception). If you don't check the result, you won't notice
 196      if the method invocation signals unexpected behavior by returning an atypical return
 197      value.
 198
 199      It's so bad that the reviews will catch all the wrong cases.
 200     !-->
 201     <Bug pattern="RV_RETURN_VALUE_IGNORED_BAD_PRACTICE"/>
 202   </Match>
 203   <Match>
 204     <Bug pattern="RV_RETURN_VALUE_IGNORED_INFERRED"/>
 205   </Match>
 206
 207
 208   <Match>
 209     <!--
 210      This method contains a redundant check of a known non-null value against the constant null.
 211
 212      Most of the time we're securing ourselves, does no much harm.
 213     !-->
 214     <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
 215   </Match>
 216
 217   <Match>
 218     <!--
 219     A final static field references an array and can be accessed by malicious code or by
 220     accident from another package. This code can freely modify the contents of the array.
 221
 222      We've got this all over the place... Cloning the array by security is not a general
 223      solution from a performance point of view
 224     !-->
 225     <Bug pattern="MS_MUTABLE_ARRAY"/>
 226   </Match>
 227
 228   <Match>
 229     <!--
 230      The logic explicitly checks equality of two floating point numbers. Ignore the warning
 231     !-->
 232     <Class name="org.apache.hadoop.hbase.master.AssignmentVerificationReport"/>
 233     <Bug pattern="FE_FLOATING_POINT_EQUALITY"/>
 234   </Match>
 235
 236   <Match>
 237     <Class name="org.apache.hadoop.hbase.HRegionInfo"/>
 238     <Or>
 239       <Method name="getEndKeyForDisplay"/>
 240       <Method name="getStartKeyForDisplay"/>
 241     </Or>
 242     <Bug pattern="MS_EXPOSE_REP"/>
 243   </Match>
 244
 245   <Match>
 246     <Class name="org.apache.hadoop.hbase.io.hfile.LruBlockCache"/>
 247     <Bug pattern="SC_START_IN_CTOR"/>
 248   </Match>
 249
 250   <Match>
 251     <Class name="org.apache.hadoop.hbase.io.hfile.LruAdaptiveBlockCache"/>
 252     <Bug pattern="SC_START_IN_CTOR"/>
 253   </Match>
 254
 255   <Match>
 256     <!--
 257       False positives, NettyRpcServer#start & SimpleRpcServer#start are already synchronized and
 258       there is check to ensure single initialization of authTokenSecretMgr field.
 259       Ignore the warning, see HBASE-25875.
 260     !-->
 261     <Or>
 262       <And>
 263         <Class name="org.apache.hadoop.hbase.ipc.NettyRpcServer"/>
 264         <Method name="start"/>
 265       </And>
 266       <And>
 267         <Class name="org.apache.hadoop.hbase.ipc.SimpleRpcServer"/>
 268         <Method name="start"/>
 269       </And>
 270     </Or>
 271     <Bug pattern="ML_SYNC_ON_UPDATED_FIELD"/>
 272   </Match>
 273
 274 </FindBugsFilter>