SMILA/Documentation/HowTo/Howto set up dev environment

This HowTo describes the necessary steps for setting up a SMILA development environment.

Preconditions

Here is the list of things that you will definitely need for developing SMILA components:

1. JDK 1.6
2. Recent Eclipse SDK - This HowTo was tested with Eclipse Classic SDK 3.7.1 (Indigo SR1)
   

Getting the source code

There is more than one way of getting the code into your Eclipse workspace. In the next two sections, two recommended ways are shown. After having imported the source code into your workspace, it will show up a lot of errors. Don't worry, they'll disappear when you run through all steps of this HowTo.

Both methods descibed below will lead you to the same result: They will provide you with a workspace containing all core SMILA projects (plus SMILA.releng when you choose the Project Set File).

Getting the source code manually

Getting the source code manually without the Project Set File is the recommended practice, especially when you wish to update frequently.

1. Use your favorite SVN client to check out SMILA's source code from the repository located at:
   http://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/core
   Hint: We recommend to check out the trunk/core as opposed to importing the projects through IDE SVN integrations. By doing so, you can easily get new projects just by updating your working copy and reimporting the sources.
2. After having checked out the source code, import it into your workspace:
   • Click File --> Import --> General --> Existing Projects into Workspace --> Next
   • Select the root folder of the local trunk --> (all projects should be selected automatically) --> Finish

Using the Project Set File to get the source code

If you do not want to check out the source files manually, you can use the provided Project Set File (.psf) to check out and import all projects automatically.

1. Install Subversive Team Provider and Subversive SVN JDT Ignore Extensions from the Eclipse software repository.
   
2. Restart Eclipse.
3. Select Windows > Preferences > SVN. This should open the Subversive Connector Discovery window.
4. Select the Subversive SVN Connector that you wish to use. We suggest to take the latest SVN Kit that is offered. At the time of writing it was SVN Kit 1.3.5.
5. Restart Eclipse.
6. Download the file SMILA-core.psf.
7. Select File --> Import --> Team --> Team Project Set --> Next.
8. Click Browse and navigate to the .psf file.
9. Click Finish.
   Now your IDE starts to download and import the SMILA projects. This will take quite a while.

Hint: When you want to reimport the .psf file (e.g. because there are new projects available in the SMILA core repository), you have to update the .psf file in the SMILA.releng project and import it (right click on it and click on "Import Project Set...", be sure to click "No To All" to the question whether to overwrite existing projects in the workspace, otherwise it will check out everything again instead of ignoring the projects, that are already checked out.

Enabling the BPEL Designer

If you want to work with the SMILA extensions for Eclipse BPEL designer, you need to check out the bundles from trunk/tooling. Currently, the required bundles are:

• org.eclipse.smila.processing.designer.model
• org.eclipse.smila.processing.designer.ui</tt>

To compile them you need additional bundles from the Eclipse BPEL Designer in your target platform. See SMILA/BPEL Designer for more information.

Defining the target platform

The target platform defines the set of bundles and features that you are developing against.

Defining the target platform the easy way

SMILA ships a target definition file at http://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/releng/devenv/SMILA-indigo-SR1.target that you can open in your IDE (after downloading it and importing the releng project; if you downloaded the source code using the Project Set File you will already have the SMILA.releng project containing the target definition in your workspace).

This file contains all the references needed for developing SMILA with Eclipse Indigo SR1 (3.7.1). After opening it, eclipse starts to download the referenced bundles/features which it tells you by stating "resolving target platform" in the status bar. This takes a good while. After it is done you can hit the link "Set as Target Platform" on the top left of the editor. Doing so will cause eclipse to start re-compiling the sources and all error markers should be gone.

Defining the target platform manually

Instead of using the target definition file you can also manually set your own target platform.

Launch SMILA in Eclipse IDE

If you've checked out SMILA's trunk correctly, than you should have a project called SMILA.launch in your workspace. This project contains the SMILA's launch configuration for Eclipse IDE. To start SMILA directly in your Eclipse IDE just follow the steps below:

• Click Debug --> Debug Configurations and expand OSGI Framework
• Select SMILA launch file
• Check if no junit 4 bundles are activated:
  • enter junit in the filter of the Bundles
  • uncheck all junit 4 bundles, if they are checked (e.g. org.junit4, org.junit(4.8.2....) etc.) since they conflict with the junit 3 bundles used in SMILA.
• press Debug

• If everything is started correctly, you will get an output in the Console view like below:

osgi> Persistence bundle starting...
ProviderTracker: New service detected...
ProviderTracker: Added service org.eclipse.persistence.jpa.osgi.PersistenceProviderOSGi
Persistence bundle started.
[INFO ] Context /zookeeper: Registered handler(1) ZooKeeperAdminHandler, pattern /(.*)$
[INFO ] Added worker webFetcher to WorkerManager.
 
...
 
[INFO ] HTTP server has SMILA handler RequestDispatcher for context /smila.
[INFO ] HTTP server started successfully on port 8080.

You're done

Congratulations! You've just successfully checked out and configured your SMILA development environment and can now start developing your own bundles.