Allow routes containing Java DSL at start to be formatted (#1208)

Author: merkuspunto

src/main/java/com/github/cameltooling/idea/service/extension/camel/JavaCamelIdeaUtils.java

@@ -97,7 +97,7 @@ public class JavaCamelIdeaUtils extends CamelIdeaUtils implements CamelIdeaUtils
     private static final Set<String> ADD_INDENT = Set.of("choice", "doTry", "pipeline", "multicast", "split",
         "circuitBreaker", "intercept", "interceptFrom", "interceptSendToEndpoint", "aggregate", "loadBalance", "loop",
         "kamelet", "step", "transacted", "saga", "route", "resequence", "policy", "onException", "onCompletion",
-        "from", "rest", "restConfiguration");
+        "from", "rest", "restConfiguration", "routeTemplate");
     /**
      * Name of the methods corresponding to the root element of sub DSL.
      */
@@ -482,13 +482,20 @@ private List<PsiElement> findEndpoints(Project project, SearchScope scope, Predi
             Collection<PsiClass> allClasses = AllClassesSearch.search(scope, project).findAll();
             for (PsiClass aClass : allClasses) {
                 boolean insideRouteBuilder = aClass.isInheritorDeep(routeBuilderClass, null);
-                Collection<PsiLiteralExpression> literals = PsiTreeUtil.findChildrenOfType(aClass, PsiLiteralExpression.class);
-                for (PsiLiteralExpression literal : literals) {
-                    if (insideRouteBuilder || isConsumerEndpoint(literal) || isProducerEndpoint(literal)) {
-                        Object val = literal.getValue();
-                        if (val instanceof String endpointUri) {
-                            if (uriCondition.test(endpointUri) && elementCondition.test(literal)) {
-                                results.add(literal);
+                Collection<PsiExpression> expressions = PsiTreeUtil.findChildrenOfType(aClass, PsiExpression.class);
+                for (PsiExpression expression : expressions) {
+                    if (insideRouteBuilder || isConsumerEndpoint(expression) || isProducerEndpoint(expression)) {
+                        if (expression instanceof PsiLiteralExpression literalExpression) {
+                            Object val = literalExpression.getValue();
+                            if (val instanceof String endpointUri) {
+                                if (uriCondition.test(endpointUri) && elementCondition.test(literalExpression)) {
+                                    results.add(expression);
+                                }
+                            }
+                        } else if (expression instanceof PsiMethodCallExpression methodCallExpression) {
+                            if (isCamelRouteStartExpression(methodCallExpression)
+                                    && !List.of("kamelet", "templateParameter").contains(methodCallExpression.getMethodExpression().getReferenceName())) {
+                                results.add(methodCallExpression);
                             }
                         }
                     }
@@ -846,7 +853,9 @@ private static boolean isReturnTypeOfMethodToFormat(String methodName, String re
             // By default, it is accepted
             return true;
         }
-        return !"org.apache.camel.builder.ValueBuilder".equals(returnType) || "expression".equals(methodName);
+        return (!"org.apache.camel.builder.ValueBuilder".equals(returnType)
+                && !returnType.startsWith("org.apache.camel.builder.endpoint.dsl"))
+                || "expression".equals(methodName);
     }
 
     /**

src/test/java/com/github/cameltooling/idea/formatter/CamelPostFormatProcessorIT.java

@@ -22,7 +22,6 @@
 import com.intellij.openapi.command.WriteCommandAction;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.util.TextRange;
-import com.intellij.psi.PsiFile;
 import com.intellij.psi.codeStyle.CodeStyleManager;
 import com.intellij.testFramework.DumbModeTestUtils;
 import com.intellij.testFramework.PlatformTestUtil;
@@ -51,6 +50,20 @@ public void testRouteWithDataFormatDSL() {
         doTest("RouteWithDataFormatDSL", null);
     }
 
+    /**
+     * Ensures that a route using only the Java DSL is supported.
+     */
+    public void testRouteWithOnlyJavaDSL() {
+        doTest("RouteWithOnlyJavaDSL", null);
+    }
+
+    /**
+     * Ensures that a route template is supported.
+     */
+    public void testRouteTemplate() {
+        doTest("RouteTemplate", null);
+    }
+
     /**
      * Ensures that a malformed route won't make the formatter fail.
      */

src/test/resources/testData/formatter/after/RouteTemplate.txt

@@ -0,0 +1,31 @@
+/*
+ * 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.
+ */
+
+import org.apache.camel.builder.RouteBuilder;
+
+import static org.apache.camel.builder.endpoint.StaticEndpointBuilders.kamelet;
+
+public class RouteTemplate extends RouteBuilder {
+
+    @Override
+    public void configure() throws Exception {
+        routeTemplate("template")
+            .templateParameter("v1")
+            .from(kamelet("source"))
+                .setProperty("version", constant("{{version}}"));
+    }
+}

src/test/resources/testData/formatter/after/RouteWithOnlyJavaDSL.txt

@@ -0,0 +1,49 @@
+/*
+ * 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.
+ */
+
+import java.util.Map;
+
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.model.dataformat.CsvDataFormat;
+
+import static org.apache.camel.builder.endpoint.StaticEndpointBuilders.direct;
+
+public class RouteWithOnlyJavaDSL extends RouteBuilder {
+
+    @Override
+    public void configure() throws Exception {
+        CsvDataFormat dataFormat = new CsvDataFormat();
+        dataFormat.setDelimiter("|");
+
+        from(direct("format"))
+            .setBody(constant(Map.of("foo", "abc", "bar", 123)))
+            .marshal(dataFormat);
+
+        from(direct("format"))
+            .setBody(constant(Map.of("foo", "abc", "bar", 123)))
+            .marshal()
+            .csv();
+
+        from(direct("format"))
+            .setBody(constant(Map.of("foo", "abc", "bar", 123)))
+            .marshal(
+                dataFormat()
+                    .csv()
+                    .delimiter(",")
+                .end());
+    }
+}

src/test/resources/testData/formatter/before/RouteTemplate.java

@@ -0,0 +1,28 @@
+/*
+ * 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.
+ */
+
+import org.apache.camel.builder.RouteBuilder;
+
+import static org.apache.camel.builder.endpoint.StaticEndpointBuilders.kamelet;
+
+public class RouteTemplate extends RouteBuilder {
+
+    @Override
+    public void configure() throws Exception {
+        routeTemplate("template").templateParameter("v1").from(kamelet("source")).setProperty("version", constant("{{version}}"));
+    }
+}

src/test/resources/testData/formatter/before/RouteWithOnlyJavaDSL.java

@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+
+import java.util.Map;
+
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.model.dataformat.CsvDataFormat;
+
+import static org.apache.camel.builder.endpoint.StaticEndpointBuilders.direct;
+
+public class RouteWithOnlyJavaDSL extends RouteBuilder {
+
+    @Override
+    public void configure() throws Exception {
+        CsvDataFormat dataFormat = new CsvDataFormat();
+        dataFormat.setDelimiter("|");
+
+        from(direct("format")).setBody(constant(Map.of("foo", "abc", "bar", 123))).marshal(dataFormat);
+
+        from(direct("format")).setBody(constant(Map.of("foo", "abc", "bar", 123))).marshal().csv();
+
+        from(direct("format")).setBody(constant(Map.of("foo", "abc", "bar", 123))).marshal(dataFormat().csv().delimiter(",").end());
+    }
+}