[fix][test] Fixed Nondeterministic Assertions in KafkaAbstractSinkTest

[LucasEby]

Fixes apache#24876

Motivation

The original test performed six assertions using the expectThrows method but was based on two incorrect assumptions. First, it implicitly assumed that field validation within IOConfigUtils.java would occur in a consistent order. However, IOConfigUtils iterates over configuration fields using the loop (Field field : getAllFields(clazz)), and getAllFields() calls Class.getDeclaredFields, which returns an array of fields that are not sorted and not in any particular order. Second, the test initialized multiple required fields as null simultaneously, assuming the validation would fail in a specific order. In reality, the nondeterministic field iteration order can cause different missing fields to be detected first, leading to inconsistent exception messages and nondeterministic test failures due to different environments producing the contents in different orders despite the logical contents being the same.

• pulsar-io/kafka/src/test/java/org/apache/pulsar/io/kafka/sink/KafkaAbstractSinkTest.java

Modifications

Instead of reusing and mutating the same map, each validation case now creates it's own copy of the valid base config data with ``validConfig``` prior to mutating it and later asserting. By isolating the mutations for each test, this ensures the behavior will be as expected. To make the code easier to read, a tiny table of cases was added (record Case(...)) which is made up of the basic components of the original test cases: how the data should be mutated, the expected exception type, and the expected message. The final sanity check which ensures the valid config passes was preserved. These changes ensure the test passes consistently, even when the fields are checked in a different order.

In essence, these changes keep the spirit of the original tests while eliminating failures caused solely by allowed (but previously unexpected) reordering.

Verifying this change

• Make sure that the change passes the CI checks.

This change is already covered by existing tests, such as

• pulsar-io/kafka/src/test/java/org/apache/pulsar/io/kafka/sink/KafkaAbstractSinkTest.java

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

• Dependencies (add or upgrade a dependency)
• The public API
• The schema
• The default values of configurations
• The threading model
• The binary protocol
• The REST endpoints
• The admin CLI options
• The metrics
• Anything that affects deployment

Documentation

• doc
• doc-required
• doc-not-needed
• doc-complete

Matching PR in forked repository

PR in forked repository:

[LucasEby]

This line was a separate small bug. Actual comes before expected in Testng assertEquals method: https://www.javadoc.io/doc/org.testng/testng/6.8.17/org/testng/Assert.html

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!