Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "SMILA/Documentation/HowTo/Howto set up dev environment"

m (Define target platform)
(Preconditions)
(62 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:SMILA]]
+
<br> This HowTo describes the necessary steps for setting up a SMILA development environment.  
 
+
This HowTo describes the necessary steps for setting up a SMILA development environment.
+
  
 
==== Preconditions  ====
 
==== Preconditions  ====
  
Here is the list of things that you will definitely need for developing SMILA components:
+
Here is the list of things that you will definitely need for developing SMILA components:  
  
# JDK 1.6
+
* JDK 1.7 (Java 8 is not yet supported by SMILA).
# Recent Eclipse SDK - This HowTo was tested with [http://download.eclipse.org/eclipse/downloads/drops/R-3.7.1-201109091335/index.php Eclipse Classic SDK 3.7.1] (Indigo SR1) <br/>
+
* Eclipse SDK - This HowTo was tested with [http://download.eclipse.org/eclipse/downloads/drops4/R-4.4.1-201409250400/ Eclipse Classic SDK 4.4.1] (Luna Release) <br>
  
 
==== Getting the source code ====
 
==== 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. When you're done with the next step, the source code will show up errors. Don't worry, they'll disappear when you run through all steps of this HowTo.
+
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 via SVN (recommended!).  
  
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).
+
As an alternative, you could download the complete source code from the [http://www.eclipse.org/smila/downloads.php release download page] or the [http://build.eclipse.org/rt/smila/nightly/ nightly build downloads] and unpack the archive into your workspace.  
  
===== Getting the source code manually =====
+
===== Installing SVN Provider =====
This is a little more involved than the Project Set File but the recommended practice, especially when you wish to update frequently.
+
''(skip this section if SVN Team Provider is already installed in your eclipse IDE)''
  
Use your favorite SVN client to check out SMILA's source code from the repository located at:
+
* Install ''Subversive SVN Team Provider'' and ''Subversive SVN JDT Ignore Extensions'' from the Eclipse software repository.<br>  
<pre>http://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/core</pre>
+
* Restart Eclipse.  
 +
* Select ''Windows &gt; Preferences &gt; Team &gt; 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.8.6.
  
'''Hint:'''
+
===== Get source code from SVN =====
''We recommend to check out the {{code|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.''
+
  
After having checked out the source code, import it in your IDE:
+
There are two ways for this, automatically by using the ''Project Set File'' or manually. Both are described in the following:  
  
Click File --> Import --> General --> Existing Projects into Workspace --> Next --> Select root folder of local trunk --> (all projects should be selected automatically) --> Finish
+
''Manually checking out and importing the projects into eclipse afterwards:''
 +
* Use your favorite SVN client (''except the eclipse SVN client'') to check out SMILA's source code from the repository located at:<br> <tt>https://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/core</tt>. If you later want to be able to build a SMILA distribution, all SMILA projects should be located in the same directory.
 +
:: <pre>svn co https://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/core</pre>
 +
::'''Note:''' ''The upside of doing so is that you can easily get new projects just by updating your working copy and reimporting the sources into eclipse. Removed projects will be deleted on update. Eclipse will indicate this to the user by displaying an empty project.''
 +
* Import all SMILA project into your workspace:
 +
** Click ''File'' &gt; ''Import'' &gt; ''General'' &gt; ''Existing Projects into Workspace'' &gt; ''Next.''
 +
** Select the folder that contains all SMILA projects --&gt; (all projects should be selected automatically) &gt; ''Finish''.
  
===== Using the Project Set File to get the source code =====
+
''Automatic checkout and import by using the Project Set File:''
This uses a ''Project Set File'' (.psf) file to check out and import all projects.
+
* In eclipse, create an SVN repository location with URL <tt>https://dev.eclipse.org/svnroot/rt/org.eclipse.smila</tt>
 +
* Checkout <tt>trunk/releng</tt>
 +
* Right click on <tt>SMILA.releng/devenv.SMILA-core.psf</tt>
 +
* Click ''Import Project Set...'' and choose "No To All"
 +
::'''Hint:''': ''New projects should always be added to the .psf file so you can import them (as before): right click on .psf file 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. If projects are removed you have to remove them manually from the workspace, this can't be handled via .psf file.''
  
You have to install a subversion team provider in your eclipse IDE in order to use the ''Project Set File''. We recommend to install the Subversive Team Provider from the eclipse software repository (you should also install SVN JDT Ignore Extensions).
+
After having imported the source code into your workspace, it will show up a lot of errors. Don't worry, they'll disappear after the next steps below.
 
+
Before you can use the subversive team provider you have to select the SVN connector to use (we suggest that you should take the latest SVN Kit the Subversive Connector Discovery offers to you).
+
 
+
# Download [https://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/releng/devenv/SMILA-core.psf SMILA-core.psf] file
+
# File --> Import --> Team --> Team Project Set
+
# Enter the .psf location
+
# Finish
+
 
+
Now your IDE starts to download and import the SMILA projects. This will take a while.
+
 
+
'''Hint:'''
+
''When you want to reimport the psf (e.g. because there are new projects available in the SMILA core repository), you have to update the psf 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 =====
+
 
+
{{note|
+
If you want to work with the SMILA extensions for Eclipse BPEL designer, you need to checkout the bundles from <tt>trunk/tooling</tt>. Currently these are:
+
* org.eclipse.smila.processing.designer.model
+
* org.eclipse.smila.processing.designer.ui
+
To compile these you need bundles from the [http://www.eclipse.org/bpel Eclipse BPEL Designer] in your target platform. See [[SMILA/BPEL_Designer]] for more information on these bundles.
+
}}
+
  
 
==== Defining the target platform  ====
 
==== Defining the target platform  ====
  
The target platform defines the set of bundles and features that you are developing against.  
+
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 Juno (Release 4.2).
  
===== Defining the target platform the easy way =====
+
===== Using the target platform provided by SMILA =====
  
'''Hint:'''
+
* Checkout <tt>../org.eclipse.smila/trunk/releng</tt>  (''if you haven't already done before'')
''This way will enable you develop or use SMILA from within your workspace, but we recommend to use the manual way, so you can build releases, even for target platforms that are different to your platform.''
+
* Open the file <tt>SMILA.releng/devenv/SMILA.target</tt> with the ''Target Definition'' editor. <br>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.
  
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 or even 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).
+
===== Defining the target platform manually  =====
  
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.
+
* Instead of using the target definition file provided by SMILA (see above) you can also [[SMILA/Development Guidelines/Howto set up target platform|manually set your own target platform]].
  
===== Defining the target platform manually =====
+
==== Launching SMILA in Eclipse IDE  ====
  
Instead of using the target definition file you can manually set your own target platform like so:
+
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:  
  
::*Download the eclipse SDK (if you have not already done so) and the <tt>Delta Pack</tt> from the eclipse download page listed in the [[#Preconditions|Preconditions]] section.
+
* Click <span style="font-style: italic;">Run</span>--&gt; ''Debug Configurations'' and expand '''''OSGI Framework'''''<b>.</b>  
::**Please note that it really should be the plain Eclipse SDK to prevent naughty problems from occurring when trying to start SMILA, because of conflicting bundles etc.
+
* Select the ''SMILA'' launch file.  
::*Extract the SDK in a directory you should name something like <tt>eclipse-target</tt> so you don't confuse it with your IDE's installation folder.
+
* Click '''Debug'''. <br> If everything works fine, you will get an output in the '''Console''' view similar to the following:
::*Unzip the Delta Pack' contents into the contents of the <tt>eclipse-target</tt> folder, always answer <tt>yes</tt> if the system asks you to confirm overwriting of files.
+
  
This directory will be referenced as "eclipse-target" in the following lines.
 
 
In your IDE do the following:
 
::*Click Window --&gt; Preferences --&gt; Plug-in Development --&gt; Target Platform
 
::*Rename the new target, e.g. to "Running target + SMILA.Extension"
 
::*Click Add... --&gt; Select "Nothing: Start with an empty target definition" for target initialization and click "Next"
 
::*Click Add... --&gt; Select "Installation" and click "Next"
 
::*Click on "Browse..." and browse to your "eclipse-target" directory (SDK + delta pack) --&gt; Click OK
 
::*--&gt; Click Finish in the "Add Installation" window
 
::*Click "Add..." --&gt; Select "Directory" --&gt; Click Next --&gt; Select <tt>SMILA.extension/eclipse/plugins</tt> folder under local trunk as the location --&gt; Click Finish
 
::*The target definition dialog should now contain the following entries:
 
::**Name: <tt>Running target + SMILA.Extension</tt>
 
::**In page "Locations" the following entries:
 
::***Installation icon with path to your <tt>eclipse-target</tt> directory, showing the number of available plug-ins
 
::***Directory icon with path to the <tt>SMILA.extension/eclipse/plugins</tt> directory in your checked out SMILA code, showing the number of available plug-ins.
 
::*Change to page "Environment" and select "JavaSE-1.6" as Execution Environment
 
::*Click "Finish" and activate the new target platform by checking the box left to its name.
 
::*Click "OK"
 
 
This will trigger a rebuild of the workspace. Afterwards the errors will have vanished.
 
 
==== 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'''
 
:: <br/>
 
::* If everything is started correctly, you will get an output in the '''Console''' view like below:
 
 
<source lang="text">
 
<source lang="text">
 
osgi> Persistence bundle starting...
 
osgi> Persistence bundle starting...
Line 116: Line 71:
 
[INFO ] Context /zookeeper: Registered handler(1) ZooKeeperAdminHandler, pattern /(.*)$
 
[INFO ] Context /zookeeper: Registered handler(1) ZooKeeperAdminHandler, pattern /(.*)$
 
[INFO ] Added worker webFetcher to WorkerManager.
 
[INFO ] Added worker webFetcher to WorkerManager.
 
 
...
 
...
 
 
[INFO ] HTTP server has SMILA handler RequestDispatcher for context /smila.
 
[INFO ] HTTP server has SMILA handler RequestDispatcher for context /smila.
 
[INFO ] HTTP server started successfully on port 8080.
 
[INFO ] HTTP server started successfully on port 8080.
 
</source>
 
</source>
  
==== You're done ====
+
==== You're done ====
Congratulations! You've just successfully checked out and configured your SMILA development environment and can now start developing your own bundles.
+
 
 +
Congratulations! You've just successfully checked out and configured your SMILA development environment and you can now start [[SMILA/Development Guidelines/Create a bundle (plug-in)|developing your own bundles]].
 +
 
 +
==== Additional steps ====
 +
 
 +
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. 
 +
 
 +
===== Delta Pack =====
 +
''(only needed for building the software outside of eclipse IDE)''
 +
 
 +
For building the software you may need to add a "Delta Pack" to an Eclipse SDK installation. You can download it from [http://download.eclipse.org/eclipse/downloads/ here] by selecting the corresponding eclipse version that you have in use. After downloading, you can copy the contained plugins and features in your eclipse installation.
 +
 
 +
===== Checkstyle configuration =====
 +
 
 +
If you have the [http://eclipse-cs.sourceforge.net/ Eclipse Checkstyle plugin] installed, you will get a lot of error messages complaining about missing check configurations when Eclipse builds the workspace.
 +
 
 +
<source lang="text">
 +
Errors running builder 'Checkstyle Builder' on project 'org.eclipse.smila.utils'.
 +
Fileset from project "org.eclipse.smila.utils" has no valid check configuration.
 +
...
 +
</source>
 +
 
 +
You can solve this by [[SMILA/Development_Guidelines#Checkstyle|setup your Checkstyle configuration]].
 +
 
 +
===== 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 <tt>trunk/tooling</tt>. Currently, the required bundles are:
 +
 
 +
*<tt>org.eclipse.smila.processing.designer.model</tt>
 +
*<tt>org.eclipse.smila.processing.designer.ui</tt>
 +
 
 +
To compile them you need additional bundles from the [http://www.eclipse.org/bpel Eclipse BPEL Designer] in your target platform. See [[SMILA/BPEL Designer]] for more information.
 +
 
 +
 
 +
[[Category:SMILA]]

Revision as of 03:40, 13 November 2014


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:

  • 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 via SVN (recommended!).

As an alternative, you could download the complete source code from the release download page or the nightly build downloads and unpack the archive into your workspace.

Installing SVN Provider

(skip this section if SVN Team Provider is already installed in your eclipse IDE)

  • Install Subversive SVN Team Provider and Subversive SVN JDT Ignore Extensions from the Eclipse software repository.
  • Restart Eclipse.
  • Select Windows > Preferences > Team > 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.8.6.
Get source code from SVN

There are two ways for this, automatically by using the Project Set File or manually. Both are described in the following:

Manually checking out and importing the projects into eclipse afterwards:

svn co https://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/core
Note: The upside of doing so is that you can easily get new projects just by updating your working copy and reimporting the sources into eclipse. Removed projects will be deleted on update. Eclipse will indicate this to the user by displaying an empty project.
  • 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.

Automatic checkout and import by using the Project Set File:

Hint:: New projects should always be added to the .psf file so you can import them (as before): right click on .psf file 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. If projects are removed you have to remove them manually from the workspace, this can't be handled via .psf file.

After having imported the source code into your workspace, it will show up a lot of errors. Don't worry, they'll disappear after the next steps below.

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 Juno (Release 4.2).

Using the target platform provided by SMILA
  • Checkout ../org.eclipse.smila/trunk/releng (if you haven't already done before)
  • 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

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.

You're done

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

Additional steps

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.

Delta Pack

(only needed for building the software outside of eclipse IDE)

For building the software you may need to add a "Delta Pack" to an Eclipse SDK installation. You can download it from here by selecting the corresponding eclipse version that you have in use. After downloading, you can copy the contained plugins and features in your eclipse installation.

Checkstyle configuration

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.

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

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

Back to the top