cleaned up reporting

Author: Claudenw

azure-sink-connector/src/templates/configData.md.vm

@@ -10,6 +10,6 @@ ${esc.hash}${esc.hash} ${section.displayName}
  - Valid values:  ${section.validator|"no restrictions"}
  - Importance: $section.importance
 
- $section.documentation
+ ${esc.markdown($section.documentation)}
 
 #end

azure-source-connector/src/main/java/io/aiven/kafka/connect/azure/source/config/AzureBlobConfigFragment.java

@@ -25,6 +25,7 @@
 import io.aiven.kafka.connect.azure.source.utils.VersionInfo;
 import io.aiven.kafka.connect.common.config.ConfigFragment;
 import io.aiven.kafka.connect.common.config.FragmentDataAccess;
+import io.aiven.kafka.connect.common.config.validators.TimeScaleValidator;
 
 import com.azure.core.http.policy.ExponentialBackoffOptions;
 import com.azure.core.http.policy.HttpLogDetailLevel;
@@ -152,11 +153,11 @@ private static void addAzureConfigGroup(final ConfigDef configDef, final boolean
     private static void addAzureRetryPolicies(final ConfigDef configDef) {
         int retryPolicyGroupCounter = 0;
         configDef.define(AZURE_RETRY_BACKOFF_INITIAL_DELAY_MS_CONFIG, ConfigDef.Type.LONG,
-                AZURE_RETRY_BACKOFF_INITIAL_DELAY_MS_DEFAULT, ConfigDef.Range.atLeast(0L), ConfigDef.Importance.MEDIUM,
-                "Initial retry delay in milliseconds.", GROUP_AZURE_RETRY_BACKOFF_POLICY, ++retryPolicyGroupCounter,
-                ConfigDef.Width.NONE, AZURE_RETRY_BACKOFF_INITIAL_DELAY_MS_CONFIG);
+                AZURE_RETRY_BACKOFF_INITIAL_DELAY_MS_DEFAULT, TimeScaleValidator.atLeast(0),
+                ConfigDef.Importance.MEDIUM, "Initial retry delay in milliseconds.", GROUP_AZURE_RETRY_BACKOFF_POLICY,
+                ++retryPolicyGroupCounter, ConfigDef.Width.NONE, AZURE_RETRY_BACKOFF_INITIAL_DELAY_MS_CONFIG);
         configDef.define(AZURE_RETRY_BACKOFF_MAX_DELAY_MS_CONFIG, ConfigDef.Type.LONG,
-                AZURE_RETRY_BACKOFF_MAX_DELAY_MS_DEFAULT, ConfigDef.Range.atLeast(0L), ConfigDef.Importance.MEDIUM,
+                AZURE_RETRY_BACKOFF_MAX_DELAY_MS_DEFAULT, TimeScaleValidator.atLeast(0), ConfigDef.Importance.MEDIUM,
                 "Maximum retry delay in milliseconds.", GROUP_AZURE_RETRY_BACKOFF_POLICY, ++retryPolicyGroupCounter,
                 ConfigDef.Width.NONE, AZURE_RETRY_BACKOFF_MAX_DELAY_MS_CONFIG);
         configDef.define(AZURE_RETRY_BACKOFF_MAX_ATTEMPTS_CONFIG, ConfigDef.Type.INT,

commons/src/main/java/io/aiven/kafka/connect/common/config/CommonConfigFragment.java

@@ -18,6 +18,7 @@
 
 import static org.apache.kafka.common.config.ConfigDef.Range.atLeast;
 
+import java.util.Collections;
 import java.util.Map;
 
 import org.apache.kafka.common.config.ConfigDef;
@@ -52,13 +53,14 @@ public static ConfigDef update(final ConfigDef configDef) {
         int orderInGroup = 0;
         final String commonGroup = "commons";
 
-        return configDef
-                .define(ConnectorConfig.TASKS_MAX_CONFIG, ConfigDef.Type.INT, 1, atLeast(1), ConfigDef.Importance.HIGH,
-                        "Maximum number of tasks to use for this connector.", commonGroup, ++orderInGroup,
-                        ConfigDef.Width.SHORT, ConnectorConfig.TASKS_MAX_CONFIG)
-                .define(TASK_ID, ConfigDef.Type.INT, 1, atLeast(0), ConfigDef.Importance.HIGH,
-                        "The task ID that this connector is working with.", commonGroup, ++orderInGroup,
-                        ConfigDef.Width.SHORT, TASK_ID);
+        configDef.define(ConnectorConfig.TASKS_MAX_CONFIG, ConfigDef.Type.INT, 1, atLeast(1), ConfigDef.Importance.HIGH,
+                "Maximum number of tasks to use for this connector.", commonGroup, ++orderInGroup,
+                ConfigDef.Width.SHORT, ConnectorConfig.TASKS_MAX_CONFIG);
+
+        final ConfigDef.ConfigKey key = new ConfigDef.ConfigKey(TASK_ID, ConfigDef.Type.INT, 0, atLeast(0),
+                ConfigDef.Importance.HIGH, "The task ID that this connector is working with.", commonGroup,
+                ++orderInGroup, ConfigDef.Width.SHORT, TASK_ID, Collections.emptyList(), null, true);
+        return configDef.define(key);
     }
 
     /**

site/src/main/java/io/aiven/kafka/connect/tools/ConfigDoc.java

@@ -74,11 +74,13 @@ public static void execute(final ConfigDef configDef, final String templateFile,
         final Collection<ConfigDef.ConfigKey> keys = configDef.configKeys().values();
         final Map<String, ConfigData> sections = new TreeMap<>();
         for (final ConfigDef.ConfigKey key : keys) {
-            sections.put(key.name, new ConfigData(key));
+            if (!key.internalConfig) {
+                sections.put(key.name, new ConfigData(key));
+            }
         }
 
         context.put("sections", sections.values());
-        context.put("esc", new EscapeTool());
+        context.put("esc", new Escaper());
 
         final File file = new File(output);
         if (!file.getParentFile().exists() && !file.getParentFile().mkdirs()) {
@@ -138,4 +140,67 @@ public static void main(final String[] args) throws IOException, ClassNotFoundEx
         }
     }
 
+    public static class Escaper extends EscapeTool {
+
+        private static String[] charParser(final String charText) {
+            char[] chars = charText.toCharArray();
+            String[] result = new String[chars.length];
+            for (int i = 0; i < chars.length; i++) {
+                result[i] = String.valueOf(chars[i]);
+            }
+            return result;
+        }
+
+        /**
+         * The characters to escape for markdown.
+         */
+        private static final String[] MARKDOWN_CHARS = charParser("\\`*_{}[]<>()#+-.!|");
+        /**
+         * The characters to escape for APT (Almost Plain Text).
+         */
+        private static final String[] APT_CHARS = charParser("\\~=-+*[]<>{}");
+
+        /**
+         * Escapes a text string.
+         *
+         * @param text
+         *            the text to escape.
+         * @param chars
+         *            the characters to escape.
+         * @return the escaped string.
+         */
+        private String escape(final String text, final String[] chars) {
+            if (text == null) {
+                return "";
+            }
+            String result = text;
+            for (String c : chars) {
+                result = result.replace(c, "\\" + c);
+            }
+            return result;
+        }
+
+        /**
+         * Escapes a string for markdown.
+         *
+         * @param text
+         *            the text to escape.
+         * @return the text with the markdown specific characters escaped.
+         */
+        public String markdown(final String text) {
+            return escape(text, MARKDOWN_CHARS);
+        }
+
+        /**
+         * Escapes a string for APT (almost plain text).
+         *
+         * @param text
+         *            the text to escape.
+         * @return the text with the APT specific characters escaped.
+         */
+        public String apt(final String text) {
+            return escape(text, APT_CHARS);
+        }
+
+    }
 }