Papyrus-RT/Developer/Developer Guide/DevEnv

Introduction

This tutorial will show you how to setup the development environment for Papyrus for Real Time using the Oomph-based Eclipse Installer.

The installer will automatically perform several actions, including:

• Download and install a base Eclipse workbench for your platform
• Add the required update sites
• Download and install all required development tools (Eclipse features and plugins, such as the PDE, the JDT, EGit, MyLyn, etc.)
• Download and install all required dependencies (Eclipse features and plugins, such as UML2, Papyrus, Xtext, etc.)
• Clone the PapyrusRT git repository
• Import all the PapyrusRT projects into the workspace
• Create working sets in the workspace organizing the projects
• Install Bugzilla and Gerrit MyLyn connectors and synchronize queries for these connectors
• Configure the workbench (e.g. set the JVM and Java compiler compliance, set character encodings, code formatting and other user preferences)

Requirements

To install the developer environment you need only three things:

• Java 8.

  Older versions may not work. You can obtain the JDK 1.8 here: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

• The Eclipse Installer
  1. Go to http://wiki.eclipse.org/Eclipse_Installer
  2. Download the "Eclipse Installer" package for your operating system
  3. Decompress the downloaded archive to a folder such as "~/Apps/EclipseInstaller/" (folder name and location will vary depending on operating system)

• The PapyrusRT developer setup project file.

  This file contains the tasks described above

  1. Download this file from https://www.eclipse.org/papyrus-rt/papyrus-rt-developer.setup
  2. Save it in a convenient folder such as "~/Apps/papyrus-rt-developer.setup/"

Operating System
The instructions in this tutorial are illustrated using screen captures from multiple operating systems. Steps and images may differ slightly if the installation is done on a different operating system (both Windows and Mac OS are supported for developing models). Some of these differences have been indicated when known, but some may also be missing.

Windows
We have had reports that these instructions fail on the next step on some Windows installations and we are investigating. If that is the case for you, You can first try using Java 8 and, if it still does not work, please follow the instructions on the manual installation tutorial: Installing the Neon developer environment for PapyrusRT manually.

Install the development environment for Papyrus for Real Time

Now that the installer and project file are available, you can install the development environment.

Start the Eclipse Installer

1. Open the eclipse-installer folder and double-click on the eclipse-inst application.

You should see this:

Switch the the Advanced Mode

You have now started the Eclipse Installer. Now you will need to add the Papyrus-RT developer setup project file to the Installer.

However, the Papyrus-RT developer setup project is not available in the list of projects presented to you. You will have to manually add it to the list by using the "Advanced Mode" of the installer.

2. Click on the icon at the top right.

3. Select "Advanced Mode..."

This has for effect to restart the Eclipse Installer in the "Advanced Mode", which will allow you to specify an external setup file.

Select a base Eclipse Package

4. Select Eclipse.org from the list.

5. Click on the [>] left of Eclipse.org to unfold.

6. Select Eclipse IDE for Eclipse Committers.

Base package
You can choose a different base package, but this is the simplest way to get started.

7. In the bottom, under Product Version select Latest (Neon).

8. Under Java VM choose the appropriate Java 1.8 JVM (you may need to navigate through the file system to find the one you need).

9. Click [Next]

Add the setup project file to the installer

10. Drag and drop the setup file (File:Papyrus-rt-developer.setup) onto the <User> folder.

Select the components to install

11. Unfold Papyrus-RT and check all the boxes on the left.

12. In the bottom of the dialog make sure that the Stream field in each entry is set to master (Neon/1.0) (You may need to click on each and select the appropriate stream).

13. Click [Next].

Configure your installation

14. Choose your installation and workspace folders and enter your Eclipse password. You may customize these values and more by checking on Show all variables at the bottom.

15. Click [Next].

This shows the first set of tasks of the installation. The second set will be executed when Eclipse launches automatically.

16. Click [Finish].

17. Click [Finish].

Restarting

Eclipse will relaunch automatically and present you with a welcome screen:

On the bottom right it says Executing startup tasks. You can leave it alone, but it will take a few minutes to complete. If you'd like to see the progress, you can click on the icon to the left of this message (two circling arrows)

When it finishes it will look like this:

18. When asked for Gerrit Code Review Repository Authentication enter your Eclipse user ID and password.

During setup, a few dialogs like the following will pop up:

These will setup and synchronize the various MyLyn queries for Bugzilla and Gerrit.

19. Once it's finished you can click [Finish] to close the setup dialog.

Setup the workspace view

20. Click on Workbench in the Eclipse Welcome page. You should see something like this:

If the Package Explorer shows individual plugin projects instead of Working sets as shown above, you can choose to show them by clicking on the down arrow shown at the top-right of the Package Explorer view, selecting Top Level Elements and then Working Sets.

Generate code for EMF projects

At this point you will likely have errors shown in several projects. For each of the following projects (found under the Papyrus XtUML-RT working set), perform the steps below:

• org.eclipse.papyrusrt.xtumlrt.common.model
• org.eclipse.papyrusrt.xtumlrt.statemach.model
• org.eclipse.papyrusrt.xtumlrt.statemach.ext.model
• org.eclipse.papyrusrt.xtumlrt.umlrt.model

Steps:

1. Unfold the project
2. Unfold the model folder
3. Open the 'XXX'.genmodel file (by double-clicking it), where 'XXX' is the name of the model.
4. In the opened EMF editor, right-click the root element (named 'XXX')
5. Select Generate Model Code

1. Do the same for each of the projects mentioned above.

Generate code for the Xtext project

1. Under the Papyrus XtUML-RT working set, locate the org.eclipse.papyrusrt.xtumlrt.xtext project
2. Unfold the project
3. Unfold the src folder
4. Unfold the org.eclipse.papyrusrt.xtumlrt.xtext folder
5. Right-click on the Tumlrt.xtext file
6. Select Run As
7. Select Generate Xtext Artifacts

You may still have a couple of errors related to some missing folders. To get rid of these,

1. Go to the org.eclipse.papyrusrt.xtumlrt.xtext.ide project
2. Right-click on the project
3. Select New
4. Select Folder
5. In the resulting dialog, set the name of the new folder to src
6. Repeat, creating the folders src-gen and xtend-gen