This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch gen-plugin in repository https://gitbox.apache.org/repos/asf/camel.git
commit a4dd833a6d263c1df314b7430e5198b3365df6c4 Author: Claus Ibsen <[email protected]> AuthorDate: Sun Jun 16 08:42:09 2024 +0200 CAMEL-20500: camel-jbang - Move generate commands to its own plugin --- .../ROOT/pages/camel-4x-upgrade-guide-4_7.adoc | 11 +++ .../modules/ROOT/pages/camel-jbang.adoc | 12 ++- dsl/camel-jbang/camel-jbang-core/pom.xml | 46 ---------- .../dsl/jbang/core/commands/CamelJBangMain.java | 2 - .../dsl/jbang/core/commands/process/ListRest.java | 3 +- .../camel/dsl/jbang/core/common/PluginType.java | 3 +- .../jbang/core/commands/plugin/PluginGetTest.java | 18 ++-- .../camel-jbang-plugin-generate/pom.xml | 98 ++++++++++++++++++++++ .../camel-jbang-plugin/camel-jbang-plugin-generate | 2 + .../core/commands/generate}/CodeGenerator.java | 4 +- .../core/commands/generate}/CodeRestGenerator.java | 4 +- .../core/commands/generate/GeneratePlugin.java} | 22 ++--- dsl/camel-jbang/pom.xml | 1 + 13 files changed, 156 insertions(+), 70 deletions(-) diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_7.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_7.adoc index 2d611503ef7..38443a1cfcc 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_7.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_7.adoc @@ -84,6 +84,17 @@ To: </route> ---- +=== camel-jbang + +The `generate` commands has been moved into separate plugin which you need to install first to be able to use. + +[source,bash] +---- +camel plugin add generate +---- + +TIP: You can see list of available plugins using `camel plugin get --all`. + === camel-jetty / camel-servlet / camel-undertow When using embedded HTTP server (consumer) then the headers `CamelHttpServletRequest` and `CamelHttpServletResponse` diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc index bba8d0df591..e94a83a7fb3 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc @@ -1016,8 +1016,9 @@ camel plugin get --all ---- Supported plugins: - NAME COMMAND DEPENDENCY DESCRIPTION - camel-k k org.apache.camel:camel-jbang-plugin-k Manage Camel integrations on Kubernetes + NAME COMMAND DEPENDENCY DESCRIPTION + camel-k k org.apache.camel:camel-jbang-plugin-k Manage Camel integrations on Kubernetes + generate generate org.apache.camel:camel-jbang-plugin-generate Generate code such as DTOs ---- In case you want to enable a plugin and its functionality you can add it as follows: @@ -1027,6 +1028,13 @@ In case you want to enable a plugin and its functionality you can add it as foll camel plugin add <plugin-name> ---- +For example to install `generate` you execute: + +[source,bash] +---- +camel plugin add generate +---- + This adds the plugin and all subcommands are now available for execution. You can list the currently installed plugins with: diff --git a/dsl/camel-jbang/camel-jbang-core/pom.xml b/dsl/camel-jbang/camel-jbang-core/pom.xml index c9b175f162d..c3688385d3e 100644 --- a/dsl/camel-jbang/camel-jbang-core/pom.xml +++ b/dsl/camel-jbang/camel-jbang-core/pom.xml @@ -129,52 +129,6 @@ <artifactId>jansi</artifactId> <version>${jansi-version}</version> </dependency> - <!-- code generator --> - <dependency> - <groupId>io.swagger.core.v3</groupId> - <artifactId>swagger-core-jakarta</artifactId> - <version>${swagger-openapi3-version}</version> - </dependency> - <dependency> - <groupId>io.swagger.core.v3</groupId> - <artifactId>swagger-models-jakarta</artifactId> - <version>${swagger-openapi3-version}</version> - </dependency> - <dependency> - <groupId>io.swagger.parser.v3</groupId> - <artifactId>swagger-parser-v3</artifactId> - <version>${swagger-openapi3-java-parser-version}</version> - <exclusions> - <exclusion> - <groupId>io.swagger.core.v3</groupId> - <artifactId>*</artifactId> - </exclusion> - </exclusions> - </dependency> - <dependency> - <groupId>org.openapitools</groupId> - <artifactId>openapi-generator</artifactId> - <version>${openapi-generator}</version> - <exclusions> - <exclusion> - <groupId>org.slf4j</groupId> - <artifactId>slf4j-api</artifactId> - </exclusion> - <exclusion> - <groupId>org.slf4j</groupId> - <artifactId>slf4j-simple</artifactId> - </exclusion> - </exclusions> - </dependency> - <dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-openapi-rest-dsl-generator</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>com.fasterxml.jackson.core</groupId> - <artifactId>jackson-databind</artifactId> - </dependency> <!-- test dependencies --> <dependency> diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CamelJBangMain.java b/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CamelJBangMain.java index a6d5d5beafe..4cdc09c3eb2 100644 --- a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CamelJBangMain.java +++ b/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CamelJBangMain.java @@ -125,8 +125,6 @@ public class CamelJBangMain implements Callable<Integer> { .addSubcommand("list", new CommandLine(new DependencyList(main))) .addSubcommand("copy", new CommandLine(new DependencyCopy(main))) .addSubcommand("update", new CommandLine(new DependencyUpdate(main)))) - .addSubcommand("generate", new CommandLine(new CodeGenerator(main)) - .addSubcommand("rest", new CommandLine(new CodeRestGenerator(main)))) .addSubcommand("sbom", new CommandLine(new SBOMGenerator(main))) .addSubcommand("catalog", new CommandLine(new CatalogCommand(main)) .addSubcommand("component", new CommandLine(new CatalogComponent(main))) diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/process/ListRest.java b/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/process/ListRest.java index eca9ea3d2ea..4000a114848 100644 --- a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/process/ListRest.java +++ b/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/process/ListRest.java @@ -109,7 +109,8 @@ public class ListRest extends ProcessWatchCommand { new Column().header("URL").dataAlign(HorizontalAlign.LEFT).with(r -> r.url), new Column().header("METHOD").dataAlign(HorizontalAlign.LEFT).with(r -> r.method), new Column().header("FIRST").visible(verbose).dataAlign(HorizontalAlign.LEFT).with(this::getKind), - new Column().header("DESCRIPTION").visible(verbose).maxWidth(40, OverflowBehaviour.NEWLINE).dataAlign(HorizontalAlign.LEFT).with(r -> r.description), + new Column().header("DESCRIPTION").visible(verbose).maxWidth(40, OverflowBehaviour.NEWLINE) + .dataAlign(HorizontalAlign.LEFT).with(r -> r.description), new Column().header("CONTENT-TYPE").dataAlign(HorizontalAlign.LEFT).with(this::getContent)))); } diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/common/PluginType.java b/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/common/PluginType.java index c4389f28cc1..f1a2f523650 100644 --- a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/common/PluginType.java +++ b/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/common/PluginType.java @@ -25,7 +25,8 @@ import java.util.Optional; */ public enum PluginType { - CAMEL_K("camel-k", "k", "Manage Camel integrations on Kubernetes"); + CAMEL_K("camel-k", "k", "Manage Camel integrations on Kubernetes"), + GENERATE("generate", "generate", "Generate code such as DTOs"); private final String name; private final String command; diff --git a/dsl/camel-jbang/camel-jbang-core/src/test/java/org/apache/camel/dsl/jbang/core/commands/plugin/PluginGetTest.java b/dsl/camel-jbang/camel-jbang-core/src/test/java/org/apache/camel/dsl/jbang/core/commands/plugin/PluginGetTest.java index 38377fa9f4f..69caf696995 100644 --- a/dsl/camel-jbang/camel-jbang-core/src/test/java/org/apache/camel/dsl/jbang/core/commands/plugin/PluginGetTest.java +++ b/dsl/camel-jbang/camel-jbang-core/src/test/java/org/apache/camel/dsl/jbang/core/commands/plugin/PluginGetTest.java @@ -69,11 +69,12 @@ class PluginGetTest extends CamelCommandBaseTest { command.doCall(); List<String> output = printer.getLines(); - Assertions.assertEquals(4, output.size()); + Assertions.assertEquals(5, output.size()); Assertions.assertEquals("Supported plugins:", output.get(0)); - Assertions.assertEquals("NAME COMMAND DEPENDENCY DESCRIPTION", output.get(2)); + Assertions.assertEquals("NAME COMMAND DEPENDENCY DESCRIPTION", output.get(2)); Assertions.assertEquals( - "camel-k k org.apache.camel:camel-jbang-plugin-k %s".formatted(PluginType.CAMEL_K.getDescription()), + "camel-k k org.apache.camel:camel-jbang-plugin-k %s" + .formatted(PluginType.CAMEL_K.getDescription()), output.get(3)); } @@ -117,17 +118,22 @@ class PluginGetTest extends CamelCommandBaseTest { command.doCall(); List<String> output = printer.getLines(); - Assertions.assertEquals(7, output.size()); + Assertions.assertEquals(8, output.size()); Assertions.assertEquals("NAME COMMAND DEPENDENCY DESCRIPTION", output.get(0)); Assertions.assertEquals( "foo-plugin foo org.apache.camel:foo-plugin:1.0.0 Plugin foo-plugin called with command foo", output.get(1)); Assertions.assertEquals("Supported plugins:", output.get(3)); - Assertions.assertEquals("NAME COMMAND DEPENDENCY DESCRIPTION", output.get(5)); + Assertions.assertEquals("NAME COMMAND DEPENDENCY DESCRIPTION", output.get(5)); Assertions.assertEquals( - "camel-k k org.apache.camel:camel-jbang-plugin-k %s".formatted(PluginType.CAMEL_K.getDescription()), + "camel-k k org.apache.camel:camel-jbang-plugin-k %s" + .formatted(PluginType.CAMEL_K.getDescription()), output.get(6)); + Assertions.assertEquals( + "generate generate org.apache.camel:camel-jbang-plugin-generate %s" + .formatted(PluginType.GENERATE.getDescription()), + output.get(7)); } } diff --git a/dsl/camel-jbang/camel-jbang-plugin-generate/pom.xml b/dsl/camel-jbang/camel-jbang-plugin-generate/pom.xml new file mode 100644 index 00000000000..5b08e5cbf3d --- /dev/null +++ b/dsl/camel-jbang/camel-jbang-plugin-generate/pom.xml @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + 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. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.camel</groupId> + <artifactId>camel-jbang-parent</artifactId> + <version>4.7.0-SNAPSHOT</version> + <relativePath>../pom.xml</relativePath> + </parent> + + <artifactId>camel-jbang-plugin-generate</artifactId> + + <name>Camel :: JBang :: Plugin :: Generate</name> + <description>Camel JBang Generate Plugin</description> + + <properties> + <firstVersion>4.7.0</firstVersion> + <label>jbang</label> + <supportLevel>Preview</supportLevel> + <camel-prepare-component>false</camel-prepare-component> + </properties> + + <dependencies> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-jbang-core</artifactId> + </dependency> + + <!-- code generator --> + <dependency> + <groupId>io.swagger.core.v3</groupId> + <artifactId>swagger-core-jakarta</artifactId> + <version>${swagger-openapi3-version}</version> + </dependency> + <dependency> + <groupId>io.swagger.core.v3</groupId> + <artifactId>swagger-models-jakarta</artifactId> + <version>${swagger-openapi3-version}</version> + </dependency> + <dependency> + <groupId>io.swagger.parser.v3</groupId> + <artifactId>swagger-parser-v3</artifactId> + <version>${swagger-openapi3-java-parser-version}</version> + <exclusions> + <exclusion> + <groupId>io.swagger.core.v3</groupId> + <artifactId>*</artifactId> + </exclusion> + </exclusions> + </dependency> + <dependency> + <groupId>org.openapitools</groupId> + <artifactId>openapi-generator</artifactId> + <version>${openapi-generator}</version> + <exclusions> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-api</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-simple</artifactId> + </exclusion> + </exclusions> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-openapi-rest-dsl-generator</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>com.fasterxml.jackson.core</groupId> + <artifactId>jackson-databind</artifactId> + </dependency> + + </dependencies> + +</project> diff --git a/dsl/camel-jbang/camel-jbang-plugin-generate/src/generated/resources/META-INF/services/org/apache/camel/camel-jbang-plugin/camel-jbang-plugin-generate b/dsl/camel-jbang/camel-jbang-plugin-generate/src/generated/resources/META-INF/services/org/apache/camel/camel-jbang-plugin/camel-jbang-plugin-generate new file mode 100644 index 00000000000..913d49d5db7 --- /dev/null +++ b/dsl/camel-jbang/camel-jbang-plugin-generate/src/generated/resources/META-INF/services/org/apache/camel/camel-jbang-plugin/camel-jbang-plugin-generate @@ -0,0 +1,2 @@ +# Generated by camel build tools - do NOT edit this file! +class=org.apache.camel.dsl.jbang.core.commands.generate.GeneratePlugin diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeGenerator.java b/dsl/camel-jbang/camel-jbang-plugin-generate/src/main/java/org/apache/camel/dsl/jbang/core/commands/generate/CodeGenerator.java similarity index 86% copy from dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeGenerator.java copy to dsl/camel-jbang/camel-jbang-plugin-generate/src/main/java/org/apache/camel/dsl/jbang/core/commands/generate/CodeGenerator.java index 3f2d63da6e6..e0fa35cb867 100644 --- a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeGenerator.java +++ b/dsl/camel-jbang/camel-jbang-plugin-generate/src/main/java/org/apache/camel/dsl/jbang/core/commands/generate/CodeGenerator.java @@ -14,8 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.camel.dsl.jbang.core.commands; +package org.apache.camel.dsl.jbang.core.commands.generate; +import org.apache.camel.dsl.jbang.core.commands.CamelCommand; +import org.apache.camel.dsl.jbang.core.commands.CamelJBangMain; import picocli.CommandLine; @CommandLine.Command(name = "generate", description = "Generate source code (use --help to see sub commands)") diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeRestGenerator.java b/dsl/camel-jbang/camel-jbang-plugin-generate/src/main/java/org/apache/camel/dsl/jbang/core/commands/generate/CodeRestGenerator.java similarity index 97% rename from dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeRestGenerator.java rename to dsl/camel-jbang/camel-jbang-plugin-generate/src/main/java/org/apache/camel/dsl/jbang/core/commands/generate/CodeRestGenerator.java index 12df871ed08..27317f0556c 100644 --- a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeRestGenerator.java +++ b/dsl/camel-jbang/camel-jbang-plugin-generate/src/main/java/org/apache/camel/dsl/jbang/core/commands/generate/CodeRestGenerator.java @@ -14,7 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.camel.dsl.jbang.core.commands; +package org.apache.camel.dsl.jbang.core.commands.generate; import java.io.File; import java.io.FileInputStream; @@ -31,6 +31,8 @@ import io.apicurio.datamodels.models.Document; import io.apicurio.datamodels.models.ModelType; import io.apicurio.datamodels.models.openapi.OpenApiDocument; import org.apache.camel.CamelContext; +import org.apache.camel.dsl.jbang.core.commands.CamelCommand; +import org.apache.camel.dsl.jbang.core.commands.CamelJBangMain; import org.apache.camel.generator.openapi.RestDslGenerator; import org.apache.camel.impl.DefaultCamelContext; import org.apache.logging.log4j.Level; diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeGenerator.java b/dsl/camel-jbang/camel-jbang-plugin-generate/src/main/java/org/apache/camel/dsl/jbang/core/commands/generate/GeneratePlugin.java similarity index 58% rename from dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeGenerator.java rename to dsl/camel-jbang/camel-jbang-plugin-generate/src/main/java/org/apache/camel/dsl/jbang/core/commands/generate/GeneratePlugin.java index 3f2d63da6e6..0d88e80280a 100644 --- a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeGenerator.java +++ b/dsl/camel-jbang/camel-jbang-plugin-generate/src/main/java/org/apache/camel/dsl/jbang/core/commands/generate/GeneratePlugin.java @@ -14,20 +14,22 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.camel.dsl.jbang.core.commands; +package org.apache.camel.dsl.jbang.core.commands.generate; +import org.apache.camel.dsl.jbang.core.commands.CamelJBangMain; +import org.apache.camel.dsl.jbang.core.common.CamelJBangPlugin; +import org.apache.camel.dsl.jbang.core.common.Plugin; import picocli.CommandLine; [email protected](name = "generate", description = "Generate source code (use --help to see sub commands)") -public class CodeGenerator extends CamelCommand { - - public CodeGenerator(CamelJBangMain main) { - super(main); - } +@CamelJBangPlugin("camel-jbang-plugin-generate") +public class GeneratePlugin implements Plugin { @Override - public Integer doCall() throws Exception { - new CommandLine(this).execute("--help"); - return 0; + public void customize(CommandLine commandLine, CamelJBangMain main) { + var cmd = new picocli.CommandLine(new CodeGenerator(main)) + .addSubcommand("rest", new CommandLine(new CodeRestGenerator(main))); + + commandLine.addSubcommand("generate", cmd); } + } diff --git a/dsl/camel-jbang/pom.xml b/dsl/camel-jbang/pom.xml index d41533f62b1..94a0ae04689 100644 --- a/dsl/camel-jbang/pom.xml +++ b/dsl/camel-jbang/pom.xml @@ -37,6 +37,7 @@ <module>camel-jbang-console</module> <module>camel-jbang-core</module> <module>camel-jbang-main</module> + <module>camel-jbang-plugin-generate</module> <module>camel-jbang-plugin-k</module> <module>camel-jbang-it</module> </modules>
