You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2024/12/05 14:19:57 UTC

(camel) branch camel-4.8.x updated: camel-jbang - Fix transform route (#16459)

This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch camel-4.8.x
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/camel-4.8.x by this push:
     new 79e7861cc0a camel-jbang - Fix transform route (#16459)
79e7861cc0a is described below

commit 79e7861cc0ace1a7539c4f45ae2f40355e436515
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Thu Dec 5 15:12:25 2024 +0100

    camel-jbang - Fix transform route (#16459)
    
    * CAMEL-21516: camel-jbang - Transform route from xml to yaml with uri-as-parameters for context-path
---
 .../org/apache/camel/reifier/ProcessorReifier.java |  15 +++
 .../util/DumpModelAsYamlTransformRouteTest.java    |  15 ++-
 .../resources/org/apache/camel/util/transform.yaml |   4 +-
 .../camel/util/{transform.yaml => transform2.yaml} |  12 ++-
 .../camel/yaml/io/ModelJSonSchemaResolver.java     | 105 +++++++++++++++++----
 .../java/org/apache/camel/yaml/io/YamlWriter.java  |  12 +--
 .../dsl/jbang/core/commands/TransformRoute.java    |   7 +-
 .../dsl/jbang/core/commands/TransformTest.java     |  79 ++++++++++++++++
 .../src/test/resources/transform-out.yaml          |  20 ++--
 .../src/test/resources/transform.xml               |  25 +++++
 .../java/org/apache/camel/main/KameletMain.java    |   4 +-
 11 files changed, 254 insertions(+), 44 deletions(-)

diff --git a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ProcessorReifier.java b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ProcessorReifier.java
index eca76cc2436..5c87134d51b 100644
--- a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ProcessorReifier.java
+++ b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ProcessorReifier.java
@@ -143,6 +143,14 @@ public abstract class ProcessorReifier<T extends ProcessorDefinition<?>> extends
      */
     public static final String DISABLE_ALL_PROCESSORS = "DisableAllProcessors";
 
+    /**
+     * Global option on {@link CamelContext#getGlobalOptions()} that tooling can use to disable route processors (bean
+     * and custom process), which allows to startup Camel without wiring up and initializing using custom
+     * bean/processors, that may not be available, or is unwanted to be in use; for example to have fast startup, and
+     * being able to introspect CamelContext and the route models.
+     */
+    public static final String DISABLE_BEAN_OR_PROCESS_PROCESSORS = "DisableBeanOrProcessProcessors";
+
     private static final Logger LOG = LoggerFactory.getLogger(ProcessorReifier.class);
 
     // for custom reifiers
@@ -180,6 +188,13 @@ public abstract class ProcessorReifier<T extends ProcessorDefinition<?>> extends
         // special if the EIP is disabled
         if (route != null && route.getCamelContext() != null) {
             Boolean disabled = CamelContextHelper.parseBoolean(route.getCamelContext(), definition.getDisabled());
+            if (disabled == null) {
+                String sn = definition.getShortName();
+                if ("process".equals(sn) || "bean".equals(sn)) {
+                    disabled = "true"
+                            .equalsIgnoreCase(route.getCamelContext().getGlobalOption(DISABLE_BEAN_OR_PROCESS_PROCESSORS));
+                }
+            }
             if (disabled == null) {
                 disabled = "true".equalsIgnoreCase(route.getCamelContext().getGlobalOption(DISABLE_ALL_PROCESSORS));
             }
diff --git a/core/camel-core/src/test/java/org/apache/camel/util/DumpModelAsYamlTransformRouteTest.java b/core/camel-core/src/test/java/org/apache/camel/util/DumpModelAsYamlTransformRouteTest.java
index fd468007692..8c72267fb51 100644
--- a/core/camel-core/src/test/java/org/apache/camel/util/DumpModelAsYamlTransformRouteTest.java
+++ b/core/camel-core/src/test/java/org/apache/camel/util/DumpModelAsYamlTransformRouteTest.java
@@ -38,12 +38,25 @@ public class DumpModelAsYamlTransformRouteTest extends DumpModelAsYamlTestSuppor
         Assertions.assertEquals(expected, out);
     }
 
+    @Test
+    public void testDumpModelAsYamlUriAsParameters() throws Exception {
+        String out = PluginHelper.getModelToYAMLDumper(context).dumpModelAsYaml(context, context.getRouteDefinition("myRoute"),
+                true, true, true);
+        assertNotNull(out);
+        log.info(out);
+
+        String expected
+                = IOHelper.stripLineComments(Paths.get("src/test/resources/org/apache/camel/util/transform2.yaml"), "#", true);
+        Assertions.assertEquals(expected, out);
+    }
+
     @Override
     protected RouteBuilder createRouteBuilder() {
         return new RouteBuilder() {
             @Override
             public void configure() {
-                from("direct:start").routeId("myRoute").transform().simple("Hello ${body}").to("mock:result").id("myMock");
+                from("direct:start?exchangePattern=InOnly").routeId("myRoute").transform().simple("Hello ${body}")
+                        .to("mock:result?failFast=false&retainFirst=5&browseLimit=123").id("myMock");
             }
         };
     }
diff --git a/core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml b/core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml
index fcf2ad9f5e6..9d598c76065 100644
--- a/core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml
+++ b/core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml
@@ -19,7 +19,7 @@
     id: myRoute
     from:
       id: from
-      uri: direct:start
+      uri: direct:start?exchangePattern=InOnly
       steps:
         - transform:
             id: transform
@@ -27,4 +27,4 @@
               expression: "Hello ${body}"
         - to:
             id: myMock
-            uri: mock:result
+            uri: mock:result?failFast=false&retainFirst=5&browseLimit=123
diff --git a/core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml b/core/camel-core/src/test/resources/org/apache/camel/util/transform2.yaml
similarity index 79%
copy from core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml
copy to core/camel-core/src/test/resources/org/apache/camel/util/transform2.yaml
index fcf2ad9f5e6..0d04a017375 100644
--- a/core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml
+++ b/core/camel-core/src/test/resources/org/apache/camel/util/transform2.yaml
@@ -19,7 +19,10 @@
     id: myRoute
     from:
       id: from
-      uri: direct:start
+      uri: direct
+      parameters:
+        name: start
+        exchangePattern: InOnly
       steps:
         - transform:
             id: transform
@@ -27,4 +30,9 @@
               expression: "Hello ${body}"
         - to:
             id: myMock
-            uri: mock:result
+            uri: mock
+            parameters:
+              name: result
+              failFast: false
+              retainFirst: 5
+              browseLimit: 123
diff --git a/core/camel-yaml-io/src/main/java/org/apache/camel/yaml/io/ModelJSonSchemaResolver.java b/core/camel-yaml-io/src/main/java/org/apache/camel/yaml/io/ModelJSonSchemaResolver.java
index 3f6bd6eb974..0f78b2ed679 100644
--- a/core/camel-yaml-io/src/main/java/org/apache/camel/yaml/io/ModelJSonSchemaResolver.java
+++ b/core/camel-yaml-io/src/main/java/org/apache/camel/yaml/io/ModelJSonSchemaResolver.java
@@ -19,7 +19,10 @@ package org.apache.camel.yaml.io;
 import java.io.IOException;
 import java.io.InputStream;
 
+import org.apache.camel.CamelContext;
+import org.apache.camel.CatalogCamelContext;
 import org.apache.camel.catalog.JSonSchemaResolver;
+import org.apache.camel.spi.ClassResolver;
 import org.apache.camel.support.CamelContextHelper;
 import org.apache.camel.util.IOHelper;
 import org.apache.camel.util.ObjectHelper;
@@ -29,44 +32,94 @@ import org.apache.camel.util.ObjectHelper;
  */
 class ModelJSonSchemaResolver implements JSonSchemaResolver {
 
+    private CatalogCamelContext camelContext;
+    private ClassLoader classLoader;
+
+    public void setCamelContext(CamelContext camelContext) {
+        this.camelContext = (CatalogCamelContext) camelContext;
+    }
+
     @Override
     public void setClassLoader(ClassLoader classLoader) {
-        // not in use
+        this.classLoader = classLoader;
     }
 
     @Override
     public String getComponentJSonSchema(String name) {
-        throw new UnsupportedOperationException("Only getModelJSonSchema is in use");
+        if (camelContext != null) {
+            try {
+                return camelContext.getComponentParameterJsonSchema(name);
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+        return null;
     }
 
     @Override
     public String getDataFormatJSonSchema(String name) {
-        throw new UnsupportedOperationException("Only getModelJSonSchema is in use");
+        if (camelContext != null) {
+            try {
+                return camelContext.getDataFormatParameterJsonSchema(name);
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+        return null;
     }
 
     @Override
     public String getLanguageJSonSchema(String name) {
-        throw new UnsupportedOperationException("Only getModelJSonSchema is in use");
+        if (camelContext != null) {
+            try {
+                return camelContext.getLanguageParameterJsonSchema(name);
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+        return null;
     }
 
     @Override
     public String getTransformerJSonSchema(String name) {
-        throw new UnsupportedOperationException("Only getModelJSonSchema is in use");
+        if (camelContext != null) {
+            try {
+                return camelContext.getTransformerParameterJsonSchema(name);
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+        return null;
     }
 
     @Override
     public String getDevConsoleJSonSchema(String name) {
-        throw new UnsupportedOperationException("Only getModelJSonSchema is in use");
+        if (camelContext != null) {
+            try {
+                return camelContext.getDevConsoleParameterJsonSchema(name);
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+        return null;
     }
 
     @Override
     public String getOtherJSonSchema(String name) {
-        throw new UnsupportedOperationException("Only getModelJSonSchema is in use");
+        // not supported
+        return null;
     }
 
     @Override
     public String getPojoBeanJSonSchema(String name) {
-        throw new UnsupportedOperationException("Only getModelJSonSchema is in use");
+        if (camelContext != null) {
+            try {
+                return camelContext.getPojoBeanParameterJsonSchema(name);
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+        return null;
     }
 
     @Override
@@ -77,9 +130,9 @@ class ModelJSonSchemaResolver implements JSonSchemaResolver {
                     "transformer/", "validator/" };
             for (String sub : subPackages) {
                 String path = CamelContextHelper.MODEL_DOCUMENTATION_PREFIX + sub + name + ".json";
-                String inputStream = doLoadResource(path);
-                if (inputStream != null) {
-                    return inputStream;
+                String data = doLoadResource(path);
+                if (data != null) {
+                    return data;
                 }
             }
         } catch (Exception e) {
@@ -90,16 +143,34 @@ class ModelJSonSchemaResolver implements JSonSchemaResolver {
 
     @Override
     public String getMainJsonSchema() {
-        throw new UnsupportedOperationException("Only getModelJSonSchema is in use");
+        try {
+            String path = "META-INF/camel-main-configuration-metadata.json";
+            return doLoadResource(path);
+        } catch (Exception e) {
+            // ignore
+        }
+        return null;
     }
 
-    private static String doLoadResource(String path) throws IOException {
-        InputStream inputStream = ObjectHelper.loadResourceAsStream(path, Thread.currentThread().getContextClassLoader());
-        if (inputStream != null) {
+    private String doLoadResource(String path) throws IOException {
+        InputStream is = null;
+        if (classLoader != null) {
+            is = classLoader.getResourceAsStream(path);
+        }
+        if (is == null && camelContext != null) {
+            ClassResolver resolver = camelContext.getClassResolver();
+            is = resolver.loadResourceAsStream(path);
+        }
+        if (is == null) {
+            is = ObjectHelper.loadResourceAsStream(path, Thread.currentThread().getContextClassLoader());
+        }
+        if (is != null) {
             try {
-                return IOHelper.loadText(inputStream);
+                return IOHelper.loadText(is);
+            } catch (IOException e) {
+                // ignore
             } finally {
-                IOHelper.close(inputStream);
+                IOHelper.close(is);
             }
         }
         return null;
diff --git a/core/camel-yaml-io/src/main/java/org/apache/camel/yaml/io/YamlWriter.java b/core/camel-yaml-io/src/main/java/org/apache/camel/yaml/io/YamlWriter.java
index f5a95277e89..298e199fb96 100644
--- a/core/camel-yaml-io/src/main/java/org/apache/camel/yaml/io/YamlWriter.java
+++ b/core/camel-yaml-io/src/main/java/org/apache/camel/yaml/io/YamlWriter.java
@@ -32,7 +32,6 @@ import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
 import org.apache.camel.CamelContext;
 import org.apache.camel.CamelContextAware;
 import org.apache.camel.catalog.impl.DefaultRuntimeCamelCatalog;
-import org.apache.camel.support.PluginHelper;
 import org.apache.camel.support.service.ServiceSupport;
 import org.apache.camel.tooling.model.BaseOptionModel;
 import org.apache.camel.tooling.model.EipModel;
@@ -59,6 +58,7 @@ public class YamlWriter extends ServiceSupport implements CamelContextAware {
     private CamelContext camelContext;
     private final Writer writer;
     private final DefaultRuntimeCamelCatalog catalog;
+    private final ModelJSonSchemaResolver resolver;
     private final List<EipModel> roots = new ArrayList<>();
     private boolean routesIsRoot;
     private final ArrayDeque<EipModel> models = new ArrayDeque<>();
@@ -67,8 +67,9 @@ public class YamlWriter extends ServiceSupport implements CamelContextAware {
 
     public YamlWriter(Writer writer) {
         this.writer = writer;
+        this.resolver = new ModelJSonSchemaResolver();
         this.catalog = new DefaultRuntimeCamelCatalog();
-        this.catalog.setJSonSchemaResolver(new ModelJSonSchemaResolver());
+        this.catalog.setJSonSchemaResolver(this.resolver);
         this.catalog.setCaching(false); // turn cache off as we store state per node
         this.catalog.start();
     }
@@ -86,11 +87,8 @@ public class YamlWriter extends ServiceSupport implements CamelContextAware {
     @Override
     protected void doStart() throws Exception {
         if (camelContext != null) {
-            DefaultRuntimeCamelCatalog runtime = (DefaultRuntimeCamelCatalog) PluginHelper.getRuntimeCamelCatalog(camelContext);
-            if (runtime != null) {
-                // use json schema resolver from camel context
-                this.catalog.setJSonSchemaResolver(runtime.getJSonSchemaResolver());
-            }
+            this.resolver.setCamelContext(camelContext);
+            this.resolver.setClassLoader(camelContext.getApplicationContextClassLoader());
         }
     }
 
diff --git a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/TransformRoute.java b/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/TransformRoute.java
index e45b546307d..407a9ca455b 100644
--- a/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/TransformRoute.java
+++ b/dsl/camel-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/TransformRoute.java
@@ -53,10 +53,9 @@ public class TransformRoute extends CamelCommand {
                         description = "Whether to resolve property placeholders in the dumped output")
     boolean resolvePlaceholders;
 
-    @CommandLine.Option(names = { "--uri-as-parameters" },
-                        description = "Whether to expand URIs into separated key/value parameters (only in use for YAML format "
-                                      + "and recommended to enable when using Apache Camel Karavan)")
-    boolean uriAsParameters;
+    @CommandLine.Option(names = { "--uri-as-parameters" }, defaultValue = "true",
+                        description = "Whether to expand URIs into separated key/value parameters (only in use for YAML format)")
+    boolean uriAsParameters = true;
 
     @CommandLine.Option(names = { "--ignore-loading-error" },
                         description = "Whether to ignore route loading and compilation errors (use this with care!)")
diff --git a/dsl/camel-jbang/camel-jbang-core/src/test/java/org/apache/camel/dsl/jbang/core/commands/TransformTest.java b/dsl/camel-jbang/camel-jbang-core/src/test/java/org/apache/camel/dsl/jbang/core/commands/TransformTest.java
new file mode 100644
index 00000000000..281832614be
--- /dev/null
+++ b/dsl/camel-jbang/camel-jbang-core/src/test/java/org/apache/camel/dsl/jbang/core/commands/TransformTest.java
@@ -0,0 +1,79 @@
+/*
+ * 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.camel.dsl.jbang.core.commands;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Arrays;
+
+import org.apache.camel.util.FileUtil;
+import org.apache.camel.util.IOHelper;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import picocli.CommandLine;
+
+class TransformTest {
+
+    private File workingDir;
+
+    @BeforeEach
+    public void setup() throws IOException {
+        Path base = Paths.get("target");
+        workingDir = Files.createTempDirectory(base, "camel-transform").toFile();
+    }
+
+    @AfterEach
+    public void end() throws IOException {
+        // force removing, since deleteOnExit is not removing.
+        FileUtil.removeDir(workingDir);
+    }
+
+    @Test
+    public void shouldTransformToYaml() throws Exception {
+        String name = workingDir + "/transform.yaml";
+        File out = new File(name);
+
+        String[] args = new String[] { "--output=" + out.getPath() };
+        TransformRoute command = createCommand(new String[] { "src/test/resources/transform.xml" }, args);
+        int exit = command.doCall();
+        Assertions.assertEquals(0, exit);
+
+        Assertions.assertTrue(out.exists());
+        String data = IOHelper.loadText(new FileInputStream(out));
+        String expected
+                = IOHelper.stripLineComments(Paths.get("src/test/resources/transform-out.yaml"), "#", true);
+        Assertions.assertEquals(expected, data);
+    }
+
+    private TransformRoute createCommand(String[] files, String... args) {
+        TransformRoute command = new TransformRoute(new CamelJBangMain());
+
+        CommandLine.populateCommand(command, "--format=yaml", "--uri-as-parameters");
+        if (args != null) {
+            CommandLine.populateCommand(command, args);
+        }
+        command.files = Arrays.asList(files);
+        return command;
+    }
+
+}
diff --git a/core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml b/dsl/camel-jbang/camel-jbang-core/src/test/resources/transform-out.yaml
similarity index 75%
copy from core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml
copy to dsl/camel-jbang/camel-jbang-core/src/test/resources/transform-out.yaml
index fcf2ad9f5e6..6d14572f41c 100644
--- a/core/camel-core/src/test/resources/org/apache/camel/util/transform.yaml
+++ b/dsl/camel-jbang/camel-jbang-core/src/test/resources/transform-out.yaml
@@ -16,15 +16,17 @@
 #
 
 - route:
-    id: myRoute
+    id: route-b785
+    nodePrefixId: route-14b
     from:
-      id: from
-      uri: direct:start
+      id: from-959e
+      uri: direct
+      parameters:
+        name: start
       steps:
-        - transform:
-            id: transform
-            simple:
-              expression: "Hello ${body}"
         - to:
-            id: myMock
-            uri: mock:result
+            id: to-65f9
+            uri: jms
+            parameters:
+              destinationType: queue
+              destinationName: demo
\ No newline at end of file
diff --git a/dsl/camel-jbang/camel-jbang-core/src/test/resources/transform.xml b/dsl/camel-jbang/camel-jbang-core/src/test/resources/transform.xml
new file mode 100644
index 00000000000..9a50f85492f
--- /dev/null
+++ b/dsl/camel-jbang/camel-jbang-core/src/test/resources/transform.xml
@@ -0,0 +1,25 @@
+<?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.
+
+-->
+<camel>
+    <route id="route-b785" nodePrefixId="route-14b">
+        <from id="from-959e" uri="direct:start"/>
+        <to id="to-65f9" uri="jms:queue:demo"/>
+    </route>
+</camel>
\ No newline at end of file
diff --git a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletMain.java b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletMain.java
index 7f17c53f513..9d33203742d 100644
--- a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletMain.java
+++ b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletMain.java
@@ -574,8 +574,8 @@ public class KameletMain extends MainCommandLineSupport {
         // if transforming DSL then disable processors as we just want to work on the model (not runtime processors)
         boolean transform = "true".equals(getInitialProperties().get("camel.jbang.transform"));
         if (transform) {
-            // we just want to transform, so disable all processors
-            answer.getGlobalOptions().put(ProcessorReifier.DISABLE_ALL_PROCESSORS, "true");
+            // we just want to transform, so disable custom bean or processors as they may use code that does not work
+            answer.getGlobalOptions().put(ProcessorReifier.DISABLE_BEAN_OR_PROCESS_PROCESSORS, "true");
             blueprintXmlBeansHandler.setTransform(true);
         }
         if (silent) {