fvaleri commented on code in PR #22384:
URL: https://github.com/apache/kafka/pull/22384#discussion_r3323756586
##########
metadata/src/test/java/org/apache/kafka/metadata/storage/FormatterTest.java:
##########
@@ -587,4 +587,18 @@ public void testFormatWithNoInitialControllers() throws
Exception {
assertNotNull(logDirProps1);
}
}
+
+ @ParameterizedTest
+ @ValueSource(strings = {"unrvTtQISjar0JUWGU/8Pg",
"igNUVIdeSPO5JCZYFhOh7Q==", "AAAAAAAAAAAAAAAAAAAAAA", "AAAAAAAAAAAAAAAAAAAAAQ"})
+ public void testFormatWithInvalidClusterId(String clusterId) throws
Exception {
Review Comment:
There's no corresponding positive test showing that a valid CID passes
validation. This would guard against the validation being too aggressive.
##########
metadata/src/main/java/org/apache/kafka/metadata/storage/Formatter.java:
##########
@@ -236,6 +236,17 @@ public void run() throws Exception {
if (clusterId == null) {
throw new FormatterException("You must specify the cluster id.");
}
+ try {
+ if (clusterId.contains("=")) {
+ throw new FormatterException("The specified cluster id, " +
clusterId + " contains padding and is invalid");
Review Comment:
```suggestion
throw new FormatterException("The specified cluster id, " +
clusterId + " is invalid: contains padding");
```
##########
metadata/src/main/java/org/apache/kafka/metadata/storage/Formatter.java:
##########
@@ -236,6 +236,17 @@ public void run() throws Exception {
if (clusterId == null) {
throw new FormatterException("You must specify the cluster id.");
}
+ try {
+ if (clusterId.contains("=")) {
+ throw new FormatterException("The specified cluster id, " +
clusterId + " contains padding and is invalid");
Review Comment:
I think this actually covers a real gap. The one in which a CID like
`igNUVIdeSPO5JCZYFhOh7Q==` would pass the validation, but would be returned as
`igNUVIdeSPO5JCZYFhOh7Q` by Uuid.toString(). I would just move it outside the
try-catch block as it throws FormatterException directly and would bypass the
catch anyway.
##########
metadata/src/test/java/org/apache/kafka/metadata/storage/FormatterTest.java:
##########
@@ -587,4 +587,18 @@ public void testFormatWithNoInitialControllers() throws
Exception {
assertNotNull(logDirProps1);
}
}
+
+ @ParameterizedTest
+ @ValueSource(strings = {"unrvTtQISjar0JUWGU/8Pg",
"igNUVIdeSPO5JCZYFhOh7Q==", "AAAAAAAAAAAAAAAAAAAAAA", "AAAAAAAAAAAAAAAAAAAAAQ"})
+ public void testFormatWithInvalidClusterId(String clusterId) throws
Exception {
+ try (TestEnv testEnv = new TestEnv(2)) {
+ FormatterContext formatter1 = testEnv.newFormatter();
+ formatter1.formatter.setClusterId(clusterId);
+ String expectedPrefix = "The specified cluster id, " + clusterId;
+ assertEquals(expectedPrefix,
+ assertThrows(FormatterException.class,
+ formatter1.formatter::run).
+ getMessage().substring(0,
expectedPrefix.length()));
Review Comment:
Wouldn't be easier to rewrite like:
assertTrue(message.startsWith(expectedPrefix))
##########
metadata/src/main/java/org/apache/kafka/metadata/storage/Formatter.java:
##########
@@ -236,6 +236,17 @@ public void run() throws Exception {
if (clusterId == null) {
throw new FormatterException("You must specify the cluster id.");
}
+ try {
+ if (clusterId.contains("=")) {
+ throw new FormatterException("The specified cluster id, " +
clusterId + " contains padding and is invalid");
+ }
+ Uuid uuid = Uuid.fromString(clusterId);
+ if (Uuid.RESERVED.contains(uuid)) {
+ throw new FormatterException("The specified cluster id, " +
clusterId + " is reserved");
+ }
Review Comment:
Good point. Let's add comment about this for future reference.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
