Update the format and tests related to using NO_DEFAULT_FORMAT (#3)

Signed-off-by: Aindriu Lavelle <aindriu.lavelle@aiven.io>

Author: aindriu-aiven

src/main/java/io/aiven/commons/kafka/config/ConfigKeyBuilder.java

@@ -19,6 +19,8 @@
 
 package io.aiven.commons.kafka.config;
 
+import static org.apache.kafka.common.config.ConfigDef.NO_DEFAULT_VALUE;
+
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
@@ -40,8 +42,8 @@ public class ConfigKeyBuilder<T extends ConfigKeyBuilder<?>> {
   /** The type of the key. Defaults to {@link ConfigDef.Type#STRING}. */
   protected ConfigDef.Type type = ConfigDef.Type.STRING;
 
-  /** The default value for the config key. Defaults to {@code null}. */
-  protected Object defaultValue = null;
+  /** The default value for the config key. Defaults to {@code NO_DEFAULT_VALUE}. */
+  protected Object defaultValue = NO_DEFAULT_VALUE;
 
   /** The validator (if any) for this key. May be {@code null}. */
   protected ConfigDef.Validator validator;

src/test/java/io/aiven/commons/kafka/config/ConfigKeyBuilderTest.java

@@ -18,6 +18,7 @@
 
        SPDX-License-Identifier: Apache-2
 */
+import static org.apache.kafka.common.config.ConfigDef.NO_DEFAULT_VALUE;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import java.util.Arrays;
@@ -40,7 +41,7 @@ private void assertStandardValues(ConfigDef.ConfigKey key, String name) {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -59,7 +60,7 @@ void testDefault() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -78,7 +79,7 @@ void testDisplayName() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -97,7 +98,7 @@ void testDocumentation() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -116,7 +117,7 @@ void testGroup() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -135,7 +136,7 @@ void testDependents() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
 
     key = new ConfigKeyBuilder<>(name).dependent("one").dependent("two").build();
@@ -150,7 +151,7 @@ void testDependents() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
 
     key = new ConfigKeyBuilder<>(name).dependents(Arrays.asList("one", "two")).build();
@@ -165,7 +166,7 @@ void testDependents() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -185,7 +186,7 @@ void testImportance() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -204,7 +205,7 @@ void testInternalConfig() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
 
     key = new ConfigKeyBuilder<>(name).internalConfig(false).build();
@@ -219,7 +220,7 @@ void testInternalConfig() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -238,7 +239,7 @@ void testOrderInGroup() {
     assertThat(key.orderInGroup).isEqualTo(5);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -270,7 +271,7 @@ public boolean visible(String s, Map<String, Object> map) {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isEqualTo(recommender);
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 
@@ -289,7 +290,7 @@ void testType() {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.BOOLEAN);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }
 

src/test/java/io/aiven/commons/kafka/config/DeprecationReporterTest.java

@@ -50,6 +50,7 @@ public class DeprecationReporterTest {
                   .build())
           .define(
               ExtendedConfigKey.builder("roads")
+                  .defaultValue("Made of asphalt")
                   .deprecatedInfo(
                       DeprecatedInfo.builder()
                           .description("Where we're going we don't need roads")
@@ -64,6 +65,7 @@ public class DeprecationReporterTest {
                   .build())
           .define(
               ExtendedConfigKey.builder("shangrila")
+                  .defaultValue("Not a cup")
                   .documentation("not deprecated no-default")
                   .build())
           .define(

src/test/java/io/aiven/commons/kafka/config/ExtendedConfigKeyBuilderTest.java

@@ -18,6 +18,7 @@
 
        SPDX-License-Identifier: Apache-2
 */
+import static org.apache.kafka.common.config.ConfigDef.NO_DEFAULT_VALUE;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import org.apache.kafka.common.config.ConfigDef;
@@ -36,7 +37,7 @@ private void assertStandardValues(ConfigDef.ConfigKey key, String name) {
     assertThat(key.orderInGroup).isEqualTo(-1);
     assertThat(key.recommender).isNull();
     assertThat(key.type).isEqualTo(ConfigDef.Type.STRING);
-    assertThat(key.defaultValue).isNull();
+    assertThat(key.defaultValue).isEqualTo(NO_DEFAULT_VALUE);
     assertThat(key.validator).isNull();
   }