Revision as of 07:07, 27 July 2011

Graphiti - a Graphical Tooling Infrastructure

This page contains useful information for developers working on the Graphiti framework itself. Users of the framework (building Graphiti-based tools) should rather have a look onto our Eclipse page at http://www.eclipse.org/graphiti.

Central Build

Build Job

Our central Hudson build job can be found here. Graphiti uses Buckminster for its automated build and test run. See here for a detailed description of the Graphiti build process.

Coding

API Tooling

We use the Eclipse API tooling to fulfill Eclipse version number and API stability requirements. You have to define an API baseline if you are working on the Graphiti releases 0.8.x (service releases only) and beyond. For service releases use the same version as baseline (e.g. 0.8.0 for Indigo SR1) otherwise the last major release (e.g. 0.8.0 for Juno developement).

Coding Conventions

We use the standard Eclipse formatter for our coding with just one exceptional setting: the maximum line width is changed to 120. This setting can be found in the Eclipse preferences under 'Java -> Code Style -> Formatter' by editing the 'Eclipse [built-in]' profile on tab 'Line Wrapping': set the 'Maximum Line Width' in Section 'General settings' to 120.

To be sure that the formatter is really used for all your changes define your save actions (Eclipe preferences under 'Java -> Editor -> Save Actions') to include 'Format source code' with 'Format edited lines' only. Also enable the 'Organize imports' action on this page to get an automated clean-up of the import statements.

Repository

The source code of Graphiti is publicly available from the Eclipse Git repository. A general page on Git at Eclipse.org can be found here. If you just want to browse the source code without checking out all the projects, you can use this link for the web access to the Eclipse Git repository for Graphiti.

Git Anonymous Access

Please set up the following Eclipse Git repository location: <protocol>://git.eclipse.org/gitroot/gmp/org.eclipse.gmp.graphiti.git, where <protocol> is one of git, ssh, http or https dependending on what your your network infrastructure allows.

Committer Git Access

Same details as anonymous access, using git, ssh or https as protocol and specific username/password as assigned by Eclipse. Eclipse Git repository location is <protocol>://<Eclipse dev user name>@git.eclipse.org/gitroot/gmp/org.eclipse.gmp.graphiti.git

Here are the steps to set up EGit in Eclipse:

1. Set environment variable HOME to define the folder where Git will clone repositories to, e.g. "C:\Users\<windows user name>\.git"
2. Import Git repository:
   • Supported protocols for cloning are git, ssh, http and https
   • From behind a firewall http and https will work
   • Recommendation is to use ssh (no firewall) or https (in case of a firewall)
     
3. Open Windows --> Preferences --> Team --> Git --> Configuration and set the following user setting in the .gitconfig file in your HOME directory
   • user.name <Eclipse dev user name>
   • user.email <Email adress registered for Eclipse dev user>

Working on Bugzillas (Contributions and Commiting)

This is what you should do to fully complete a Bugzilla:

• Of course, fix the bug or provide the enhancement
• Create a JUnit test testing the change and add it to one of the Graphiti test suites
  • Prefered tests are the pure JUnit tests, if not possible also adding to the SWTBot test suite (as JUnit Plugin or real SWTBot test) is ok as well
  • It should be green, of course ;-)
• All other tests contained in all the test suites should still pass
• Check for any warnings in your coding and fix them if possible
• Provide some kind of raw documentation for your change, this may be directly in the Bugzilla, in the JavaDoc, on this Wiki page or in the online help (e.g. in the tutorial)
  • Bugs will need very little documentation, while functional enhancements will need more attention

Installation

As development IDE you should use the newest Eclipse installation of your choice, at the time this was written the newest Eclipse version was 3.7 (Indigo). You will need SWTBot in your developement IDE to be able to run the Graphiti SWTBot-based UI tests. Also you will need to add Buckminster (version 3.7 at the time this was written) to your installation. For more details see the Getting Started Guide.

Basically you will need the same installation for your target platform as well, but it needs to contain EMF SDK, EMF Transactions SDK and GEF SDK (see getting started guide). Buckminster is not needed here, but SWTBot is. Additionally you will need to install GMF runtime (it hosts some vector support functionality we use from export.batik plugin that you have to collect individually otherwise).

Mailing List

The Graphiti developer mailing list allows to follow and participate in discussions on the Graphiti framework. You can subscribe here.