JBoss Community

Test in the container!

Arquillian provides a easy mechanism to test your application code inside a remote or embedded container or by interacting as a client of the container.

Mission Statement

Arquillian defines two styles of container, remote and embedded. A remote container resides in a separate JVM from the test runner. Its lifecycle may be managed by Arquillian, or Arquillian may bind to a container that is already started. An embedded container resides in the same JVM and is mostly likely managed by Arquillian. Containers can be further classified by their capabilities. Examples include a fully compliant Java EE application server (e.g., GlassFish, JBoss AS, Embedded GlassFish), a Servlet container (e.g., Tomcat, Jetty) and a bean container (e.g., Weld SE). Arquillian ensures that the container used for testing is pluggable, so the developer is not locked into a proprietary testing environment.

Arquillian seeks to minimize the burden on the developer to carry out integration testing by handling all aspects of test execution, including:

• managing the lifecycle of the container (start/stop),
• bundling the test class with dependent classes and resources into a deployable archive,
• enhancing the test class (e.g., resolving @Inject, @EJB and @Resource injections),
• deploying the archive to test (deploy/undeploy) and
• capturing results and failures.

To avoid introducing unnecessary complexity into the developer's build environment, Arquillian integrates transparently with familiar testing frameworks (e.g., JUnit 4, TestNG 5), allowing tests to be launched using existing IDE, Ant and Maven test plugins without any add-ons.

Arquillian makes integration testing a breeze.

Project Information

Modules

Release Plan

Sample Code

Test a EJB in container using JUnit

package com.acme.ejb;
 
import javax.ejb.EJB;
 
import junit.framework.Assert;
 
import org.jboss.arquillian.api.Deployment;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.shrinkwrap.api.Archives;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.Test;
import org.junit.runner.RunWith;
 
@RunWith(Arquillian.class)
public class GreetingManagerTest
{
   @Deployment
   public static JavaArchive createDeployment() {
      return Archives.create("test.jar", JavaArchive.class)
               .addClasses(
                     GreetingManager.class,
                     GreetingManagerBean.class);
   }
   
   @EJB
   private GreetingManager greetingManager;
   
   @Test
   public void shouldGreetUser() throws Exception {
      
      String userName = "Devoxx";
      
      Assert.assertEquals(
            "Hello " + userName,
            greetingManager.greet(userName));
   }
}

Maven Dependencies

   <dependencies>
 
      <dependency>
         <groupId>org.jboss.arquillian</groupId>
         <artifactId>arquillian-junit</artifactId>
         <version>${version.org.jboss.arquillian_arquillian}</version>
      </dependency>
      <dependency>
         <groupId>org.jboss.arquillian.container</groupId>
         <artifactId>arquillian-jbossas-remote-60</artifactId>
         <version>${version.org.jboss.arquillian_arquillian}</version>
      </dependency>
 
   </dependencies>