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

APP4MC/devinfo

Setup of IDE

APP4MC supports the Eclipse Installer provided by Ooomph to install and setup the development environment. Getting started can be found here. Please follow these steps to install an Eclipse IDE for APP4MC development:

  1. Save the following setup files locally:
  2. Download an Eclipse installer for your operating system from here if you do not already have one installed.
  3. Start the installer
  4. Select a product (e.g. Eclipse IDE for Java Developers, Eclipse IDE for Eclipse Committers or Eclipse for RCP and RAP Developers)
  5. Select the Latest Release, a Java VM and the installation folder
  6. Switch to the Advanced Mode by opening the menu on the upper right corner

Oomph advanced mode.png

  1. Click Next to approve the product selection
  2. In the Projects selection page click on the + sign to add a new User Project
  3. Select Eclipse Projects in the combobox
  4. Click Browse File System... and select the downloaded .setup file
  5. Select the newly added APP4MC Development or APP4MC Model Migration entry

Oomph app4mc.png

  1. Click Next
  2. You can keep the default settings or modify for example the installation folders (possibly you need to enable Show all variables at the bottom left to be able to modify the default settings)
  3. Click Next
  4. Click Finish and wait until the installation is done

After the Eclipse IDE opens and the setup tasks are done, you should see the imported projects in the Package Explorer. If you see a lot of errors in the projects, the target definition could not be resolved. In that case open the target definition file

  • org.eclipse.app4mc.target/org.eclipse.app4mc.target.target
  • org.eclipse.app4mc.converters.target/org.eclipse.app4mc.converters.target)

wait until it is resolved and once it is successfully resolved click Set as Active Target Platform.

Alternatively you can manually download an Eclipse IDE or use an existing installation. In that case you need to

Development Information

Contains general technical information related to developers, who are interested to contribute to the APP4MC project or wants to use it as a basis for their own tooling.

An overview about the existing repositories and links to the Bug tracker can be found under https://projects.eclipse.org/projects/technology.app4mc/developer

Repository structure

The APP4MC Platform Tools repository is http://git.eclipse.org/c/app4mc/org.eclipse.app4mc.git The APP4MC Model Migration repository is http://git.eclipse.org/c/app4mc/org.eclipse.app4mc.addon.migration.git

The code is structured in the following folders:

examples/
all Examples that can be manipulated or viewed using the AMALTHEA Tool Platform
features/
all Eclipse feature projects
plugins/
all Eclipse plug-in projects
releng/
all build related projects like product and target definition
tests/
all Eclipse test plug-in and fragment projects

Building the product

The APP4MC build is based on Maven Tycho pom-less builds in structured environments. The parent pom.xml is located in the repository root folder. A local build can be triggered via mvn clean verify from the repository root in your local file system. After successful build the products for different platforms can be found under releng/org.eclipse.app4mc.platform.product/target/products

Add new modules

As pom-less builds are used, it is not necessary to add a pom.xml for a new plugin, feature or test. Only if a custom build step is needed, a pom.xml needs to be created and linked to the parent pom file. As some modules are currently excluded from the build you need to check if there is a pom.tycho file located in the folder where the new project is created. If such a file exists you need to add the new project to the list of projects in that file in order to get it included to the build.

UI Tests

The UI tests are currently deactivated. The following information is still valid but some tests are outdated.

The APP4MC/AMALTHEA platform uses the RCPTT for UI tests. General project site including documentation: https://www.eclipse.org/rcptt/. Basic tutorial and introduction: http://eclipsesource.com/blogs/tutorials/rcp-testing-tool-rcptt-basic-tutorial/

Existing Project

The general project including the UI tests is located in the repository in the project tests/org.eclipse.app4mc.rcptt

This project includes the following folder structure:

contexts
Includes several basic context definition to perform the tests. This includes the setup like the opened perspective or the content of the workbench, including projects if needed.
tests
The test definitions to run.
editor: Tests related to the basic AMALTHEA editor.
examples: Tests related to the provided samples.
wizard: Tests related to the model wizard.
verifications
Additional verifications for the test runs. Currently it includes several timing restrictions for the tests.

New test definitions should be included in the tests folder in a dedicated sub-folder! The pom.xml includes already a setup to run all the tests with maven. 

The UI tests must run at the end of the build as it relies on the build target!

Build Infrastructure

APP4MC uses Jenkins as a Continuous Integration build server, which is available under https://ci.eclipse.org/app4mc/. There following list gives an overview about the existing main jobs:

Retrieved from "https://wiki.eclipse.org/index.php?title=APP4MC/devinfo&oldid=442383"

This page was last modified 08:32, 22 February 2021 by Dirk Fauth. Based on work by Harald Mackamul and Daniel Kunz.

Copyright © Eclipse Foundation, Inc. All Rights Reserved.