Arquillian, TomEE and big applications: avoid N times the same dump

TomEE arquillian adapters try to make test as isolated as possible but it means if you test a single application in N tests you’ll dump the application N times. For small apps no issue but for big ones it takes time.

To solve it several solutions exist.

The most obvious one is to use the built war and not a shrinkwrap memory archive but then you have to build your war before testing your code which can lead to install broken artifacts! You can also use one of the arquillian suite extensions but you can get issues with the container adapter (IIRC you need TomEE trunk/1.7.2 at least) or with other arquillian extensions because of the lifecycle which is not common.

To get an intermediate solution TomEE adapters have now the singleDumpByArchiveName property (you can set it to “true” in arquillian.xml in tomee container properties). This property means: when I have an archive “foo.war” it will always be the same content. In this case TomEE adapter will dump it only the first time. You can of course have several different archives but just ensure to name them differently.

This is a not a rare pattern when you use an “Applications” utility class and just call “Applications.myApp()” in @Deployment method of your arquillian test. Note also that setting “preloadClasses” property of tomee adapter to the fully qualified name of your “Applications” class and initializing your app (war) in a static block to just return a field in “myApp()” can save few seconds as well.

Finally here what it looks like:

public class Applications {
    private static final Archive<?> WAR = ShrinkWrap.create(WebArchive.class, "myapp.war")
              // ... add your classes/resources/...
               ;

   public static Archive<?> myApp() {
       // Note: if you don't use singleDumpByArchiveName then you need to copy WAR here
       // using ShrinkWrap ExplodedImporter for instance and archive.merge(...)
       return WAR;
   }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<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">	
       <container qualifier="tomee" default="true">
           <configuration>
               <property name="singleDumpByArchiveName">true</property>
               <property name="httpPort">-1</property>
               <property name="stopPort">-1</property>
               <property name="ajpPort">-1</property>
               <property name="dir">target/apache-tomee-remote</property>
               <property name="appWorkingDir">target/arquillian-test-working-dir</property>
           </configuration>
       </container>
</arquillian>

Advertisement