CAMEL-21975: Jbang diagram command to visualize camel routes

[vignesh-manel]

JIRA: CAMEL-21975

Description

Added Playwright-based PNG export for camel diagram via hawtio and Jolokia

Target

• I checked that the commit is targeting the correct branch (Camel 4 uses the main branch)

Tracking

• If this is a large change, bug fix, or code improvement, I checked there is a JIRA issue filed for the change (usually before you start working on it).

Apache Camel coding standards and style

• I checked that each commit in the pull request has a meaningful subject line and body.

• I have run mvn clean install -DskipTests locally from root folder and I have committed all auto-generated changes.

[davsclaus]

Thanks for helping with jbang. Can you make this into its own plugin as this should not be in the core.

You can look at one of the existing pluigins such as the new validate
https://github.com/apache/camel/tree/main/dsl/camel-jbang/camel-jbang-plugin-validate

[orpiske]

Nice idea, I'm but I'm under the impression this would be better done as a plugin. Let's see what others think about it ...

[github-actions]

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

• First-time contributors require MANUAL approval for the GitHub Actions to run
• You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot although they are normally detected and executed by CI.
• You can label PRs using build-all, build-dependents, skip-tests and test-dependents to fine-tune the checks executed by this PR.
• Build and test logs are available in the summary page. Only Apache Camel committers have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

[vignesh-manel]

@davsclaus @Croway @orpiske Refactored as plugin, please review

[Croway]

Nice @vignesh-manel , were you able to test everything locally? can you provide some commands and outputs?

[davsclaus]

there are changes to camel-launcher / camel-jbang run etc - that is of course a bit more worring since this plugin should not break existing behaviour.

And what web browsers and OS does this work on ? Is it only google chrome ?

[vignesh-manel]

Nice @vignesh-manel , were you able to test everything locally? can you provide some commands and outputs?

I tested with the jar locally using below command from camel-launcher directory, it requires a browser executable which is compatible with chromium

java -jar target/camel-launcher-4.19.0-SNAPSHOT.jar diagram ../camel-jbang-core/src/test/resources/hello.yaml --output=hello.png --playwright-browser-path="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"

if --output is not specified it will open the hawtio console, where the integration can be viewed
if --keep-running option is provided, the integration will keep running in the background
--name=hello can be provided to capture diagram of integration which is already running in the background
--route-id=xyz can be provided if a there are multiple routes to capture diagram of specific route

[vignesh-manel]

there are changes to camel-launcher / camel-jbang run etc - that is of course a bit more worring since this plugin should not break existing behaviour.

And what web browsers and OS does this work on ? Is it only google chrome ?

I tried to simplify the changes, right now any chromium based browser is supported, I have tested it only in MacOS

[davsclaus]

Nice @vignesh-manel , were you able to test everything locally? can you provide some commands and outputs?

I tested with the jar locally using below command from camel-launcher directory, it requires a browser executable which is compatible with chromium

java -jar target/camel-launcher-4.19.0-SNAPSHOT.jar diagram ../camel-jbang-core/src/test/resources/hello.yaml --output=hello.png --playwright-browser-path="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"

if --output is not specified it will open the hawtio console, where the integration can be viewed if --keep-running option is provided, the integration will keep running in the background --name=hello can be provided to capture diagram of integration which is already running in the background --route-id=xyz can be provided if a there are multiple routes to capture diagram of specific route

I think this information would be good to add to the documentation, with that little example so others better can understand how to use this feature

[sonarqubecloud]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

[davsclaus]

there is another approach for a diagram command just merged that does not rely on using web browsers, give that a try and look.

6b103ea

[davsclaus]

closing this as we implemented this without using hawtio or the likes. There is a new camel-diagram component that renders and we have a jbang command for this as well. And more to come there.