KAFKA-19574: Improve producer and consumer config files

[fvaleri]

This is an attempt at improving the client configuration files. We now have sections and comments similar to the other properties files.

Reviewers: Kirk True [email protected], Luke Chen [email protected]

[fvaleri]

@showuon fyi.

Let me know if you want to add or remove anything.

[github-actions]

A label of 'needs-attention' was automatically added to this PR in order to raise the
attention of the committers. Once this issue has been triaged, the triage label
should be removed to prevent this automation from happening again.

[kirktrue]

Thanks for the PR @fvaleri!

I like the idea of providing more of the configuration and some explanation behind it.

How do we keep this from getting out of sync with ConsumerConfig and ProducerConfig?

[fvaleri]

Hi @kirktrue, thanks for having a look.

I added a couple of tests to ensure that these files remain in sync with config definitions.

Let me know what you think.

[kirktrue]

I added a couple of tests to ensure that these files remain in sync with config definitions.

Perfect! Thanks!

[kirktrue]

We need someone to add the ci-approved label so that we can see it pass the tests, but looks good otherwise.

[showuon]

Thanks for the improvement. This is definitely better than before.

[fvaleri]

@showuon @kirktrue we have 2 unrelated quarantined tests, but the rest looks good. Do you have additional comments on this?

  PlaintextConsumerTest > testAsyncConsumerCloseLeavesGroupOnInterrupt [1] Type=Raft-Isolated, MetadataVersion=4.2-IV1,BrokerSecurityProtocol=PLAINTEXT,BrokerListenerName=ListenerName(EXTERNAL),ControllerSecurityProtocol=PLAINTEXT,ControllerListenerName=ListenerName(CONTROLLER)
  PlaintextConsumerTest > testClassicConsumerCloseLeavesGroupOnInterrupt [1] Type=Raft-Isolated, MetadataVersion=4.2-IV1,BrokerSecurityProtocol=PLAINTEXT,BrokerListenerName=ListenerName(EXTERNAL),ControllerSecurityProtocol=PLAINTEXT,ControllerListenerName=ListenerName(CONTROLLER)

[showuon]

LGTM!

[showuon]

@kirktrue , I'm going to merge this PR tomorrow if you don't have any other comments. Thanks.

[kirktrue]

LGTM. Thanks @fvaleri!