Lately I had a chance to use the OSGi-JAX-RS-Connector library written by my dear fellow Holger Staudacher. The connector enables you to publish resources easily by registering @Path annotated types as OSGi services – which actually works quite nicely.

While it is natural for me to write the service classes test driven using plain JUnit tests it is also very important to provide additional integration tests. Those tests allow to check runtime availability and functionality of such services. To provide the latter I used another little helper written by Holger – restfuse which is a JUnit extension for automated HTTP/REST Tests.

The scenario looks somewhat like this:

A service

@Path( "/message" ) public class SampleService { @GET @Produces( MediaType.TEXT_PLAIN ) public String getMessage() { return "Hello World"; } }

A JUnit test case

public class SampleServiceTest { @Test public void testGetMessage() { SampleService service = new SampleService(); String message = service.getMessage(); assertEquals( "Hello World", message ); } }

The service registration

<?xml version="1.0" encoding="UTF-8"?> <scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" name="SampleService"> <implementation class="sample.SampleService"/> <service> <provide interface="sample.SampleService"/> </service> </scr:component>

The restfuse integration test

@RunWith( HttpJUnitRunner.class ) public class SampleServiceHttpTest { @Rule public Destination destination = new Destination( this, "http://localhost:9092" ); @Context private Response response; @HttpTest( method = Method.GET, path = "/services/message" ) public void checkMessage() { String body = response.getBody(); assertOk( response ); assertEquals( MediaType.TEXT_PLAIN, response.getType() ); assertEquals( "HelloWorld", body ); } }

The running service



While all of this was quite straight forward it bugged me somehow that running the integration tests locally required first to launch the server before I was able to execute the integration test. Preoccupied by the task at hand I often forgot to launch the server and ran into connection timeouts or the like.

Testing with JUnit Testing with JUnit is one of the most valuable skills a Java developer can learn. No matter what your specific background, whether you’re simply interested in building up a safety net to reduce regressions of your desktop application or in improving your server-side reliability based on robust and reusable components, unit testing is the way to go. Frank has written a book that gives a profound entry point in the essentials of testing with JUnit and prepares you for test-related daily work challenges. Get It Now!

But I found a solution for this by using a PDE JUnit launch configuration, because such a configuration can be setup to start the server within the process that runs the tests.

To do so create and select a test suite that contains all the integration tests to run …

…after that switch to the main tab and select the headless mode…

… and last but not least configure the program arguments used by the server which in our case basically concerns the port definition.

The bundle selection in the Plug-ins tab contains the same bundles as those of the osgi launch configuration that is used to run the server standalone plus the JUnit-, PDE JUnit-, restfuse-bundles and their dependencies. The selected test suite may looks like this:

@RunWith( Suite.class ) @SuiteClasses( { SampleServiceHttpTest.class } ) public class AllRestApiIntegrationTestSuite { public static String BASE_URL = "http://localhost:" + System.getProperty( "org.osgi.service.http.port" ); }

The only unusual thing here is the BASE_URL constant definition. As mentioned above the server port of the test run is specified as a program argument in the launch configuration. But restfuse tests need to provide the port during the destination rule definition. Using the approach above allows to change the port in the configuration without affecting the tests. Simply use the constant as parameter in the definition as shown in the following snippet .

@Rule public Destination destination = new Destination( this, BASE_URL );

This simple setup worked out very well and improved my workflow of running the integration tests locally. And saving the launch configuration in a shared project easily enables your team mates to reuse it.

So this is it for today and as always feedback is highly appreciated. By the way, Holger promised me to write a post about how to integrate that stuff described above into a maven/tycho based build – so stay tuned :-)

Update 2015/01/21: Reflect API changes of restfuse 1.2.