JOnAS Test Suite

Table of contents

• Aim of the suite
• Getting the suite from CVS repository
• Description of the source tree
• Building the suite
• Running the suite
• Naming conventions
• How to contribute ?
• Current conformance test results

Aim of the suite

The aim of this suite is to provide tests that verify that JOnAS conforms to the EJB specifications. This suite is used to identify regressions in contributions made in the JOnAS code. This suite is far from complete and will be expanded in the future. Anyone is welcome to write or add new test cases to this suite according to the guidelines explained below.

Note that this test suite has been done to test JOnAS, and its use to test other application servers is not straightforward.

Getting the suite from CVS repository

Anyone can checkout source code from our anonymous CVS server. To do so, simply use the following commands (if you are using a GUI CVS client, configure it appropriatly):

  cvs -d :pserver:anonymous@cvs.objectweb.org:/cvs/Jonas login
  cvs -d :pserver:anonymous@cvs.objectweb.org:/cvs/Jonas co jonas_tests
    

When prompted for a password for anonymous, simply press the Enter key.

Description of the source tree

Under jonas_tests you will find two different test suites :

conformance and stress are made of the following files and directories:

The source code is organized according to the package name. So, for the conformance test suite, the source is located in src/org/objectweb/jonas/jtests :

Building the suite

Using ant

This test has been designed to be compiled and run using Ant.
Ant must be installed (with the optional tasks package) and the environment variables %ANT_HOME% or $ANT_HOME must be set.
$ANT_HOME/bin must have been added to the PATH environment variable.
The xalan product must be installed, and the xalan.jar must be present in $ANT_HOME/lib. (xalan is necessary for the JUnitReport ant task).

The JUnit product must also be installed and the junit.jar must be present in $ANT_HOME/lib.
For xalan and JUnit, you may also choose to update the file $JONAS_ROOT/bin/unix/config_env (on Unix) or %JONAS_ROOT%\bin\nt\config_env.bat (on Windows) by adding the path to xalan.jar and junit.jar in the predefined classpath used by JOnAS which is defined in this file.

The main ant targets are the following :

To build the jonas tests :

1. Customize jonas-tests/build.properties according to your environment.

2. Go to the jonas-tests/ directory and type
   ant install

Running the suite

Using Ant

You can launch the complete JOnAS test suite via ant and obtain a test suite report.

You should use the CLASSPATH environment variable or modify the predefined classpath used by JOnAS in the $JONAS_ROOT/bin/unix/config_env (on Unix) or %JONAS_ROOT%\bin\nt\config_env.bat (on Windows) file, by adding the path to jonas_tests/conformance/classes/$OBJECTWEB_ORB.

1. Update the jonas.properties file according to your environment.
   Actually, the JOnAS suite needs only one datasource with jdbc_1 as datasource.name.
   The jms service must be set in jonas.services property.
2. Run the JOnAS Server with name "EJB" : jonas start -n EJB
3. Once it is running you can launch the complete JOnAS test suite via the runtest ant target.
4. A test suite report is generated under jonas_tests/conformance/reports/html.

Using JDBC Resource Adapter

To execute the JDBC Resouce Adapter tests, two datasources jdbc_xa1 and jdbc_xa2 are required.

1. Update the jonas.properties file according to your environment.
   Replace the dbm service with resource in jonas.services property.
2. There are four JDBC Resource Adapters available:
   Data Manager
   Data Service
   Connection Pool
   XA Support
3. Configure the deployment descriptors to access the JDBC driver.
4. Reference the JOnAS documentation for configuration details.

Using scripts

It may be interesting to launch only one of the suites or only one testcase of a test suite, particularly to debug a testcase that fails.

To do this a script jonas_tests/conformance/junit.sh can be run. Depending on the number of arguments, you will run:

1. all the junit tests
2. all suite in a client directory
3. 1 named suite in a directory
4. 1 testcase in 1 particular suite in a directory

Example:

sh junit.sh security
sh junit.sh entity F_BasicHomeInterfaceEB testFinderEnumObjNotFound
    

Naming conventions

In order to have a homogeneous suite we have defined strict naming conventions that should be followed. This makes it easier to understand a test suite.

The coding conventions are related to :

• file names for the suite classes
• interfaces, beans, deployment descriptor, ejb-jar names
• ejb-name, jndi names, table names in DB, field names
• etc.

Rules for bean names in the tests

XX must be one of the following values :

Note : that these rules are inforced when using the Newbean tool.

Rules for files names for the client suites

Each directory in src/org/objectweb/jonas/jtests/clients holds a set of test suites relative to a common topic (entity, session, transaction, etc...). To improve the readability of these files and to know which suite can be run with which testcase, we have enforced the following naming conventions :

How to contribute?

Coding conventions

Coding conventions are the same for jonas or for jonas_tests. They must follow Code Conventions for the JavaTM Programming Language

Methodology for writing new tests

• Each testcase must be independent of the others. It is possible to run each testcase more than once without problems. This implies that everything is clean after the test, for example, a testcase creating an instance should remove it before returning.
• Beans and clients are in different packages. All beans should be under beans directory, all clients (tests) should be in clients directory. A useBean() method must be used in the client to ask the EJBServer to load a bean, if it is not already loaded.
• When loading entity beans the first time in the server, tables in database are dropped and created. This is to avoid problems due to previous run of tests. This is done by setting a boolean in useBean.
• Each testcase name must begin by the String test. Inside the tests method, there is no need to try/catch unexpected exceptions. Only catch exceptions that are expected.

Creating a new suite

• You must first decide which directory your Suite should be in. A limited number of directories has been defined in clients. See Structure of source code. You should not need to add new directories since all needed directories have already been defined.
• An example of Suites can be found in src/org/objectweb/jonas/jtests/templates
• Examples of more sophisticated suites can be found in src/org/objectweb/jonas/jtests/clients/entity

Adding test cases to an existing suite

Adding a new test case is pretty straightforward. Have a look at the tests already written then mimic them. In most cases you will not have to catch exceptions. So the tests look very simple. You can refer to the junit primer for more details.

Submitting a contribution to jonas team

Follow the same rules as for contributing to jonas.

Current conformance test results

ORB/Operating System/DataSource/JDK version/JOnAS build

e.g. RMI / Solaris / Oracle / JDK1.3/JOnAS-Tomcat