JT Harness Repository Structure

This document describes the high-level structure of the JT harness source tree.

Repository Structure

The JT harness repository currently has a very flat Mercurial structure to it (vs SVN). The content of this section will be updated as a less flat forest structure evolves.

Working Copy Structure

Use the Mercurial hg(1) command to create a working copy of the javatest/trunk/code directory. For example:

% hg clone http://hg.openjdk.java.net/code-tools/jtharness JTOS

If you omit the last parameter (JTOS), the source will appear in a directory named jtharness/.

Your working copy (in this example, named JTOS) has the following structure:

JTOS/
    build/

    This directory contains the Ant build files and build properties. You must change property values in the local.properties file in order to successfully build the JT harness. For more information, see JT Harness Build Instructions.

     
    doc/

    This directory contains release documentation that is copied to the build distribution directory as part of the build process. The directory also contains class dependency lists required for the various agents.

    When you build the JT harness, the release notes are copied into the build-distribution.
    examples/

    This directory contains the source files required to create the examples in the binary release. The examples can only be built by building the product.
    legal/

    This directory contains the Gnu Public License (2), and copyrights that apply to this open source product.
    src/

    This directory contains all Java programming language source files and various property files that are used to produce the JT harness binary.
    tests/

    Contains source files for tests used to test the product, both during the build and manually.

    Please review the JT Harness Developer's Guide and JT Harness Source Code Description for coding guidelines and descriptions of the various packages included in the JT harness source.

Build Distribution Structure

The build distribution directory is created by the JT harness Ant build, into which it generates the built binary distribution. By default, this directory is named JTHarness-build, and it is created in the same parent directory as the jtos working copy.

The JT harness build output directory has the following structure:

JTHarness-build/
    binaries/

    This directory contains the entire unbundled distribution. It includes the binary and documentation files required to execute the JT harness.

        legal/

        Contains the Gnu Public License (2), and Oracle copyrights that apply to this open source product.
        lib/

        Contains the JT harness binary (javatest.jar)
        doc/

        Contains documentation that accompanies the JT harness product. The release notes from the working copy are copied to this location.

    bundles/

    Contains the jtharness.zip file. This Zip archive contains the entire JT harness distribution including documentation, examples, and sample code (the contents of the binaries directory).
    classes/

    Contains intermediate binaries produced during the build process.
    javadoc/

    A placeholder directory. Contains the output of the Javadoc™ tool when you specify the javadoc Ant target.

Source Repository

JT Harness Repository Structure

Table of Contents

Repository Structure

Working Copy Structure

Build Distribution Structure