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 Launching SMILA in Eclipse IDE
- 5 You're done
- 6 Additional steps
Here is the list of things that you will definitely need for developing SMILA components:
- JDK 1.7 (Java 8 is not yet supported by SMILA).
- Eclipse SDK - This HowTo was tested with Eclipse Classic SDK 4.4.1 (Luna Release)
Getting the source code
There is more than one way of getting the code into your Eclipse workspace. The following sections will describe how to get the source code from the Git repository (recommended!).
Installing Git Provider
(skip this section if Git Team Provider is already installed in your Eclipse IDE - most current Eclipse Packages do contain it)
- Install Eclipse Git Team Provider and Java Implementaton of Git from the Eclipse software repository.
- Restart Eclipse.
Get source code from Git
- Open the "Git" perspective
- Select "Clone a Git repository"
- Enter one of the following URIs for read-only access:
(** Committers: use ssh://git.eclipse.org/gitroot/smila/org.eclipse.smila.core.git for read-write access and enter your credentials below)
- Click "Next". In the following dialog ensure that branch "master" and other branches you need are selected (there are no other branches at the time of writing ;-)
- Enter the desired location of your clone of the Git repository. You can put this into your current workspace, but this is not necessary.
- You can activate the "Import all existing projects after clone finishes" now to import ALL projects, or you can manually import them afterwards to be a bit more selective.
- Click "Finish". The Git repository will be cloned now. This will probably take a few minutes.
- Switch to the "Plug-in Development" perspective.
- To import the projects into the workspace (if not done automatically):
- Open "File" -> "Import ..." and select "Git"/"Projects from Git". Click "Next" and select "Existing local repository". Click "Next" and select "org.eclipse.smila.core - ...". Click "Next".
- Select "Import existing projects" and "core" in the tree below, and click "Next". Make sure all projects are selected and click "Finish".
- After a while a "Problem occurred" dialog will open and there will be lots of compile errors. This is OK, we will fix this now.
Defining the target platform
The target platform defines the set of bundles and features that you are developing against. 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 Luna (Release 4.4.1).
Using the target platform provided by SMILA
- Import project "SMILA.devenv" from the "releng" directory of your local Git repository (same procedure as for importing the other projects).
- Open the file SMILA.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 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.
- If you have the Checkstyle Eclipse plugin installed in your IDE, you will still get error messages. See /SMILA/Development_Guidelines#Checkstyle Checkstyle configuration for instructions on how to fix this.
Defining the target platform manually
- Instead of using the target definition file provided by SMILA (see above) you can also manually set your own target platform.
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.
The following steps may be needed for special purposes. If you are a SMILA user who only wants to integrate an own component you won't need them.
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 setup your Checkstyle configuration.
Setting up the Eclipse build
See SMILA/Documentation/HowTo/Howto_build_a_SMILA-Distribution for details on how to setup a build for SMILA.
Add examples projects
The examples directory of the repository contains three simple bundles that demonstrate how to develop SMILA pipelets and workers. You can import them to your workspace just like the other projects.
Enabling the BPEL Designer
If you want to work with the SMILA extensions for Eclipse BPEL designer, you need to clone the Git repository at http://git.eclipse.org/gitroot/smila/org.eclipse.smila.tooling.git (or git://... or ssh://...). Currently, the required bundles are: