Skip to content

KAFKA-19944: kafka-share-groups.sh describe offsets message improvement #21024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 3, 2025
+68 −23
Merged

KAFKA-19944: kafka-share-groups.sh describe offsets message improvement #21024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b29290d
KAFKA-19944: kafka-share-groups.sh describe offsets message improvement
AndrewJSchofield Nov 30, 2025
c199986
Improve assertion condition details
AndrewJSchofield Nov 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 27 additions & 23 deletions tools/src/main/java/org/apache/kafka/tools/consumer/group/ShareGroupCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,35 +545,39 @@ private void printOffsets(TreeMap<String, Entry<ShareGroupDescription, Collectio
.thenComparingInt(info -> info.partition))
.toList();

String fmt = printOffsetFormat(groupId, offsetsInfo, verbose);

if (verbose) {
System.out.printf(fmt, "GROUP", "TOPIC", "PARTITION", "LEADER-EPOCH", "START-OFFSET", "LAG");
if (offsetsInfo.isEmpty()) {
System.out.println("\nShare group '" + groupId + "' has no offset information.");
} else {
System.out.printf(fmt, "GROUP", "TOPIC", "PARTITION", "START-OFFSET", "LAG");
}
String fmt = printOffsetFormat(groupId, offsetsInfo, verbose);

for (SharePartitionOffsetInformation info : offsetsInfo) {
if (verbose) {
System.out.printf(fmt,
groupId,
info.topic,
info.partition,
info.leaderEpoch.map(Object::toString).orElse(MISSING_COLUMN_VALUE),
info.offset.map(Object::toString).orElse(MISSING_COLUMN_VALUE),
info.lag.map(Object::toString).orElse(MISSING_COLUMN_VALUE)
);
System.out.printf(fmt, "GROUP", "TOPIC", "PARTITION", "LEADER-EPOCH", "START-OFFSET", "LAG");
} else {
System.out.printf(fmt,
groupId,
info.topic,
info.partition,
info.offset.map(Object::toString).orElse(MISSING_COLUMN_VALUE),
info.lag.map(Object::toString).orElse(MISSING_COLUMN_VALUE)
);
System.out.printf(fmt, "GROUP", "TOPIC", "PARTITION", "START-OFFSET", "LAG");
}

for (SharePartitionOffsetInformation info : offsetsInfo) {
if (verbose) {
System.out.printf(fmt,
groupId,
info.topic,
info.partition,
info.leaderEpoch.map(Object::toString).orElse(MISSING_COLUMN_VALUE),
info.offset.map(Object::toString).orElse(MISSING_COLUMN_VALUE),
info.lag.map(Object::toString).orElse(MISSING_COLUMN_VALUE)
);
} else {
System.out.printf(fmt,
groupId,
info.topic,
info.partition,
info.offset.map(Object::toString).orElse(MISSING_COLUMN_VALUE),
info.lag.map(Object::toString).orElse(MISSING_COLUMN_VALUE)
);
}
}
System.out.println();
}
System.out.println();
});
}

Expand Down
41 changes: 41 additions & 0 deletions tools/src/test/java/org/apache/kafka/tools/consumer/group/ShareGroupCommandTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,47 @@ public void testDescribeOffsetsOfExistingGroupWithNulls() throws Exception {
}
}

@Test
public void testDescribeOffsetsOfExistingGroupWithNoOffsetInfo() throws Exception {
String firstGroup = "group1";
String bootstrapServer = "localhost:9092";

for (List<String> describeType : DESCRIBE_TYPE_OFFSETS) {
List<String> cgcArgs = new ArrayList<>(List.of("--bootstrap-server", bootstrapServer, "--describe", "--group", firstGroup));
cgcArgs.addAll(describeType);
Admin adminClient = mock(KafkaAdminClient.class);
DescribeShareGroupsResult describeShareGroupsResult = mock(DescribeShareGroupsResult.class);
ShareGroupDescription exp = new ShareGroupDescription(
firstGroup,
List.of(),
GroupState.EMPTY,
new Node(0, "host1", 9090), 0, 0);
// When there is no offset information at all, an empty map will be returned
ListShareGroupOffsetsResult listShareGroupOffsetsResult = AdminClientTestUtils.createListShareGroupOffsetsResult(
Map.of(
firstGroup,
KafkaFuture.completedFuture(Map.of())
)
);

when(describeShareGroupsResult.describedGroups()).thenReturn(Map.of(firstGroup, KafkaFuture.completedFuture(exp)));
when(adminClient.describeShareGroups(ArgumentMatchers.anyCollection(), any(DescribeShareGroupsOptions.class))).thenReturn(describeShareGroupsResult);
when(adminClient.listShareGroupOffsets(ArgumentMatchers.anyMap(), any(ListShareGroupOffsetsOptions.class))).thenReturn(listShareGroupOffsetsResult);
try (ShareGroupService service = getShareGroupService(cgcArgs.toArray(new String[0]), adminClient)) {
TestUtils.waitForCondition(() -> {
Entry<String, String> res = ToolsTestUtils.grabConsoleOutputAndError(describeGroups(service));
String[] lines = res.getKey().trim().split("\n");
if (lines.length != 1 && !res.getValue().isEmpty()) {
return false;
}

String expectedValue = "Share group '" + firstGroup + "' has no offset information.";
return expectedValue.equals(lines[0]);
}, "Expected just an informational message with describe type " + String.join(" ", describeType) + ".");
}
}
}

@Test
public void testDescribeOffsetsOfAllExistingGroups() throws Exception {
String firstGroup = "group1";
Expand Down