Nimal's Weblog

This is the final part of the so called Ant series I have been writing in this blog, about Apache Ant. This is an extremely brief tutorial on JUnit. The goal is to test Ant and JUnit framework integration .

The previous posts on Ant can be found here:

1. Apache Ant
2. Ant: Installation
3. Ant: Hello World in Ant
4. Ant: Java Hello World in Ant
5. Ant: Java Swing Hello World in Ant
   

Prerequisites

In order to do this we will need to have a Java compiler, Ant, and JUnit installed.

Java Classes

First, we need a Java class to test. I had to make this example too simple according to my Java knowledge. This lacks any Java Docs or comments, but it's a pretty simple bit of code.

public class Math {	static public int add(int a, int b) {		return a + b;	}

	static public int multiply ( int a, int b) {		return a * b;	}}

Then to test this code, we need a second Java class that will

1. import junit.framework.*
2. extend TestCase

There are two important points to note in the sample. First, the routine is named testAdd. This convention tells that the routine is supposed to be a test and that it's targeting the add functionality. Here's the matching example.

import junit.framework.*;

public class TestMath extends TestCase { 

  protected void setUp() {   	// put common setup code in here  }

  protected void tearDown() {  	// put common cleanup code in here

  }

  public void testAdd() {  	int num1 = 3;  	int num2 = 2;  	int total = 5;  	int sum = 0;  	sum = Math.add(num1, num2);  	assertEquals(sum, total);  }

  public void testMulitply() {

  	int num1 = 3;   	int num2 = 7;   	int total = 21;  	int sum = 0;  	sum = Math.multiply(num1, num2);  	assertEquals("Problem with multiply", sum, total);

  	num1 = 5;   	num2 = 4;

  	total = 20;  	sum = Math.multiply(num1, num2);  	assertEquals("Problem with multiply", sum, total);  }}

And both these files could be kept in a sub-folder named src

Ant Script

The last step is how to run your JUnit tests using Ant. Create a file called build.xml and place it in the main folder. The core of this scripts is the following, which does the JUnit tests.

<junit printsummary="yes" haltonfailure="yes" showoutput="yes" >	<classpath>		<pathelement path="${build}"/>		<fileset dir="lib">

			<include name="**/*.jar"/>		</fileset>	</classpath> 	<batchtest fork="yes" todir="${reports}/raw/">		<formatter type="xml"/> 		<fileset dir="${src}">

			<include name="**/*Test*.java"/>		</fileset>	</batchtest></junit>

The file I used is this one. (The inner details of this scripts are Ant Scripting and XML, which is not explained in this document, but really straightforward to understand)

Output

Run ant test in command line:

[root@nimal junit-sample]# ant testBuildfile: build.xml

init:

compile:    [javac] Compiling 2 source files to /opt/junit-sample/bin

run-tests:    [junit] Running TestMath

    [junit] Tests run: 2, Failures: 0, Errors: 0, Time elapsed: 0.321 sec

test:[junitreport] Processing /opt/junit-sample/reports/TESTS-TestSuites.xml to /tmp/null1227203872[junitreport] Loading stylesheet jar:file:/usr/local/ant/lib/ant-junit.jar!/org/apache/tools/ant

 /taskdefs/optional/junit/xsl/junit-frames.xsl[junitreport] Transform time: 1714ms[junitreport] Deleting: /tmp/null1227203872

BUILD SUCCESSFULTotal time: 6 seconds

Ant will also do nice things like create nice HTML reports! I've linked to a simple Ant script that will compile all the code in your "src" folder, run all the tests named "test*" and then create an HTML report in your "reports\html" folder.

I've linked to a zip file (ant-junit-sample.zip) that contains the build.xml file, the source code and the test class. (If you try to run it and get errors about JUnit not being found, remember to add that junit.jar to your Ant lib folder.)