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 "Papyrus/Papyrus Developer Guide"

m (Papyrus Build Process: add the link for the table documentation)
(47 intermediate revisions by 14 users not shown)
Line 1: Line 1:
 
== Development Environment  ==
 
== Development Environment  ==
  
To ease the development on Papyrus, each member of the team works with basically the same configuration. <br>
+
To ease the development on Papyrus, each member of the team works with basically the same configuration.
 +
 
 +
One way to manage this is using the [[Eclipse Installer]] (by Oomph) to manage your Papyrus development workbench.
 +
 
 +
=== Papyrus Oomph Setup Model ===
 +
 
 +
The [[Eclipse Installer]] provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code.  Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.
 +
 
 +
Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on.  For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse.  On the second page, expand '''Eclipse.org''' / '''Papyrus''' to see the various components that you can import to work on.  Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like.  In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform.  This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).
 +
 
 +
Contributing your changes is easy because Oomph will clone the Papyrus Git repository for you and configure Gerrit push.
 +
 
 +
Amongst possibly other details, the setup model configures:
 +
 
 +
* your IDE with all of the tools needed to edit and build the source projects you choose
 +
* your workspace with a Git clone and the source projects imported from it that you choose
 +
* a PDE target that includes all of the dependencies required by Papyrus plus the latest nightly build of Papyrus, itself, so that you can import only a subset of the (many) source projects but still run the complete Papyrus toolset in a run-time workbench
 +
* Mylyn queries for current open bugs and enhancements in the Papyrus bugzilla database
 +
* Mylyn queries for the status of the latest Papyrus automated builds, including tests
 +
* Mylyn queries for open Gerrit reviews
 +
* preferences enforcing the Papyrus standard compiler and code formatter/template settings
 +
 
 +
Please raise bugs if you see any problems in the setup configuration.
 +
 
 +
When you first launch the Eclipse Installer, it will show the default "simple mode" installer presentation:
 +
 
 +
[[Image:Papyrus_Oomph_simple.png]]
 +
 
 +
You can choose to proceed from here, picking for example the "Eclipse IDE for Committers" package to install, which is the minimal configuration, and later using Oomph to import the Papyrus sources into the workspace (box 1 in the screenshot).  However, you may as well select all of the Papyrus content that you need in your development environment now to set everything up in one go.  To do that, switch to the "advanced mode":  open the dialog tray by clicking on the button (box 2) and select "Advanced Mode..." (box 3).  Now you should see the dialog reconfigured as shown below:
 +
 
 +
[[Image:Papyrus_Oomph_page1.png]]
 +
 
 +
Again, the simplest option is to start with the "Eclipse IDE for Committers" package because the setup model will add everything else you need for working on Papyrus's various code and models.
 +
 
 +
On the second page, pick whatever Papyrus components you need to import into the workspace:
 +
 
 +
[[Image:Papyrus_Oomph_page2.png]]
 +
 
 +
{{note|Minimal Project Selection|Note that, at a minimum, you must select the top-level "Papyrus" project node for import, to get the correct tooling installed for working with the source and to bring the nightly builds into your PDE Target}}.
 +
 
 +
If you need to work on and test the Papyrus setup model, itself, then you should also import the "Papyrus / Developer / Oomph Setup" project (selected in the screenshot above) to configure the workbench to load the Papyrus setup model from your Git checkout instead of from the central Git repository via HTTP.
 +
 
 +
Next, tell Oomph where to check out the Papyrus repository, where to install Eclipse, and where to create the workspace:
 +
 
 +
[[Image:Papyrus_Oomph_page3.png]]
 +
 
 +
'''Note''' that exactly how this page looks will depend on the options you choose for how to manage installation and workspace locations, and whether you have previously used Oomph to install other Eclipse instances (I have).
 +
 
 +
'''Note''' also that if you do not see the target platform that you need in the 'Target Platform' pick-list (for example, Neon to start working on the Papyrus Neon branch that is the master at the time of this writing), then you can just type the name into the field.
 +
 
 +
The last page summarizes the steps that Oomph will follow to start the installation:
 +
 
 +
[[Image:Papyrus_Oomph_page4.png]]
 +
 
 +
After the newly installed Eclipse instance starts up, it will complete the setup by performing the rest of the tasks that have to be done in the workspace that didn't exist initially.  These include the git checkout, importing projects from the checkout into the workspace, creating working sets, Mylyn queries, and more.  Once these steps have completed, you will be ready to start working on the Papyrus code.
 +
 
 +
If you used Oomph's "simple mode" to create your Eclipse workspace, or if you need to make changes to what Papyrus bits you have imported (even for setting up the set-up model redirection), you can do this at any time by launching the Oomph installer wizard from within the Eclipse workbench.  '''Note''' that you will first have to make the Oomph setup actions available in the toolbar be enabling the preference:
 +
 
 +
[[Image:Papyrus_Oomph_updater.png]]
 +
 
 +
This launches essentially the same wizard as the "advanced mode" of the Oomph Installer.
  
 
=== Common Environment  ===
 
=== Common Environment  ===
Line 7: Line 67:
 
Following is a description of the basic configuration:  
 
Following is a description of the basic configuration:  
  
*The latest Eclipse Modeling release.
+
*The latest Eclipse Modeling (Or Standard) release
*[http://www.eclipse.org/projects/project_summary.php?projectid=technology.subversive] SVN Subversive (or Subclipse, update site: http://subclipse.tigris.org/update_1.6.x)  
+
*EGit
*[http://eclipse-cs.sourceforge.net/downloads.html] CheckStyle
+
 
*[http://jautodoc.sourceforge.net/] JAutoDoc  
 
*[http://jautodoc.sourceforge.net/] JAutoDoc  
 
**Configure the header template according to your company: Eclipse Preferences -&gt; Java -&gt; JAutodoc  
 
**Configure the header template according to your company: Eclipse Preferences -&gt; Java -&gt; JAutodoc  
*Java 1.5:  
+
*Java 1.6:  
 
**Eclipse Preferences -&gt; Java -&gt; Compiler  
 
**Eclipse Preferences -&gt; Java -&gt; Compiler  
 
**Eclipse Preferences -&gt; Java -&gt; Installed JREs  
 
**Eclipse Preferences -&gt; Java -&gt; Installed JREs  
*Set the API Baseline to Ignore
 
**Eclipse Preferences -&gt; Plug-In Developpement -&gt; API Baselines-&gt; Missing API Baseline should be setted to Ignore
 
 
**VM Arguments for debug mode:
 
**VM Arguments for debug mode:
<pre>-Dosgi.requiredJavaVersion=1.5 -Xms768m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+CMSClassUnloadingEnabled
+
<pre>-Dosgi.requiredJavaVersion=1.6 -Xms768m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=384m -XX:+CMSClassUnloadingEnabled
 
</pre>  
 
</pre>  
 +
 
=== Required External Plugins  ===
 
=== Required External Plugins  ===
  
Papyrus requires some external plugins in order to compile. <br> The following page maintain a list of [[Papyrus Required External Plugins|Papyrus Required External Plugins]]  
+
Papyrus may require some external plugins to compile. <br> The following page maintain a list of [[Papyrus Required External Plugins|Papyrus Required External Plugins]]
 +
 
 +
=== Version Management Tooling ===
 +
 
 +
As of late February 2016 in the Neon development cycle, the Papyrus Main plug-ins and features and the Developer Tools are configured for PDE API Tooling and Oomph Version Management validation.  One of the value-added capabilities of Oomph is flagging plug-ins and features that aren't included in any other feature, and thus appear to be slipping through a crack in the release.  This only works when the workspace has all of the plug-in and feature projects of Papyrus imported.
 +
 
 +
If your workspace only has a subset of the Papyrus projects imported, then you can tell Oomph that this check is not appropriate by configuring the "check mode" in the Preferences:
 +
 
 +
[[File:Papyrus_Oomph_versionmgmt_prefs.png|800px]]
 +
 
 +
=== [Future] Maven Integration ===
 +
 
 +
The Hudson builds are currently implemented with Maven, using Tycho to build Eclipse-compatible artifacts.  Therefore, all active plug-in and feature projects have Maven POM files describing them.  There is a proposal under consideration to implement Maven Nature provided by M2Eclipse in the Papyrus source projects, to more closely align the Hudson build environment with the developer's local build environment in the Eclipse workbench.
 +
 
 +
An initial analysis of what would be involved in this change, both in terms of actually implementing the Maven Nature and its impact on Papyrus developers' daily workflow, is captured in this document:
 +
 
 +
* [http://www.slideshare.net/cdamus/adopting-maven-nature-in-papyrus-source-projects Adopting Maven Nature] in the Papyrus source projects
  
 
== Development Plan  ==
 
== Development Plan  ==
Line 28: Line 102:
 
=== Specifications  ===
 
=== Specifications  ===
  
The specifications are available here: http://wiki.eclipse.org/Papyrus_Developer_Guide/Specifications
+
The specifications are available here: [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/papyrus/project-info/plan_luna.xml Luna plan]
 +
 
 +
=== Contributing to the plan for the release ===
 +
 
 +
*How To - Contributing to the release plan, ... [[Papyrus Developer Guide/Contributing To Release Plan]]
  
 
== Getting the code  ==
 
== Getting the code  ==
  
=== Connecting to the svn  ===
+
=== Cloning the Git repository and importing the code ===
  
The code is available under svn at this location http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/  
+
The Papyrus code and some documents are located in a Git repository. In the website [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git] you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git).
  
=== Retrieve code  ===
+
Follow the next instructions if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace.
  
The following [[PSF]] files will allow you to import all Papyrus plugins used during build phase: PSF files are now automatically generated using the SVN repository. They do not necessarily correspond to what is built. The script used to generate them is available in this project http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/readme/ The following psf files are automatically update several time by day.  
+
First, you have to clone the Papyrus repository. Open the Eclipse import wizard (“File” => “Import”), select “Git” => “Projects from Git” and click “Next”. Select “Clone URI” and click “Next”. Now you will have to enter the repository’s location and connection data. Entering the repository URI will automatically fill some fields. In the case of using the URI http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git, you will not have to fill any field. Complete any other required fields and hit “Next”.  
  
These PSF are builded using the SVN contents and NOT using the build process. So some downloaded plugins should be deprecated, not maintained, and not provided in the Papyrus installation.  
+
The Git repository of Papyrus contains many different branches and you must select at least one. Select the branch “streams/1.1-maintenance” if you want to fix code bugs in the Mars version of the Papyrus plugins or “master” if you want to contribute with new features to the latest version of Papyrus called Neon. Click “Next” and select the storage location (e.g., “C:\git”) and the name of the initial branch (e.g., “streams/1.1-maintenance”).
  
To know if a downloaded plugin should compile, you can have a look to a Papyrus installation. If the plugin comes with the installation, it should compile!
+
Finally, follow the import projects wizard to select the plugins projects that you want to study or modify, and click “Finish”. You will see all those projects in your workspace.
  
Some downloaded plugins should have dependencies on plugins stored in the incoming folder. In this case you should download them manually.
+
See the [https://projects.eclipse.org/projects/modeling.mdt.papyrus/developer Papyrus project developer resources] page for more details
 +
 
 +
=== Note about compilable plugins ===
 +
 
 +
To know if a downloaded plugin should compile, you can have a look to a Papyrus installation. If the plugin comes with the installation, it should compile!
  
*'''Trunk 0.10.X (Kepler)'''
+
*The following plugins are not distributed and could be closed (deprecated, not yet provided in the Papyrus distribution or for developpers only):
**last versions of the psf files for Papyrus/trunk using http for non-commiters:
+
<pre>all plugins of the layer 'developer', except if you need to generate diagrams (in this case you should install GMF Tooling as well)  
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/build_http.psf build_http.psf] release engineering projects
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/extraplugins_http.psf extraplugins_http.psf] all papyrus extraplugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/full_papyrus_http.psf full_papyrus_http.psf] all papyrus plugins available on the SVN
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/plugins_http.psf plugins_http.psf] all papyrus plugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/tests_http.psf tests_http.psf] Junit and other test plugins (mandatory for developers)
+
**last versions of the psf files for Papyrus/trunk using svn+ssh for commiters:
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/build_svn_ssh.psf build_svn_ssh.psf] release engineering projects
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/extraplugins_svn_ssh.psf extraplugins_svn_ssh.psf] all papyrus extraplugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/full_papyrus_svn_ssh.psf full_papyrus_svn_ssh.psf] all papyrus plugins available on the SVN
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/plugins_svn_ssh.psf plugins_svn_ssh.psf] all papyrus plugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/tests_svn_ssh.psf tests_svn_ssh.psf] Junit and other test plugins (mandatory for developers)
+
**Details
+
***psf for plugins (updated the 2nd January 2013). The following plugins are not distributed and could be closed (deprecated, not yet provided in the Papyrus distribution or for developpers only):
+
<pre>oep.customization
+
oep.customization.properties
+
oep.customization.properties.generation
+
all plugins of the layer 'developer', excepted if you need to generate diagrams (in this case you should install the GMF Tooling too)  
+
oep.editor.perspectiveconfiguration
+
 
oep.infra.emf.editor  
 
oep.infra.emf.editor  
 
oep.infra.emf.embeddededitor  
 
oep.infra.emf.embeddededitor  
 
oep.infra.emf.newchild  
 
oep.infra.emf.newchild  
all plugins oep.infra.gmfdiag.css if you don't use the css excepted oep.infra.gmfdiag.css.model
+
oep.team.svn
org.eclipse.papyrus.infra.xtext.widgets
+
oep.sysml.diagram.parametric
+
oep.team.svn  
+
oep.uml.documentation
+
oep.uml.standard
+
oep.uml.standard.edit
+
oep.uml.ui.perspectiveconfiguration
+
oep.uml.properties.tabbedproperties.comments
+
oep.uml.textedit.state.xtext.generator
+
all plugins oep.views.documentation
+
 
</pre>  
 
</pre>  
*psf for extraplugins (updated the 2nd January 2013) . Only the follwing projects are currently provided by the Papyrus extra-plugins update site. The others projects can be closed.(They are deprecated, not yet provided in the Papyrus distribution or for developpers only):
+
*Only the follwing projects are currently provided by the Papyrus extra-plugins update site. The others projects can be closed.(They are deprecated, not yet provided in the Papyrus distribution or for developpers only):
 
<pre>
 
<pre>
 
org.eclipse.papyrus.compare.report.ui
 
org.eclipse.papyrus.compare.report.ui
Line 112: Line 166:
 
org.eclipse.papyrus.uml.export
 
org.eclipse.papyrus.uml.export
 
</pre>  
 
</pre>  
*psf for tests (updated the 2nd January 2013) . Only the follwing projects are used for tests. The others projects can be closed.
+
*The tests plug-ins are located under tests/junit/plugins or tests/junit/extraplugins. Other test projects are not necessarily maintained
<pre>
+
org.eclipse.papyrus.sysml.tests
+
org.eclipse.papyrus.bundles.tests
+
org.eclipse.papyrus.core.resourceloading.tests
+
org.eclipse.papyrus.customization.properties.tests
+
org.eclipse.papyrus.diagram.clazz.test
+
org.eclipse.papyrus.diagram.common.tests
+
org.eclipse.papyrus.diagram.stereotypeproperty
+
org.eclipse.papyrus.infra.services.edit.tests
+
org.eclipse.papyrus.infra.services.labelprovider.tests
+
org.eclipse.papyrus.sysml.diagram.blockdefinition.tests
+
org.eclipse.papyrus.sysml.diagram.internalblock.tests
+
org.eclipse.papyrus.sysml.service.types.tests
+
org.eclipse.papyrus.tests
+
org.eclipse.papyrus.uml.diagram.dnd.tests
+
org.eclipse.papyrus.uml.diagram.usecase.tests
+
org.eclipse.papyrus.uml.modelexplorer.tests
+
org.eclipse.papyrus.uml.service.types.tests
+
org.eclipse.papyrus.uml.tools.tests
+
org.eclipse.papyrus.views.modelexplorer.tests
+
org.eclipse.papyrus.tests.extra
+
org.eclipse.papyrus.infra.gmfdiag.css.tests.tests
+
</pre>
+
<br>
+
 
+
*'''Branch 0.9.X (Juno)'''
+
**last versions of the psf files for Papyrus/branch using http for non-commiters:
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/build_0.9.X_http.psf build_0.9.X_http.psf] release engineering projects
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/extraplugins_0.9.X_http.psf extraplugins_0.9.X_http.psf] all papyrus extraplugins  
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/full_papyrus_0.9.X_http.psf full_papyrus_0.9.X_http.psf] all papyrus plugins available on the SVN
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/plugins_0.9.X_http.psf plugins_0.9.X_http.psf] all papyrus plugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/tests_0.9.X_http.psf tests_0.9.X_http.psf] Junit and other test plugins (mandatory for developers)
+
**last versions of the psf files for Papyrus/branch using svn+ssh for commiters:
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/build_0.9.X_svn_ssh.psf build_0.9.X_svn_ssh.psf] release engineering projects  
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/extraplugins_0.9.X_svn_ssh.psf extraplugins_0.9.X_svn_ssh.psf] all papyrus extraplugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/full_papyrus_0.9.X_svn_ssh.psf full_papyrus_0.9.X_svn_ssh.psf] all papyrus plugins available on the SVN
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/plugins_0.9.X_svn_ssh.psf plugins_0.9.X_svn_ssh.psf] all papyrus plugins
+
***[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/tests_0.9.X_svn_ssh.psf tests_0.9.X_svn_ssh.psf] Junit and other test plugins (mandatory for developers)
+
 
+
=== How to update the script generating the psf files. ===
+
 
+
The script is located on build.eclipse.org in /opt/public/modeling/mdt/papyrus/create_psf_files.sh.
+
 
+
*To modify it&nbsp;:
+
**download this project with Eclipse http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/readme/
+
**modify it and commit it on the SVN
+
**log you on hudson
+
**execute the script /opt/public/modeling/mdt/papyrus/update_psf_files_script.sh. This script allows to download and "install" the last version of the scripts located in trunk/readme/script (so it updates itself too)
+
  
<br>
 
  
 
=== Retrieve configuration files  ===
 
=== Retrieve configuration files  ===
  
The Papyrus [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/templates/Papyrus%20Code%20templates.xml Code Templates] and [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/templates/Papyrus%20Formatter%20profile.xml Java Formatter] files are available under the Papyrus repository in the plugin org.eclipse.papyrus.doc under the folder "templates"<br> [[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]<br> [[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]<br> Checkstyle: available soon <br>  
+
The Papyrus [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/templates/Papyrus%20Code%20templates.xml Code Templates] and [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/templates/Papyrus%20Formatter%20profile.xml Java Formatter] files are available under the Papyrus repository in the folder doc/DeveloperDocuments/templates/<br> [[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]<br> [[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]<br>
  
[http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/templates/HowToUseTemplates.txt The note] explains how to install the templates in your environment.
+
[http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/templates/HowToUseTemplates.txt The note] explains how to install the templates in your environment.
  
 
== Papyrus Architecture ==
 
== Papyrus Architecture ==
 +
 +
*[[Dependencies to Eclipse components ]]
  
 
*Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture|Papyrus Architecture ]]
 
*Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture|Papyrus Architecture ]]
 +
 +
== Papyrus Requirements==
 +
*This topic contains all [[MDT/Papyrus/Developer Guide/HighRequirements|Papyrus Requirements ]].
  
 
== Papyrus Generation  ==
 
== Papyrus Generation  ==
Line 182: Line 192:
 
*Java Doc - every class, method and field including private ones should be documented with Java Doc  
 
*Java Doc - every class, method and field including private ones should be documented with Java Doc  
 
*No abbreviations - the class, methods and variables should have meaningful names  
 
*No abbreviations - the class, methods and variables should have meaningful names  
*Formatting - the code should be formatted in accordance with format templates  
+
*Formatting - the code should be formatted in accordance with format templates
 +
*Always use brackets in conditions, loops, ...
 
*Compile - the modified code and other plugins should be compilable. Be sure to use '''Java 1.5 code compatibility'''. Check other plugins that could be influenced before commiting!  
 
*Compile - the modified code and other plugins should be compilable. Be sure to use '''Java 1.5 code compatibility'''. Check other plugins that could be influenced before commiting!  
 
*Standard Java Rules coding - Unless specified differently, the Java Standard Coding rules should be applied: no abbreviations, variables starting with lower case; class and types with upper case; Composed name separated with upper case; no underscore in names; ...  
 
*Standard Java Rules coding - Unless specified differently, the Java Standard Coding rules should be applied: no abbreviations, variables starting with lower case; class and types with upper case; Composed name separated with upper case; no underscore in names; ...  
Line 201: Line 212:
 
=== Structure and behavior of papyrus  ===
 
=== Structure and behavior of papyrus  ===
  
*Presentation of the papyrus stucture and the behavior of some parts [[Papyrus Developer Guide/Papyrus Structure Behavior]]
+
*Presentation of the papyrus structure and the behavior of some parts [[Papyrus Developer Guide/Papyrus Structure Behavior]]
  
 
=== Papyrus Command Execution, History, Undo/Redo  ===
 
=== Papyrus Command Execution, History, Undo/Redo  ===
Line 208: Line 219:
  
 
*This second document tries to explain how the differents Eclipse Command frameworks work and how they are related. It also explains how commands should be executed in Papyrus, in order to have correct undo/redo.  
 
*This second document tries to explain how the differents Eclipse Command frameworks work and how they are related. It also explains how commands should be executed in Papyrus, in order to have correct undo/redo.  
**http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/architecture/commandExecution.doc  
+
**http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/commandExecution.doc  
 
**Following UML model with code reverse can also be useful:  
 
**Following UML model with code reverse can also be useful:  
***http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.di  
+
***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.di  
***http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.notation  
+
***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.notation  
***http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.uml
+
***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.uml
  
 
=== Papyrus ServiceRegistry<br>  ===
 
=== Papyrus ServiceRegistry<br>  ===
Line 218: Line 229:
 
The ServiceRegistry is one of the main Papyrus component. The idea is that each Papyrus feature should be a service registered to the ServiceRegistry.  
 
The ServiceRegistry is one of the main Papyrus component. The idea is that each Papyrus feature should be a service registered to the ServiceRegistry.  
  
The ServiceRegistry should be accessible from any code. It allows to retrieve the components you need to perform your task. <br> A new implementation of the ServiceRegistry is submitted. The new ServiceRegistry is discused here [[Papyrus Developer Guide/Service Registry]]  
+
The ServiceRegistry should be accessible from any code. It allows to retrieve the components you need to perform your task. <br> A new implementation of the ServiceRegistry is submitted. The new ServiceRegistry is discussed here [[Papyrus Developer Guide/Service Registry]]
 +
 
 +
=== Manage Decorators On Papyrus ===
 +
Papyrus provide services in order To manage decoration on Edit Parts from graphical editor or on icons from model explorer. An application example are describe here: [[Manage Decorators On Papyrus]]
  
 
== How To ...  ==
 
== How To ...  ==
Line 225: Line 239:
  
 
*How To - related to reporting bugs, patching, commit, ... [[Papyrus Developer Guide/How To- Code Contributing]]
 
*How To - related to reporting bugs, patching, commit, ... [[Papyrus Developer Guide/How To- Code Contributing]]
 +
 +
=== Commit, Report Bugs, patchs (Gerrit Contributing)  ===
 +
 +
*How To - related to reporting bugs, patching, commit, ... [[Papyrus_Developer_Guide/How_to_Contribute_to_Papyrus_with_Gerrit]]
 +
 +
=== Model your papyrus development, and generate User doc  ===
 +
 +
*How To - create your model (requirements, use cases, design, tests) ... [[Papyrus Developer Guide/Model your development]]
  
 
=== Papyrus Code Examples  ===
 
=== Papyrus Code Examples  ===
Line 237: Line 259:
  
 
Currently Papyrus provides 2 editors kinds&nbsp;: Diagrams and Table. How to add your own editor kind is explained here [[Papyrus Developper Guide/How to - Add your own editor in Papyrus]]  
 
Currently Papyrus provides 2 editors kinds&nbsp;: Diagrams and Table. How to add your own editor kind is explained here [[Papyrus Developper Guide/How to - Add your own editor in Papyrus]]  
 +
 +
=== JUnit Tests  ===
 +
 +
* How to add JUnit tests to the build: [[Papyrus Developer Guide/Add JUnit Test Bundle]]
 +
* A code generation framework has been developed to automatically generate JUnit tests for GMF-based editors:  [[Papyrus Developer Guide/Automatic Test Generation for Diagram Editors]]
 +
* Useful utilities for JUnit tests:  [[Papyrus Developer Guide/JUnit Test Framework]]
  
 
=== Write Documentation for Papyrus  ===
 
=== Write Documentation for Papyrus  ===
  
 
How to - Related to documentation [[Papyrus Developer Guide/Writing Documentation]]  
 
How to - Related to documentation [[Papyrus Developer Guide/Writing Documentation]]  
 +
 +
=== Contribute to Papyrus release plan ===
 +
 +
How to - Related to release plan contribution [[Papyrus Developer Guide/Contributing To Release Plan]]
  
 
=== Papyrus Discovery  ===
 
=== Papyrus Discovery  ===
Line 246: Line 278:
 
==== Papyrus additional components  ====
 
==== Papyrus additional components  ====
  
To add extra features to the Papyrus Discover, you should edit the files located here:<strike>/cvsroot/org.eclipse/HEAD/www/modeling/mdt/papyrus/downloazds/discovery/juno/</strike>
+
To add extra features to the Papyrus Discover, you should edit the files located here: ssh://USER_ID@git.eclipse.org/gitroot/www.eclipse.org/papyrus.git
 
+
Now it is on git: ssh://USER_ID@git.eclipse.org/gitroot/www.eclipse.org/modeling/mdt.git  
+
  
 
==== Papyrus as a Modeling component  ====
 
==== Papyrus as a Modeling component  ====
  
Papyrus is available from the Modeling Package, using the discovery UI pf this package. This contribution is made by the project located here:&nbsp;git://git.eclipse.org/gitroot/www.eclipse.org/modeling/amalgam.git,  
+
Papyrus is available from the Modeling Package, using the discovery UI of this package. This contribution is made by the project located here:&nbsp;git://git.eclipse.org/gitroot/www.eclipse.org/modeling/amalgam.git,  
  
the file is located in the folders discovery/downloads/RELEASE_NAME  
+
the file is located in the folders discovery/downloads/RELEASE_NAME
  
== Papyrus (Nat)Table Developper Documentation  ==
+
== Papyrus Table Developer Documentation  ==
* The documentation for developpers is available here [[Table Developper Documentation]]
+
* The documentation for developers is available here [[Table Developer Documentation]]
 +
 
 +
== Papyrus Diagram Developer Documentation  ==
 +
* The documentation for developpers is available here [[Diagram Developer Documentation]]
 +
 
 +
== Papyrus Embedded Editors Documentation  ==
 +
* The documentation for developers is available here [[Embedded Editors Developer Documentation]]
 +
 
 +
== Papyrus Extraplugins Documentation ==
 +
The following describe developer guide for papyrus extraplugins:
 +
 
 +
*[[Java Code Generation Developer Guide]]
 +
*[[Java Code Reverse Developer Guide]]
  
 
== Papyrus Build Process  ==
 
== Papyrus Build Process  ==
  
*Papyrus build process on Athena is explained here [[Papyrus Developer Guide/Build Process]].
+
*Papyrus build process: How to Use [[Papyrus Developer Guide/Build Process: How To]].
 +
 
 +
*Papyrus build process: Documentation [[Papyrus Developer Guide/Build Process: Doc]].
 +
 
 +
*Papyrus Release Standard Operating Procedure:  [[Papyrus Developer Guide/Release Standard Operating Procedure: Doc]].
 +
 
 +
*Papyrus API Evolution Reports: [[Papyrus Developer Guide/API Evolution Reports]]
  
 
== New plugin Submition Process  ==
 
== New plugin Submition Process  ==

Revision as of 07:06, 23 June 2016

Development Environment

To ease the development on Papyrus, each member of the team works with basically the same configuration.

One way to manage this is using the Eclipse Installer (by Oomph) to manage your Papyrus development workbench.

Papyrus Oomph Setup Model

The Eclipse Installer provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code. Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.

Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on. For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse. On the second page, expand Eclipse.org / Papyrus to see the various components that you can import to work on. Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like. In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform. This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).

Contributing your changes is easy because Oomph will clone the Papyrus Git repository for you and configure Gerrit push.

Amongst possibly other details, the setup model configures:

  • your IDE with all of the tools needed to edit and build the source projects you choose
  • your workspace with a Git clone and the source projects imported from it that you choose
  • a PDE target that includes all of the dependencies required by Papyrus plus the latest nightly build of Papyrus, itself, so that you can import only a subset of the (many) source projects but still run the complete Papyrus toolset in a run-time workbench
  • Mylyn queries for current open bugs and enhancements in the Papyrus bugzilla database
  • Mylyn queries for the status of the latest Papyrus automated builds, including tests
  • Mylyn queries for open Gerrit reviews
  • preferences enforcing the Papyrus standard compiler and code formatter/template settings

Please raise bugs if you see any problems in the setup configuration.

When you first launch the Eclipse Installer, it will show the default "simple mode" installer presentation:

Papyrus Oomph simple.png

You can choose to proceed from here, picking for example the "Eclipse IDE for Committers" package to install, which is the minimal configuration, and later using Oomph to import the Papyrus sources into the workspace (box 1 in the screenshot). However, you may as well select all of the Papyrus content that you need in your development environment now to set everything up in one go. To do that, switch to the "advanced mode": open the dialog tray by clicking on the button (box 2) and select "Advanced Mode..." (box 3). Now you should see the dialog reconfigured as shown below:

Papyrus Oomph page1.png

Again, the simplest option is to start with the "Eclipse IDE for Committers" package because the setup model will add everything else you need for working on Papyrus's various code and models.

On the second page, pick whatever Papyrus components you need to import into the workspace:

Papyrus Oomph page2.png

Note.png
Minimal Project Selection
Note that, at a minimum, you must select the top-level "Papyrus" project node for import, to get the correct tooling installed for working with the source and to bring the nightly builds into your PDE Target

.

If you need to work on and test the Papyrus setup model, itself, then you should also import the "Papyrus / Developer / Oomph Setup" project (selected in the screenshot above) to configure the workbench to load the Papyrus setup model from your Git checkout instead of from the central Git repository via HTTP.

Next, tell Oomph where to check out the Papyrus repository, where to install Eclipse, and where to create the workspace:

Papyrus Oomph page3.png

Note that exactly how this page looks will depend on the options you choose for how to manage installation and workspace locations, and whether you have previously used Oomph to install other Eclipse instances (I have).

Note also that if you do not see the target platform that you need in the 'Target Platform' pick-list (for example, Neon to start working on the Papyrus Neon branch that is the master at the time of this writing), then you can just type the name into the field.

The last page summarizes the steps that Oomph will follow to start the installation:

Papyrus Oomph page4.png

After the newly installed Eclipse instance starts up, it will complete the setup by performing the rest of the tasks that have to be done in the workspace that didn't exist initially. These include the git checkout, importing projects from the checkout into the workspace, creating working sets, Mylyn queries, and more. Once these steps have completed, you will be ready to start working on the Papyrus code.

If you used Oomph's "simple mode" to create your Eclipse workspace, or if you need to make changes to what Papyrus bits you have imported (even for setting up the set-up model redirection), you can do this at any time by launching the Oomph installer wizard from within the Eclipse workbench. Note that you will first have to make the Oomph setup actions available in the toolbar be enabling the preference:

Papyrus Oomph updater.png

This launches essentially the same wizard as the "advanced mode" of the Oomph Installer.

Common Environment

Following is a description of the basic configuration:

  • The latest Eclipse Modeling (Or Standard) release
  • EGit
  • [1] JAutoDoc
    • Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc
  • Java 1.6:
    • Eclipse Preferences -> Java -> Compiler
    • Eclipse Preferences -> Java -> Installed JREs
    • VM Arguments for debug mode:
-Dosgi.requiredJavaVersion=1.6 -Xms768m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=384m -XX:+CMSClassUnloadingEnabled

Required External Plugins

Papyrus may require some external plugins to compile.
The following page maintain a list of Papyrus Required External Plugins

Version Management Tooling

As of late February 2016 in the Neon development cycle, the Papyrus Main plug-ins and features and the Developer Tools are configured for PDE API Tooling and Oomph Version Management validation. One of the value-added capabilities of Oomph is flagging plug-ins and features that aren't included in any other feature, and thus appear to be slipping through a crack in the release. This only works when the workspace has all of the plug-in and feature projects of Papyrus imported.

If your workspace only has a subset of the Papyrus projects imported, then you can tell Oomph that this check is not appropriate by configuring the "check mode" in the Preferences:

Papyrus Oomph versionmgmt prefs.png

[Future] Maven Integration

The Hudson builds are currently implemented with Maven, using Tycho to build Eclipse-compatible artifacts. Therefore, all active plug-in and feature projects have Maven POM files describing them. There is a proposal under consideration to implement Maven Nature provided by M2Eclipse in the Papyrus source projects, to more closely align the Hudson build environment with the developer's local build environment in the Eclipse workbench.

An initial analysis of what would be involved in this change, both in terms of actually implementing the Maven Nature and its impact on Papyrus developers' daily workflow, is captured in this document:

Development Plan

Specifications

The specifications are available here: Luna plan

Contributing to the plan for the release

Getting the code

Cloning the Git repository and importing the code

The Papyrus code and some documents are located in a Git repository. In the website http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git).

Follow the next instructions if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace.

First, you have to clone the Papyrus repository. Open the Eclipse import wizard (“File” => “Import”), select “Git” => “Projects from Git” and click “Next”. Select “Clone URI” and click “Next”. Now you will have to enter the repository’s location and connection data. Entering the repository URI will automatically fill some fields. In the case of using the URI http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git, you will not have to fill any field. Complete any other required fields and hit “Next”.

The Git repository of Papyrus contains many different branches and you must select at least one. Select the branch “streams/1.1-maintenance” if you want to fix code bugs in the Mars version of the Papyrus plugins or “master” if you want to contribute with new features to the latest version of Papyrus called Neon. Click “Next” and select the storage location (e.g., “C:\git”) and the name of the initial branch (e.g., “streams/1.1-maintenance”).

Finally, follow the import projects wizard to select the plugins projects that you want to study or modify, and click “Finish”. You will see all those projects in your workspace.

See the Papyrus project developer resources page for more details

Note about compilable plugins

To know if a downloaded plugin should compile, you can have a look to a Papyrus installation. If the plugin comes with the installation, it should compile!

  • The following plugins are not distributed and could be closed (deprecated, not yet provided in the Papyrus distribution or for developpers only):
all plugins of the layer 'developer', except if you need to generate diagrams (in this case you should install GMF Tooling as well) 
oep.infra.emf.editor 
oep.infra.emf.embeddededitor 
oep.infra.emf.newchild 
oep.team.svn
  • Only the follwing projects are currently provided by the Papyrus extra-plugins update site. The others projects can be closed.(They are deprecated, not yet provided in the Papyrus distribution or for developpers only):
				
org.eclipse.papyrus.compare.report.ui
org.eclipse.papyrus.compare.report
org.eclipse.papyrus.diagramtemplate.edit
org.eclipse.papyrus.diagramtemplate.editor
org.eclipse.papyrus.diagramtemplate
org.eclipse.papyrus.eclipse.project.editors
org.eclipse.papyrus.infra.gmfdiag.css.configuration
org.eclipse.papyrus.infra.gmfdiag.css.properties
org.eclipse.papyrus.infra.gmfdiag.css.theme
org.eclipse.papyrus.infra.gmfdiag.css.xtext.ui
org.eclipse.papyrus.infra.gmfdiag.css.xtext
org.eclipse.papyrus.infra.gmfdiag.css
org.eclipse.papyrus.layout.algorithms.gridAlgorithm
org.eclipse.papyrus.layout.algorithms.horizontalAlgorithm
org.eclipse.papyrus.layout.algorithms.horizontalSymmetryAlgorithm
org.eclipse.papyrus.layout.algorithms.horizontalTreeAlgorithm
org.eclipse.papyrus.layout.algorithms.radialAlgorithm
org.eclipse.papyrus.layout.algorithms.springAlgorithm
org.eclipse.papyrus.layout.algorithms.treeAlgorithm
org.eclipse.papyrus.layout.algorithms.verticalAlgorithm
org.eclipse.papyrus.layout.algorithms.verticalSymmetryAlgorithm
org.eclipse.papyrus.layout.subeditor.gmf
org.eclipse.papyrus.layout
org.eclipse.papyrus.marte.properties
org.eclipse.papyrus.marte.static.profile
org.eclipse.papyrus.marte.vsl
org.eclipse.papyrus.migration.properties.model
org.eclipse.papyrus.uml.export
  • The tests plug-ins are located under tests/junit/plugins or tests/junit/extraplugins. Other test projects are not necessarily maintained


Retrieve configuration files

The Papyrus Code Templates and Java Formatter files are available under the Papyrus repository in the folder doc/DeveloperDocuments/templates/
FAQ How do I control the Java formatter
FAQ How can templates make me the fastest coder ever

The note explains how to install the templates in your environment.

Papyrus Architecture

Papyrus Requirements

Papyrus Generation

Papyrus Code Standards

  • Java Doc - every class, method and field including private ones should be documented with Java Doc
  • No abbreviations - the class, methods and variables should have meaningful names
  • Formatting - the code should be formatted in accordance with format templates
  • Always use brackets in conditions, loops, ...
  • Compile - the modified code and other plugins should be compilable. Be sure to use Java 1.5 code compatibility. Check other plugins that could be influenced before commiting!
  • Standard Java Rules coding - Unless specified differently, the Java Standard Coding rules should be applied: no abbreviations, variables starting with lower case; class and types with upper case; Composed name separated with upper case; no underscore in names; ...
  • In case of doubt - check existing code from those following the rules :-)

Papyrus Plug-ins and Features

See Papyrus code standards for plug-ins and features

Papyrus Coding guidelines

A few points may be a little tricky when coding for Papyrus. Among them:

Papyrus Plugin Naming Scheme and Folders Structure

Structure and behavior of papyrus

Papyrus Command Execution, History, Undo/Redo

Papyrus ServiceRegistry

The ServiceRegistry is one of the main Papyrus component. The idea is that each Papyrus feature should be a service registered to the ServiceRegistry.

The ServiceRegistry should be accessible from any code. It allows to retrieve the components you need to perform your task.
A new implementation of the ServiceRegistry is submitted. The new ServiceRegistry is discussed here Papyrus Developer Guide/Service Registry

Manage Decorators On Papyrus

Papyrus provide services in order To manage decoration on Edit Parts from graphical editor or on icons from model explorer. An application example are describe here: Manage Decorators On Papyrus

How To ...

Commit, Report Bugs, patchs (Code Contributing)

Commit, Report Bugs, patchs (Gerrit Contributing)

Model your papyrus development, and generate User doc

Papyrus Code Examples

Papyrus Log

Papyrus Editors

Currently Papyrus provides 2 editors kinds : Diagrams and Table. How to add your own editor kind is explained here Papyrus Developper Guide/How to - Add your own editor in Papyrus

JUnit Tests

Write Documentation for Papyrus

How to - Related to documentation Papyrus Developer Guide/Writing Documentation

Contribute to Papyrus release plan

How to - Related to release plan contribution Papyrus Developer Guide/Contributing To Release Plan

Papyrus Discovery

Papyrus additional components

To add extra features to the Papyrus Discover, you should edit the files located here: ssh://USER_ID@git.eclipse.org/gitroot/www.eclipse.org/papyrus.git

Papyrus as a Modeling component

Papyrus is available from the Modeling Package, using the discovery UI of this package. This contribution is made by the project located here: git://git.eclipse.org/gitroot/www.eclipse.org/modeling/amalgam.git,

the file is located in the folders discovery/downloads/RELEASE_NAME

Papyrus Table Developer Documentation

Papyrus Diagram Developer Documentation

Papyrus Embedded Editors Documentation

Papyrus Extraplugins Documentation

The following describe developer guide for papyrus extraplugins:

Papyrus Build Process

New plugin Submition Process

New plugin should follow the submition process describe here: Papyrus New Plugin Submission Process

Back to the top