Building and Installing a WO Framework with Ant

Version 30.1 by David Avendasora on 2011/04/25 17:37

Building

Warning

Requires WebObjects

These build instructions require the WebObjects frameworks to already be installed in the normal location:

  • Mac OS X: {{/System/Library/Framworks/}}
  • Linux: {{/Library/Frameworks}}

Otherwise you will get compiler errors like this:
{noformat}
[wocompile] /Wonder/WonderGit/WonderSource/Frameworks/Core/JavaWOExtensions/Sources/com/webobjects/woextensions/JSAlertPanel.java:10:
     package com.webobjects.appserver does not exist
[wocompile] import com.webobjects.appserver.WOContext;
{noformat}

Command Line / Terminal

  • h5. Standard WebObjects Framework
    You can build a standard WebObjects Framework project by calling Ant and passing it the Project directory, and the name of the build target contained in the build.xml file at your project's root.

cd /my/project/
ant build

By default, the built framework will be put in a dist directory in your project's root.

  • h5. Project Wonder Frameworks
    If you are building Project Wonder's frameworks you will use these commands instead:

cd /path/to/Wonder
ant frameworks

By default, all the Wonder frameworks will be built to (/Roots) directory in your home directory.

Eclipse/WOLips

Hudson/Jenkins

In general, it is recommended that you use Hudson/Jenkins to build your WebObjects frameworks and applications, but it is not required. You can build either from the Terminal as outlined below, or from within Eclipse directly.

Success

Pro Tip

If you use Hudson/Jenkins to build your WebObjects applications, then you do not need to actually build or install the Project Wonder frameworks on your development machine, just having the individual Wonder source code projects open in your eclipse workspace is sufficient. Your Hudson/Jenkins server will need the built frameworks installed. See the [Hudson/Jenkins Page|WO:Installing and Using the Hudson build server] for more information.

Installing

Assuming you already cloned and installed Wonder from source using the method outlined above, you can use the following procedure pull the latest changes into your local repository.

Install the frameworks
sudo ant frameworks.install

This copies the built frameworks from /Roots to the runtime Frameworks directory:

  • Mac OS X: /Library/Framworks/
  • Linux: /Local/Library/Frameworks

You can combine the build and install steps by simply executing this Ant command:

sudo ant frameworks frameworks.install

Upgrading

This will clean out the existing versions of the frameworks. This isn't strictly necessary, you could just re-install over the top of the old frameworks, but deleting then manually copying over the new ones will clean up any old frameworks that are no longer included in the standard build.

  1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
cd /path/to/WonderSource
  1. h5. Pull the changes you do not have and merge them with your local repository
git pull
  1. h5. Build the frameworks.
ant frameworks
  1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
cd ~/Roots/
  1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done