Developer setup

Overview

• Setting up your Eclipse to start developing on jUCMNav is fairly straightforward but there are a few things to remember.
• This guide was initially written for Eclipse 3.0.1 and upgraded, some aspects may have changed as Eclipse evolves...
• We now need Eclipse 3.5 and above as a development environment.

Installing Eclipse and required plug-ins

Eclipse 3.7 Modeling Tools (Indigo)

• Download Eclipse 3.7 Modeling Tools (Indigo).
• Install "Web Tools Platform (WTP) 3.3.2" from the Eclipse update site: http://download.eclipse.org/webtools/repository/indigo/

Eclipse 3.5 Modeling Tools

• Download Eclipse 3.5 Modeling Tools.
• Install Web Tools Platform (WTP) from the Eclipse update site: http://download.eclipse.org/webtools/updates/

Eclipse 3.3

• Download Eclipse 3.3 from http://download.eclipse.org/eclipse/downloads/
• Install EMF 2.3 from the Eclipse update site or from http://www.eclipse.org/modeling/emf/downloads/
• Install GEF 3.3 from the Eclipse update site or from http://download.eclipse.org/tools/gef/downloads/
• Install UML2 2.1 from the Eclipse update site or from http://www.eclipse.org/modeling/mdt/downloads/?project=uml2
• Install OCL 1.1.2 from the Eclipse update site or from http://www.eclipse.org/modeling/mdt/downloads/?project=ocl
• Download WTP 2.0 from http://download.eclipse.org/webtools/downloads/
  • IMPORTANT: Alternatively, you can unzip the attached bundle zip file to your eclipse/plugins folder. It does not contain what is required to run Web services for dynamically feeding data to KPI values, but it allows to compile and run the tool.
  • You can also get this plug-in using its update site: http://download.eclipse.org/webtools/updates/
• Extract and copy any downloaded package (EMF, GEF, UML, OCL, and/or WTP) to the Eclipse folder

Setup from Subversion Server (SVN)

Install Subclipse

• Help -> Install New Software...
• Add Remote Site
  • Name: subclipse
  • URL: http://subclipse.tigris.org/update_1.6.x (or whatever is the latest from http://subclipse.tigris.org)
• Select all subclipse update site (others have been added) (Next)
• Select all features (Next)
• Accept the terms (Next)
• Finish

Checkout the code

Checkout takes the code from the repository and saves it on your machine.

• Window -> Show View -> Other -> SVN -> SVN Repository
• Right click in SVN Repository view -> New -> Repository Location
• Location Url: svn://cserg0.site.uottawa.ca/projetseg/
• Authentication user/password: given by Jacques Sincennes
• svn://cserg0.site.uottawa.ca/projetseg/ -> trunk -> seg.jUCMNav (right click) -> Checkout as project

Setup project properties

Eclipse 3.1.1 and above

By default, Eclipse 3.1 should be configured properly but more recent versions use JDK 1.5 or 1.6 by default, whereas we use JDK 1.4 compatibility. Follow the following steps.

• Right-click on the seg.jUCMNav project you just created, choose properties.
• Choose Java Compiler
• Check Enable Project Specific Settings
• Put the JDK compliance to 1.4 as in the following screenshot.
• Accept this and give Eclipse a while to rebuild the solution.

Run/Debug/Test jUCMNav

• Developers should always have assertions enabled when running jUCMNav as our commands are built to catch bugs using assertions.
• In the Debug or Run configuration preferences (accessible by right-clicking on the project name), select Run-time workbench as the configuration used to run jUCMNav. Create a new configuration (jUCMNav) if necessary. In Eclipse 3.1 and above, run-time workbench was renamed to Eclipse Application.
• Make sure you have the -ea Java Virtual Machine attribute set.
• jUCMnav: Runtime workbench settings
• 

• To test jUCMNav, create a new JUnit Plug-in Test for the test class seg.jUCMNav.tests.TestAllTestSuite and don't forget the -ea JVM attribute!
• jUCMnav: TestAllTestSuite settings (1):
• Note: if you are using Eclipse 3.5, make sure "Run in UI thread" in the Test tab has checked. Otherwise the tests will fail.
  

Last thing, coding standards

• Please review Dev Doc Coding Standards before starting to program.

-- Jason Kealey - 08 Jul 2005