leJOSUnit 1.0.2

Overview

October 1 2003

leJOSUnit is a simple test unit framework for leJOS, a Java Operating System for LEGO (TM) Mindstorms. It is a port of the famous JUnit framework, a testing framework for Java, developed by Kent Beck and Erich Gamma. leJOSUnit has been adopted to the specific requirements (few resources, less footprint) of the leJOS environment.

Download

Download the latest version from leJOSUnit here. For prerequisites see docs/ImplementationDetails.html.

Contributions

leJOSUnit has been originally developed by Jochen Hiller (jochen.hiller@t-online.de) and will be hosted at SourceForge (http://sourceforge.net/projects/lejosunit).

Thanks for Erich Gamma and Kent Beck to the wonderful idea and implementation of JUnit.
Thanks to Chris Collins (ccollins@rolemodelsoft.com), for writing J2MEUnit, which inspirated me to do the same for leJOS. Included ideas and excerpts of the code from J2MEUnit. For further information see http://j2meunit.sourceforge.net.

History
Contents of the release
Installation
Getting Started
Documentation

History

Version 1.0.2 (2003-10-01)

Minor optimizations of less footprint

Version 1.0.1 (2003-09-23)

Fixed distribution, as this is missing the jar files.
Changed TestRunner to check, whether running in Emulator or at RCX. This eliminates needs to change the code.
Added more tests. Identified a bug of JavaVM. See test/java/lang/Bug1.java.
Moved util methods from TestRunner to Util, due to overflow of constants.

Version 1.0 (2003-09-05)

Initial version released to SourceForge and leJOS mailing list.
The leJOSUnit version 1.0 is based and has been tested with leJOS version 2.0 and 2.1.

Contents of the Release

`index.html`	this file
`build.bat, build.sh, build.xml`	Scripts and ant-based build file, to build the leJOSUnit project from the scratch.
`bin/run_examples.bat, bin/run_main.bat`	Scripts to compile and run main programs, e.g. a simple example.
`docs/*`	Additional documentation, implementation details, images, etc.
`docs/api`	The generated JavaDocs (docs/api).
`docs/licenses`	The licenses of the projects used.
`lib/lejosunit-1.0.2.jar`	The library containing only the core framework. This should be the default library to be included, due to the very restricted resources of leJOS.
`lib/lejosunit-1.0.2-complete.jar`	The library containing the core framework, all examples and tests.
`src/java`	The Java source code for leJOSUnit.

Installation

Below are the installation steps for installing leJOSUnit:

Unzip the lejosunit-1.0.2.zip file
Add lib/lejosunit-1.0.2.jar to the CLASSPATH of your leJOS project.
Write your test classes, provide a main(String[]) method starting the lejosunit.rcxui.TestRunner.

Getting Started

To get started with unit testing make familiar yourself using the JUnit framework. See JUnit for more information.

leJOSUnit provides some simple examples as a demonstration how to use the framework based on the leJOS virtual machine running on LEGO Mindstorms. See the examples within the package lejosunit.examples package.

src/java/lejosunit/examples/AllTests.java
src/java/lejosunit/examples/OneTest.java
src/java/lejosunit/examples/TwoTest.java

Notice: This example can the be compiled, linked and downloaded to the RCX, using the script bin/run_examples.bat. Make sure, that LEJOS_HOME and JAVA_HOME are set to the corresponding directories.

The TestRunner provided by leJOSUnit running on RCX provides this functionality:

Figure 1: The RCX user interface

All tests will be executed in RCX.
The TestRunner waits until Run button will be presses. The running man will then be started.
A running test suite can be stopped through the Run button.
Tests can be re-run using the Run button again.
Each test will be displayed at the Text display:
- A successful test will be display with an "." (dot).
- A failed test will be displayed with a "F".
- Any unexpected exception will be displayed with an "E".
At the end, the total elapsed time will be displayed in milliseconds or seconds, dependent on the required time.
After stopping the tests with the Run button, it will be displayed for about 1.5 seconds whether the tests have been sucessful (OK) or not (FAILS).
leJOSUnit provides scrolling using the View (left) and Prgm (right) buttons.

Documentation

leJOSUnit documentation

Created JavaDocs are available. See docs/api/index.html
Implementation details, how leJOSUnit has been ported. Describes also some limitations, footprint etc. See docs/ImplementationDetails.html

External links

JUnit framework. See http://www.junit.org
leJOS - Java virtual machine for LEGO Mindstorms. See http://www.lejos.org
LEGO Mindstorms. See http://mindstorms.lego.com
J2MEUnit framework (gave some inspiration). See http://j2meunit.sourceforge.net

Links to the licenses of the referred open source projects

JUnit software license (CPL 1.0). See docs/licenses/LICENSE.junit.cpl-v10.html
leJOS software license (MPL 1.0). See docs/licenses/LICENSE.leJOS
J2MEUnit software license (RoleModel specific). See docs/licenses/LICENSE.J2MEUnit
leJOSUnit software license (MPL 1.0). Same as used from leJOS. See docs/licenses/LICENSE.leJOSUnit