essobedo commented on code in PR #860: URL: https://github.com/apache/camel-website/pull/860#discussion_r903710056
########## content/blog/2022/06/HowToUseCamelRouteTextualDebuggerWithUnitTest/index.md: ########## @@ -0,0 +1,157 @@ +--- +title: "How to use Camel textual Route Debugger with Unit test in VS Code" +date: 2022-06-22 +authors: [apupier] +categories: ["Tooling"] +preview: "How to use Camel textual Route Debugger with Unit test in VS Code" +--- + +Textual debug for Camel routes allows to set breakpoints at Route definition. It is convenient to leverage this feature with a Unit test. + +This article will explain how it is possible to configure the project and the VS Code IDE for that. Similar functionality should be possible with other IDEs but not covered in this article. + +# Requirements + +In this article, we will focus on using VS Code IDE. It implies the following requirements: + +- [VS Code client for Debug Adapter for Camel](https://github.com/camel-tooling/camel-dap-client-vscode/issues) installed in your VS Code instance +- Maven available on system path +- Java 11+ installed +- Camel 3.17+ + +# Project configuration + +## Pom file configuration + +`camel-debug` must be on the classpath. One way to achieve that is to provide the dependency in a profile which needs to be activated when the tests are launched. + +```xml +<profiles> + <profile> + <id>camel.debug</id> + <activation> + <property> + <name>camel.debug</name> + <value>true</value> + </property> + </activation> + <dependencies> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-debug</artifactId> + </dependency> + </dependencies> + </profile> +</profiles> +``` + +## Test class configuration + +Two methods must have a specific value: + +- `isUseDebugger` method must return false. This is the default implementation, just ensure that it is not overridden. +- `useJMX` method must return true. This needs to be overridden. + + +We also need to ensure that the test is starting after Debugger is attached and breakpoint set. For now, the only solution that I can propose is to insert a (ugly) `Thread.sleep` at the beginning of the test. It will work only if the test is triggering the route execution. If your route is automatically triggered like for a `timer`, some route executions might happen before the debugger is attached and breakpoints enabled. + +You should end up with something like that: + +```java +class MainTest extends CamelMainTestSupport { + @Test + void myTest() throws Exception { + Thread.sleep(2000); // to let time to Debugger to attach and install breakpoints + template.asyncSendBody("direct:demo", ""); // Take care to start the route in an async way + NotifyBuilder notify = new NotifyBuilder(context) + .whenCompleted(1).whenBodiesDone("Bye World").create(); + assertTrue( + notify.matches(60, TimeUnit.SECONDS), "1 message should be completed" + ); + } + + @Override + protected boolean useJmx() { + return true; + } +} +``` + +You might also want to introduce a longer timeout to let you time to debug. + +# IDE configuration + +## VS Code Task configuration + +The following VS Code task must be created in the `settings/tasks.json` file: + +```json +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Start test with camel.debug profile", + "type": "shell", + "command": "mvn", // mvn binary of Maven must be available on command-line + "args": [ + "test", + "-Pcamel.debug" // This depends on your project. The goal here is to have camel-debug on the classpath. + ], + "problemMatcher": "$camel.debug.problemMatcher", + "presentation": { + "reveal": "always" + }, + "isBackground": true // Must be set as background as the Maven commands doesn't return until the Camel application stops. + } + ] +} +``` + +It allows to start the test with `camel-debug` on the classpath. + +## VSCode Launch configuration + +The following launch configuration must be created in the `.settings/launch.json`: Review Comment: @apupier I'm wondering if the right path is rather `.vscode/launch.json`? ########## content/blog/2022/06/HowToUseCamelRouteTextualDebuggerWithUnitTest/index.md: ########## @@ -0,0 +1,157 @@ +--- +title: "How to use Camel textual Route Debugger with Unit test in VS Code" +date: 2022-06-22 +authors: [apupier] +categories: ["Tooling"] +preview: "How to use Camel textual Route Debugger with Unit test in VS Code" +--- + +Textual debug for Camel routes allows to set breakpoints at Route definition. It is convenient to leverage this feature with a Unit test. + +This article will explain how it is possible to configure the project and the VS Code IDE for that. Similar functionality should be possible with other IDEs but not covered in this article. + +# Requirements + +In this article, we will focus on using VS Code IDE. It implies the following requirements: + +- [VS Code client for Debug Adapter for Camel](https://github.com/camel-tooling/camel-dap-client-vscode/issues) installed in your VS Code instance +- Maven available on system path +- Java 11+ installed +- Camel 3.17+ + +# Project configuration + +## Pom file configuration + +`camel-debug` must be on the classpath. One way to achieve that is to provide the dependency in a profile which needs to be activated when the tests are launched. + +```xml +<profiles> + <profile> + <id>camel.debug</id> + <activation> + <property> + <name>camel.debug</name> + <value>true</value> + </property> + </activation> + <dependencies> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-debug</artifactId> + </dependency> + </dependencies> + </profile> +</profiles> +``` + +## Test class configuration + +Two methods must have a specific value: + +- `isUseDebugger` method must return false. This is the default implementation, just ensure that it is not overridden. +- `useJMX` method must return true. This needs to be overridden. + + +We also need to ensure that the test is starting after Debugger is attached and breakpoint set. For now, the only solution that I can propose is to insert a (ugly) `Thread.sleep` at the beginning of the test. It will work only if the test is triggering the route execution. If your route is automatically triggered like for a `timer`, some route executions might happen before the debugger is attached and breakpoints enabled. + +You should end up with something like that: + +```java +class MainTest extends CamelMainTestSupport { + @Test + void myTest() throws Exception { + Thread.sleep(2000); // to let time to Debugger to attach and install breakpoints + template.asyncSendBody("direct:demo", ""); // Take care to start the route in an async way + NotifyBuilder notify = new NotifyBuilder(context) + .whenCompleted(1).whenBodiesDone("Bye World").create(); + assertTrue( + notify.matches(60, TimeUnit.SECONDS), "1 message should be completed" + ); + } + + @Override + protected boolean useJmx() { + return true; + } +} +``` + +You might also want to introduce a longer timeout to let you time to debug. + +# IDE configuration + +## VS Code Task configuration + +The following VS Code task must be created in the `settings/tasks.json` file: Review Comment: ditto -- 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]
