Contributing to Chrysalis

To contribute to Chrysalis, please contact one of the project administrators on the Project Team. We are using the following development tools to work on Chrysalis. Familiarity with the tools is a prerequisite for working on the project:

  • The JDK
  • Tomcat
  • Ant
  • JUnit
  • Eclipse

To make it easier to get started, we have put together a Java Software Bundle containing all the necessary software.

We are also using Putty for secure communications on Windows (SSH, FTPS, etc.) and CVS as our source code control system.

Building Chrysalis

You can build Chrysalis in your working environment as follows:

  1. Setup Your Source Forge Account
  2. Install Putty
  3. Install the Java Software Bundle (Optional)
  4. Create CVS Location in Eclipse
  5. Check Out the Project in Eclipse
  6. Build the Project With Ant

You must be connected to the Internet for this process to work. Once you have built Chrysalis, you can work on it locally, though you are encouraged to synchronize with the CVS repository on a regular basis.

1. Setup Your Source Forge Account

Go to sourceforge.net and select the "New User" link in the upper left-hand corner. Follow the instructions.

2. Install Putty

If you are a developer, you will only need Putty to enable security for your Source Forge account. After that, Eclipse can handle the rest.

You can get Putty at: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html

Install it, then use Putty.exe to connect to the Chrysalis CVS server:

Field Value
Host Name cvs.chrysalis.sourceforge.net
Port 22
Protocol SSH

Click Open when you are finished.

If this is the first time you have used Putty to connect to SourceForge, Putty will inform you that it does not recognize Source Forge's digital certificate. Click "Yes" to accept it.

Putty will open a SSH window, which will immediately close. This is normal. The Putty connection is only used to establish your user directory on the CVS server.

3. Install the Java Software Bundle

This step is optional. If you do not install the bundle, you will need to install all the separate software packages (the JDK, Ant, Tomcat, etc.) yourself. To install the Java Software Bundle:

http://www.LearningGain.com/java-software-bundle/

We apologize, but for the moment, the software-bundle is set up for Windows only. When we get the time, we will upgrade it to cover Unix-based OS.

4. Create CVS Location in Eclipse

To point Eclipse to the Source Forge CVS repository:

  1. Open the CVS Perspective: Window | Open Perspective | CVS Repository Exploring .
  2. Open the "Add CVS Repository" Wizard by right-clicking in the "CVS Repositories" view and select New | Repository Location .

  3. Enter the following information into the "Add CVS Repository" Wizard:

    Field Value
    Host cvs.chrysalis.sourceforge.net
    Repository Path /cvsroot/chrysalis
    User anonymous
    Password [Blank line]
    Connection Type pserver
    Use Default Port [Select]
    Validate Connection on Finish [Select]

    If you have commit-rights to the Chrysalis CVS repository, use the following settings instead.

    Field Value
    User Your Source Forge User Name
    Password Your Source Forge Password
    Connection Type extssh

    If you given are commit-rights but have already downloaded Chysalis anonymously, you will need to delete the old Chrysalis project and download it again using the "extssh" protocol.

  4. Click Finish .

Once you have finished, you should be able to browse the Chrysalis repository in the "CVS Repositories" view.

5. Check Out the Project in Eclipse

To open the project in Eclipse:

  1. Browse to HEAD | chrysalis .
  2. Right-Click on "chrysalis" and select Check Out As .

  3. You can let Eclipse put the project files in its default location, but if (like me) you prefer to control where the project files go, enter the following into the "Check Out project As" Wizard:

    Field Value
    Project Name chrysalis
    Use default location [Unselect]
    Location Project Directory

    If you are using the Java Software Bundle, your project directory should be a subdirectory of the software bundle.

Warning: Be careful not to select Check Out As Project . If you do, Eclipse will open a "Simple Project" instead of a "Java Project". If you accidentally create a simple project, delete the project (and all of its contents) and start over.

6. Build the Project With Ant

When you first check out the project in Eclipse, it will not build successfully, because you are still missing dependencies like JUnit and the servlet API. You can retrieve the necessary jars by building the project using Ant.

  1. Locate the Ant "build.xml" file in Eclipse. Right-click on the file and select Run Ant ...

  2. Be sure the "auto-help" target is selected and click Run . This will download the necessary jars to your file system.

  3. Right-click the root of the "chrysalis" project and select Refresh to pull the jars into Eclipse.