Skip to main content
Jump to: navigation, search

Difference between revisions of "Capra"

(Created Wiki page for the Capra project)
 
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Capra is a configurable and extendable traceability management tool based on EMF. It is created in the context of an ITEA funded project called AMALTHEA4Public whose main aim is to develop a platform that will improve the development of embedded multicore and many core systems.
+
Eclipse Capra is a configurable and extendable traceability management tool based on EMF. It is created in the context of an ITEA funded project called AMALTHEA4Public whose main aim is to develop a platform that will improve the development of embedded multicore and many core systems.
  
 
The project website can be found [https://projects.eclipse.org/projects/modeling.capra here].
 
The project website can be found [https://projects.eclipse.org/projects/modeling.capra here].
Line 5: Line 5:
 
= How it works =
 
= How it works =
  
Capra uses the Eclipse Modelling Framework (EMF) as its base technology and stores the traceability model as an EMF model. Out of the box, it provides a number of artifact handlers that allow using, e.g., Papyrus UML models, Java methods, C functions, or Hudson builds as sources and targets for traceability links. New traceability links can be created with drag and drop and changes to the artifacts that affect the traceability links are shown in the Problems view.
+
Eclipse Capra uses the Eclipse Modelling Framework (EMF) as its base technology and stores the traceability model as an EMF model. Out of the box, it provides a number of artifact handlers that allow using, e.g., Papyrus UML models, Java methods, C functions, or Hudson builds as sources and targets for traceability links. New traceability links can be created with drag and drop and changes to the artifacts that affect the traceability links are shown in the Problems view.
  
The traceability metamodel is not fixed and can be defined by the user. It relies on the Eclipse Extension mechanism and provides an extension point for artifacts types to be supported. To add a new type of artifact, one simply needs to add an extension to this extension point and implement the provided interfaces.
+
The traceability metamodel is not fixed and can be defined by the user. It relies on the Eclipse extension mechanism and provides an extension point for artifacts types to be supported. To add a new type of artifact, one simply needs to add an extension to this extension point and implement the provided interfaces.
  
 
= Getting Started =
 
= Getting Started =
Line 13: Line 13:
 
== Installing Capra from the Update Site ==
 
== Installing Capra from the Update Site ==
  
An update site with nightly builds of the current development branch of Capra is available [https://hudson.eclipse.org/capra/job/build-src-develop-nightly/lastSuccessfulBuild/artifact/org.eclipse.capra.releng.p2/target/repository/ here]. Use the update site to install Capra through Eclipse's "Install Software..." functionality.
+
Update sites with nightly builds, milestones and releases are available at [http://download.eclipse.org/capra/].
 +
An update site with nightly builds of the current development branch of Eclipse Capra is available [https://download.eclipse.org/capra/nightlies/latest/ here]. Use one of the update sites to install Capra through Eclipse's "Install Software..." functionality.
  
 
== Installing Capra from Sourcecode ==
 
== Installing Capra from Sourcecode ==
  
=== Pre-requisites ===
+
Please make sure that JDK 8 is installed. You can use the version from [https://adoptopenjdk.net/ AdoptOpenJDK]. It is very important that both the Eclipse installation in which the development is done as well as Maven actually use Java 1.8 since source code compatibility is not ensured when using later JDKs/JREs in 1.8-mode! In Eclipse, JRE 8 has to be activated and JAVA_HOME should point to JDK 8 for Maven!
  
Before downloading and using Capra, download Eclipse Modelling Environment and make sure you have the listed dependencies installed.
+
=== Using the Eclipse Installer ===
  
* [https://wiki.eclipse.org/Xcore Xcore]: Install through Eclipse's "Install new software..." feature
+
The easiest way to get up and running with Eclipse Capra is to use the [https://wiki.eclipse.org/Eclipse_Installer Eclipse Installer]. It lets you select which version of Eclipse to download and sets up everything you need to run and develop Eclipse Capra automatically. Here's how to use it:
* [https://eclipse.org/xtend/ Xtend]: Install through the Eclipse Market Place
+
  
=== Get the source code ===
+
# Download the [https://wiki.eclipse.org/Eclipse_Installer Eclipse Installer].
 +
# Open the Eclipse Installer. In the menu in the top-right corner, select the advanced mode.
 +
# Select the "Eclipse for Eclipse Committers" package from the list. In the selection for "Product Version" below the list, select your favorite version of Eclipse (at least Neon) and JRE 8 as the runtime environment. Click "Next".
 +
# In the list of Eclipse projects, select "Eclipse Capra". Make sure the checkbox in front of Eclipse Capra is checked and click "Next".
 +
# In the next step, you get to select some variables. Most of these can remain on their default, but you have to select the  correct target platform for the Eclipse product version you selected earlier. You might also want to provide credentials for your Eclipse account here to ensure that the git repository and the connections to Bugzilla and Gerrit are set up correctly. Change other variables such as installation and workspace location at your own discretion. Click "Next."
 +
# The Eclipse Installer will now download the packages for your chosen Eclipse product version. You might have to agree to some licenses. After that, it will automatically start the Eclipse IDE it just installed and start setting up the development environment. That includes cloning the git repository, setting up connections to Bugzilla and Gerrit, and setting the target platform. This might take a while, but after all is said and done, you are all set!
 +
 
 +
=== Manual installation of the Eclipse development environment for Capra  ===
 +
 
 +
Before downloading and using Eclipse Capra, download the [https://www.eclipse.org/downloads/packages/ Eclipse Modelling Environment]. All dependencies will be downloaded automatically when Eclipse Capra is installed. In particular, parts of [https://eclipse.org/papyrus/ Papyrus], the [https://www.eclipse.org/jdt Java Development Tools], the [https://www.eclipse.org/cdt/ C/C++ Development Tools], [https://wiki.eclipse.org/Xcore Xcore], and [https://eclipse.org/xtend/ Xtend] will be installed.
 +
 
 +
=== Get the source code manually ===
  
 
* Open your Eclipse Environment
 
* Open your Eclipse Environment
 
* Go to File --> Import and select Git --> Projects from Git
 
* Go to File --> Import and select Git --> Projects from Git
* Use the [https://git.eclipse.org/r/capra/org.eclipse.capra Capra Git repository] and import all available projects to your workspace. Information about the developer resources and the source code repositories is available at [https://projects.eclipse.org/projects/modeling.capra/developer the project website].
+
* Clone the [https://git.eclipse.org/c/capra/org.eclipse.capra Eclipse Capra Git repository] and import all available projects to your workspace. Information about the developer resources and the source code repositories is available at [https://projects.eclipse.org/projects/modeling.capra/developer the project website].
* All dependencies are listed in the target platform file org.eclipse.capra.releng.target/org.eclipse.capra.releng.target.target. Set it as the active target platform by opening it and clicking on "Set as Target Platform" in the upper right corner. Eclipse will now download all dependencies. Note that this will take a while. Check the progress in the lower right corner.
+
* Make sure to switch to the <code>develop</code> branch if you want to use the current version of Eclipse Capra
 +
* To make sure Eclipse can resolve all dependencies, set the correct target platform file for your version of Eclipse. All target platform files can be found in <code>releng/org.eclipse.capra.releng.target</code>. Open the correct file and set it as the active target platform by opening it and clicking on "Set as Target Platform" in the upper right corner. Eclipse will now download all dependencies. Note that this will take a while. Check the progress in the lower right corner.
 
* Build your workspace
 
* Build your workspace
 
* Make sure that all the projects have no errors.
 
* Make sure that all the projects have no errors.
Line 35: Line 47:
 
If compilation errors occur during the first build, check if any of the dependencies above are missing. Cleaning all binaries also often helps resolve issues.
 
If compilation errors occur during the first build, check if any of the dependencies above are missing. Cleaning all binaries also often helps resolve issues.
  
=== Run Capra ===
+
=== Start Capra ===
  
 
* Make sure that all the projects have no errors.
 
* Make sure that all the projects have no errors.
Line 43: Line 55:
 
* Once the new workspace opens, create or import projects that you want to  use to create traceability links
 
* Once the new workspace opens, create or import projects that you want to  use to create traceability links
 
* Go to perspectives and switch to the Capra perspective
 
* Go to perspectives and switch to the Capra perspective
* Follow [https://www.dropbox.com/s/9p76ebqvax16uc1/HVAC-Capra%20Incomplete1.mov?dl=0 this video] to create and visualize traceability links
+
* Follow [https://youtu.be/XRtLs5OT_yM this video] to create and visualize traceability links.
**NOTE:** For better resolution, download the video first.
+
 
 +
== Install Graphviz ==
 +
 
 +
In order to use the trace link visualisation based on PlantUML, <code>graphviz</code> needs to be installed on the system. If it cannot be found, the Capra PlantUML viewer will display an error message. Please follow the [https://graphviz.gitlab.io/download/ installation instructions] on the Graphviz website to install the tool in your system.
 +
 
 +
= Customizing Capra =
 +
 
 +
Eclipse Capra has been designed for extensibility and configurability. Many aspects of Capra can be changed by implementing a new plugin and registering it to the right extension points. This includes which artifacts Eclipse Carpa can handle, how the traceability links are persisted, and of course the traceability link types.
 +
 
 +
[[Capra/CustomTraceabilityMetaModel|Adding a custom traceability meta-model]]
 +
 
 +
= Contributing to Capra =
 +
 
 +
The Capra project uses the Eclipse infrastructure for development, source code management, building, and bug tracking. Please refer to [[Capra/Contributing]] for details on how to contribute and to [[Capra/PreparingForRelease]] for information on release engineering.
 +
 
 +
[[Category:Capra]]

Latest revision as of 05:02, 6 February 2020

Eclipse Capra is a configurable and extendable traceability management tool based on EMF. It is created in the context of an ITEA funded project called AMALTHEA4Public whose main aim is to develop a platform that will improve the development of embedded multicore and many core systems.

The project website can be found here.

How it works

Eclipse Capra uses the Eclipse Modelling Framework (EMF) as its base technology and stores the traceability model as an EMF model. Out of the box, it provides a number of artifact handlers that allow using, e.g., Papyrus UML models, Java methods, C functions, or Hudson builds as sources and targets for traceability links. New traceability links can be created with drag and drop and changes to the artifacts that affect the traceability links are shown in the Problems view.

The traceability metamodel is not fixed and can be defined by the user. It relies on the Eclipse extension mechanism and provides an extension point for artifacts types to be supported. To add a new type of artifact, one simply needs to add an extension to this extension point and implement the provided interfaces.

Getting Started

Installing Capra from the Update Site

Update sites with nightly builds, milestones and releases are available at [1]. An update site with nightly builds of the current development branch of Eclipse Capra is available here. Use one of the update sites to install Capra through Eclipse's "Install Software..." functionality.

Installing Capra from Sourcecode

Please make sure that JDK 8 is installed. You can use the version from AdoptOpenJDK. It is very important that both the Eclipse installation in which the development is done as well as Maven actually use Java 1.8 since source code compatibility is not ensured when using later JDKs/JREs in 1.8-mode! In Eclipse, JRE 8 has to be activated and JAVA_HOME should point to JDK 8 for Maven!

Using the Eclipse Installer

The easiest way to get up and running with Eclipse Capra is to use the Eclipse Installer. It lets you select which version of Eclipse to download and sets up everything you need to run and develop Eclipse Capra automatically. Here's how to use it:

  1. Download the Eclipse Installer.
  2. Open the Eclipse Installer. In the menu in the top-right corner, select the advanced mode.
  3. Select the "Eclipse for Eclipse Committers" package from the list. In the selection for "Product Version" below the list, select your favorite version of Eclipse (at least Neon) and JRE 8 as the runtime environment. Click "Next".
  4. In the list of Eclipse projects, select "Eclipse Capra". Make sure the checkbox in front of Eclipse Capra is checked and click "Next".
  5. In the next step, you get to select some variables. Most of these can remain on their default, but you have to select the correct target platform for the Eclipse product version you selected earlier. You might also want to provide credentials for your Eclipse account here to ensure that the git repository and the connections to Bugzilla and Gerrit are set up correctly. Change other variables such as installation and workspace location at your own discretion. Click "Next."
  6. The Eclipse Installer will now download the packages for your chosen Eclipse product version. You might have to agree to some licenses. After that, it will automatically start the Eclipse IDE it just installed and start setting up the development environment. That includes cloning the git repository, setting up connections to Bugzilla and Gerrit, and setting the target platform. This might take a while, but after all is said and done, you are all set!

Manual installation of the Eclipse development environment for Capra

Before downloading and using Eclipse Capra, download the Eclipse Modelling Environment. All dependencies will be downloaded automatically when Eclipse Capra is installed. In particular, parts of Papyrus, the Java Development Tools, the C/C++ Development Tools, Xcore, and Xtend will be installed.

Get the source code manually

  • Open your Eclipse Environment
  • Go to File --> Import and select Git --> Projects from Git
  • Clone the Eclipse Capra Git repository and import all available projects to your workspace. Information about the developer resources and the source code repositories is available at the project website.
  • Make sure to switch to the develop branch if you want to use the current version of Eclipse Capra
  • To make sure Eclipse can resolve all dependencies, set the correct target platform file for your version of Eclipse. All target platform files can be found in releng/org.eclipse.capra.releng.target. Open the correct file and set it as the active target platform by opening it and clicking on "Set as Target Platform" in the upper right corner. Eclipse will now download all dependencies. Note that this will take a while. Check the progress in the lower right corner.
  • Build your workspace
  • Make sure that all the projects have no errors.

If compilation errors occur during the first build, check if any of the dependencies above are missing. Cleaning all binaries also often helps resolve issues.

Start Capra

  • Make sure that all the projects have no errors.
  • Click on Run --> Run Configurations and create a new Eclipse Application Configuration
  • Select your running workspace
  • Click "Apply", then "Run"
  • Once the new workspace opens, create or import projects that you want to use to create traceability links
  • Go to perspectives and switch to the Capra perspective
  • Follow this video to create and visualize traceability links.

Install Graphviz

In order to use the trace link visualisation based on PlantUML, graphviz needs to be installed on the system. If it cannot be found, the Capra PlantUML viewer will display an error message. Please follow the installation instructions on the Graphviz website to install the tool in your system.

Customizing Capra

Eclipse Capra has been designed for extensibility and configurability. Many aspects of Capra can be changed by implementing a new plugin and registering it to the right extension points. This includes which artifacts Eclipse Carpa can handle, how the traceability links are persisted, and of course the traceability link types.

Adding a custom traceability meta-model

Contributing to Capra

The Capra project uses the Eclipse infrastructure for development, source code management, building, and bug tracking. Please refer to Capra/Contributing for details on how to contribute and to Capra/PreparingForRelease for information on release engineering.

Copyright © Eclipse Foundation, Inc. All Rights Reserved.