uDig Support Classes¶

There are a few classes to assist writing uDig tests.

In org.locationtech.udig.ui.tests:

• UDIGTestUtil - Provides methods for:
  • Creating Features
  • Creating GeoResources
  • Creating Services
  • Waiting for UI events to complete

In org.locationtech.udig.project.tests:

• MapTests - Provides methods for creating maps
• AbstractProjectTest - Super class for test cases. Attempts to clean up after running by clearing the project registry, maps, and projects

In org.locationtech.udig.project.ui.tests:

• AbstractProjectUITest - Extends AbstractProjectTest and tries to close mapeditors in addition to what AbstractProjectTest does..

Naming Conventions¶

The naming convention for plugins is [namespace].[major subsystem].[minor subsystem]. Examples include:

the feature.xml file

org.locationtech.udig.catalog
org.locationtech.udig.catalog.wfs

org.locationtech.udig.project
net.refractoins.udig.project.ui

the feature.xml file

The naming convention for test plugins is [namespace].[major subsystem].tests.[minor subsystem]. Examples include:

org.locationtech.udig.catalog.tests
org.locationtech.udig.catalog.tests.wfs

org.locationtech.udig.project.tests
net.refractoins.udig.project.tests.ui

Running Tests in the IDE¶

After creating a test case in your new test plugin, right click on the class while in the Java perspective, and the context menu should contain a menu item entitled Run As ‣ JUnit Plug-in Test. This will start an eclipse runtime environment and run your test class.

Running Automated Tests¶

In order to have your test plugin run with the rest of the automated test plugins, the following steps must be taken:

1. Create a test suite
2. Create a test.xml from the template
3. Add your test plugin to the org.locationtech.udig.test feature
4. Add your test plugin to the automated test set

Creating a Test Suite¶

A test suite is a java class which extends junit.framework.TestSuite. Each test class you write must be added to the test suite. The following is an example of a test suite which contains three test classes.

public class CatalogUITestSuite extends TestSuite {

    /** Returns the suite. This is required to use the JUnit Launcher. */
    public static Test suite() {
        return new CatalogUITestSuite();
    }

    public CatalogUITestSuite() {
        addTest(new TestSuite(HeadlessWizardDialogTest.class));
        addTest(new TestSuite(BasicDataPipelineTest.class));
        addTest(new TestSuite(BasicDataPipelineDialogTest.class));
    }

}

public static Test suite();

Creating the test.xml Script.¶

The test.xml file is an ant build script which runs your unit tests. The following is a template test.xml of such a script. Located near the top of the file are three properties which must be modified to reflect your particular test plugin. The properties include:

1. plugin-name - This is name of your test plugin. For simplicity, keep it the same as the id of your plugin.
2. testClass - This is the fully qualified class name of your test suite.
3. testTarget - This is the name of ant target which will be used to run your tests.

Adding the Plugin to the org.locationtech.udig.test Feature¶

The easiest way to add a plugin to a particular feature is using the eclipse feature editor.

1. Navigate to the org.locationtech.udig.test feature while in the Java Perspective

   

2. Open the feature.xml file with the eclipse editor and select the Plug-ins tab

   

3. Click the Add button and select the test plugin from the pop-up dialog.

   

4. Click OK and save the feature.xml file

Adding the Plugin to the Automated Test Set¶

To add the plugin to the automated test set, you must check out http://svn.geotools.org/udig/trunk/scripts. This directory contains two files that must be modified.

1. test.properties
2. test.xml (different from the one above)

org.eclipse.test=org.eclipse.test_3.1.0
org.locationtech.udig.catalog.tests=org.locationtech.udig.catalog.tests_1.0.0
org.locationtech.udig.catalog.tests.wfs=org.locationtech.udig.catalog.tests.wfs_1.0.0
org.locationtech.udig.project.tests=org.locationtech.udig.project.tests_1.0.0
org.locationtech.udig.project.tests.ui=org.locationtech.udig.project.tests.ui_1.0.0

org.locationtech.udig.catalog.tests.ui=org.locationtech.udig.catalog.tests.ui_1.0.0

<target name="all">
  <antcall target="catalog" />
  <antcall target="catalog.wfs" />
  <antcall target="project" />
  <antcall target="project.ui" />
</target>

<antcall target="catalog.ui" />

<target name="catalog.ui">
   <antcall target="runtests">
     <param name="testPlugin" value="${org.locationtech.udig.catalog.tests.ui}"/>
     <param name="report" value="org.locationtech.udig.catalog.tests.ui"/>
   </antcall>
</target>