SMILA/Documentation/HowTo/Howto set up dev environment
This HowTo describes the necessary steps for setting up a SMILA development environment.
- 1 Preconditions
- 2 Getting the source code
- 3 Defining the target platform
- 4 Checkstyle configuration
- 5 Launching SMILA in Eclipse IDE
- 6 You're done
Here is the list of things that you will definitely need for developing SMILA components:
- JDK 1.7
- Recent Eclipse SDK - This HowTo was tested with Eclipse Classic SDK 4.2 (Juno Release)
- Delta Pack - for some parts of the setup you are advised to add a "Delta Pack" to an Eclipse SDK installation. You can download it from the same page.
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 described 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.
- Choose one:
- Download the complete source code from the release download page or the nightly build downloads and unpack complete the archive into your workspace.
- 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. If you later want to be able to build a SMILA distribution including your own extensions, all SMILA projects should be located immediately in your workspace directory.
- 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.
- Import all SMILA project into your workspace:
- Click File --> Import --> General --> Existing Projects into Workspace --> Next.
- Select the folder that contains all SMILA projects --> (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.
- Install Subversive Team Provider and Subversive SVN JDT Ignore Extensions from the Eclipse software repository.
- Restart Eclipse.
- Select Windows > Preferences > SVN. This should open the Subversive Connector Discovery window.
- 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.
- Restart Eclipse.
- Download the file SMILA-core.psf.
- Select File --> Import --> Team --> Team Project Set --> Next.
- Click Browse and navigate to the .psf file.
- 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:
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 that you can open in your IDE to configure the target platform automatically. This file contains all the references needed for developing SMILA with Eclipse Juno (Release 4.2):
- If the SMILA.releng project is not already contained in your workspace (e.g. because you have chosen the manual way to check out and import the source files), check out http://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/releng with your preferred SVN client and import the project into your workspace.
- Open the file SMILA.releng/devenv/SMILA.target with the Target Definition editor.
Eclipse starts downloading the referenced bundles/features which it tells you by stating "Resolving Target Definition" in its status bar. Be patient, this will take quite a while. After it has finished, you can click the link "Set as Target Platform" on the top right of the Target Definition editor. Doing so will cause Eclipse to start re-compiling the sources and all error markers should be gone when finished.
Defining the target platform manually
Instead of using the target definition file you can also manually set your own target platform.
If you have the Eclipse Checkstyle plugin installed, you will get a lot of error messages complaining about missing check configurations when Eclipse builds the workspace.
Errors running builder 'Checkstyle Builder' on project 'org.eclipse.smila.utils'. Fileset from project "org.eclipse.smila.utils" has no valid check configuration. ...
You can solve this by importing them:
- Open Window -> Preferences and go to Checkstyle.
- Click New..., enter SMILA Checkstyle as the name, click Import..., and select SMILA.builder/checkstyle/smila_checkstyle-5.xml from your workspace. Click OK.
- Click New... again, enter SMILA Test Checkstyle as the name, click Import..., and select SMILA.builder/checkstyle/smila-test_checkstyle-5.xml from your workspace. Click OK.
- Select SMILA Checkstyle and click Set as Default.
- Click OK.
Now you should not get those error messages again.
Launching SMILA in Eclipse IDE
If you've checked out SMILA's trunk correctly, 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 Run--> Debug Configurations and expand OSGI Framework.
- Select the SMILA launch file.
- Click Debug.
If everything works fine, you will get an output in the Console view similar to the following:
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.
Congratulations! You've just successfully checked out and configured your SMILA development environment and you can now start developing your own bundles.