ORUnit 1.0

Introduction

Where To Find

Contents

LICENSE.html

The IBM Public License Version 1.0, under which ORUnit is distributed.

README.html

this file

ORUnitFramework.exp

an OpenROAD export file containing the OpenROAD application implementing the ORUnit framework

ORUnitGUI.exp

an OpenROAD export file containing the OpenROAD application implementing the Gui for running tests

ORUnitUtil.exp

an OpenROAD export file containing an OpenROAD application with some utility classes for the framework

ORUnitSamples.exp

an OpenROAD export file containing an OpenROAD application with the unit tests for the ORUnit framework itself, and some sample tests.

Installation

1. Unzip the ORUnit-1.0.zip file into an empty directory.
2. Import the four OpenROAD applications into a database:

w4gldev backupapp in <your-database> ORUnitFramework ORUnitFramework.exp
w4gldev backupapp in <your-database> ORUnitUtil ORUnitUtil.exp
w4gldev backupapp in <your-database> ORUnitGUI ORUnitGUI.exp
w4gldev backupapp in <your-database> ORUnitSamples ORUnitSamples.exp

3. Test the installation by running the sample tests:

w4gldev rundbapp <your-database> ORUnitSamples -cli -/appflags AllTests

If the progress-bar remains green to the very end the installation was successful.

Getting started

• create a separate OpenROAD application to contain your unit tests.
• Make this application include ORUnitFramework, ORUnitGUI and ORUnitUtil, and of course the application containing the components to wish to unit test.
• Then create a User Class as a subclass of TestCase.
• Declare and write one or more public methods with names starting with "test", and a smallint return value.
• Write code to exercise the unit you want to test and use one or more of the several assert methods, available in TestCase, to check the results and to generate a failure when those do not conform to expectations. The assert methods return TRUE if everything is OK, and FALSE if not, in addition to generating a failure. You can also use fail to unconditionally generate a failure. Have your test method return TRUE. Else ORUnit will generate an error instead of success or failure.
• Write a 4GL-procedure to start the GUI testrunner from within the same application that contains your testclasses.You can copy the procedure li in ORUnitSamples and adapt it to your liking.
• Start this 4GL-procedure. Enter the name of your testclass in the entryfield of the frame that should appear and press Run. That should be about it.
• If you prefer, you can of course compile the ORUnit applications into images for easier deployment.

Status of this release

Differences include:

1. Only a GUI interface is implemented, no text interface.
2. Most methods in JUnit have no return values and rely on exceptions to end the method and indicate an error condition to its caller. OpenROAD has no exception, and therefore I have made many methods to return FALSE to indicate error conditions to its caller. Success is indicated by a return value of TRUE. This conventions also applies to testmethods that you write. For instance, when a failure occurs in one of your testmethods, the method is not automatically exited. You should code this yourself after checking the return value of the assert-method.
3. There are some more variations of assert. This is because in OpenROAD, conditional expressions have no boolean datatype, so you can't pass a conditional expression as a parameter to let assert determine whether it evaluates to TRUE or FALSE. Also, in OpenROAD, parameters are named, so you must know the parameter names in order to use them. Look in the source code of ORUnitFramework!Test.
4. The extension framework is not implemented.
5. In the test browser, the tests in the table field do not indicate success or failure.
6. In ORUnit, you don't have to write a suite-method in your testclass to have ORUnit collect all the "test"-methods into a TestSuite. The implementation in the superclass TestCase already does this for you.

To do

1. Implement a nowindows interface, suitable to run from a makefile or script.
2. Write an OpenROAD 4.x version of the GUI.
3. Implement the extension framework.
4. Follow the ongoing development of JUnit. As of the time of writing, JUnit is at version 3.5.
5. Write some documentation.

Have fun!