Debugging WOLips

Version 100.1 by mark_ritchie on 2009/09/08 19:19

Warning

Under Construction

This page is currently under construction by Mark Ritchie!

Debugging WOLips as the master does!

These instructions is intended for the developer who wants to compile and run WOLips source for the purpose of debugging or other exploration.  Thanks very much to Mike Schrag for the guidance to get this setup and working!

Overview of what's going on

We're going to check out the latest source for WOLips, build it and arrange for Eclipse to launch is a debug mode to test it out.  It's very handy that Eclipse has a built in ability to launch itself in debug mode and load the local versions of the plugins.  If you read the old and out dated instructions floating about that talk about building an entire release and installing them into a new copy of Eclipse then you're going to like this method a whole lot better! ;-)

The setup

When I did this and wrote these notes, I was using:

  • Mac OS X 10.5.7
  • Java 1.5.019
  • Eclipse 3.4.2 (eclipse-SDK-3.4.2-macosx-carbon.tar.gz)

Checking out the source code

A note for the impatient - don't try to checkout the source right into Eclipse.  The files aren't structured in a way that allows this to work.  I know because I tried to do it that way first! ;-)

Check out the source code into a local folder

You're checking out a local copy of the code from the source repository.  Next, we're going to selectively import (but not copy) parts of that code into Eclipse.   I'm using command line subversion to check out the lastest version however feel free to use a different tool or different version, as you like.

svn co https://svn.objectstyle.org/repos/woproject/trunk/woproject /woproject

Note that I've checked out the source code into my home folder.  It doesn't matter where you put the source code as long as you can find it in the steps below.

Create a new eclipse workspace

Launch a clean copy of Eclipse with no plugings installed.  Strictly speaking, probably not necessary however these are the steps which I took.

Create a new Workspace
I chose /WOLipsDebugging
Workspace.png

Import woenvironment

Start off by importing the woenvironment project.  From the File menu, select Import
ImportMenu.png
Click the disclosure triangle for General and select Existing Projects into Workspace
ExistingProject.png
Click Next button.
Ensure that "Select root directory" is selected and click Browse
Browse to the folder where you checked out the woproject source code above and select woenvironment.
woenvironmentCheckout.png
Eclipse should scan the folder and notice one project in the folder called woenvironment.
It's important that you don't have 'Copy the project into your workspace' selected.
woenvironmentProject.png
Click Finish.

Once Eclipse has finished building the project, there should be no errors!  If that's not the case, then you need to back up and make sure that you've followed all the steps above.

Import wolips projects into your workspace

Repeat the steps above and import all the wolips projects except for 3!
EntityModler, eomodeldoc and org.objectstyle.wolips.eomodeler.factories
Are special projects which require special setup and caffination before touching.

The import of wolips should look like this:
wolipsImport.png

And Eclipse should identify a whole bunch of projects.
Make sure that you deselect the 3 special cases noted above
The list of projects should look something like this:
wolipsProjects.png

Click Finish and the projects should all be imported.

Warning

!ResourceErrorMessage.png!

Import wolips plugins

Import 3rd party plugins

Close special projects

  • EntityModeler
  • eomodeldoc
  • org.objectstyle.wolips.eomodeler.factories

Close projects which require additional resources to compile

  • org.objectstyle.wolips.groovy.ui
  • org.objectstyle.wolips.jprofiler.launching

The run configuration setup