This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel-kafka-connector.git
commit e09c9276d9da16d47651ff34507ae61eacfd554b Author: Aurélien Pupier <[email protected]> AuthorDate: Thu Nov 5 11:27:52 2020 +0100 Provide description for connector in catalog #672 it is picking as-is the description from the corresponding connector in normal Camel Catalog Signed-off-by: Aurélien Pupier <[email protected]> --- .../kafkaconnector/catalog/CamelKafkaConnectorCatalog.java | 1 + .../kafkaconnector/catalog/CamelKafkaConnectorCatalogTest.java | 7 +++++++ .../kafkaconnector/maven/CamelKafkaConnectorUpdateMojo.java | 10 ++++++---- .../kafkaconnector/maven/utils/JsonMapperKafkaConnector.java | 1 + .../camel/kafkaconnector/model/CamelKafkaConnectorModel.java | 9 +++++++++ 5 files changed, 24 insertions(+), 4 deletions(-) diff --git a/camel-kafka-connector-catalog/src/main/java/org/apache/camel/kafkaconnector/catalog/CamelKafkaConnectorCatalog.java b/camel-kafka-connector-catalog/src/main/java/org/apache/camel/kafkaconnector/catalog/CamelKafkaConnectorCatalog.java index 7009c58..7b28a69 100644 --- a/camel-kafka-connector-catalog/src/main/java/org/apache/camel/kafkaconnector/catalog/CamelKafkaConnectorCatalog.java +++ b/camel-kafka-connector-catalog/src/main/java/org/apache/camel/kafkaconnector/catalog/CamelKafkaConnectorCatalog.java @@ -112,6 +112,7 @@ public class CamelKafkaConnectorCatalog { model.setGroupId((String)wrapper.get("groupId")); model.setType((String)wrapper.get("type")); model.setVersion((String)wrapper.get("version")); + model.setDescription((String)wrapper.get("description")); model.setOptions(getConnectorOptionModel(obj)); if (obj.get("aggregationStrategies") != null) { model.setAggregationStrategies((List<String>) obj.get("aggregationStrategies")); diff --git a/camel-kafka-connector-catalog/src/test/java/org/apache/camel/kafkaconnector/catalog/CamelKafkaConnectorCatalogTest.java b/camel-kafka-connector-catalog/src/test/java/org/apache/camel/kafkaconnector/catalog/CamelKafkaConnectorCatalogTest.java index f285424..175e131 100644 --- a/camel-kafka-connector-catalog/src/test/java/org/apache/camel/kafkaconnector/catalog/CamelKafkaConnectorCatalogTest.java +++ b/camel-kafka-connector-catalog/src/test/java/org/apache/camel/kafkaconnector/catalog/CamelKafkaConnectorCatalogTest.java @@ -161,5 +161,12 @@ class CamelKafkaConnectorCatalogTest { CamelKafkaConnectorOptionModel nonExistingOption = catalog.getOptionModel("camel-aws2-sns-sink", "camel.sink.path.topiNameOrAr"); assertNull(nonExistingOption); } + + @Test + void testConnectorContainsDescription() throws Exception { + Map<String, CamelKafkaConnectorModel> p = catalog.getConnectorsModel(); + CamelKafkaConnectorModel model = p.get("camel-aws2-s3-sink"); + assertEquals("Store and retrieve objects from AWS S3 Storage Service using AWS SDK version 2.x.", model.getDescription()); + } } diff --git a/tooling/camel-kafka-connector-generator-maven-plugin/src/main/java/org/apache/camel/kafkaconnector/maven/CamelKafkaConnectorUpdateMojo.java b/tooling/camel-kafka-connector-generator-maven-plugin/src/main/java/org/apache/camel/kafkaconnector/maven/CamelKafkaConnectorUpdateMojo.java index cb5e434..a4a8410 100644 --- a/tooling/camel-kafka-connector-generator-maven-plugin/src/main/java/org/apache/camel/kafkaconnector/maven/CamelKafkaConnectorUpdateMojo.java +++ b/tooling/camel-kafka-connector-generator-maven-plugin/src/main/java/org/apache/camel/kafkaconnector/maven/CamelKafkaConnectorUpdateMojo.java @@ -558,7 +558,7 @@ public class CamelKafkaConnectorUpdateMojo extends AbstractCamelKafkaConnectorMo File docFile = new File(docFolder, getMainDepArtifactId() + "-kafka-" + ct.name().toLowerCase() + "-connector.adoc"); File docFolderWebsite = new File(projectBaseDir, "docs/modules/ROOT/pages/connectors/"); File docFileWebsite = new File(docFolderWebsite, getMainDepArtifactId() + "-kafka-" + ct.name().toLowerCase() + "-connector.adoc"); - String changed = templateAutoConfigurationOptions(listOptions, getMainDepArtifactId(), connectorDir, ct, packageName + "." + javaClassConnectorName, convertersList, + String changed = templateAutoConfigurationOptions(listOptions, model.getDescription(), connectorDir, ct, packageName + "." + javaClassConnectorName, convertersList, transformsList, aggregationStrategiesList); @@ -576,7 +576,7 @@ public class CamelKafkaConnectorUpdateMojo extends AbstractCamelKafkaConnectorMo } // generate json descriptor src/generated/resources/<connector-name>.json - writeJson(listOptions, getMainDepArtifactId(), connectorDir, ct, packageName + "." + javaClassConnectorName, convertersList, transformsList, aggregationStrategiesList); + writeJson(listOptions, model.getDescription(), connectorDir, ct, packageName + "." + javaClassConnectorName, convertersList, transformsList, aggregationStrategiesList); // generate descriptor src/generated/descriptors/connector-{sink,source}.properties writeDescriptors(connectorDir, ct); } @@ -668,7 +668,7 @@ public class CamelKafkaConnectorUpdateMojo extends AbstractCamelKafkaConnectorMo listOptions.add(optionModel); } - private String templateAutoConfigurationOptions(List<CamelKafkaConnectorOptionModel> options, String componentName, File connectorDir, ConnectorType ct, String connectorClass, + private String templateAutoConfigurationOptions(List<CamelKafkaConnectorOptionModel> options, String componentDescription, File connectorDir, ConnectorType ct, String connectorClass, List<String> convertersList, List<String> transformsList, List<String> aggregationStrategiesList) throws MojoExecutionException { @@ -681,6 +681,7 @@ public class CamelKafkaConnectorUpdateMojo extends AbstractCamelKafkaConnectorMo model.setConverters(convertersList); model.setTransforms(transformsList); model.setAggregationStrategies(aggregationStrategiesList); + model.setDescription(componentDescription); if (getMainDepArtifactId().equalsIgnoreCase("camel-coap+tcp")) { model.setTitle("camel-coap-tcp"); } else if (getMainDepArtifactId().equalsIgnoreCase("camel-coaps+tcp")) { @@ -703,7 +704,7 @@ public class CamelKafkaConnectorUpdateMojo extends AbstractCamelKafkaConnectorMo } } - private void writeJson(List<CamelKafkaConnectorOptionModel> options, String componentName, File connectorDir, ConnectorType ct, String connectorClass, + private void writeJson(List<CamelKafkaConnectorOptionModel> options, String componentDescription, File connectorDir, ConnectorType ct, String connectorClass, List<String> convertersList, List<String> transformsList, List<String> aggregationStrategiesList) throws MojoExecutionException { @@ -712,6 +713,7 @@ public class CamelKafkaConnectorUpdateMojo extends AbstractCamelKafkaConnectorMo model.setArtifactId(getMainDepArtifactId()); model.setGroupId(getMainDepGroupId()); model.setVersion(getMainDepVersion()); + model.setDescription(componentDescription); model.setConnectorClass(connectorClass); model.setType(ct.name().toLowerCase()); model.setConverters(convertersList); diff --git a/tooling/camel-kafka-connector-generator-maven-plugin/src/main/java/org/apache/camel/kafkaconnector/maven/utils/JsonMapperKafkaConnector.java b/tooling/camel-kafka-connector-generator-maven-plugin/src/main/java/org/apache/camel/kafkaconnector/maven/utils/JsonMapperKafkaConnector.java index 80c69e1..ecb143a 100644 --- a/tooling/camel-kafka-connector-generator-maven-plugin/src/main/java/org/apache/camel/kafkaconnector/maven/utils/JsonMapperKafkaConnector.java +++ b/tooling/camel-kafka-connector-generator-maven-plugin/src/main/java/org/apache/camel/kafkaconnector/maven/utils/JsonMapperKafkaConnector.java @@ -39,6 +39,7 @@ public final class JsonMapperKafkaConnector { obj.put("id", model.getTitle() + "-" + model.getType()); obj.put("type", model.getType()); obj.put("version", model.getVersion()); + obj.put("description", model.getDescription()); JsonObject wrapper = new JsonObject(); wrapper.put("connector", obj); wrapper.put("properties", asJsonObject(model.getOptions())); diff --git a/tooling/camel-kafka-connector-model/src/main/java/org/apache/camel/kafkaconnector/model/CamelKafkaConnectorModel.java b/tooling/camel-kafka-connector-model/src/main/java/org/apache/camel/kafkaconnector/model/CamelKafkaConnectorModel.java index 4e4ad97..55df7a7 100644 --- a/tooling/camel-kafka-connector-model/src/main/java/org/apache/camel/kafkaconnector/model/CamelKafkaConnectorModel.java +++ b/tooling/camel-kafka-connector-model/src/main/java/org/apache/camel/kafkaconnector/model/CamelKafkaConnectorModel.java @@ -29,6 +29,7 @@ public class CamelKafkaConnectorModel { private List<String> transforms; private List<String> aggregationStrategies; private List<CamelKafkaConnectorOptionModel> options; + private String componentDescription; public List<CamelKafkaConnectorOptionModel> getOptions() { return options; @@ -109,4 +110,12 @@ public class CamelKafkaConnectorModel { public void setType(String type) { this.type = type; } + + public String getDescription() { + return componentDescription; + } + + public void setDescription(String componentDescription) { + this.componentDescription = componentDescription; + } }
