Difference between revisions of "Papyrus/Papyrus Developer Guide"

Revision as of 12:05, 25 January 2018

Developer Charter

This is the charter that all papyrus contrubitor must respect.Papyrus Contributor charter

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.

Follow this link for a step by step installation guide.

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.8:
  • Eclipse Preferences -> Java -> Compiler
  • Eclipse Preferences -> Java -> Installed JREs
  • VM Arguments for debug mode:

-Dosgi.requiredJavaVersion=1.8 -Xms768m -Xmx1024m -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

Oomph includes a way to manage the version changes between two releases as illustrated here

[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:

• Adopting Maven Nature in the Papyrus source projects

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

Retrieve configuration files

The Papyrus Code Templates, Java Cleanup and Java Formatter files are available under the Papyrus repository in the folder releng/templates/ and should be used for all your development on Papyrus.

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

• Dependencies to Eclipse components

• Papyrus architecture is explained here: Papyrus Architecture

Papyrus Requirements

• This topic contains all Papyrus Requirements .

Papyrus Generation

• Papyrus generation mechanism is explained here: Papyrus Developer Guide/Papyrus diagram 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 :-)

String Externalization/Internalization

• the goal of the externalization process is to distinguish the string used as messages and visible by the final user and the string required in your code, but not visible for the user,

Follow this link for a guide on externalization in Eclipse.

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

• Papyrus plugins naming scheme and folder structure used to locate and name plugins is described here: Papyrus_Plugin_Naming_Scheme

Structure and behavior of papyrus

• Presentation of the papyrus structure and the behavior of some parts Papyrus Developer Guide/Papyrus Structure Behavior

Papyrus Command Execution, History, Undo/Redo

• This first document describes the usage of editing domains and gmf/gef/emf commands. See this detailed article Papyrus Developer Guide/Editing Domains and Commands.

• 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://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:
    • http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.di
    • http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.notation
    • http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.uml

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)

• 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

• How to - Related to Papyrus code,Papyrus Developer Guide/How To Code Examples
  

Papyrus Log

• Papyrus Log is explained here Papyrus Developer Guide/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

• 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

Rcptt Tests

Rcptt is under evaluation but a developer guide can be find here.

Write Documentation for Papyrus

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

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

• 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

New plugin Submition Process

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

Release Engineering

Release Plans

The specifications are available here:

• Oxygen release plan
• Photon release plan

Contributing to the plan for the release

• Contribute to the Release Plan
• Create a Contribution Questionaire

Release Process

• How to release Papyrus.
• Releng Documentation.
• Release Standard Operating Procedure.

API Evolution

• Papyrus API Evolution Reports: Papyrus Developer Guide/API Evolution Reports

Hudson Instance

• Papyrus Hipp standard guide: Papyrus Developer Guide/How to use the Hipp and its functionalities.