.
|-- target                          ; maven output directory of a build
|   |-- classes                     ; java classes compiled from source
|   |-- dist                        ; contain different version of the binary distribution
|   |   `-- gridrus-x.x             ;
|   |       `-- gridrus             ; the directory containing the binary distribution
|   |                               ; (see next section)
|   |-- javagen                     ; temporary directory for dynamically generated classes
|   |-- javagen-nc                  ; temporary directory for dynamically generated sources
|   `-- surefire-reports            ; containing junit test reports
|-- dist
|   |-- client                      ; client binary distribution created by "build-client"
|   |-- server                      ; server binary distribution created by "build-server"
|-- src                             ; source code
|   |-- doc                         ; root of the documentation directory
|-- modules                         ; GridRUS sub-modules
|   |-- service                     ; service sub-module
|   |-- core                        ; core sub-module
|   `-- client                      ; client sub-module
|
|-- build.xml                       ; the main build file
`-- build.properties                ; the build configuration file

$> ant -projecthelp
Buildfile: build.xml

Main targets:

 build-all     build the server, client and documentation
 build-client  build the client
 build-doc     build the documentation
 build-server  build the server
 test          performs tests
 

package mypackage;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;


public class MyClass {

    // the class logger. The name of the logger is the same as the fully-qualified
    // class name
    private static final Log sLog = LogFactory.getLog(MyClass.class);

    public void myMethod(){
        sLog.debug("this is a debug message");
        sLog.info("this is a informational message");
        sLog.warn("this is a warning message");
        sLog.error("this is a warning message");

        try {
            // critical work here...
        } catch (SomeException e){
            sLog.error("we have encountered an error", e);
        }
    }

}
            
Unit Testing
JUnit is a regression testing framework. It is a powerful and simple tool to unit test a piece of functionality or a class against a set of requirement.

Developers are encouraged to write JUnit TestCase for each class they have created, or at least for any well-defined piece of functionality. The gridrus build system will automatically execute all junit.framework.TestCase derived classes that has class name ending with *TestCase.java unless excluded in the build.xml file. A sample test case class looks like the following

package mypackage;

import junit.framework.TestCase;

public class MyClassTestCase extends TestCase {

        public MyClassTestCase(String args){
                super(args);
        }

        public void testMethodAWithNullParameter(){
                MyClass c = new MyClass();
                assertTrue(c.methodA(null));
        }

        public void testMethodAWithStringParameter(){
                MyClass c = new MyClass();
                assertTrue(c.methodA("some string"));
        }

}