This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 5d9d6e3 Fix route-coverage to not throw NPE if camel-management JAR
is not on classpath.
5d9d6e3 is described below
commit 5d9d6e331a1890dc314e6ae33603fc0fd552cb3c
Author: Claus Ibsen <[email protected]>
AuthorDate: Fri May 7 09:35:42 2021 +0200
Fix route-coverage to not throw NPE if camel-management JAR is not on
classpath.
---
.../src/main/docs/camel-report-maven-plugin.adoc | 16 +++++++++++++++-
.../test/spring/junit5/CamelAnnotationsHandler.java | 7 ++++---
.../camel/test/spring/junit5/RouteCoverageDumper.java | 12 ++++++++----
.../camel/test/spring/CamelAnnotationsHandler.java | 7 ++++---
.../apache/camel/test/spring/RouteCoverageDumper.java | 12 ++++++++----
5 files changed, 39 insertions(+), 15 deletions(-)
diff --git
a/catalog/camel-report-maven-plugin/src/main/docs/camel-report-maven-plugin.adoc
b/catalog/camel-report-maven-plugin/src/main/docs/camel-report-maven-plugin.adoc
index aa2a49d..8167e8f 100644
---
a/catalog/camel-report-maven-plugin/src/main/docs/camel-report-maven-plugin.adoc
+++
b/catalog/camel-report-maven-plugin/src/main/docs/camel-report-maven-plugin.adoc
@@ -178,9 +178,23 @@ For generating a report of the coverage of your Camel
routes from unit testing.
In the same manner you can generate Java code coverage reports, then this is
the same but for Camel routes.
You can therefore use this to know which parts of your Camel routes has been
used or not.
+Camel uses JMX to capture metrics during tests which is used for calculating
route coverage.
+You must have `camel-management` JAR on the classpath (can be test scoped)
+such as by declaring the following Maven dependency in your pom.xml file:
+
+[source,xml]
+----
+<!-- JMX is needed for route coverage testing -->
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-management</artifactId>
+ <scope>test</scope>
+</dependency>
+----
+
=== Enabling route coverage
-You can enable route coverage while running unit tests either by
+You can enable route coverage while running unit tests either by:
- setting global JVM system property enabling for all test classes
- using `@EnableRouteCoverage` annotation per test class if using
`camel-test-spring` module
diff --git
a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelAnnotationsHandler.java
b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelAnnotationsHandler.java
index 390601c..9266a62 100644
---
a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelAnnotationsHandler.java
+++
b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelAnnotationsHandler.java
@@ -149,11 +149,12 @@ public final class CamelAnnotationsHandler {
RouteCoverageDumper.dumpRouteCoverage(camelContext,
testClass.getName(), testMethodName);
// reset JMX statistics
- ManagedCamelContextMBean managedCamelContext
- =
camelContext.getExtension(ManagedCamelContext.class).getManagedCamelContext();
+ ManagedCamelContext managedCamelContext
+ =
camelContext.getExtension(ManagedCamelContext.class);
if (managedCamelContext != null) {
+ ManagedCamelContextMBean mBean =
managedCamelContext.getManagedCamelContext();
LOGGER.debug("Resetting JMX statistics for
RouteCoverage");
- managedCamelContext.reset(true);
+ mBean.reset(true);
}
// turn off dumping one more time by removing the event
listener (which would dump as well when Camel is stopping)
diff --git
a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/RouteCoverageDumper.java
b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/RouteCoverageDumper.java
index e664a3a..a8a4a48 100644
---
a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/RouteCoverageDumper.java
+++
b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/RouteCoverageDumper.java
@@ -44,13 +44,17 @@ public final class RouteCoverageDumper {
String dir = "target/camel-route-coverage";
String name = testClassName + "-" + testName + ".xml";
- ManagedCamelContextMBean managedCamelContext
- =
context.getExtension(ManagedCamelContext.class).getManagedCamelContext();
+ ManagedCamelContext managedCamelContext
+ = context.getExtension(ManagedCamelContext.class);
if (managedCamelContext == null) {
LOG.warn(
- "Cannot dump route coverage to file as JMX is not
enabled. Override useJmx() method to enable JMX in the unit test classes.");
+ "Cannot dump route coverage to file as JMX is not
enabled."
+ + " Ensure camel-management JAR is on classpath (can
be test scope)."
+ + " Override useJmx() method to enable JMX in the
unit test classes."
+ + " Or when using Spring you can add the
@EnableRouteCoverage annotation to the test classes.");
} else {
- String xml = managedCamelContext.dumpRoutesCoverageAsXml();
+ ManagedCamelContextMBean mBean =
managedCamelContext.getManagedCamelContext();
+ String xml = mBean.dumpRoutesCoverageAsXml();
String combined = "<camelRouteCoverage>\n" +
gatherTestDetailsAsXml(testClassName, testName) + xml
+ "\n</camelRouteCoverage>";
diff --git
a/components/camel-test/camel-test-spring/src/main/java/org/apache/camel/test/spring/CamelAnnotationsHandler.java
b/components/camel-test/camel-test-spring/src/main/java/org/apache/camel/test/spring/CamelAnnotationsHandler.java
index 9be399b..a162abf 100644
---
a/components/camel-test/camel-test-spring/src/main/java/org/apache/camel/test/spring/CamelAnnotationsHandler.java
+++
b/components/camel-test/camel-test-spring/src/main/java/org/apache/camel/test/spring/CamelAnnotationsHandler.java
@@ -149,11 +149,12 @@ public final class CamelAnnotationsHandler {
RouteCoverageDumper.dumpRouteCoverage(camelContext,
testClass.getName(), testMethodName);
// reset JMX statistics
- ManagedCamelContextMBean managedCamelContext
- =
camelContext.getExtension(ManagedCamelContext.class).getManagedCamelContext();
+ ManagedCamelContext managedCamelContext
+ =
camelContext.getExtension(ManagedCamelContext.class);
if (managedCamelContext != null) {
+ ManagedCamelContextMBean mBean =
managedCamelContext.getManagedCamelContext();
LOGGER.debug("Resetting JMX statistics for
RouteCoverage");
- managedCamelContext.reset(true);
+ mBean.reset(true);
}
// turn off dumping one more time by removing the event
listener (which would dump as well when Camel is stopping)
diff --git
a/components/camel-test/camel-test-spring/src/main/java/org/apache/camel/test/spring/RouteCoverageDumper.java
b/components/camel-test/camel-test-spring/src/main/java/org/apache/camel/test/spring/RouteCoverageDumper.java
index fa558bb..81f8401 100644
---
a/components/camel-test/camel-test-spring/src/main/java/org/apache/camel/test/spring/RouteCoverageDumper.java
+++
b/components/camel-test/camel-test-spring/src/main/java/org/apache/camel/test/spring/RouteCoverageDumper.java
@@ -44,13 +44,17 @@ public final class RouteCoverageDumper {
String dir = "target/camel-route-coverage";
String name = testClassName + "-" + testName + ".xml";
- ManagedCamelContextMBean managedCamelContext
- =
context.getExtension(ManagedCamelContext.class).getManagedCamelContext();
+ ManagedCamelContext managedCamelContext
+ = context.getExtension(ManagedCamelContext.class);
if (managedCamelContext == null) {
LOG.warn(
- "Cannot dump route coverage to file as JMX is not
enabled. Override useJmx() method to enable JMX in the unit test classes.");
+ "Cannot dump route coverage to file as JMX is not
enabled."
+ + " Ensure camel-management JAR is on classpath (can
be test scope)."
+ + " Override useJmx() method to enable JMX in the
unit test classes."
+ + " Or when using Spring you can add the
@EnableRouteCoverage annotation to the test classes.");
} else {
- String xml = managedCamelContext.dumpRoutesCoverageAsXml();
+ ManagedCamelContextMBean mBean =
managedCamelContext.getManagedCamelContext();
+ String xml = mBean.dumpRoutesCoverageAsXml();
String combined = "<camelRouteCoverage>\n" +
gatherTestDetailsAsXml(testClassName, testName) + xml
+ "\n</camelRouteCoverage>";