EasyBeans Test Suite's Guide

First, all the requirements used in Developer's Guide building chapter need to be checked.

The build.xml file which is at the root of the tests folder will be used.

In the tests folder of the project (named EasyBeans by default), the command ant install needs to be launched.

	Note
	The command ant -p could be used to list the targets that are available.

Once the command has been run successfully, output and tests/output folders are created and each one contains a subfolder classes. The output/classes contains the EasyBeans Server classes and the tests/output/classes contains the classes used by the test suite. Furthermore, the binaries(.jar) used with EasyBeans Server are installed in the ejb3s folder.

ant clean.classes is used to clean the generated classes.

First, all the requirements used in building chapter need to be checked.

In the tests folder of the project (named EasyBeans by default), the following three commands need to be used:

This example only requires Java 5 knowledges.

This example tests if a business method can be invoked from a bean, and if the bean can return an Integer value without modifications.

The source code(TestExample.java) can be found in the tests/examples folder of the project (named EasyBeans by default):

package org.objectweb.easybeans.tests.examples;

import static org.objectweb.easybeans.tests.common.helper.EJBHelper.getBeanRemoteInstance;
import static org.testng.Assert.assertEquals;

import org.objectweb.easybeans.tests.common.ejbs.base.ItfExample;
import org.objectweb.easybeans.tests.common.ejbs.stateless.containermanaged.SLSBExample;
import org.testng.annotations.Configuration;
import org.testng.annotations.Test;

/**
 * This is an example of a EasyBeans Test Suite Class.
 * @reference It is used to specify the document that the tests cover. Example:
 *            JSR220-PROPOSED FINAL
 * @requirement It is used to specify the classes and files needed to run the
 *              tests. Exampe: EasyBeans must be running and the bean
 *              org.objectweb.easybeans.tests.common.ejbs.stateless.containermanaged.SFSBExample
 *              must be deployed.
 * @setup It is used to specify the classes and files needed to run the test.
 * @author Eduardo Studzinski Estima de Castro
 * @author Gisele Pinheiro Souza
 */
public class TestExample {

    /**
     * Constant.
     */
    private static final Integer INPUT = new Integer(1);

    /**
     * Bean used in tests.
     */
    private ItfExample<Integer> bean;

    /**
     * Gets a new bean instance used during the tests.
     * @throws Exception if an error occurs during the setup.
     */
    @Configuration(beforeTestMethod = true)
    public void setup() throws Exception {
        // Gets a bean instance.
        bean = getBeanRemoteInstance(SLSBExample.class, ItfExample.class);
    }

    /**
     * Indicates the test description. Example: Tests if the bean can return a
     * value without modifications.
     * @input It is used to specify the classes and files needed to run the
     *        test. Example: Integer value.
     * @output It is used to specify the classes and files needed to run the
     *         test. Example: The same input integer.
     * @throws Exception if an error occurs during the test.
     */
    @Test
    public void test00() throws Exception {
        // Output value, it must be the same as the input.
        Integer output = bean.getValue(INPUT);

        // Test if input and output are equal.
        assertEquals(INPUT, output, "The input and output values should be equal.");
    }
}

There are two mainly annotations in TestNG: @Configuration and @Test.

    /**
     * Gets a new bean instance used during the tests.
     * @throws Exception if an error occurs during the setup.
     */
    @Configuration(beforeTestMethod = true)
    public void setup() throws Exception {
        // Gets a bean instance.
        bean = getBeanRemoteInstance(SLSBExample.class, ItfExample.class);
    }

    @Test
    public void test00() throws Exception {
         ...
    }

    @Test(enabled = false)
    public void test00() throws Exception {
         ...
    }

To make easier the test development, some helper classes are available in the package org.objectweb.easybeans.tests.common.helper

In the example, the EJBHelper class is used to get a bean instance:

bean = getBeanRemoteInstance(SLSBExample.class, ItfExample.class);

The method getBeanRemoteInstance() is used to a remote access of a bean and the method getBeanLocalInstance() is used to a local access of a bean. They need two parameters:

Once the test class is defined, it is necessary to write the XML configuration file for TestNG. The following example indicates that the tests inside the package org.objectweb.easybeans.tests.examples must be run:

<!DOCTYPE suite SYSTEM "http://beust.com/testng/testng-1.0.dtd">
<suite name="Test Suite Example" verbose="1">
  <test name="Test Example">
    <packages>
      <package name="org.objectweb.easybeans.tests.examples"/>
   </packages>
 </test>
</suite>

The TestNG XML configuration file also supports the classes/class tags that define which classes must be run. This following example indicates that only the tests in the TestExample class must be run:

<!DOCTYPE suite SYSTEM "http://beust.com/testng/testng-1.0.dtd">
<suite name="Test Suite Example" verbose="1">
  <test name="Test Example">
    <classes>
      <class name="org.objectweb.easybeans.tests.examples.TestExample"/>
   </classes>
 </test>
</suite>

Additional information about TestNG could be found in www.testng.org.

The test classes respect a comment convention that has some custom tags. The custom tags are:

The Test Suite and the EasyBeans has the same code convention. You can see the convention details in EasyBeans code convention.

The first thing needed is defining where the test classes should be in. After that, the TestNG XML file must be created to run the tests. Each package has a XML file to run all package tests. In addition, an entry for each test package is needed in the file src/main/java/testng_conformance.xml.

In the tests/examples folder of the project (named EasyBeans by default), there is a TestNG XML file example called testng_xml:

<!DOCTYPE suite SYSTEM "http://beust.com/testng/testng-1.0.dtd">
<suite name="Test Suite Example" verbose="1">
  <test name="Test Example">
    <packages>
      <package name="org.ow2.easybeans.tests.examples"/>
   </packages>
 </test>
</suite>

The submmition has the same rule that the EasyBeans contributions. You can see details in EasyBeans contribution.