claudio4j commented on code in PR #22208: URL: https://github.com/apache/camel/pull/22208#discussion_r3002205963
########## dsl/camel-jbang/camel-jbang-core/src/test/java/org/apache/camel/dsl/jbang/core/commands/DependencyUpdateJBangTest.java: ########## @@ -0,0 +1,312 @@ +/* + * 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.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.stream.Stream; + +import org.apache.camel.dsl.jbang.core.common.RuntimeType; +import org.apache.camel.dsl.jbang.core.common.StringPrinter; +import org.apache.camel.util.FileUtil; +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 org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import picocli.CommandLine; + +import static org.assertj.core.api.Assertions.assertThat; + +class DependencyUpdateJBangTest extends CamelCommandBaseTestSupport { Review Comment: Having a single DependencyUpdateTest class is easier to maintain, instead 2 files to the same DependencyUpdate command. ########## dsl/camel-jbang/camel-jbang-core/src/test/java/org/apache/camel/dsl/jbang/core/commands/DependencyUpdateJBangTest.java: ########## @@ -0,0 +1,312 @@ +/* + * 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.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.stream.Stream; + +import org.apache.camel.dsl.jbang.core.common.RuntimeType; +import org.apache.camel.dsl.jbang.core.common.StringPrinter; +import org.apache.camel.util.FileUtil; +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 org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import picocli.CommandLine; + +import static org.assertj.core.api.Assertions.assertThat; + +class DependencyUpdateJBangTest extends CamelCommandBaseTestSupport { + + private File workingDir; + + @BeforeEach + @Override + public void setup() throws Exception { + super.setup(); + Path base = Paths.get("target"); + workingDir = Files.createTempDirectory(base, "camel-dependency-update-jbang-tests").toFile(); + } + + @AfterEach + void end() { + FileUtil.removeDir(workingDir); + } + + @ParameterizedTest + @MethodSource("runtimeProvider") + void shouldScanRoutesAddDependency(RuntimeType rt) throws Exception { + prepareMavenProject(rt); + + // add arangodb to the route + addArangodbToCamelFile(); + + // run with --scan-routes + StringPrinter updatePrinter = new StringPrinter(); + DependencyUpdate command = new DependencyUpdate(new CamelJBangMain().withPrinter(updatePrinter)); + CommandLine.populateCommand(command, + "--scan-routes", + "--dir=" + workingDir, + new File(workingDir, "pom.xml").getAbsolutePath()); + int exit = command.doCall(); + Assertions.assertEquals(0, exit, updatePrinter.getLines().toString()); + + String pomContent = Files.readString(new File(workingDir, "pom.xml").toPath()); + switch (rt) { + case quarkus: + assertThat(pomContent).contains("camel-quarkus-arangodb"); + break; + case springBoot: + assertThat(pomContent).contains("camel-arangodb-starter"); + break; + case main: + assertThat(pomContent).contains("camel-arangodb<"); + break; + } + } + + @Test + void shouldScanRoutesRemoveUnusedMavenDependency() throws Exception { + prepareMavenProject(RuntimeType.main); + + // manually add camel-kafka to the pom.xml (which is not used by the route) + File pomFile = new File(workingDir, "pom.xml"); + String pomContent = Files.readString(pomFile.toPath()); + // insert before the closing </dependencies> tag in the main dependencies section + String kafkaDep = " <dependency>\n" + + " <groupId>org.apache.camel</groupId>\n" + + " <artifactId>camel-kafka</artifactId>\n" + + " </dependency>\n "; + pomContent = pomContent.replaceFirst("(</dependencies>)", kafkaDep + "$1"); + Files.writeString(pomFile.toPath(), pomContent); + + // verify kafka is there + assertThat(Files.readString(pomFile.toPath())).contains("camel-kafka"); + + // run with --scan-routes to sync + StringPrinter updatePrinter = new StringPrinter(); + DependencyUpdate command = new DependencyUpdate(new CamelJBangMain().withPrinter(updatePrinter)); + CommandLine.populateCommand(command, + "--scan-routes", + "--dir=" + workingDir, + pomFile.getAbsolutePath()); + int exit = command.doCall(); + Assertions.assertEquals(0, exit, updatePrinter.getLines().toString()); + + // camel-kafka should be removed (not used in routes) + String updatedPom = Files.readString(pomFile.toPath()); + assertThat(updatedPom).doesNotContain("camel-kafka"); + // should still have camel-yaml-dsl (used for the route file) + assertThat(updatedPom).contains("camel-yaml-dsl"); + } + + @Test + void shouldScanRoutesAddAndRemoveMavenDependency() throws Exception { + prepareMavenProject(RuntimeType.main); + + // manually add camel-kafka to the pom.xml (which is not used by the route) + File pomFile = new File(workingDir, "pom.xml"); + String pomContent = Files.readString(pomFile.toPath()); + String kafkaDep = " <dependency>\n" + + " <groupId>org.apache.camel</groupId>\n" + + " <artifactId>camel-kafka</artifactId>\n" + + " </dependency>\n "; + pomContent = pomContent.replaceFirst("(</dependencies>)", kafkaDep + "$1"); + Files.writeString(pomFile.toPath(), pomContent); + + // add arangodb to the route + addArangodbToCamelFile(); + + // run with --scan-routes to sync + StringPrinter updatePrinter = new StringPrinter(); + DependencyUpdate command = new DependencyUpdate(new CamelJBangMain().withPrinter(updatePrinter)); + CommandLine.populateCommand(command, + "--scan-routes", + "--dir=" + workingDir, + pomFile.getAbsolutePath()); + int exit = command.doCall(); + Assertions.assertEquals(0, exit, updatePrinter.getLines().toString()); + + String updatedPom = Files.readString(pomFile.toPath()); + // camel-kafka should be removed (not used in routes) + assertThat(updatedPom).doesNotContain("camel-kafka"); + // camel-arangodb should be added (used in the route) + assertThat(updatedPom).contains("camel-arangodb<"); + // should still have camel-yaml-dsl (used for the route file) + assertThat(updatedPom).contains("camel-yaml-dsl"); + } + + @Test + void shouldPreserveNonCamelDepsInJBangFile() throws Exception { + // create a Java file with mixed Camel and non-Camel //DEPS + Path javaFile = createFile("MyRoute.java", """ + ///usr/bin/env jbang + //DEPS org.apache.camel:camel-bom:4.13.0@pom + //DEPS org.apache.camel:camel-kafka + //DEPS com.google.guava:guava:33.0.0-jre + //DEPS io.netty:netty-all:4.1.100.Final + import org.apache.camel.builder.RouteBuilder; + public class MyRoute extends RouteBuilder { + public void configure() { + from("timer:tick").to("log:info"); + } + } + """); + + // run scan-routes with just the Java file (no separate route files) + StringPrinter p = new StringPrinter(); + DependencyUpdate command = new DependencyUpdate(new CamelJBangMain().withPrinter(p)); + CommandLine.populateCommand(command, + "--scan-routes", + "--dir=" + workingDir, + javaFile.toAbsolutePath().toString()); + int exit = command.doCall(); + Assertions.assertEquals(0, exit, p.getLines().toString()); + + String content = Files.readString(javaFile); + // non-Camel deps should be preserved + assertThat(content).contains("//DEPS com.google.guava:guava:33.0.0-jre"); + assertThat(content).contains("//DEPS io.netty:netty-all:4.1.100.Final"); + // should have camel-bom (resolved fresh) + assertThat(content).contains("//DEPS org.apache.camel:camel-bom:"); + // kafka should be removed (not used in the route definition) + assertThat(content).doesNotContain("camel-kafka"); + } + + @Test + void shouldScanRoutesIdempotentJBang() throws Exception { + Path javaFile = createFile("MyRoute.java", """ + ///usr/bin/env jbang + //DEPS com.google.guava:guava:33.0.0-jre + import org.apache.camel.builder.RouteBuilder; + public class MyRoute extends RouteBuilder { + public void configure() { + from("timer:tick").to("log:info"); + } + } + """); + + // run scan-routes twice + for (int run = 0; run < 2; run++) { + StringPrinter p = new StringPrinter(); + DependencyUpdate command = new DependencyUpdate(new CamelJBangMain().withPrinter(p)); + CommandLine.populateCommand(command, + "--scan-routes", + "--dir=" + workingDir, + javaFile.toAbsolutePath().toString()); + int exit = command.doCall(); + Assertions.assertEquals(0, exit, p.getLines().toString()); + } + + String content = Files.readString(javaFile); + // should have exactly one camel-bom line + long bomCount = content.lines().filter(l -> l.contains("camel-bom")).count(); + assertThat(bomCount).isEqualTo(1); + // non-Camel deps should still be there + assertThat(content).contains("//DEPS com.google.guava:guava:33.0.0-jre"); + } + + @Test + void shouldUpdateMultipleJBangFiles() throws Exception { + Path java1 = createFile("MyRoute1.java", """ + ///usr/bin/env jbang + import org.apache.camel.builder.RouteBuilder; + public class MyRoute1 extends RouteBuilder { + public void configure() { + from("timer:tick").to("log:info"); + } + } + """); + Path java2 = createFile("MyRoute2.java", """ + ///usr/bin/env jbang + import org.apache.camel.builder.RouteBuilder; + public class MyRoute2 extends RouteBuilder { + public void configure() { + from("timer:tick").to("log:info"); + } + } + """); + + DependencyUpdate command = new DependencyUpdate(new CamelJBangMain().withPrinter(printer)); + CommandLine.populateCommand(command, + "--dir=" + workingDir, + java1.toAbsolutePath().toString(), + java2.toAbsolutePath().toString()); + + int exit = command.doCall(); + Assertions.assertEquals(0, exit, printer.getLines().toString()); + + // both files should have //DEPS + String content1 = Files.readString(java1); + String content2 = Files.readString(java2); + assertThat(content1).contains("//DEPS org.apache.camel:camel-bom:"); + assertThat(content2).contains("//DEPS org.apache.camel:camel-bom:"); + } + + private void prepareMavenProject(RuntimeType rt) throws Exception { Review Comment: Calling jbang init and export for each test is not good for tests in CI, since it will take time to invoke and write files. I suggest to have the files ready at src/test/resources, this way the test class is less hassle to maintain and easier to understand. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
