dezgeg / tmc-eclipse Goto Github PK

#TMC-Eclipse project

####Master

======= ####DEV

TMC-Eclipse project is a University of Helsinki Department of Computer Science project for porting the Netbeans TestMyCode plugin to the Eclipse IDE.

##Project structure The project consists of two discrete components: a TestMyCode plugin core and a TestMyCode Eclipse plugin.

###TestMyCode core The plugin core is a Java Maven project that contains the platform independent parts of the project. It interfaces with other TestMyCode components like the server and the test runner.

###TestMyCode Eclipse plugin The Eclipse plugin is an Ant project that binds the core to the Eclipse IDE allowing users to retrieve, complete, test and return exercises for courses utilizing the testMyCode enviroment.

The plugin component supports both Eclipse 4.3 (Kepler) and Eclipse 4.4 (Luna).

###TestMyCode Eclipse feature This part of the project describes the TMC plugin "feature" for usage by the update site. In general, features describe customer level artifacts. In our case, the only such artifact is the TMC Eclipse plugin.

###TestMyCode Eclipse update site The update site is a website that faciliates to use the Eclipse's "Install new software" feature and updating of installing plugins. For usage, see

##Building the project To build the project, follow the following process:

1. Clone this repository
2. Run the "clean" and "verify" Maven goals for the core component ("plugin-core")
3. Open the Eclipse IDE
4. Make sure you have the following components installed from the marketplace:

• m2e - Provides the required Maven support to the Eclipse IDE
• CDT - C and C++ development tools for Eclipse IDE
• PDE - Plug-in Development Environment for Eclipse IDE
• Mylyn - Provides the notification elements

5. Restart the IDE if you had to install any of the above components
6. Import the Eclipse plugin component ("eclipse-plugin") using the "General > Existing Projects into Workspace" settings
7. Import the plugin core component using the "Maven > Existing Maven Projects" settings

This allows you to run the project as "Eclipse Application" to run an instance of Eclipse with the plugin within the Eclipse instance you are developing on.

The plugin component utilizes the core component via a shaded .jar file that must be present in the plugin's /lib folder. When running the "verify" Maven goal for the core a shaded .jar will be built and moved to the plugin components /lib folder. For this reason, you must run the "clean verify" goals for any changes in the core to be visible within the plugin. Changes that only affect the plugin component's code do not require running the "clean verify" goal.

###Manually building a plugin .jar To manually build the plugin .jar, right click the Eclipse plugin component from the project browser and Export it using "Deployable plug-ins and fragments" settings

To use the built plugin, place it in the /plugins folder within your eclipse installation.

###Updating the update site

1. Import the TestMyCode Plugin update site using "General > Existing Projects into Workspace" settings.
2. Open site.xml in Eclipse. Select the "Site Map" view tab if it not automatically open.
3. Re-add current feature.
4. Click "Build all".
5. Replace the current update site (on your server) with the contents of your local "update site" folder.

##Using the plugin ###Installation

####Installation using the update site

1. Start Eclipse.
2. Open the "Help | Install new software..." window.
3. Click "Add"
4. Insert the details of the update site (Demo at http://cs.loezi.fi/tmc)
5. Check "TestMyCode_Eclipse from the "TestMyCodeEclipse Plugin" category.
6. Click Next a few times to complete the installation.
7. If warned about unsigned content, allow the installation.
8. Restart Eclipse when installation if complete.

####Manual installation

1. Move the plugin's .jar file to the /plugins folder within your Eclipse folder.
2. Start Eclipse
3. Make sure you have the following plugin components installed:

• m2e - Provides the required Maven support to the Eclipse IDE
• CDT - C and C++ development tools for Eclipse IDE
• PDE - Plug-in Development Environment for Eclipse IDE
• Mylyn - Provides the notification elements

4. Restart the IDE if you had to install any of the above components

####Updating the plugin using the update site

1. Follow the steps in "Installation using the update site". Eclipse will detect the plugin as installed and perform an update instead.

ALTERNATIVELY

1. Open the "Help | Check for updates" window
2. Select "TestMyCode_Eclipse"
3. Click next a couple of times, accept the license and allow the unsigned content.
4. Restart Eclipse.

###Using the plugin See the instructions for using the Netbeans version.

##Credits

TMC-Eclipse team:

Developers

• Juhani Heliö (jphelio)
• Ville-Pekka Hämäläinen (veepee)
• Nikke Kostiainen (nkostiai)
• Erkka Kääriä (valtis)
• Leo Leppänen (ljleppan)
• Joel Nummelin (numppa)

Instructor

• Jarmo Isotalo (jamox)

Client

• Arto Vihavainen (avihavai)