kafka/checkstyle/suppressions.xml

<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
        "-//Puppy Crawl//DTD Suppressions 1.1//EN"
        "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<!--
 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.
-->
<suppressions>

    <!-- Note that [/\\] must be used as the path separator for cross-platform support -->

    <!-- Generator -->
    <suppress checks="CyclomaticComplexity|BooleanExpressionComplexity"
              files="(SchemaGenerator|MessageDataGenerator|FieldSpec|FieldType).java"/>
    <suppress checks="NPathComplexity"
              files="(MessageDataGenerator|FieldSpec|WorkerSinkTask).java"/>
    <suppress checks="JavaNCSS"
              files="(ApiMessageType|FieldSpec|MessageDataGenerator|KafkaConsumerTest).java"/>
    <suppress checks="MethodLength"
              files="(FieldSpec|MessageDataGenerator).java"/>
    <suppress id="dontUseSystemExit"
              files="MessageGenerator.java"/>

    <!-- core -->
    <suppress checks="(NPathComplexity|ClassFanOutComplexity|CyclomaticComplexity|ClassDataAbstractionCoupling|FinalLocalVariable|LocalVariableName|MemberName|ParameterName|MethodLength|JavaNCSS|AvoidStarImport)"
              files="core[\\/]src[\\/](generated|generated-test)[\\/].+.java$"/>
    <suppress checks="NPathComplexity" files="(ClusterTestExtensions|KafkaApisBuilder).java"/>
    <suppress checks="NPathComplexity|ClassFanOutComplexity|ClassDataAbstractionCoupling" files="(RemoteLogManager|RemoteLogManagerTest).java"/>
    <suppress checks="ClassFanOutComplexity" files="RemoteLogManagerTest.java"/>
    <suppress checks="MethodLength"
              files="(KafkaClusterTestKit).java"/>

    <!-- server tests -->
    <suppress checks="MethodLength|JavaNCSS|NPath" files="DescribeTopicPartitionsRequestHandlerTest.java"/>

    <!-- Clients -->
    <suppress id="dontUseSystemExit"
              files="Exit.java"/>
    <suppress checks="ClassFanOutComplexity"
              files="(AbstractFetch|Sender|SenderTest|ConsumerCoordinator|KafkaConsumer|KafkaProducer|Utils|TransactionManager|TransactionManagerTest|KafkaAdminClient|NetworkClient|Admin|KafkaRaftClient|KafkaRaftClientTest|RaftClientTestContext).java"/>
    <suppress checks="ClassFanOutComplexity"
              files="(SaslServerAuthenticator|SaslAuthenticatorTest).java"/>
    <suppress checks="NPath"
              files="SaslServerAuthenticator.java"/>
    <suppress checks="ClassFanOutComplexity"
              files="Errors.java"/>
    <suppress checks="ClassFanOutComplexity"
              files="Utils.java"/>
    <suppress checks="ClassFanOutComplexity"
              files="AbstractRequest.java"/>
    <suppress checks="ClassFanOutComplexity"
              files="AbstractResponse.java"/>

    <suppress checks="MethodLength"
              files="(KerberosLogin|RequestResponseTest|ConnectMetricsRegistry|KafkaConsumer|AbstractStickyAssignor|AbstractRequest|AbstractResponse).java"/>

    <suppress checks="ParameterNumber"
              files="(NetworkClient|FieldSpec|KafkaRaftClient|KafkaProducer).java"/>
    <suppress checks="ParameterNumber"
              files="(KafkaConsumer|ConsumerCoordinator).java"/>
    <suppress checks="ParameterNumber"
              files="(RecordAccumulator|Sender).java"/>
    <suppress checks="ParameterNumber"
              files="ConfigDef.java"/>
    <suppress checks="ParameterNumber"
              files="DefaultRecordBatch.java"/>
    <suppress checks="ParameterNumber"
              files="MemoryRecordsBuilder.java"/>
    <suppress checks="ParameterNumber"
              files="ClientUtils.java"/>

    <suppress checks="ClassDataAbstractionCoupling"
              files="(KafkaConsumer|ConsumerCoordinator|AbstractFetch|KafkaProducer|AbstractRequest|AbstractResponse|TransactionManager|Admin|KafkaAdminClient|MockAdminClient|KafkaRaftClient|KafkaRaftClientTest).java"/>
    <suppress checks="ClassDataAbstractionCoupling"
              files="(Errors|SaslAuthenticatorTest|AgentTest|CoordinatorTest|NetworkClientTest).java"/>

    <suppress checks="BooleanExpressionComplexity"
              files="(Utils|Topic|KafkaLZ4BlockOutputStream|AclData|JoinGroupRequest).java"/>

    <suppress checks="CyclomaticComplexity"
              files="(AbstractFetch|ConsumerCoordinator|CommitRequestManager|FetchCollector|OffsetFetcherUtils|KafkaProducer|Sender|ConfigDef|KerberosLogin|AbstractRequest|AbstractResponse|Selector|SslFactory|SslTransportLayer|SaslClientAuthenticator|SaslClientCallbackHandler|SaslServerAuthenticator|AbstractCoordinator|TransactionManager|AbstractStickyAssignor|DefaultSslEngineFactory|Authorizer|RecordAccumulator|MemoryRecords|FetchSessionHandler|MockAdminClient).java"/>

    <suppress checks="JavaNCSS"
              files="(AbstractRequest|AbstractResponse|KerberosLogin|WorkerSinkTaskTest|TransactionManagerTest|SenderTest|KafkaAdminClient|ConsumerCoordinatorTest|KafkaAdminClientTest|KafkaRaftClientTest).java"/>

    <suppress checks="NPathComplexity"
              files="(ConsumerCoordinator|BufferPool|MetricName|Node|ConfigDef|RecordBatch|SslFactory|SslTransportLayer|MetadataResponse|KerberosLogin|Selector|Sender|Serdes|TokenInformation|Agent|Values|PluginUtils|MiniTrogdorCluster|TasksRequest|KafkaProducer|AbstractStickyAssignor|KafkaRaftClient|Authorizer|FetchSessionHandler|RecordAccumulator).java"/>

    <suppress checks="(JavaNCSS|CyclomaticComplexity|MethodLength)"
              files="CoordinatorClient.java"/>
    <suppress checks="(UnnecessaryParentheses|BooleanExpressionComplexity|CyclomaticComplexity|WhitespaceAfter|LocalVariableName)"
              files="Murmur3.java"/>

    <suppress checks="(NPathComplexity|ClassFanOutComplexity|CyclomaticComplexity|ClassDataAbstractionCoupling|LocalVariableName|MemberName|ParameterName|MethodLength|JavaNCSS|AvoidStarImport)"
            files="clients[\\/]src[\\/](generated|generated-test)[\\/].+.java$"/>

    <suppress checks="NPathComplexity"
            files="MessageTest.java|OffsetFetchRequest.java"/>

    <!-- Clients tests -->
    <suppress checks="ClassDataAbstractionCoupling"
              files="(Sender|Fetcher|FetchRequestManager|OffsetFetcher|KafkaConsumer|Metrics|RequestResponse|TransactionManager|KafkaAdminClient|Message|KafkaProducer)Test.java"/>

    <suppress checks="ClassFanOutComplexity"
              files="(ConsumerCoordinator|KafkaConsumer|RequestResponse|Fetcher|FetchRequestManager|KafkaAdminClient|Message|KafkaProducer)Test.java"/>

    <suppress checks="ClassFanOutComplexity"
              files="MockAdminClient.java"/>

    <suppress checks="CyclomaticComplexity"
              files="(OffsetFetcher|RequestResponse)Test.java"/>

    <suppress checks="JavaNCSS"
              files="RequestResponseTest.java|FetcherTest.java|FetchRequestManagerTest.java|KafkaAdminClientTest.java"/>

    <suppress checks="NPathComplexity"
              files="MemoryRecordsTest|MetricsTest|RequestResponseTest|TestSslUtils|AclAuthorizerBenchmark"/>

    <suppress checks="MethodLength"
              files="ConsumerTestBuilder.java"/>

    <suppress checks="(WhitespaceAround|LocalVariableName|ImportControl|AvoidStarImport)"
              files="Murmur3Test.java"/>

    <!-- Connect -->
    <suppress checks="ClassFanOutComplexity"
              files="(AbstractHerder|DistributedHerder|Worker).java"/>
    <suppress checks="ClassFanOutComplexity"
              files="Worker(|Test).java"/>
    <suppress checks="MethodLength"
              files="(DistributedHerder|DistributedConfig|KafkaConfigBackingStore|Values|IncrementalCooperativeAssignor).java"/>
    <suppress checks="ParameterNumber"
              files="Worker(SinkTask|SourceTask|Coordinator)?.java"/>
    <suppress checks="ParameterNumber"
              files="(ConfigKeyInfo|DistributedHerder).java"/>
    <suppress checks="DefaultComesLast"
              files="LoggingResource.java" />

    <suppress checks="ClassDataAbstractionCoupling"
              files="(RestServer|AbstractHerder|DistributedHerder|Worker(Test)?).java"/>

    <suppress checks="BooleanExpressionComplexity"
              files="JsonConverter.java"/>

    <suppress checks="CyclomaticComplexity"
              files="(FileStreamSourceTask|DistributedHerder|KafkaConfigBackingStore).java"/>
    <suppress checks="CyclomaticComplexity"
              files="(JsonConverter|Values|ConnectHeaders).java"/>

    <suppress checks="JavaNCSS"
              files="(KafkaConfigBackingStore|Values|ConnectMetricsRegistry).java"/>

    <suppress checks="NPathComplexity"
              files="(DistributedHerder|AbstractHerder|RestClient|RestServer|JsonConverter|KafkaConfigBackingStore|FileStreamSourceTask|WorkerSourceTask|TopicAdmin).java"/>

    <!-- connect tests-->
    <suppress checks="ClassDataAbstractionCoupling"
              files="(DistributedHerder|KafkaBasedLog|WorkerSourceTaskWithTopicCreation|WorkerSourceTask)Test.java"/>

    <suppress checks="ClassFanOutComplexity"
              files="(WorkerSink|WorkerSource|ErrorHandling)Task(|WithTopicCreation)Test.java"/>
    <suppress checks="ClassFanOutComplexity"
              files="DistributedHerderTest.java"/>

    <suppress checks="MethodLength"
              files="(RequestResponse|WorkerSinkTask)Test.java"/>

    <suppress checks="JavaNCSS"
              files="(DistributedHerder|Worker)Test.java"/>

    <!-- Raft -->
    <suppress checks="NPathComplexity"
              files="RecordsIterator.java"/>

    <!-- Streams -->
    <suppress checks="ClassFanOutComplexity"
              files="(KafkaStreams|KStreamImpl|KTableImpl|InternalTopologyBuilder|StreamsPartitionAssignor|StreamThread|IQv2StoreIntegrationTest|KStreamImplTest|RocksDBStore).java"/>

    <suppress checks="MethodLength"
              files="KTableImpl.java"/>

    <suppress checks="ParameterNumber"
              files="StreamThread.java"/>

    <suppress checks="ClassDataAbstractionCoupling"
              files="(KafkaStreams|KStreamImpl|KTableImpl).java"/>

    <suppress checks="CyclomaticComplexity"
              files="(KafkaStreams|StreamsPartitionAssignor|StreamThread|TaskManager|PartitionGroup|SubscriptionWrapperSerde|AssignorConfiguration).java"/>

    <suppress checks="StaticVariableName"
              files="StreamsMetricsImpl.java"/>

    <suppress checks="NPathComplexity"
              files="(KafkaStreams|StreamsPartitionAssignor|StreamThread|TaskManager|GlobalStateManagerImpl|KStreamImplJoin|TopologyConfig|KTableKTableOuterJoin).java"/>

    <suppress checks="(FinalLocalVariable|UnnecessaryParentheses|BooleanExpressionComplexity|CyclomaticComplexity|WhitespaceAfter|LocalVariableName)"
              files="Murmur3.java"/>

    <suppress checks="(NPathComplexity|CyclomaticComplexity)"
              files="(KStreamSlidingWindowAggregate|RackAwareTaskAssignor).java"/>

    <!-- suppress FinalLocalVariable outside of the streams package. -->
    <suppress checks="FinalLocalVariable"
              files="^(?!.*[\\/]org[\\/]apache[\\/]kafka[\\/]streams[\\/].*$)"/>

    <!-- Generated code -->
    <suppress checks="(NPathComplexity|ClassFanOutComplexity|CyclomaticComplexity|ClassDataAbstractionCoupling|FinalLocalVariable|LocalVariableName|MemberName|ParameterName|MethodLength|JavaNCSS|AvoidStarImport)"
              files="streams[\\/]src[\\/](generated|generated-test)[\\/].+.java$"/>
    <suppress checks="(NPathComplexity|ClassFanOutComplexity|CyclomaticComplexity|ClassDataAbstractionCoupling|FinalLocalVariable|LocalVariableName|MemberName|ParameterName|MethodLength|JavaNCSS|AvoidStarImport)"
              files="raft[\\/]src[\\/](generated|generated-test)[\\/].+.java$"/>
    <suppress checks="(NPathComplexity|ClassFanOutComplexity|CyclomaticComplexity|ClassDataAbstractionCoupling|FinalLocalVariable|LocalVariableName|MemberName|ParameterName|MethodLength|JavaNCSS|AvoidStarImport)"
              files="storage[\\/]src[\\/](generated|generated-test)[\\/].+.java$"/>
    <suppress checks="(NPathComplexity|ClassFanOutComplexity|CyclomaticComplexity|ClassDataAbstractionCoupling|FinalLocalVariable|LocalVariableName|MemberName|ParameterName|MethodLength|JavaNCSS|AvoidStarImport)"
              files="group-coordinator[\\/]src[\\/](generated|generated-test)[\\/].+.java$"/>

    <suppress checks="ImportControl" files="FetchResponseData.java"/>
    <suppress checks="ImportControl" files="RecordsSerdeTest.java"/>

    <!-- Streams tests -->
    <suppress checks="ClassFanOutComplexity"
              files="(RecordCollectorTest|StreamsPartitionAssignorTest|StreamThreadTest|StreamTaskTest|TaskManagerTest|TopologyTestDriverTest|KafkaStreamsTest|EosIntegrationTest).java"/>

    <suppress checks="MethodLength"
              files="(EosIntegrationTest|EosV2UpgradeIntegrationTest|KStreamKStreamJoinTest|RocksDBWindowStoreTest|StreamStreamJoinIntegrationTest).java"/>

    <suppress checks="ClassDataAbstractionCoupling"
              files=".*[/\\]streams[/\\].*test[/\\].*.java"/>

    <suppress checks="CyclomaticComplexity"
              files="(EosV2UpgradeIntegrationTest|KStreamKStreamJoinTest|KTableKTableForeignKeyJoinIntegrationTest|KTableKTableForeignKeyVersionedJoinIntegrationTest|RocksDBGenericOptionsToDbOptionsColumnFamilyOptionsAdapterTest|RelationalSmokeTest|MockProcessorContextStateStoreTest|IQv2StoreIntegrationTest).java"/>

    <suppress checks="JavaNCSS"
              files="(EosV2UpgradeIntegrationTest|KStreamKStreamJoinTest|StreamThreadTest|TaskManagerTest|StreamTaskTest).java"/>

    <suppress checks="NPathComplexity"
              files="(EosV2UpgradeIntegrationTest|EosTestDriver|KStreamKStreamJoinTest|KTableKTableForeignKeyJoinIntegrationTest|KTableKTableForeignKeyVersionedJoinIntegrationTest|RelationalSmokeTest|MockProcessorContextStateStoreTest|TopologyTestDriverTest|IQv2StoreIntegrationTest).java"/>

    <suppress checks="(FinalLocalVariable|WhitespaceAround|LocalVariableName|ImportControl|AvoidStarImport)"
              files="Murmur3Test.java"/>

    <suppress checks="MethodLength"
              files="(KStreamSlidingWindowAggregateTest|KStreamKStreamLeftJoinTest|KStreamKStreamOuterJoinTest|KTableKTableForeignKeyVersionedJoinIntegrationTest).java"/>

    <suppress checks="ClassFanOutComplexity"
              files="StreamTaskTest.java"/>

    <!-- Streams test-utils -->
    <suppress checks="ClassFanOutComplexity"
              files="TopologyTestDriver.java"/>
    <suppress checks="ClassDataAbstractionCoupling"
              files="TopologyTestDriver.java"/>

    <!-- Streams examples -->
    <suppress id="dontUseSystemExit"
              files="PageViewTypedDemo.java|PipeDemo.java|TemperatureDemo.java|WordCountDemo.java|WordCountProcessorDemo.java|WordCountTransformerDemo.java"/>

    <!-- Tools -->
    <suppress checks="ClassDataAbstractionCoupling"
              files="VerifiableConsumer.java"/>
    <suppress checks="CyclomaticComplexity"
              files="(ConsoleConsumer|DefaultMessageFormatter|StreamsResetter|ProducerPerformance|Agent).java"/>
    <suppress checks="BooleanExpressionComplexity"
              files="StreamsResetter.java"/>
    <suppress checks="NPathComplexity"
              files="(DefaultMessageFormatter|ProducerPerformance|StreamsResetter|Agent|TransactionalMessageCopier|ReplicaVerificationTool).java"/>
    <suppress checks="ImportControl"
              files="SignalLogger.java"/>
    <suppress checks="IllegalImport"
              files="SignalLogger.java"/>
    <suppress checks="ParameterNumber"
              files="ProduceBenchSpec.java"/>
    <suppress checks="ParameterNumber"
              files="ConsumeBenchSpec.java"/>
    <suppress checks="ParameterNumber"
              files="SustainedConnectionSpec.java"/>
    <suppress id="dontUseSystemExit"
              files="VerifiableConsumer.java"/>
    <suppress id="dontUseSystemExit"
              files="VerifiableProducer.java"/>

    <!-- Shell -->
    <suppress checks="CyclomaticComplexity"
              files="(GlobComponent|MetadataNodeManager).java"/>
    <suppress checks="MethodLength"
              files="(MetadataNodeManager).java"/>
    <suppress checks="JavaNCSS"
              files="(MetadataNodeManager).java"/>

    <!-- Log4J-Appender -->
    <suppress checks="CyclomaticComplexity"
              files="KafkaLog4jAppender.java"/>

    <suppress checks="NPathComplexity"
              files="KafkaLog4jAppender.java"/>
    <suppress checks="JavaNCSS"
              files="RequestResponseTest.java"/>

    <!-- metadata -->
    <suppress checks="ClassDataAbstractionCoupling"
              files="(QuorumController|QuorumControllerTest|ReplicationControlManager|ReplicationControlManagerTest|ClusterControlManagerTest|KRaftMigrationDriverTest).java"/>
    <suppress checks="ClassFanOutComplexity"
              files="(QuorumController|QuorumControllerTest|ReplicationControlManager|ReplicationControlManagerTest).java"/>
    <suppress checks="(ParameterNumber|ClassDataAbstractionCoupling)"
              files="(QuorumController).java"/>
    <suppress checks="(CyclomaticComplexity|NPathComplexity)"
              files="(PartitionRegistration|PartitionChangeBuilder).java"/>
    <suppress checks="CyclomaticComplexity"
              files="(ClientQuotasImage|KafkaEventQueue|MetadataDelta|QuorumController|ReplicationControlManager|KRaftMigrationDriver|ClusterControlManager|MetaPropertiesEnsemble).java"/>
    <suppress checks="NPathComplexity"
              files="(ClientQuotasImage|KafkaEventQueue|ReplicationControlManager|FeatureControlManager|KRaftMigrationDriver|ScramControlManager|ClusterControlManager|MetadataDelta|MetaPropertiesEnsemble).java"/>
    <suppress checks="(NPathComplexity|ClassFanOutComplexity|CyclomaticComplexity|ClassDataAbstractionCoupling|LocalVariableName|MemberName|ParameterName|MethodLength|JavaNCSS|AvoidStarImport)"
            files="metadata[\\/]src[\\/](generated|generated-test)[\\/].+.java$"/>
    <suppress checks="BooleanExpressionComplexity"
              files="(MetadataImage).java"/>
    <suppress checks="ImportControl"
              files="ApiVersionsResponse.java"/>
    <suppress checks="AvoidStarImport"
              files="MetadataVersionTest.java"/>

    <!-- group coordinator -->
    <suppress checks="CyclomaticComplexity"
              files="(ConsumerGroupMember|GroupMetadataManager|GeneralUniformAssignmentBuilder).java"/>
    <suppress checks="(NPathComplexity|MethodLength)"
              files="(GroupMetadataManager|ConsumerGroupTest|GroupMetadataManagerTest|GeneralUniformAssignmentBuilder).java"/>
    <suppress checks="NPathComplexity"
              files="CoordinatorRuntime.java"/>
    <suppress checks="ClassFanOutComplexity"
              files="(GroupMetadataManager|GroupMetadataManagerTest|GroupCoordinatorService|GroupCoordinatorServiceTest).java"/>
    <suppress checks="ParameterNumber"
              files="(ConsumerGroupMember|GroupMetadataManager|GroupCoordinatorConfig).java"/>
    <suppress checks="ClassDataAbstractionCouplingCheck"
              files="(RecordHelpersTest|GroupMetadataManager|GroupMetadataManagerTest|OffsetMetadataManagerTest|GroupCoordinatorServiceTest|GroupCoordinatorShardTest).java"/>
    <suppress checks="JavaNCSS"
              files="GroupMetadataManagerTest.java"/>

    <!-- storage -->
    <suppress checks="CyclomaticComplexity"
              files="(LogValidator|RemoteLogManagerConfig|RemoteLogManager).java"/>
    <suppress checks="NPathComplexity"
              files="(LogValidator|RemoteLogManager|RemoteIndexCache).java"/>
    <suppress checks="ParameterNumber"
              files="(LogAppendInfo|RemoteLogManagerConfig).java"/>

    <!-- benchmarks -->
    <suppress checks="(ClassDataAbstractionCoupling|ClassFanOutComplexity)"
              files="(ReplicaFetcherThreadBenchmark).java"/>

</suppressions>