Testing (utest and itest) Apache Camel Blueprint route

In any integration project, testing is vital for multiple reasons:

  • to guarantee that the integration logic matches the expectations
  • to quickly identify some regression issues
  • to test some special cases, like the errors for instance
  • to validate the succesful provisioning (deployment) on a runtime as close as possible to the target platform

We distinguish two kinds of tests:

  • the unit tests (utest) aim to test the behaviors of integration logic, and define the expectations that the logic has to match
  • the integration tests (itest) aim to provision the integration logic artifact to a runtime, and check the behaviors on the actual platform

Camel is THE framework to implement your integration logic (mediation).

It provides the Camel Test Kit, based on JUnit to implement utest. In combinaison with Karaf and Pax Exam, we can cover both utest and itest.

In this blog, we will:

  • create an OSGi service
  • create a Camel route using the Blueprint DSL, using the previously created OSGi service
  • implement the utest using the Camel Blueprint Test
  • implement the itest using Pax Exam and Karaf

You can find the whole source code used for this blog post on my github: https://github.com/jbonofre/blog-camel-blueprint.

Blueprint Camel route and features

We create a project (using Maven) containing the following modules:

  • my-service is the OSGi bundle providing the service that we will use in the Camel route
  • my-route is the OSGi bundle providing the Camel route, using the Blueprint DSL. This route uses the OSGi service provided by my-service. It’s where we will implement the utest.
  • features packages the OSGi bundles as a Karaf features XML, ready to be deployed.
  • itests contains the integration test (itest) leveraging Karaf and Pax Exam.

It means we have the following parent pom:

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <groupId>net.nanthrax.blog</groupId>    <artifactId>net.nanthrax.blog.camel.route.blueprint</artifactId>    <name>Nanthrax Blog :: Camel :: Blueprint</name>    <version>1.0-SNAPSHOT</version>    <packaging>pom</packaging>    <modules>        <module>my-service</module>        <module>my-route</module>        <module>features</module>        <module>itests</module>    </modules></project>

OSGi service

The my-service Maven module provides an OSGi bundle providing an echo service.

It uses the following Maven POM:

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <parent>        <groupId>net.nanthrax.blog</groupId>        <artifactId>net.nanthrax.blog.camel.route.blueprint</artifactId>        <version>1.0-SNAPSHOT</version>        <relativePath>../pom.xml</relativePath>    </parent>    <artifactId>net.nanthrax.blog.camel.route.blueprint.service</artifactId>    <name>Nanthrax Blog :: Camel :: Blueprint :: Service</name>    <packaging>bundle</packaging>    <dependencies>        <dependency>            <groupId>org.slf4j</groupId>            <artifactId>slf4j-api</artifactId>            <version>1.7.5</version>        </dependency>    </dependencies>    <build>        <plugins>            <plugin>                <groupId>org.apache.felix</groupId>                <artifactId>maven-bundle-plugin</artifactId>                <version>2.4.0</version>                <extensions>true</extensions>                <configuration>                    <instructions>                        <Export-Package>                            net.nanthrax.blog.service                        </Export-Package>                        <Import-Package>                            org.slf4j*;resolution:=optional                        </Import-Package>                        <Private-Package>                            net.nanthrax.blog.service.internal                        </Private-Package>                    </instructions>                </configuration>            </plugin>        </plugins>    </build></project>

The echo service is described by the net.nanthrax.blog.service.EchoService interface:

package net.nanthrax.blog.service;public interface EchoService {    public String echo(String message);}

We expose the package containing this interface using OSGi Export-Package header.

The implementation of the EchoService is hidden using the OSGi Private-Package header. This implementation is very simple, it gets a message and return the same message with the “Echoing ” prefix:

package net.nanthrax.blog.service.internal;import net.nanthrax.blog.service.EchoService;import org.slf4j.Logger;import org.slf4j.LoggerFactory;public class EchoServiceImpl implements EchoService {    private final static Logger LOGGER = LoggerFactory.getLogger(EchoServiceImpl.class);    public String echo(String message) {        return "Echoing " + message;    }}

To expose this service in OSGi, we use blueprint. We create the blueprint descriptor in src/main/resources/OSGI-INF/blueprint/blueprint.xml:

<?xml version="1.0" encoding="UTF-8"?><blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0">    <service interface="net.nanthrax.blog.service.EchoService">        <bean class="net.nanthrax.blog.service.internal.EchoServiceImpl"/>    </service></blueprint>

The Camel route will use this Echo service.

Camel route and utest

We use the Camel Blueprint DSL to design the route.

The route is packaged as an OSGi bundle, in the my-route Maven module, using the following pom:

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <parent>        <groupId>net.nanthrax.blog</groupId>        <artifactId>net.nanthrax.blog.camel.route.blueprint</artifactId>        <version>1.0-SNAPSHOT</version>        <relativePath>../pom.xml</relativePath>    </parent>    <artifactId>net.nanthrax.blog.camel.route.blueprint.myroute</artifactId>    <name>Nanthrax Blog :: Camel :: Blueprint :: My Route</name>    <packaging>bundle</packaging>    <dependencies>        <dependency>            <groupId>org.apache.camel</groupId>            <artifactId>camel-test-blueprint</artifactId>            <version>2.12.1</version>            <scope>test</scope>        </dependency>        <dependency>            <groupId>org.slf4j</groupId>            <artifactId>slf4j-simple</artifactId>            <version>1.7.5</version>            <scope>test</scope>        </dependency>        <dependency>            <groupId>net.nanthrax.blog</groupId>            <artifactId>net.nanthrax.blog.camel.route.blueprint.service</artifactId>            <version>1.0-SNAPSHOT</version>            <scope>test</scope>        </dependency>    </dependencies>    <build>        <plugins>            <plugin>                <groupId>org.apache.felix</groupId>                <artifactId>maven-bundle-plugin</artifactId>                <version>2.4.0</version>                <extensions>true</extensions>                <configuration>                    <instructions>                        <Import-Package>                            net.nanthrax.blog.service                        </Import-Package>                    </instructions>                </configuration>            </plugin>        </plugins>    </build></project>

The src/main/resources/OSGI-INF/blueprint/route.xml contains the route definition:

<?xml version="1.0" encoding="UTF-8"?><blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0">    <reference id="myService" interface="net.nanthrax.blog.service.EchoService"/>    <camelContext xmlns="http://camel.apache.org/schema/blueprint">        <route>            <from uri="timer:fire?period=5000"/>            <setBody>                <constant>Hello Blog</constant>            </setBody>            <to uri="bean:myService"/>            <to uri="log:net.nanthrax.blog.route"/>            <to uri="file:camel-output"/>        </route>    </camelContext></blueprint>

This route:

  • creates an exchange every 5 secondes, using a Camel timer
  • we set the body of the “in” message in the exchange to “Hello Blog”
  • the message is sent to the EchoService, which prefix the message with “Echoing”, resulting to an updated message containing “Echoing Hello Blog”
  • we log the exchange
  • we create a file for each exchange, in the camel-output folder, using the Camel file component

We are now to create the utest for this route.

As this route uses Blueprint, and Blueprint is an OSGi specific technology, normally, we would have to deploy the route on Karaf to test it.

However, thanks to Camel Blueprint Test and the use of PojoSR, we can test the Blueprint route “outside” of OSGi. Camel Blueprint Test also supports a mock of the OSGi service registry, allowing to mock the OSGi service as well.

Basically, in the unit test, we:

  • load the route Blueprint XML by overridding the getBlueprintDescriptor() method
  • mock the timer and file endpoints by overridding the isMockEndpointsAndSkip() method (skip means that we don’t send the message to the actual endpoint)
  • mock the Echo OSGi service by overriding the addServicesOnStartup() method
  • finally implement a test in the testMyRoute() method

The test itself get the mocked file endpoint, and define the expectations on this endpoint: we expect one message containing “Echoing Hello Blog” on the file endpoint.
Instead of using the actual timer endpoint, we mock it and we use the producer template to send an exchange (in order to control the number of created exchange).
Finally, we check if the expectations are satisfied on the mocked file endpoint.

package net.nanthrax.blog;import net.nanthrax.blog.service.EchoService;import net.nanthrax.blog.service.internal.EchoServiceImpl;import org.apache.camel.component.mock.MockEndpoint;import org.apache.camel.model.language.ConstantExpression;import org.apache.camel.test.blueprint.CamelBlueprintTestSupport;import org.apache.camel.util.KeyValueHolder;import org.junit.Test;import java.util.Dictionary;import java.util.Map;public class MyRouteTest extends CamelBlueprintTestSupport {    @Override    protected String getBlueprintDescriptor() {        return "OSGI-INF/blueprint/route.xml";    }    @Override    public String isMockEndpointsAndSkip() {        return "((file)|(timer)):(.*)";    }    @Override    protected void addServicesOnStartup(Map<String, KeyValueHolder<Object, Dictionary>> services) {        KeyValueHolder serviceHolder = new KeyValueHolder(new EchoServiceImpl(), null);        services.put(EchoService.class.getName(), serviceHolder);    }    @Test    public void testMyRoute() throws Exception {        // mocking the file endpoint and define the expectation        MockEndpoint mockEndpoint = getMockEndpoint("mock:file:camel-output");        mockEndpoint.expectedMessageCount(1);        mockEndpoint.expectedBodiesReceived("Echoing Hello Blog");        // send a message at the timer endpoint level        template.sendBody("mock:timer:fire", "empty");        // check if the expectation is satisfied        assertMockEndpointsSatisfied();    }}

We can see that we mock the Echo OSGi service using the actual EchoServiceImpl. However, of course, it’s possible to use your own local test implementation of the EchoService. It’s interesting to test some use cases, or to simulate errors.

We can note that we use a regex (((file)|(timer)):(.*)) to mock both timer and file endpoints.

We load the route.xml blueprint descriptor directly from the bundle location (OSGI-INF/blueprint/route.xml).

We can run mvn to test the route:

my-route$ mvn clean install[INFO] Scanning for projects...[INFO][INFO] ------------------------------------------------------------------------[INFO] Building Nanthrax Blog :: Camel :: Blueprint :: My Route 1.0-SNAPSHOT[INFO] ------------------------------------------------------------------------[INFO][INFO] --- maven-clean-plugin:2.4.1:clean (default-clean) @ net.nanthrax.blog.camel.route.blueprint.myroute ---[INFO][INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ net.nanthrax.blog.camel.route.blueprint.myroute ---[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent![INFO] Copying 1 resource[INFO][INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ net.nanthrax.blog.camel.route.blueprint.myroute ---[INFO] No sources to compile[INFO][INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ net.nanthrax.blog.camel.route.blueprint.myroute ---[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent![INFO] skip non existing resourceDirectory /home/jbonofre/Workspace/blog-camel-blueprint/my-route/src/test/resources[INFO][INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ net.nanthrax.blog.camel.route.blueprint.myroute ---[INFO] Changes detected - recompiling the module![WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent![INFO] Compiling 1 source file to /home/jbonofre/Workspace/blog-camel-blueprint/my-route/target/test-classes[WARNING] /home/jbonofre/Workspace/blog-camel-blueprint/my-route/src/test/java/net/nanthrax/blog/MyRouteTest.java: /home/jbonofre/Workspace/blog-camel-blueprint/my-route/src/test/java/net/nanthrax/blog/MyRouteTest.java uses unchecked or unsafe operations.[WARNING] /home/jbonofre/Workspace/blog-camel-blueprint/my-route/src/test/java/net/nanthrax/blog/MyRouteTest.java: Recompile with -Xlint:unchecked for details.[INFO][INFO] --- maven-surefire-plugin:2.17:test (default-test) @ net.nanthrax.blog.camel.route.blueprint.myroute ---[INFO] Surefire report directory: /home/jbonofre/Workspace/blog-camel-blueprint/my-route/target/surefire-reports------------------------------------------------------- T E S T S-------------------------------------------------------Running net.nanthrax.blog.MyRouteTest[main] INFO org.apache.camel.test.blueprint.CamelBlueprintHelper - Using Blueprint XML file: /home/jbonofre/Workspace/blog-camel-blueprint/my-route/target/classes/OSGI-INF/blueprint/route.xmlAug 28, 2014 2:57:43 PM org.ops4j.pax.swissbox.tinybundles.core.metadata.RawBuilder runINFO: Copy thread finished.[main] INFO org.apache.camel.impl.osgi.Activator - Camel activator starting[main] INFO org.apache.camel.impl.osgi.Activator - Camel activator started[main] INFO org.apache.aries.blueprint.container.BlueprintExtender - No quiesce support is available, so blueprint components will not participate in quiesce operations[main] INFO net.nanthrax.blog.MyRouteTest - ********************************************************************************[main] INFO net.nanthrax.blog.MyRouteTest - Testing: testMyRoute(net.nanthrax.blog.MyRouteTest)[main] INFO net.nanthrax.blog.MyRouteTest - ********************************************************************************[main] INFO net.nanthrax.blog.MyRouteTest - Skipping starting CamelContext as system property skipStartingCamelContext is set to be true.[main] INFO org.apache.camel.blueprint.BlueprintCamelContext - Apache Camel 2.12.1 (CamelContext: 23-camel-3) is starting[main] INFO org.apache.camel.management.DefaultManagementStrategy - JMX is disabled[main] INFO org.apache.camel.impl.InterceptSendToMockEndpointStrategy - Adviced endpoint [timer://fire?period=5000] with mock endpoint [mock:timer:fire][main] INFO org.apache.camel.impl.InterceptSendToMockEndpointStrategy - Adviced endpoint [file://camel-output] with mock endpoint [mock:file:camel-output][main] INFO org.apache.camel.blueprint.BlueprintCamelContext - StreamCaching is not in use. If using streams then its recommended to enable stream caching. See more details at http://camel.apache.org/stream-caching.html[main] INFO org.apache.camel.blueprint.BlueprintCamelContext - Route: route1 started and consuming from: Endpoint[timer://fire?period=5000][main] INFO org.apache.camel.blueprint.BlueprintCamelContext - Total 1 routes, of which 1 is started.[main] INFO org.apache.camel.blueprint.BlueprintCamelContext - Apache Camel 2.12.1 (CamelContext: 23-camel-3) started in 0.069 seconds[main] INFO org.apache.camel.component.mock.MockEndpoint - Asserting: Endpoint[mock://file:camel-output] is satisfied[Camel (23-camel-3) thread #0 - timer://fire] INFO net.nanthrax.blog.route - Exchange[ExchangePattern: InOnly, BodyType: String, Body: Echoing Hello Blog][main] INFO org.apache.camel.component.mock.MockEndpoint - Asserting: Endpoint[mock://timer:fire] is satisfied[main] INFO net.nanthrax.blog.MyRouteTest - ********************************************************************************[main] INFO net.nanthrax.blog.MyRouteTest - Testing done: testMyRoute(net.nanthrax.blog.MyRouteTest)[main] INFO net.nanthrax.blog.MyRouteTest - Took: 1.094 seconds (1094 millis)[main] INFO net.nanthrax.blog.MyRouteTest - ********************************************************************************[main] INFO org.apache.camel.blueprint.BlueprintCamelContext - Apache Camel 2.12.1 (CamelContext: 23-camel-3) is shutting down[main] INFO org.apache.camel.impl.DefaultShutdownStrategy - Starting to graceful shutdown 1 routes (timeout 10 seconds)[Camel (23-camel-3) thread #1 - ShutdownTask] INFO org.apache.camel.impl.DefaultShutdownStrategy - Route: route1 shutdown complete, was consuming from: Endpoint[timer://fire?period=5000][main] INFO org.apache.camel.impl.DefaultShutdownStrategy - Graceful shutdown of 1 routes completed in 0 seconds[main] INFO org.apache.camel.blueprint.BlueprintCamelContext - Apache Camel 2.12.1 (CamelContext: 23-camel-3) uptime 1.117 seconds[main] INFO org.apache.camel.blueprint.BlueprintCamelContext - Apache Camel 2.12.1 (CamelContext: 23-camel-3) is shutdown in 0.021 seconds[main] INFO org.apache.aries.blueprint.container.BlueprintExtender - Destroying BlueprintContainer for bundle MyRouteTest[main] INFO org.apache.aries.blueprint.container.BlueprintExtender - Destroying BlueprintContainer for bundle net.nanthrax.blog.camel.route.blueprint.service[main] INFO org.apache.aries.blueprint.container.BlueprintExtender - Destroying BlueprintContainer for bundle org.apache.aries.blueprint[main] INFO org.apache.aries.blueprint.container.BlueprintExtender - Destroying BlueprintContainer for bundle org.apache.camel.camel-blueprint[main] INFO org.apache.camel.impl.osgi.Activator - Camel activator stopping[main] INFO org.apache.camel.impl.osgi.Activator - Camel activator stopped[main] INFO org.apache.camel.test.blueprint.CamelBlueprintHelper - Deleting work directory target/bundles/1409230663118Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.581 sec - in net.nanthrax.blog.MyRouteTestResults :Tests run: 1, Failures: 0, Errors: 0, Skipped: 0[INFO] [INFO] --- maven-bundle-plugin:2.4.0:bundle (default-bundle) @ net.nanthrax.blog.camel.route.blueprint.myroute ---[WARNING] Bundle net.nanthrax.blog:net.nanthrax.blog.camel.route.blueprint.myroute:bundle:1.0-SNAPSHOT : Unused Private-Package instructions, no such package(s) on the class path: [!*][INFO] [INFO] --- maven-install-plugin:2.5.1:install (default-install) @ net.nanthrax.blog.camel.route.blueprint.myroute ---[INFO] Installing /home/jbonofre/Workspace/blog-camel-blueprint/my-route/target/net.nanthrax.blog.camel.route.blueprint.myroute-1.0-SNAPSHOT.jar to /home/jbonofre/.m2/repository/net/nanthrax/blog/net.nanthrax.blog.camel.route.blueprint.myroute/1.0-SNAPSHOT/net.nanthrax.blog.camel.route.blueprint.myroute-1.0-SNAPSHOT.jar[INFO] Installing /home/jbonofre/Workspace/blog-camel-blueprint/my-route/pom.xml to /home/jbonofre/.m2/repository/net/nanthrax/blog/net.nanthrax.blog.camel.route.blueprint.myroute/1.0-SNAPSHOT/net.nanthrax.blog.camel.route.blueprint.myroute-1.0-SNAPSHOT.pom[INFO] [INFO] --- maven-bundle-plugin:2.4.0:install (default-install) @ net.nanthrax.blog.camel.route.blueprint.myroute ---[INFO] Installing net/nanthrax/blog/net.nanthrax.blog.camel.route.blueprint.myroute/1.0-SNAPSHOT/net.nanthrax.blog.camel.route.blueprint.myroute-1.0-SNAPSHOT.jar[INFO] Writing OBR metadata[INFO] ------------------------------------------------------------------------[INFO] BUILD SUCCESS[INFO] ------------------------------------------------------------------------[INFO] Total time: 6.906s[INFO] Finished at: Thu Aug 28 14:57:47 CEST 2014[INFO] Final Memory: 22M/557M[INFO] ------------------------------------------------------------------------

Again, the purpose of the utest is to test the behaviors of the route: check if the message content is what we expect, if the message arrives on the expected endpoint, etc.

Karaf features and itests

The purpose of the itest is not really to test the behavior of the route: it’s more to test if the provisioning (deployment) of the route is OK, if the route starts without problem, and, when possible, if the “default” behavior is what we expect.

If it’s possible to deploy bundle per bundle (first the one providing the Echo service, and after the one providing the route), with Karaf, it’s largely easier to create a features XML.

It’s what we do in the features Maven module, grouping the bundles in two features as show in the following features XML:

<?xml version="1.0" encoding="UTF-8"?><features name="blog-camel-blueprint" xmlns="http://karaf.apache.org/xmlns/features/v1.0.0">    <feature name="blog-camel-blueprint-service" version="${project.version}">        <bundle>mvn:net.nanthrax.blog/net.nanthrax.blog.camel.route.blueprint.service/${project.version}</bundle>    </feature>    <feature name="blog-camel-blueprint-route" version="${project.version}">        <feature>blog-camel-blueprint-service</feature>        <bundle>mvn:net.nanthrax.blog/net.nanthrax.blog.camel.route.blueprint.myroute/${project.version}</bundle>    </feature></features>

Now, we can use Pax Exam to implement our itests, by:

  • bootstrap a Karaf container, where we deploy the camel-blueprint, and our features
  • test if the provisioning is OK
  • create a local route to test the output of my-route

We do that in the itests Maven module, where we define the Pax Exam dependency:

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <parent>        <groupId>net.nanthrax.blog</groupId>        <artifactId>net.nanthrax.blog.camel.route.blueprint</artifactId>        <version>1.0-SNAPSHOT</version>        <relativePath>../pom.xml</relativePath>    </parent>    <artifactId>itests</artifactId>    <dependencies>        <dependency>            <groupId>net.nanthrax.blog</groupId>            <artifactId>camel-blueprint</artifactId>            <version>1.0-SNAPSHOT</version>            <classifier>features</classifier>            <type>xml</type>            <scope>test</scope>        </dependency>        <!-- Pax Exam -->        <dependency>            <groupId>org.ops4j.pax.exam</groupId>            <artifactId>pax-exam-container-karaf</artifactId>            <version>3.4.0</version>            <scope>test</scope>        </dependency>        <dependency>            <groupId>org.ops4j.pax.exam</groupId>            <artifactId>pax-exam-junit4</artifactId>            <version>3.4.0</version>            <scope>test</scope>        </dependency>        <dependency>            <groupId>org.ops4j.pax.exam</groupId>            <artifactId>pax-exam-inject</artifactId>            <version>3.4.0</version>            <scope>test</scope>        </dependency>        <dependency>            <groupId>org.apache.geronimo.specs</groupId>            <artifactId>geronimo-atinject_1.0_spec</artifactId>            <version>1.0</version>            <scope>test</scope>        </dependency>        <!-- Camel Test -->        <dependency>            <groupId>org.apache.camel</groupId>            <artifactId>camel-test</artifactId>            <version>2.12.1</version>            <scope>test</scope>        </dependency>        <!-- Karaf -->        <dependency>            <groupId>org.apache.karaf</groupId>            <artifactId>apache-karaf</artifactId>            <version>2.3.6</version>            <type>tar.gz</type>            <scope>test</scope>            <exclusions>                <exclusion>                    <groupId>org.apache.karaf</groupId>                    <artifactId>org.apache.karaf.client</artifactId>                </exclusion>            </exclusions>        </dependency>    </dependencies></project>

We create MyRouteTest in src/test/java/net/nanthrax/blog/itests:

package net.nanthrax.blog.itests;import static org.ops4j.pax.exam.CoreOptions.maven;import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.*;import org.apache.camel.Exchange;import org.apache.camel.Processor;import org.apache.camel.builder.RouteBuilder;import org.apache.camel.component.mock.MockEndpoint;import org.apache.camel.model.language.ConstantExpression;import org.apache.camel.test.junit4.CamelTestSupport;import org.apache.karaf.features.FeaturesService;import org.junit.Test;import org.junit.runner.RunWith;import org.ops4j.pax.exam.Configuration;import org.ops4j.pax.exam.Option;import org.ops4j.pax.exam.junit.PaxExam;import org.ops4j.pax.exam.karaf.options.LogLevelOption;import org.osgi.framework.BundleContext;import javax.inject.Inject;import java.io.File;@RunWith(PaxExam.class)public class MyRouteTest extends CamelTestSupport {    @Inject    protected FeaturesService featuresService;    @Inject    protected BundleContext bundleContext;    @Configuration    public static Option[] configure() throws Exception {        return new Option[] {                karafDistributionConfiguration()                        .frameworkUrl(maven().groupId("org.apache.karaf").artifactId("apache-karaf").type("tar.gz").version("2.3.6"))                        .karafVersion("2.3.6")                        .useDeployFolder(false)                        .unpackDirectory(new File("target/paxexam/unpack")),                logLevel(LogLevelOption.LogLevel.WARN),                features(maven().groupId("org.apache.camel.karaf").artifactId("apache-camel").type("xml").classifier("features").version("2.12.1"), "camel-blueprint", "camel-test"),                features(maven().groupId("net.nanthrax.blog").artifactId("camel-blueprint").type("xml").classifier("features").version("1.0-SNAPSHOT"), "blog-camel-blueprint-route"),                keepRuntimeFolder()        };    }    @Test    public void testProvisioning() throws Exception {        // first check that the features are installed        assertTrue(featuresService.isInstalled(featuresService.getFeature("camel-blueprint")));        assertTrue(featuresService.isInstalled(featuresService.getFeature("blog-camel-blueprint-route")));        // now we check if the OSGi services corresponding to the camel context and route are there    }    @Test    public void testMyRoute() throws Exception {        MockEndpoint itestMock = getMockEndpoint("mock:itest");        itestMock.expectedMinimumMessageCount(3);        itestMock.whenAnyExchangeReceived(new Processor() {            public void process(Exchange exchange) {                System.out.println(exchange.getIn().getBody(String.class));            }        });        template.start();        Thread.sleep(20000);        assertMockEndpointsSatisfied();    }    @Override    protected RouteBuilder createRouteBuilder() {        return new RouteBuilder() {            public void configure() {                from("file:camel-output").to("mock:itest");            }        };    }}

In this test class, we can see:

  • the configure() method where we define the Karaf distribution to use, the log level, the Camel features XML location and the Camel features that we want to install (camel-blueprint and camel-test), the location of our features XML and the feature that we want to install (blog-camel-blueprint-route)
  • the testProvisioning() method where we check if the features have been correctly installed
  • the createRouteBuilder() method where we programmatically create a new route (using the Java DSL here) consuming the files created by my-route and sending to a mock endpoint
  • the testMyRoute() gets the itest mock endpoint (from the route created by the createRouteBuilder() method) and check that it receives at least 3 messages, during an update of 20 secondes (and also display the content of the message)

Running mvn, it bootstraps a Karaf instance, install the features, deploy our test bundle, and check the execution:

itests$ mvn clean install...------------------------------------------------------- T E S T S-------------------------------------------------------Running net.nanthrax.blog.itests.MyRouteTest[org.ops4j.pax.exam.spi.DefaultExamSystem] : Pax Exam System (Version: 3.4.0) created.[org.ops4j.store.intern.TemporaryStore] : Storage Area is /tmp/1409248259083-0[org.ops4j.pax.exam.junit.impl.ProbeRunner] : creating PaxExam runner for class net.nanthrax.blog.itests.MyRouteTest...[org.ops4j.pax.exam.karaf.container.internal.KarafTestContainer] : Test Container started in 3 millis[org.ops4j.pax.exam.karaf.container.internal.KarafTestContainer] : Wait for test container to finish its initialization [ RelativeTimeout value = 180000 ][org.ops4j.pax.exam.rbc.client.RemoteBundleContextClient] : Waiting for remote bundle context.. on 21414 name: 7cd8df34-0ed2-4449-8d60-d51f395cfa1d timout: [ RelativeTimeout value = 180000 ]        __ __                  ____       / //_/____ __________ _/ __/      / ,<  / __ `/ ___/ __ `/ /_     / /| |/ /_/ / /  / /_/ / __/    /_/ |_|\__,_/_/   \__,_/_/  Apache Karaf (2.3.6)Hit '<tab>' for a list of available commandsand '[cmd] --help' for help on a specific command.Hit '<ctrl-d>' or type 'osgi:shutdown' or 'logout' to shutdown Karaf.karaf@root> SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".SLF4J: Defaulting to no-operation (NOP) logger implementationSLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.[org.ops4j.pax.exam.rbc.client.RemoteBundleContextClient] : Remote bundle context found after 5774 millis[org.ops4j.pax.tinybundles.core.intern.RawBuilder] : make()[org.ops4j.store.intern.TemporaryStore] : Enter store()[org.ops4j.pax.tinybundles.core.intern.RawBuilder] : Creating manifest from added headers....[org.ops4j.pax.exam.container.remote.RBCRemoteTarget] : Installed bundle (from stream) as ID: 102[org.ops4j.pax.exam.container.remote.RBCRemoteTarget] : call [[TestAddress:PaxExam-d7899c82-74e1-445e-9fcb-ab9b18e286b4 root:PaxExam-5dfb0f4b-96d9-4226-bdea-5b057e7e7335]]Echoing Hello BlogEchoing Hello BlogEchoing Hello BlogEchoing Hello Blog...Results :Tests run: 2, Failures: 0, Errors: 0, Skipped: 0[INFO][INFO] --- maven-jar-plugin:2.3.2:jar (default-jar) @ itests ---[WARNING] JAR will be empty - no content was marked for inclusion![INFO] Building jar: /home/jbonofre/Workspace/blog-camel-blueprint/itests/target/itests-1.0-SNAPSHOT.jar[INFO][INFO] --- maven-install-plugin:2.3.1:install (default-install) @ itests ---[INFO] Installing /home/jbonofre/Workspace/blog-camel-blueprint/itests/target/itests-1.0-SNAPSHOT.jar to /home/jbonofre/.m2/repository/net/nanthrax/blog/itests/1.0-SNAPSHOT/itests-1.0-SNAPSHOT.jar[INFO] Installing /home/jbonofre/Workspace/blog-camel-blueprint/itests/pom.xml to /home/jbonofre/.m2/repository/net/nanthrax/blog/itests/1.0-SNAPSHOT/itests-1.0-SNAPSHOT.pom[INFO] ------------------------------------------------------------------------[INFO] BUILD SUCCESS[INFO] ------------------------------------------------------------------------[INFO] Total time: 35.904s[INFO] Finished at: Thu Aug 28 19:51:32 CEST 2014[INFO] Final Memory: 28M/430M[INFO] ------------------------------------------------------------------------

Integration in Jenkins

We can now integrate our project in Jenkins CI. We now have a complete CI covering, build of the service, packaging of the route, utest on the route, itest of the service and route in Karaf.

jenkins1

jenkins2

jenkins3

Comments

Post a Comment

Popular posts from this blog

Exposing Apache Karaf configurations with Apache Arrow Flight

Image
This blog post shows how to use Apache Arrow and Arrow Flight in Apache Karaf runtime. The code base is available here: https://github.com/jbonofre/karaf-arrow . Apache Arrow ? Apache Arrow is composed by: The Arrow format (specification). Format implementations with different languages (C, Java, Go, Rust, ...). Extra subprojects like Flight, Flight SQL, ADBC, nanoarrow, ... Apache Arrow format is a in-memory columnar format, super efficient for scanning and iterating a large chunks of data. In traditional memory buffer, we focus on "row". Apache Arrow format "groups" data per column, which is much more efficient on modern CPUs/GPUs. The Apache Arrow format is basically a specification. We have several implementations for this specification: C C++ C# Go Java Python Ruby Rust As the purpose of this blog post is to show Apache Arrow in Apache Karaf, we will use Arrow Java. In addition, Apache Arrow also provides several...
Read more

Getting started with Apache Karaf Minho

Image
Apache Karaf Minho Apache Karaf Minho is a new runtime, completely created from scratch. The objectives are: super easy to use and run ligtning fast, including GraalVM support Kubernetes compliant to be easily used on the cloud helping to optimize cloud costs by supporting applications colocation providing turnkey services allowing you to create Minho applications in a minute Minho is composed by: minho-boot is the core of Minho. It contains the runtime launcher and the core services (service registry, lifecycle service, configuration service, ...). minho-* services provided additional functionnalities in the runtime. You can use these services to create your own services, it's also where you will find the services managing sepcific kind of applications, allowing colocation. minho-tooling optionally provide convenient tools to create your own runtime. It includes minho-maven-plugin for instance. In this blog post, we will take a quick tour on A...
Read more

Using Apache Karaf with Kubernetes

Image
In a previous blog post ( http://blog.nanthrax.net/?p=893 ), I introduced the “new” docker support in Karaf and the use of Karaf static distribution. This post follows the previous one by illustrating how to use Karaf docker image with a Kubernetes cluster. Preparing Karaf static docker image As in the previous blog post, we are preparing a Karaf static distribution based docker image. For this blog post, I’m using the example provided in Karaf: https://github.com/apache/karaf/tree/master/examples/karaf-docker-example/karaf-docker-example-static-dist . I’m just building the distribution as usual: karaf-docker-example-static-dist$ mvn clean install Preparing kubernetes testing cluster For this blog, I’m using a minikube installed locally. The installation is pretty simple: Download minikube from https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 Rename minikube-linux-amd64 as minikube Copy minikube in your path, for instance /us...
Read more