Code Coverage Report Generation using JaCoCO

   Given the importance  given to the Unit and Integration tests , it is important to evaluate the amount of code that our test cases cover. The contenders  for tool of choice were Emma, Cobertura and JACOCO (sure has a strange name than others,it is actually JAva COde COverage). JACOCO won for the following reasons 

• While Emma and Cobertura have been around for long time they are not much efficient in collecting run time coverage data from a test running inside the container. JACOCO is made for it.
• They also do cool stuffs like on the fly Instrumentation of classes
• They work hand in hand with Arquillian  etc etc
• You can read further @ http://www.eclemma.org/jacoco/

 The generated report is very detailed, refer to the screen shots below (classified certain areas of screen print to honor NDA)

Project Level

Package level

Class level

Method Level

Highlighted in GREEN is covered code.
This report should help us to really write quality tests and in turn deliver a quality product.Now lets see how to set this up.


JACOCO Setup.

You will be so surprised that it is so simple with maven. add the following to your pom and thats it, yes really thats it. Your unit and integration tests coverage reports are ready.
Add the following dependency

<dependency>
   <groupId>org.jacoco</groupId>
   <artifactId>org.jacoco.core</artifactId>
   <version>0.5.3.201107060350</version>
   <scope>test</scope>
  </dependency>

and this

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.5.3.201107060350</version>
    <executions>
     <execution>
      <id>jacoco-initialize</id>
      <goals>
       <goal>prepare-agent</goal>
      </goals>
     </execution>
     <execution>
      <id>report</id>
      <phase>install</phase>
      <goals>
       <goal>report</goal>
      </goals>
     </execution>
    </executions>
  </plugin> 

 Suggestions and user experience are welcome

Debugging Arquillian Integration Tests using Eclipse and Jboss

Debugging is an important aspect of development. This post is about setting a debug environment for arquillian integration test using eclipse and jboss. This is a bit different from normal unit tests debugging as the tests, in this case really runs inside the container so we should actually set up the remote debugging.

 

1) For debugging we need to first have the arquillian test run in the remote container and not in the managed one.In order to do that you have to first import the following maven dependency.

         <dependency>

                    <groupId>org.jboss.as</groupId>

                     <artifactId>jboss-as-arquillian-container-remote</artifactId>

                     <version>7.1.0.Alpha1-SNAPSHOT</version>

            </dependency>

Note : Since we are going to debug on remote container, kindly remove the jboss-as-arquillian-container-managed  dependency in pom.xml if exists.

2) Set the following as you java opts in your Jboss and start the server. This will start your jboss in debug mode.

set JAVA_OPTS=%JAVA_OPTS% -Xdebug -Xrunjdwp:transport=dt_socket,address=8585,server=y,suspend=n

3) Set the remote debugging option in eclipse, following the quick steps given below

         Select the Debug > Debug Configurations... menu from the main menu bar      
         Double Click on the Remote Java Application tree node available in left side of the popup  window and create new debug config
         Configure the name of the debug configuration
         Configure the project which we need to debug
         Configure the host name (where the jboss server is actually running) 
         Configure the port number (debug port number)
          Click on Apply Button

 

Click Debug

 

 

 

 

 

 

 

 

 

 

 

4)Open your test. Add break points and run using "Debug as.."
 

Credits:RajendraPrasad Kancharla

Integration tests made easy with Arquillian

Wikipedia defines Integration testing as follows

"Integration testing (sometimes called Integration and Testing, abbreviated "I&T") is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing"

It should be clear by now the purpose of integration testing is way different from Unit testing.

Arquillian makes it really easy to write integration tests by handling the following

• Manages the lifecycle of the container (start/stop),
• Bundles the test class with dependent classes and resources into a deployable archive,
• Enriches the test class (e.g., resolving @Inject, @EJB and @Resource injections),
• Deploys the archive to test (deploy/undeploy) and
• Captures results and failures.

The above said points were something that developers should handle so far with mock objects and embedded containers so far. With Arquillian the integration tests are as simple as writing straight forward unit tests. It also provides good integration with maven.

How it works?

1) Import arquillian dependencies

2) Configure arquillian using arquillian.xml - You will configure the containers and container properties like location, port and protocol of the jboss server for example

3) Annotate test as arquillian tests if using Junit or Extend org.jboss.arquillian.testng.Arquillian if using testng.

4) Prepare the archive containing the classes you are writing tests for - You should include all the referred classes and libraries also. You can prepare a JAR, WAR or EAR based on your needs. Remember you are building this archive on the fly using Shrinkwrap. You should annotate the method preparing the archive using  @Deployment

5) Execute tests- Arquillian will build the archive  in the beforesuite phase of test execution , deploy it based on the configuration in arquillian.xml , execute the tests in the container (because of this your eclipse debugging will have to setup differently to debug test case execution, will see that in a different post) and send you back the results.


Quick Startup guide:

I am using Maven, Jboss 7.0.2 (Arc) , JEE6 and TestNG for this example


Maven Integration

Add the following dependencies
<dependency>
  <groupId>org.testng</groupId>
  <artifactId>testng</artifactId>
  <version>6.1.1</version>
  <scope>test</scope>
 </dependency>
 <dependency>
  <groupId>org.jboss.arquillian.testng</groupId>
  <artifactId>arquillian-testng-container</artifactId>
  <version>1.0.0.CR7</version>
 </dependency>
 <dependency>
  <groupId>org.jboss.arquillian.protocol</groupId>
  <artifactId>arquillian-protocol-servlet</artifactId>
  <version>1.0.0.CR7</version>
  <scope>provided</scope>
 </dependency>
The following will start and stop the container of its own
 <dependency>
  <groupId>org.jboss.as</groupId>
  <artifactId>jboss-as-arquillian-container-managed</artifactId>
  <version>7.0.2.Final</version>
 </dependency>
or
The following will deploy and undeploy the testabke archive to the container that is already running
 <dependency>
  <groupId>org.jboss.as</groupId>
  <artifactId>jboss-as-arquillian-container-remote</artifactId>
  <version>7.0.2.Final</version>
 </dependency>


Arquillian.xml (Have this test resources)

<?xml version="1.0" encoding="UTF-8"?>
<arquillian
    xmlns="http://jboss.org/schema/arquillian"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://jboss.org/schema/arquillian http://jboss.org/schema/arquillian/arquillian_1_0.xsd">
<defaultProtocol />
<container qualifier="jboss7" default="true">
    <configuration>
        <property>C:\DevTools\jboss-as-web-7.0.2.Final\jboss-as-web-7.0.2.Final</property>
    </configuration>
      <protocol>
            <property>REMOTE</property>
        </protocol>
   </container>
</arquillian>


Code snippets showing archive preparation

public abstract class AbstractTestServices extends Arquillian {
...
....
@Deployment(testable = true)
public static WebArchive createTestArchive() {
test = ShrinkWrap.create(WebArchive.class,"test.war").addClass(AbstractTestServices.class).addAsLibraries(servicesJar, entitiesJar);
return test;
}


Code Snippets of Integration test cases


public class PersonServiceTestIT extends AbstractTestServices {
@Inject private personService personService;
@Test
 public void shouldBeAbleToInjectEJB() throws Exception AssertJUnit.assertEquals(personService.dummyTestMethod(), true);  }

Maven will look for integration tests in the Integration-test phase, you should end your integration tests with the name IT for that to be identified as Integration test. Also remember to use Maven failsafe plug-in.

That’s it!!!

Further reading:
http://www.jboss.org/arquillian
http://maven.apache.org/plugins/maven-failsafe-plugin/
https://docs.jboss.org/author/display/ARQ/Complete+Container+Reference
https://docs.jboss.org/author/display/ARQ/Supported+containers
https://docs.jboss.org/author/display/ARQ/Introduction
http://www.jboss.org/shrinkwrap