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.
Difference between revisions of "APP4MC/devinfo"
< APP4MC
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | |||
== Setup of IDE == | == Setup of IDE == | ||
| − | APP4MC | + | APP4MC supports the Eclipse Installer provided by [https://projects.eclipse.org/projects/tools.oomph Ooomph] to install and setup the development environment. Getting started can be found [https://wiki.eclipse.org/Eclipse_Installer here]. |
| − | Please follow | + | Please follow these steps to install an Eclipse IDE for APP4MC development: |
| − | # Save the following | + | # Save the following setup files locally: |
| − | # Select '''Eclipse IDE for Java Developers''' | + | #* APP4MC Tool Platform - http://git.eclipse.org/c/app4mc/org.eclipse.app4mc.git/plain/releng/org.eclipse.app4mc.ide.setup/APP4MC-Development-IDE-latest.setup?h=develop |
| − | # | + | #* APP4MC Model Migration - http://git.eclipse.org/c/app4mc/org.eclipse.app4mc.addon.migration.git/plain/releng/org.eclipse.app4mc.ide.setup/APP4MCModelMigrationDevelopmentEnvironment.setup?h=develop |
| − | # Select ''Browse File System...'' and | + | # Download an Eclipse installer for your operating system from here if you do not already have one installed. |
| − | # | + | # Start the installer |
| − | # | + | # Select a product (e.g. '''Eclipse IDE for Java Developers''', '''Eclipse IDE for Eclipse Committers''' or '''Eclipse for RCP and RAP Developers''') |
| + | # Select the '''Latest Release''', a Java VM and the installation folder | ||
| + | # Switch to the '''Advanced Mode''' by opening the menu on the upper right corner | ||
| + | [[File:oomph_advanced_mode.png|700px]] | ||
| + | # Click '''Next''' to approve the product selection | ||
| + | # In the Projects selection page click on the + sign to add a new User Project | ||
| + | # Select ''Eclipse Projects'' in the combobox | ||
| + | # Click ''Browse File System...'' and select the downloaded .setup file | ||
| + | # Select the newly added '''APP4MC Development''' or '''APP4MC Model Migration''' entry | ||
| + | [[File:oomph_app4mc.png|700px]] | ||
| + | # Click ''Next'' | ||
| + | # 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) | ||
| + | # Click ''Next'' | ||
| + | # 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 | ||
| + | * install e(fx)clipse into your IDE (needed for various model visualizations), e.g. via the latest update site https://download.eclipse.org/efxclipse/updates-released/3.6.0/site/ | ||
| + | * install and configure a JavaFX SDK | ||
| + | * manually clone the APP4MC repos and import the projects to your workspace | ||
== Development Information == | == Development Information == | ||
| Line 18: | Line 41: | ||
=== Repository structure === | === Repository structure === | ||
| − | The | + | The APP4MC Platform Tools repository is http://git.eclipse.org/c/app4mc/org.eclipse.app4mc.git |
| − | The | + | 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: |
| − | :all | + | |
| + | ;examples/ | ||
| + | :all Examples that can be manipulated or viewed using the AMALTHEA Tool Platform | ||
;features/ | ;features/ | ||
:all Eclipse feature projects | :all Eclipse feature projects | ||
;plugins/ | ;plugins/ | ||
:all Eclipse plug-in projects | :all Eclipse plug-in projects | ||
| + | ;releng/ | ||
| + | :all build related projects like product and target definition | ||
;tests/ | ;tests/ | ||
:all Eclipse test plug-in and fragment projects | :all Eclipse test plug-in and fragment projects | ||
| − | |||
| − | |||
=== Building the product === | === Building the product === | ||
| − | + | The APP4MC build is based on [http://blog.vogella.com/2019/11/25/pom-less-tycho-enhanced/ 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''' | |
| − | + | ||
| − | + | ||
| − | After successful build the products for | + | |
=== Add new modules === | === 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 === | |
| − | + | <div style="color:red; text-align:center"> | |
| − | + | '''The UI tests are currently deactivated.''' The following information is still valid but some tests are outdated. | |
| − | + | </div> | |
| − | + | 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/ | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | The APP4MC/AMALTHEA | + | |
==== Existing Project ==== | ==== Existing Project ==== | ||
| − | The general project | + | The general project including the UI tests is located in the repository in the project [http://git.eclipse.org/c/app4mc/org.eclipse.app4mc.git/tree/tests/org.eclipse.app4mc.rcptt tests/org.eclipse.app4mc.rcptt] |
| − | + | ||
This project includes the following folder structure: | This project includes the following folder structure: | ||
| Line 115: | Line 98: | ||
APP4MC uses Jenkins as a Continuous Integration build server, which is available under https://ci.eclipse.org/app4mc/. | 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: | There following list gives an overview about the existing main jobs: | ||
| − | * [https://ci.eclipse.org/app4mc/job/build-and-publish-website/ build-and-publish-website]: Manual triggered job to build the | + | * [https://ci.eclipse.org/app4mc/job/build-and-publish-website/ build-and-publish-website]: Manual triggered job to build the [https://www.eclipse.org/app4mc Eclipse APP4MC web site] (by open-source static site generator [https://gohugo.io Hugo]). |
| − | * [https://ci.eclipse.org/app4mc/job/build-master-release/ build-master-release]: Job to build and distribute release based on master branch. Release is copied only if proper tag is set. Must be started manually. | + | * [https://ci.eclipse.org/app4mc/job/build-master-release/ build-master-release]: Job to build and distribute a release based on the master branch. Release is copied only if proper tag is set. Must be started manually. |
| − | * [https://ci.eclipse.org/app4mc/job/build-src-branches-pipes/ build-src-branches-pipes]: Job to build all user related branches(**/feature/*, **/hotfix*, **/release*). Triggered by time every | + | * [https://ci.eclipse.org/app4mc/job/build-src-branches-pipes/ build-src-branches-pipes]: Job to build all user related branches(**/feature/*, **/hotfix*, **/release*). Triggered by time every 15 min, not by event. This job uses [https://jenkins.io/solutions/pipeline/ Jenkins pipeline], which is configured in the [http://git.eclipse.org/c/app4mc/org.eclipse.app4mc.git/tree/Jenkinsfile?h=develop Jenkinsfile] available in the root of the repository. |
| − | * [https://ci.eclipse.org/app4mc/job/build-src-develop/ build-src-develop]: Job to build the develop branch. Triggered by time every | + | * [https://ci.eclipse.org/app4mc/job/build-src-develop/ build-src-develop]: Job to build the develop branch. Triggered by time every 15 min, not by event. |
* [https://ci.eclipse.org/app4mc/job/build-src-develop-nightly/ build-src-develop-nightly]: Dedicated nightly job for develop branch. | * [https://ci.eclipse.org/app4mc/job/build-src-develop-nightly/ build-src-develop-nightly]: Dedicated nightly job for develop branch. | ||
* [https://ci.eclipse.org/app4mc/job/build-src-gerrit/ build-src-gerrit]: Job to build patches for gerrit. Triggered by Gerrit events. | * [https://ci.eclipse.org/app4mc/job/build-src-gerrit/ build-src-gerrit]: Job to build patches for gerrit. Triggered by Gerrit events. | ||
Latest revision as of 08:32, 22 February 2021
Contents
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:
- Save the following setup files locally:
- APP4MC Tool Platform - http://git.eclipse.org/c/app4mc/org.eclipse.app4mc.git/plain/releng/org.eclipse.app4mc.ide.setup/APP4MC-Development-IDE-latest.setup?h=develop
- APP4MC Model Migration - http://git.eclipse.org/c/app4mc/org.eclipse.app4mc.addon.migration.git/plain/releng/org.eclipse.app4mc.ide.setup/APP4MCModelMigrationDevelopmentEnvironment.setup?h=develop
- Download an Eclipse installer for your operating system from here if you do not already have one installed.
- Start the installer
- Select a product (e.g. Eclipse IDE for Java Developers, Eclipse IDE for Eclipse Committers or Eclipse for RCP and RAP Developers)
- Select the Latest Release, a Java VM and the installation folder
- Switch to the Advanced Mode by opening the menu on the upper right corner
- Click Next to approve the product selection
- In the Projects selection page click on the + sign to add a new User Project
- Select Eclipse Projects in the combobox
- Click Browse File System... and select the downloaded .setup file
- Select the newly added APP4MC Development or APP4MC Model Migration entry
- Click Next
- 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)
- Click Next
- 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
- install e(fx)clipse into your IDE (needed for various model visualizations), e.g. via the latest update site https://download.eclipse.org/efxclipse/updates-released/3.6.0/site/
- install and configure a JavaFX SDK
- manually clone the APP4MC repos and import the projects to your workspace
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:
- build-and-publish-website: Manual triggered job to build the Eclipse APP4MC web site (by open-source static site generator Hugo).
- build-master-release: Job to build and distribute a release based on the master branch. Release is copied only if proper tag is set. Must be started manually.
- build-src-branches-pipes: Job to build all user related branches(**/feature/*, **/hotfix*, **/release*). Triggered by time every 15 min, not by event. This job uses Jenkins pipeline, which is configured in the Jenkinsfile available in the root of the repository.
- build-src-develop: Job to build the develop branch. Triggered by time every 15 min, not by event.
- build-src-develop-nightly: Dedicated nightly job for develop branch.
- build-src-gerrit: Job to build patches for gerrit. Triggered by Gerrit events.