content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements. See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License. You may obtain a copy of the License at
   *
   *    http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.kafka.common.config;
  
  import org.apache.kafka.common.config.ConfigDef.CaseInsensitiveValidString;
  import org.apache.kafka.common.config.ConfigDef.Importance;
  import org.apache.kafka.common.config.ConfigDef.ListSize;
  import org.apache.kafka.common.config.ConfigDef.Range;
  import org.apache.kafka.common.config.ConfigDef.Type;
  import org.apache.kafka.common.config.ConfigDef.ValidString;
  import org.apache.kafka.common.config.ConfigDef.Validator;
  import org.apache.kafka.common.config.ConfigDef.Width;
  import org.apache.kafka.common.config.types.Password;
  
  import org.junit.jupiter.api.Test;
  
  import java.time.Duration;
  import java.util.Arrays;
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.HashSet;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Map;
  import java.util.Properties;
  import java.util.Set;
  
  import static java.util.Arrays.asList;
  import static java.util.Collections.singletonList;
  import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertFalse;
  import static org.junit.jupiter.api.Assertions.assertNull;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  import static org.junit.jupiter.api.Assertions.fail;
  
  public class ConfigDefTest {
  
      @Test
      public void testBasicTypes() {
          ConfigDef def = new ConfigDef().define("a", Type.INT, 5, Range.between(0, 14), Importance.HIGH, "docs")
                                         .define("b", Type.LONG, Importance.HIGH, "docs")
                                         .define("c", Type.STRING, "hello", Importance.HIGH, "docs")
                                         .define("d", Type.LIST, Importance.HIGH, "docs")
                                         .define("e", Type.DOUBLE, Importance.HIGH, "docs")
                                         .define("f", Type.CLASS, Importance.HIGH, "docs")
                                         .define("g", Type.BOOLEAN, Importance.HIGH, "docs")
                                         .define("h", Type.BOOLEAN, Importance.HIGH, "docs")
                                         .define("i", Type.BOOLEAN, Importance.HIGH, "docs")
                                         .define("j", Type.PASSWORD, Importance.HIGH, "docs");
  
          Properties props = new Properties();
          props.put("a", "1   ");
          props.put("b", 2);
          props.put("d", " a , b, c");
          props.put("e", 42.5d);
          props.put("f", String.class.getName());
          props.put("g", "true");
          props.put("h", "FalSE");
          props.put("i", "TRUE");
          props.put("j", "password");
  
          Map<String, Object> vals = def.parse(props);
          assertEquals(1, vals.get("a"));
          assertEquals(2L, vals.get("b"));
          assertEquals("hello", vals.get("c"));
          assertEquals(asList("a", "b", "c"), vals.get("d"));
          assertEquals(42.5d, vals.get("e"));
          assertEquals(String.class, vals.get("f"));
          assertEquals(true, vals.get("g"));
          assertEquals(false, vals.get("h"));
          assertEquals(true, vals.get("i"));
          assertEquals(new Password("password"), vals.get("j"));
          assertEquals(Password.HIDDEN, vals.get("j").toString());
      }
  
      @Test
      public void testInvalidDefault() {
          assertThrows(ConfigException.class, () -> new ConfigDef().define("a", Type.INT, "hello", Importance.HIGH, "docs"));
      }
  
      @Test
      public void testNullDefault() {
          ConfigDef def = new ConfigDef().define("a", Type.INT, null, null, "docs");
          Map<String, Object> vals = def.parse(new Properties());
  
          assertNull(vals.get("a"));
      }
  
      @Test
      public void testMissingRequired() {
          assertThrows(ConfigException.class, () -> new ConfigDef().define("a", Type.INT, Importance.HIGH, "docs").parse(new HashMap<String, Object>()));
      }
  
      @Test
      public void testParsingEmptyDefaultValueForStringFieldShouldSucceed() {
          new ConfigDef().define("a", Type.STRING, "", ConfigDef.Importance.HIGH, "docs")
                  .parse(new HashMap<String, Object>());
      }
  
      @Test
      public void testDefinedTwice() {
          assertThrows(ConfigException.class, () -> new ConfigDef().define("a", Type.STRING,
              Importance.HIGH, "docs").define("a", Type.INT, Importance.HIGH, "docs"));
      }
  
      @Test
      public void testBadInputs() {
          testBadInputs(Type.INT, "hello", "42.5", 42.5, Long.MAX_VALUE, Long.toString(Long.MAX_VALUE), new Object());
          testBadInputs(Type.LONG, "hello", "42.5", Long.MAX_VALUE + "00", new Object());
          testBadInputs(Type.DOUBLE, "hello", new Object());
          testBadInputs(Type.STRING, new Object());
          testBadInputs(Type.LIST, 53, new Object());
          testBadInputs(Type.BOOLEAN, "hello", "truee", "fals");
          testBadInputs(Type.CLASS, "ClassDoesNotExist");
      }
  
      private void testBadInputs(Type type, Object... values) {
          for (Object value : values) {
              Map<String, Object> m = new HashMap<>();
              m.put("name", value);
              ConfigDef def = new ConfigDef().define("name", type, Importance.HIGH, "docs");
              try {
                  def.parse(m);
                  fail("Expected a config exception on bad input for value " + value);
              } catch (ConfigException e) {
                  // this is good
              }
          }
      }
  
      @Test
      public void testInvalidDefaultRange() {
          assertThrows(ConfigException.class, () -> new ConfigDef().define("name", Type.INT, -1,
              Range.between(0, 10), Importance.HIGH, "docs"));
      }
  
      @Test
      public void testInvalidDefaultString() {
          assertThrows(ConfigException.class, () -> new ConfigDef().define("name", Type.STRING, "bad",
              ValidString.in("valid", "values"), Importance.HIGH, "docs"));
      }
  
      @Test
      public void testNestedClass() {
          // getName(), not getSimpleName() or getCanonicalName(), is the version that should be able to locate the class
          Map<String, Object> props = Collections.singletonMap("name", NestedClass.class.getName());
          new ConfigDef().define("name", Type.CLASS, Importance.HIGH, "docs").parse(props);
      }
  
      @Test
      public void testValidators() {
          testValidators(Type.INT, Range.between(0, 10), 5, new Object[]{1, 5, 9}, new Object[]{-1, 11, null});
          testValidators(Type.STRING, ValidString.in("good", "values", "default"), "default",
                  new Object[]{"good", "values", "default"}, new Object[]{"bad", "inputs", "DEFAULT", null});
          testValidators(Type.STRING, CaseInsensitiveValidString.in("good", "values", "default"), "default",
              new Object[]{"gOOd", "VALUES", "default"}, new Object[]{"Bad", "iNPUts", null});
          testValidators(Type.LIST, ConfigDef.ValidList.in("1", "2", "3"), "1", new Object[]{"1", "2", "3"}, new Object[]{"4", "5", "6"});
          testValidators(Type.STRING, new ConfigDef.NonNullValidator(), "a", new Object[]{"abb"}, new Object[] {null});
          testValidators(Type.STRING, ConfigDef.CompositeValidator.of(new ConfigDef.NonNullValidator(), ValidString.in("a", "b")), "a", new Object[]{"a", "b"}, new Object[] {null, -1, "c"});
          testValidators(Type.STRING, new ConfigDef.NonEmptyStringWithoutControlChars(), "defaultname",
                  new Object[]{"test", "name", "test/test", "test\u1234", "\u1324name\\", "/+%>&):??<&()?-", "+1", "\uD83D\uDE01", "\uF3B1", "     test   \n\r", "\n  hello \t"},
                  new Object[]{"nontrailing\nnotallowed", "as\u0001cii control char", "tes\rt", "test\btest", "1\t2", ""});
      }
  
      @Test
      public void testSslPasswords() {
          ConfigDef def = new ConfigDef();
          SslConfigs.addClientSslSupport(def);
  
          Properties props = new Properties();
          props.put(SslConfigs.SSL_KEY_PASSWORD_CONFIG, "key_password");
          props.put(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG, "keystore_password");
          props.put(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG, "truststore_password");
  
          Map<String, Object> vals = def.parse(props);
          assertEquals(new Password("key_password"), vals.get(SslConfigs.SSL_KEY_PASSWORD_CONFIG));
          assertEquals(Password.HIDDEN, vals.get(SslConfigs.SSL_KEY_PASSWORD_CONFIG).toString());
          assertEquals(new Password("keystore_password"), vals.get(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG));
          assertEquals(Password.HIDDEN, vals.get(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG).toString());
          assertEquals(new Password("truststore_password"), vals.get(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG));
          assertEquals(Password.HIDDEN, vals.get(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG).toString());
      }
  
      @Test
      public void testNullDefaultWithValidator() {
          final String key = "enum_test";
  
          ConfigDef def = new ConfigDef();
          def.define(key, Type.STRING, ConfigDef.NO_DEFAULT_VALUE,
                     ValidString.in("ONE", "TWO", "THREE"), Importance.HIGH, "docs");
  
          Properties props = new Properties();
          props.put(key, "ONE");
          Map<String, Object> vals = def.parse(props);
          assertEquals("ONE", vals.get(key));
      }
  
      @Test
      public void testGroupInference() {
          List<String> expected1 = Arrays.asList("group1", "group2");
          ConfigDef def1 = new ConfigDef()
              .define("a", Type.INT, Importance.HIGH, "docs", "group1", 1, Width.SHORT, "a")
              .define("b", Type.INT, Importance.HIGH, "docs", "group2", 1, Width.SHORT, "b")
              .define("c", Type.INT, Importance.HIGH, "docs", "group1", 2, Width.SHORT, "c");
  
          assertEquals(expected1, def1.groups());
  
          List<String> expected2 = Arrays.asList("group2", "group1");
          ConfigDef def2 = new ConfigDef()
              .define("a", Type.INT, Importance.HIGH, "docs", "group2", 1, Width.SHORT, "a")
              .define("b", Type.INT, Importance.HIGH, "docs", "group2", 2, Width.SHORT, "b")
              .define("c", Type.INT, Importance.HIGH, "docs", "group1", 2, Width.SHORT, "c");
  
          assertEquals(expected2, def2.groups());
      }
  
      @Test
      public void testParseForValidate() {
          Map<String, Object> expectedParsed = new HashMap<>();
          expectedParsed.put("a", 1);
          expectedParsed.put("b", null);
          expectedParsed.put("c", null);
          expectedParsed.put("d", 10);
  
          Map<String, ConfigValue> expected = new HashMap<>();
          String errorMessageB = "Missing required configuration \"b\" which has no default value.";
          String errorMessageC = "Missing required configuration \"c\" which has no default value.";
          ConfigValue configA = new ConfigValue("a", 1, Collections.emptyList(), Collections.emptyList());
          ConfigValue configB = new ConfigValue("b", null, Collections.emptyList(), Arrays.asList(errorMessageB, errorMessageB));
          ConfigValue configC = new ConfigValue("c", null, Collections.emptyList(), singletonList(errorMessageC));
          ConfigValue configD = new ConfigValue("d", 10, Collections.emptyList(), Collections.emptyList());
          expected.put("a", configA);
          expected.put("b", configB);
          expected.put("c", configC);
          expected.put("d", configD);
  
          ConfigDef def = new ConfigDef()
              .define("a", Type.INT, Importance.HIGH, "docs", "group", 1, Width.SHORT, "a", Arrays.asList("b", "c"), new IntegerRecommender(false))
              .define("b", Type.INT, Importance.HIGH, "docs", "group", 2, Width.SHORT, "b", new IntegerRecommender(true))
              .define("c", Type.INT, Importance.HIGH, "docs", "group", 3, Width.SHORT, "c", new IntegerRecommender(true))
              .define("d", Type.INT, Importance.HIGH, "docs", "group", 4, Width.SHORT, "d", singletonList("b"), new IntegerRecommender(false));
  
          Map<String, String> props = new HashMap<>();
          props.put("a", "1");
          props.put("d", "10");
  
          Map<String, ConfigValue> configValues = new HashMap<>();
  
          for (String name : def.configKeys().keySet()) {
              configValues.put(name, new ConfigValue(name));
          }
  
          Map<String, Object> parsed = def.parseForValidate(props, configValues);
  
          assertEquals(expectedParsed, parsed);
          assertEquals(expected, configValues);
      }
  
      @Test
      public void testValidate() {
          Map<String, ConfigValue> expected = new HashMap<>();
          String errorMessageB = "Missing required configuration \"b\" which has no default value.";
          String errorMessageC = "Missing required configuration \"c\" which has no default value.";
  
          ConfigValue configA = new ConfigValue("a", 1, Arrays.asList(1, 2, 3), Collections.emptyList());
          ConfigValue configB = new ConfigValue("b", null, Arrays.asList(4, 5), Arrays.asList(errorMessageB, errorMessageB));
          ConfigValue configC = new ConfigValue("c", null, Arrays.asList(4, 5), singletonList(errorMessageC));
          ConfigValue configD = new ConfigValue("d", 10, Arrays.asList(1, 2, 3), Collections.emptyList());
  
          expected.put("a", configA);
          expected.put("b", configB);
          expected.put("c", configC);
          expected.put("d", configD);
  
          ConfigDef def = new ConfigDef()
              .define("a", Type.INT, Importance.HIGH, "docs", "group", 1, Width.SHORT, "a", Arrays.asList("b", "c"), new IntegerRecommender(false))
              .define("b", Type.INT, Importance.HIGH, "docs", "group", 2, Width.SHORT, "b", new IntegerRecommender(true))
              .define("c", Type.INT, Importance.HIGH, "docs", "group", 3, Width.SHORT, "c", new IntegerRecommender(true))
              .define("d", Type.INT, Importance.HIGH, "docs", "group", 4, Width.SHORT, "d", singletonList("b"), new IntegerRecommender(false));
  
          Map<String, String> props = new HashMap<>();
          props.put("a", "1");
          props.put("d", "10");
  
          List<ConfigValue> configs = def.validate(props);
          for (ConfigValue config : configs) {
              String name = config.name();
              ConfigValue expectedConfig = expected.get(name);
              assertEquals(expectedConfig, config);
          }
      }
  
      @Test
      public void testValidateMissingConfigKey() {
          Map<String, ConfigValue> expected = new HashMap<>();
          String errorMessageB = "Missing required configuration \"b\" which has no default value.";
          String errorMessageC = "Missing required configuration \"c\" which has no default value.";
          String errorMessageD = "d is referred in the dependents, but not defined.";
  
          ConfigValue configA = new ConfigValue("a", 1, Arrays.asList(1, 2, 3), Collections.emptyList());
          ConfigValue configB = new ConfigValue("b", null, Arrays.asList(4, 5), singletonList(errorMessageB));
          ConfigValue configC = new ConfigValue("c", null, Arrays.asList(4, 5), singletonList(errorMessageC));
          ConfigValue configD = new ConfigValue("d", null, Collections.emptyList(), singletonList(errorMessageD));
          configD.visible(false);
  
          expected.put("a", configA);
          expected.put("b", configB);
          expected.put("c", configC);
          expected.put("d", configD);
  
          ConfigDef def = new ConfigDef()
              .define("a", Type.INT, Importance.HIGH, "docs", "group", 1, Width.SHORT, "a", Arrays.asList("b", "c", "d"), new IntegerRecommender(false))
              .define("b", Type.INT, Importance.HIGH, "docs", "group", 2, Width.SHORT, "b", new IntegerRecommender(true))
              .define("c", Type.INT, Importance.HIGH, "docs", "group", 3, Width.SHORT, "c", new IntegerRecommender(true));
  
          Map<String, String> props = new HashMap<>();
          props.put("a", "1");
  
          List<ConfigValue> configs = def.validate(props);
          for (ConfigValue config: configs) {
              String name = config.name();
              ConfigValue expectedConfig = expected.get(name);
              assertEquals(expectedConfig, config);
          }
      }
  
      @Test
      public void testValidateCannotParse() {
          Map<String, ConfigValue> expected = new HashMap<>();
          String errorMessageB = "Invalid value non_integer for configuration a: Not a number of type INT";
          ConfigValue configA = new ConfigValue("a", null, Collections.emptyList(), singletonList(errorMessageB));
          expected.put("a", configA);
  
          ConfigDef def = new ConfigDef().define("a", Type.INT, Importance.HIGH, "docs");
          Map<String, String> props = new HashMap<>();
          props.put("a", "non_integer");
  
          List<ConfigValue> configs = def.validate(props);
          for (ConfigValue config: configs) {
              String name = config.name();
              ConfigValue expectedConfig = expected.get(name);
              assertEquals(expectedConfig, config);
          }
      }
  
      @Test
      public void testCanAddInternalConfig() {
          final String configName = "internal.config";
          final ConfigDef configDef = new ConfigDef().defineInternal(configName, Type.STRING, "", Importance.LOW);
          final HashMap<String, String> properties = new HashMap<>();
          properties.put(configName, "value");
          final List<ConfigValue> results = configDef.validate(properties);
          final ConfigValue configValue = results.get(0);
          assertEquals("value", configValue.value());
          assertEquals(configName, configValue.name());
      }
  
      @Test
      public void testInternalConfigDoesntShowUpInDocs() {
          final String name = "my.config";
          final ConfigDef configDef = new ConfigDef().defineInternal(name, Type.STRING, "", Importance.LOW);
          configDef.defineInternal("my.other.config", Type.STRING, "", null, Importance.LOW, null);
          assertFalse(configDef.toHtmlTable().contains("my.config"));
          assertFalse(configDef.toEnrichedRst().contains("my.config"));
          assertFalse(configDef.toRst().contains("my.config"));
          assertFalse(configDef.toHtmlTable().contains("my.other.config"));
          assertFalse(configDef.toEnrichedRst().contains("my.other.config"));
          assertFalse(configDef.toRst().contains("my.other.config"));
      }
  
      @Test
      public void testDynamicUpdateModeInDocs() {
          final ConfigDef configDef = new ConfigDef()
                  .define("my.broker.config", Type.LONG, Importance.HIGH, "docs")
                  .define("my.cluster.config", Type.LONG, Importance.HIGH, "docs")
                  .define("my.readonly.config", Type.LONG, Importance.HIGH, "docs");
          final Map<String, String> updateModes = new HashMap<>();
          updateModes.put("my.broker.config", "per-broker");
          updateModes.put("my.cluster.config", "cluster-wide");
          final String html = configDef.toHtmlTable(updateModes);
          Set<String> configsInHtml = new HashSet<>();
          for (String line : html.split("\n")) {
              if (line.contains("my.broker.config")) {
                  assertTrue(line.contains("per-broker"));
                  configsInHtml.add("my.broker.config");
              } else if (line.contains("my.cluster.config")) {
                  assertTrue(line.contains("cluster-wide"));
                  configsInHtml.add("my.cluster.config");
              } else if (line.contains("my.readonly.config")) {
                  assertTrue(line.contains("read-only"));
                  configsInHtml.add("my.readonly.config");
              }
          }
          assertEquals(configDef.names(), configsInHtml);
      }
  
      @Test
      public void testNames() {
          final ConfigDef configDef = new ConfigDef()
                  .define("a", Type.STRING, Importance.LOW, "docs")
                  .define("b", Type.STRING, Importance.LOW, "docs");
          Set<String> names = configDef.names();
          assertEquals(new HashSet<>(Arrays.asList("a", "b")), names);
          // should be unmodifiable
          try {
              names.add("new");
              fail();
          } catch (UnsupportedOperationException e) {
              // expected
          }
      }
  
      @Test
      public void testMissingDependentConfigs() {
          // Should not be possible to parse a config if a dependent config has not been defined
          final ConfigDef configDef = new ConfigDef()
                  .define("parent", Type.STRING, Importance.HIGH, "parent docs", "group", 1, Width.LONG, "Parent", singletonList("child"));
          assertThrows(ConfigException.class, () -> configDef.parse(Collections.emptyMap()));
      }
  
      @Test
      public void testBaseConfigDefDependents() {
          // Creating a ConfigDef based on another should compute the correct number of configs with no parent, even
          // if the base ConfigDef has already computed its parentless configs
          final ConfigDef baseConfigDef = new ConfigDef().define("a", Type.STRING, Importance.LOW, "docs");
          assertEquals(new HashSet<>(singletonList("a")), baseConfigDef.getConfigsWithNoParent());
  
          final ConfigDef configDef = new ConfigDef(baseConfigDef)
                  .define("parent", Type.STRING, Importance.HIGH, "parent docs", "group", 1, Width.LONG, "Parent", singletonList("child"))
                  .define("child", Type.STRING, Importance.HIGH, "docs");
  
          assertEquals(new HashSet<>(Arrays.asList("a", "parent")), configDef.getConfigsWithNoParent());
      }
  
  
      private static class IntegerRecommender implements ConfigDef.Recommender {
  
          private final boolean hasParent;
  
          public IntegerRecommender(boolean hasParent) {
              this.hasParent = hasParent;
          }
  
          @Override
          public List<Object> validValues(String name, Map<String, Object> parsedConfig) {
              List<Object> values = new LinkedList<>();
              if (!hasParent) {
                  values.addAll(Arrays.asList(1, 2, 3));
              } else {
                  values.addAll(Arrays.asList(4, 5));
              }
              return values;
          }
  
          @Override
          public boolean visible(String name, Map<String, Object> parsedConfig) {
              return true;
          }
      }
  
      private void testValidators(Type type, Validator validator, Object defaultVal, Object[] okValues, Object[] badValues) {
          ConfigDef def = new ConfigDef().define("name", type, defaultVal, validator, Importance.HIGH, "docs");
  
          for (Object value : okValues) {
              Map<String, Object> m = new HashMap<>();
              m.put("name", value);
              def.parse(m);
          }
  
          for (Object value : badValues) {
              Map<String, Object> m = new HashMap<>();
              m.put("name", value);
              try {
                  def.parse(m);
                  fail("Expected a config exception due to invalid value " + value);
              } catch (ConfigException e) {
                  // this is good
              }
          }
      }
  
      @Test
      public void toRst() {
          final ConfigDef def = new ConfigDef()
                  .define("opt1", Type.STRING, "a", ValidString.in("a", "b", "c"), Importance.HIGH, "docs1")
                  .define("opt2", Type.INT, Importance.MEDIUM, "docs2")
                  .define("opt3", Type.LIST, Arrays.asList("a", "b"), Importance.LOW, "docs3")
                  .define("opt4", Type.BOOLEAN, false, Importance.LOW, null);
  
          final String expectedRst =
                  "``opt2``\n" +
                  "  docs2\n" +
                  "\n" +
                  "  * Type: int\n" +
                  "  * Importance: medium\n" +
                  "\n" +
                  "``opt1``\n" +
                  "  docs1\n" +
                  "\n" +
                  "  * Type: string\n" +
                  "  * Default: a\n" +
                  "  * Valid Values: [a, b, c]\n" +
                  "  * Importance: high\n" +
                  "\n" +
                  "``opt3``\n" +
                  "  docs3\n" +
                  "\n" +
                  "  * Type: list\n" +
                  "  * Default: a,b\n" +
                  "  * Importance: low\n" +
                  "\n" +
                  "``opt4``\n" +
                  "\n" +
                  "  * Type: boolean\n" +
                  "  * Default: false\n" +
                  "  * Importance: low\n" +
                  "\n";
  
          assertEquals(expectedRst, def.toRst());
      }
  
      @Test
      public void toEnrichedRst() {
          final ConfigDef def = new ConfigDef()
                  .define("opt1.of.group1", Type.STRING, "a", ValidString.in("a", "b", "c"), Importance.HIGH, "Doc doc.",
                          "Group One", 0, Width.NONE, "..", Collections.emptyList())
                  .define("opt2.of.group1", Type.INT, ConfigDef.NO_DEFAULT_VALUE, Importance.MEDIUM, "Doc doc doc.",
                          "Group One", 1, Width.NONE, "..", Arrays.asList("some.option1", "some.option2"))
                  .define("opt2.of.group2", Type.BOOLEAN, false, Importance.HIGH, "Doc doc doc doc.",
                          "Group Two", 1, Width.NONE, "..", Collections.emptyList())
                  .define("opt1.of.group2", Type.BOOLEAN, false, Importance.HIGH, "Doc doc doc doc doc.",
                          "Group Two", 0, Width.NONE, "..", singletonList("some.option"))
                  .define("poor.opt", Type.STRING, "foo", Importance.HIGH, "Doc doc doc doc.");
  
          final String expectedRst =
                  "``poor.opt``\n" +
                  "  Doc doc doc doc.\n" +
                  "\n" +
                  "  * Type: string\n" +
                  "  * Default: foo\n" +
                  "  * Importance: high\n" +
                  "\n" +
                  "Group One\n" +
                  "^^^^^^^^^\n" +
                  "\n" +
                  "``opt1.of.group1``\n" +
                  "  Doc doc.\n" +
                  "\n" +
                  "  * Type: string\n" +
                  "  * Default: a\n" +
                  "  * Valid Values: [a, b, c]\n" +
                  "  * Importance: high\n" +
                  "\n" +
                  "``opt2.of.group1``\n" +
                  "  Doc doc doc.\n" +
                  "\n" +
                  "  * Type: int\n" +
                  "  * Importance: medium\n" +
                  "  * Dependents: ``some.option1``, ``some.option2``\n" +
                  "\n" +
                  "Group Two\n" +
                  "^^^^^^^^^\n" +
                  "\n" +
                  "``opt1.of.group2``\n" +
                  "  Doc doc doc doc doc.\n" +
                  "\n" +
                  "  * Type: boolean\n" +
                  "  * Default: false\n" +
                  "  * Importance: high\n" +
                  "  * Dependents: ``some.option``\n" +
                  "\n" +
                  "``opt2.of.group2``\n" +
                  "  Doc doc doc doc.\n" +
                  "\n" +
                  "  * Type: boolean\n" +
                  "  * Default: false\n" +
                  "  * Importance: high\n" +
                  "\n";
  
          assertEquals(expectedRst, def.toEnrichedRst());
      }
  
      @Test
      public void testConvertValueToStringBoolean() {
          assertEquals("true", ConfigDef.convertToString(true, Type.BOOLEAN));
          assertNull(ConfigDef.convertToString(null, Type.BOOLEAN));
      }
  
      @Test
      public void testConvertValueToStringShort() {
          assertEquals("32767", ConfigDef.convertToString(Short.MAX_VALUE, Type.SHORT));
          assertNull(ConfigDef.convertToString(null, Type.SHORT));
      }
  
      @Test
      public void testConvertValueToStringInt() {
          assertEquals("2147483647", ConfigDef.convertToString(Integer.MAX_VALUE, Type.INT));
          assertNull(ConfigDef.convertToString(null, Type.INT));
      }
  
      @Test
      public void testConvertValueToStringLong() {
          assertEquals("9223372036854775807", ConfigDef.convertToString(Long.MAX_VALUE, Type.LONG));
          assertNull(ConfigDef.convertToString(null, Type.LONG));
      }
  
      @Test
      public void testConvertValueToStringDouble() {
          assertEquals("3.125", ConfigDef.convertToString(3.125, Type.DOUBLE));
          assertNull(ConfigDef.convertToString(null, Type.DOUBLE));
      }
  
      @Test
      public void testConvertValueToStringString() {
          assertEquals("foobar", ConfigDef.convertToString("foobar", Type.STRING));
          assertNull(ConfigDef.convertToString(null, Type.STRING));
      }
  
      @Test
      public void testConvertValueToStringPassword() {
          assertEquals(Password.HIDDEN, ConfigDef.convertToString(new Password("foobar"), Type.PASSWORD));
          assertEquals("foobar", ConfigDef.convertToString("foobar", Type.PASSWORD));
          assertNull(ConfigDef.convertToString(null, Type.PASSWORD));
      }
  
      @Test
      public void testConvertValueToStringList() {
          assertEquals("a,bc,d", ConfigDef.convertToString(Arrays.asList("a", "bc", "d"), Type.LIST));
          assertNull(ConfigDef.convertToString(null, Type.LIST));
      }
  
      @Test
      public void testConvertValueToStringClass() throws ClassNotFoundException {
          String actual = ConfigDef.convertToString(ConfigDefTest.class, Type.CLASS);
          assertEquals("org.apache.kafka.common.config.ConfigDefTest", actual);
          // Additionally validate that we can look up this class by this name
          assertEquals(ConfigDefTest.class, Class.forName(actual));
          assertNull(ConfigDef.convertToString(null, Type.CLASS));
      }
  
      @Test
      public void testConvertValueToStringNestedClass() throws ClassNotFoundException {
          String actual = ConfigDef.convertToString(NestedClass.class, Type.CLASS);
          assertEquals("org.apache.kafka.common.config.ConfigDefTest$NestedClass", actual);
          // Additionally validate that we can look up this class by this name
          assertEquals(NestedClass.class, Class.forName(actual));
      }
  
      @Test
      public void testClassWithAlias() {
          final String alias = "PluginAlias";
          ClassLoader originalClassLoader = Thread.currentThread().getContextClassLoader();
          try {
              // Could try to use the Plugins class from Connect here, but this should simulate enough
              // of the aliasing logic to suffice for this test.
              Thread.currentThread().setContextClassLoader(new ClassLoader(originalClassLoader) {
                  @Override
                  public Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException {
                      if (alias.equals(name)) {
                          return NestedClass.class;
                      } else {
                          return super.loadClass(name, resolve);
                      }
                  }
              });
              ConfigDef.parseType("Test config", alias, Type.CLASS);
          } finally {
              Thread.currentThread().setContextClassLoader(originalClassLoader);
          }
      }
  
      private static class NestedClass {
      }
  
      @Test
      public void testNiceMemoryUnits() {
          assertEquals("", ConfigDef.niceMemoryUnits(0L));
          assertEquals("", ConfigDef.niceMemoryUnits(1023));
          assertEquals(" (1 kibibyte)", ConfigDef.niceMemoryUnits(1024));
          assertEquals("", ConfigDef.niceMemoryUnits(1025));
          assertEquals(" (2 kibibytes)", ConfigDef.niceMemoryUnits(2 * 1024));
          assertEquals(" (1 mebibyte)", ConfigDef.niceMemoryUnits(1024 * 1024));
          assertEquals(" (2 mebibytes)", ConfigDef.niceMemoryUnits(2 * 1024 * 1024));
          assertEquals(" (1 gibibyte)", ConfigDef.niceMemoryUnits(1024 * 1024 * 1024));
          assertEquals(" (2 gibibytes)", ConfigDef.niceMemoryUnits(2L * 1024 * 1024 * 1024));
          assertEquals(" (1 tebibyte)", ConfigDef.niceMemoryUnits(1024L * 1024 * 1024 * 1024));
          assertEquals(" (2 tebibytes)", ConfigDef.niceMemoryUnits(2L * 1024 * 1024 * 1024 * 1024));
          assertEquals(" (1024 tebibytes)", ConfigDef.niceMemoryUnits(1024L * 1024 * 1024 * 1024 * 1024));
          assertEquals(" (2048 tebibytes)", ConfigDef.niceMemoryUnits(2L * 1024 * 1024 * 1024 * 1024 * 1024));
      }
  
      @Test
      public void testNiceTimeUnits() {
          assertEquals("", ConfigDef.niceTimeUnits(0));
          assertEquals("", ConfigDef.niceTimeUnits(Duration.ofSeconds(1).toMillis() - 1));
          assertEquals(" (1 second)", ConfigDef.niceTimeUnits(Duration.ofSeconds(1).toMillis()));
          assertEquals("", ConfigDef.niceTimeUnits(Duration.ofSeconds(1).toMillis() + 1));
          assertEquals(" (2 seconds)", ConfigDef.niceTimeUnits(Duration.ofSeconds(2).toMillis()));
  
          assertEquals(" (1 minute)", ConfigDef.niceTimeUnits(Duration.ofMinutes(1).toMillis()));
          assertEquals(" (2 minutes)", ConfigDef.niceTimeUnits(Duration.ofMinutes(2).toMillis()));
  
          assertEquals(" (1 hour)", ConfigDef.niceTimeUnits(Duration.ofHours(1).toMillis()));
          assertEquals(" (2 hours)", ConfigDef.niceTimeUnits(Duration.ofHours(2).toMillis()));
  
          assertEquals(" (1 day)", ConfigDef.niceTimeUnits(Duration.ofDays(1).toMillis()));
          assertEquals(" (2 days)", ConfigDef.niceTimeUnits(Duration.ofDays(2).toMillis()));
  
          assertEquals(" (7 days)", ConfigDef.niceTimeUnits(Duration.ofDays(7).toMillis()));
          assertEquals(" (365 days)", ConfigDef.niceTimeUnits(Duration.ofDays(365).toMillis()));
      }
  
      @Test
      public void testThrowsExceptionWhenListSizeExceedsLimit() {
          final ConfigException exception = assertThrows(ConfigException.class, () -> new ConfigDef().define("lst",
                                                                                                             Type.LIST,
                                                                                                             asList("a", "b"),
                                                                                                             ListSize.atMostOfSize(1),
                                                                                                             Importance.HIGH,
                                                                                                             "lst doc"));
          assertEquals("Invalid value [a, b] for configuration lst: exceeds maximum list size of [1].",
                       exception.getMessage());
      }
  
      @Test
      public void testNoExceptionIsThrownWhenListSizeEqualsTheLimit() {
          final List<String> lst = asList("a", "b", "c");
          assertDoesNotThrow(() -> new ConfigDef().define("lst",
                                                          Type.LIST,
                                                          lst,
                                                          ListSize.atMostOfSize(lst.size()),
                                                          Importance.HIGH,
                                                          "lst doc"));
      }
  
      @Test
      public void testNoExceptionIsThrownWhenListSizeIsBelowTheLimit() {
          assertDoesNotThrow(() -> new ConfigDef().define("lst",
                                                          Type.LIST,
                                                          asList("a", "b"),
                                                          ListSize.atMostOfSize(3),
                                                          Importance.HIGH,
                                                          "lst doc"));
      }
  
      @Test
      public void testListSizeValidatorToString() {
          assertEquals("List containing maximum of 5 elements", ListSize.atMostOfSize(5).toString());
      }
  
  }
  