wip

tools/src/test/java/org/apache/kafka/tools/consumer/group/ConsumerGroupCommandTestUtils.java

@@ -46,6 +46,31 @@
 import static org.apache.kafka.coordinator.group.GroupCoordinatorConfig.OFFSETS_TOPIC_PARTITIONS_CONFIG;
 import static org.apache.kafka.coordinator.group.GroupCoordinatorConfig.OFFSETS_TOPIC_REPLICATION_FACTOR_CONFIG;
 
+/**
+ * The old test framework {@link kafka.api.BaseConsumerTest#getTestQuorumAndGroupProtocolParametersAll} test for the following cases:
+ * <ul>
+ *     <li>(ZK / KRAFT servers) with (group.coordinator.new.enable=false) with (classic group protocol) = 2 cases</li>
+ *     <li>(KRAFT server) with (group.coordinator.new.enable=true) with (classic group protocol) = 1 case</li>
+ *     <li>(KRAFT server) with (group.coordinator.new.enable=true) with (consumer group protocol) = 1 case</li>
+ * </ul>
+ * <p>
+ * The new test framework run seven cases for the following cases:
+ * <ul>
+ *     <li>(ZK / KRAFT / CO_KRAFT servers) with (group.coordinator.new.enable=false) with (classic group protocol) = 3 cases</li>
+ *     <li>(KRAFT / CO_KRAFT servers) with (group.coordinator.new.enable=true) with (classic group protocol) = 2 cases</li>
+ *     <li>(KRAFT / CO_KRAFT servers) with (group.coordinator.new.enable=true) with (consumer group protocol) = 2 cases</li>
+ * </ul>
+ * <p>
+ * We can reduce the number of cases as same as the old test framework by using the following methods:
+ * <ul>
+ *     <li>{@link #forConsumerGroupCoordinator()} for the case of (consumer group protocol)</li>
+ *     <li>(CO_KRAFT servers) with (group.coordinator.new.enable=true) with (classic / consumer group protocols) = 2 cases</li>
+ * </ul>
+ * <ul>
+ *     <li>{@link #forClassicGroupCoordinator()} for the case of (classic group protocol)</li>
+ *     <li>(ZK / KRAFT servers) with (group.coordinator.new.enable=false) with (classic group protocol) = 2 cases</li>
+ * </ul>
+ */
 class ConsumerGroupCommandTestUtils {
 
     private ConsumerGroupCommandTestUtils() {