Kauri source code

Getting the source

To get the source you have a few different options

  • Get the source from the subversion repository: (see also the community page)
    svn checkout http://kauriproject.org/svn/trunk kauri-trunk
  • Download the source code of a public release from Sourceforge

Building the source

Install the basics:

  • Sun Java 5 (1.5) or above. Define an environment variable JAVA_HOME pointing to your Java installation. Check everything is fine using:
    Unix
$JAVA_HOME/bin/java -version

Windows
%JAVA_HOME%\bin\java -version
  • Maven 2.0.x

It is a known problem that Kauri does not build on Java 1.6.0_03, due to problems with this Java version which are fixed in later versions.

Then execute:

mvn install

To speed up the build, you can skip the testcases by using the fast profile: 

mvn -P fast install

Running Kauri build from source

After building the source, you have two options for running Kauri:

  1. Build a binary distribution and run it the same as any downloaded binary Kauri distribution.
  2. More likely, run Kauri directly. Kauri will load its jars from your local Maven repository, allowing fast build-test cycles when developing on Kauri itself.

Here is an example of how to run Kauri directly after building, using the template sample application:

cd samples
cd kauri-template-sample

[Windows]
..\..\kauri

[Unix]
../../kauri.sh

In this case, not only Kauri will be loaded from the local Maven repository, but the application modules (in this case the template sample module) and its dependencies will also be loaded from the local Maven repository.

Using the archetypes

For your convenience, here are the commands to generate projects using the archetypes (adjust version numbers as appropriate):

mvn archetype:generate -DarchetypeGroupId=org.kauriproject -DarchetypeArtifactId=kauri-archetype-basic -DarchetypeVersion=0.3-dev-SNAPSHOT

mvn archetype:generate -DarchetypeGroupId=org.kauriproject -DarchetypeArtifactId=kauri-archetype-prototyping -DarchetypeVersion=0.3-dev-SNAPSHOT

Test hints

When running tests based on AbstractRuntimeTest, all warning-and-up log messages are logged to the console. If you want to see more logging output when running a testcase, you can easily enable this by passing some system properties, for example:

mvn install -Dconsole-logging=debug -Dconsole-log-category=org.kauriproject.i18n

The property console-logging sets the log level.

The property console-log-category sets the log category for which to enable this level of logging. It is optional to specify this property, if not specified, the log level will apply to the root log category.

Comments (0)