INTEGRATION TEST WITH REMOTE TOMCAT

Tomcat is simply a servlet container which lacks Enterprise Java capabilities like JPA (persistence) and JTA (transactions), so we will install the OpenEJB for Tomcat plug-in. Rather than package JumpStart into an EAR we will package it in a WAR in Collapsed EAR format.

Prepare Tomcat 5.5.x or 6.0.x for JumpStart

• Assuming you have a normal working Tomcat 5.5 or 6.0 installation...


• Install the OpenEJB plugin:
  1. Download openejb.war (OpenEJB for Tomcat).
  2. Copy openejb.war to ${catalina.base}/webapps/ (Note: the file must be named openejb.war)
  3. Start Tomcat if it is not already running.
     ...in Windows:
     • cd /devel/apache-tomcat-6.0.18/bin
     • catalina.bat start
     ...in tcsh (the default shell in OS X Terminal):
     • cd /devel/apache-tomcat-6.0.18/bin
     • ./catalina.sh start
  4. Visit http://localhost:8080/openejb/installer and click the 'install' button.


• Stop Tomcat with catalina:
  ...in Windows:
  • cd /devel/apache-tomcat-6.0.18/bin
  • catalina.bat stop
  ...in tcsh (the default shell in OS X Terminal):
  • cd /devel/apache-tomcat-6.0.18/bin
  • ./catalina.sh stop


• Add Hibernate to Tomcat:
  • Modify the add.hibernate.to.dir property in the JumpStart project's data_util.properties file.
  • Run the add-hibernate-to-a-server target of the JumpStart project's data_tuil.xml Ant file.
  • Check Tomcat's common/lib/ now has the Hibernate jars, eg. hibernate-core-3.3.1.GA.jar.


• Add log4j and jndi config.
  • Copy log4j.jar from business/src/test/lib-test/ to Tomcat's common/lib/.
  • Copy log4j.properties from business/src/test/conf-tomcat-remote/ to Tomcat's common/classes/.
  • Copy jndi.properties from business/src/test/conf-tomcat-remote/ to Tomcat's common/classes/.


• Tell Hibernate to drop and create the database tables at restart:
  Caution: DO NOT DO THIS STEP IN A PRODUCTION ENVIRONMENT as all existing data will be lost.
  Include the following system property in the JAVA_OPTS environment variable. The property is explained here: hibernate:
  1. -Dhibernate.hbm2ddl.auto=create-drop
  ...in Windows:
  • set JAVA_OPTS=-Dhibernate.hbm2ddl.auto=create-drop
  ...in tcsh (the default shell in OS X Terminal):
  • setenv JAVA_OPTS '-Dhibernate.hbm2ddl.auto=create-drop'


• Start Tomcat with catalina (as above):

The DataSource is set in ${catalina.base}/conf/openejb.xml. By default it uses the HSQLDB whose files are in ${catalina.base}/data/hsqldb/.

Prepare the build

• In the project's build.properties file, edit the value of these properties:
  • deployment.server.type
  • deployment.persistence.descriptor
  • deployment.web.descriptor
  • integration.test.server.dir.

Either build and run the tests from Ant...

Ant will compile, package and deploy jumpstart.war to the server, wait for it to load, then run the integration test suite which will test through the session beans running in the server.

• Run the Ant target clean-compile-test-package-integrationtest in the project's build.xml file.
• If you get an error about JAVA_HOME, read this. Use a JDK 1.5 tools.jar.

...or build with Ant and run/debug the tests from Eclipse

First, use Ant to compile, package and deploy jumpstart.war to the server and wait for it to load:

• Run the Ant target clean-compile-test-package-preintegrationtest in the project's build.xml file.
• If you get an error about JAVA_HOME, read this. Use a JDK 1.5 tools.jar.

Second, create a User Library over Tomcat:

• In Eclipse, choose Window > Preferences > Java > Build Path > User Libraries (or in OS X, choose Eclipse > Preferences > Java > Build Path > User Libraries), and
• create a new user library called tomcat-client-lib, then
• add Tomcat's webpps/openejb/lib/openejb-client-3.1.jar file to the new user library.

Run the integration test suite from Eclipse:

• Choose Run > Open Run Dialog.... The Run window will appear.
• Right-click on JUnit and choose New.

Set Test Runner to JUnit 4. Set the other variables as shown in the diagram on the left.

• Click on the Classpath tab.

Remove the (default classpath) entry. It will be the project name followed by (default classpath). Remove it. Click on User Entries. Add conf-tomcat-remote from business tests. Choose Advanced... > Add Folders, then from your project choose business/src/test/conf-tomcat-remote/. Add jumpstart.jar from exploded. Choose Advanced... > Add Folders, then from your project choose exploded/jumpstart.ear/jumpstart.jar/. Add JARs from business libs. Choose Add JARs..., open your project, then choose these JARs: Add Tomcat client from user libraries. Choose Advanced... > Add Library > User Library, then select your tomcat-client-lib library. Move conf and jumpstart.jar to the top to avoid any conflicts.

• Click Run.
• Watch the results in the JUnit View panel. In the Console View you might see lots of exceptions but that's normal. The JUnit View will tell you quickly whether the tests succeeded or not.

Of course, since JumpStart is now running in your server, you can visit it with your web browser at http://yourserver:8080/jumpstart.

Problems? Eclipse might not be ready for junit - see Could not create task or type of type: junit.