Commit f1972474 authored by Philip Makedonski's avatar Philip Makedonski
Browse files

+ readme updates

parent 47e2fc89
......@@ -12,6 +12,10 @@ Once Eclipse is up and running, you need to add the [update site](https://tdl.et
https://tdl.etsi.org/eclipse/latest/
For the latest preview version of the TDL tools, you shall use the the [following update site](https://tdl.etsi.org/eclipse/ucaat2021/) instead:
https://tdl.etsi.org/eclipse/ucaat2021/
After the update site is added, the list of plug-ins and features shall be shown in the installation dialog (menu item Help->Install New Software..). Select the desired features and proceed with the installation, which will require Eclipse to be restarted once the installation is finished.
Find more detailed information at [Installation wiki](https://labs.etsi.org/rep/top/ide/-/wikis/Installation).
......@@ -32,7 +36,7 @@ To create a new TDL model by means of the **TDLan2 textual representation**:
* type the filename ending with `.tdlan2` and
* the corresponding editor shall be automatically opened.
To create a new TDL model by means of the TDLan2 textual representation for **structured test objectives**:
To create a new TDL model by means of the TPLan2 textual representation for **structured test objectives**:
* right click on a project or a folder in the package explorer and select New -> File,
* type the filename ending with `.tplan2` and
......@@ -40,6 +44,8 @@ To create a new TDL model by means of the TDLan2 textual representation for **st
To translate a TDL model from the TDLan2 textual representation to the **XF format** (or the other way around) open the source model and press the <code>T</code> icon on the toolbar. The resulting model shall be stored in the same folder as the source model with the type of the model (`.tdlan2` or `.tdl`) appended to the name of the source model.
The same steps can be applied to create a new TDL model by means of the brace-based and indentation-based **TDL TX textual representations** (using the `.tdltx` and `.tdltxi` endings for the filenames). The translation functionality provides a dialog to select the target format, including the **TDL TX** representations.
More information on using the plugins is available at [Usage wiki](https://labs.etsi.org/rep/top/ide/-/wikis/Usage).
## Setting up a local environment for development and testing
......@@ -59,10 +65,15 @@ More information on using the plugins is available at [Usage wiki](https://labs.
* Open the `GenerateTDLan2.mwe`
* Right click and select Run As -> MWE2 Workflow
* Additionally (or alternatively) repeat the same steps for the `GenerateTPLan2.mwe` (for editing structured test objectives)
* Additionally (or alternatively) repeat the same steps for the `GenerateTDLtx.mwe` (for brace-based TDL TX representation)
* Additionally (or alternatively) repeat the same steps for the `GenerateTDLtxi.mwe` (for indentation-based TDL TX representation)
* Additionally (or alternatively) repeat the same steps for the `GenerateData.mwe` (for the graphical viewer)
## Converters
The converters component can be optionally installed with the TDL core and editor components. It includes implementaions for importing data from OpenAPI and ASN.1 specifications, as well as exporting structured test objectives into Word documents and converting structured test objectives to test descriptions. The functionality is depends on the currently selected resource. To import data from OpenAPI or ASN.1 specifications, use the corresponding menu item or press the `>T>` icon on the toolbar. Note that the converters functionality is still in active development and some parts may be incomplete, while others may change.
## Implementation of the OpenAPI import into TDL
### Implementation of the OpenAPI import into TDL
The generation of data types and other elements based on OpenAPI yaml specifications is based on the [KaiZen OpenAPI Parser](https://github.com/RepreZen/KaiZen-OpenApi-Parser). The corresponding [Eclipse plug-in](https://marketplace.eclipse.org/content/kaizen-openapi-editor) needs to be installed before installing the importer. While the transformation components can be installed individually, the user-interface currently depends on all the transformation plug-ins.
......@@ -78,21 +89,21 @@ Part of the implementation was developed as a lab project with contributions fro
* René Lars Wetzelt
* Vincent Florens Hasse
## Implementation of the ASN.1 import into TDL
### Implementation of the ASN.1 import into TDL
The generation of data types based on ASN.1 specifications is based on the [BeanIt ASN1Bean](https://github.com/beanit/asn1bean) (formerly known as jASN).
The implementation currently supports:
* Importing of data definitions within the module (imports from other modules are currently not resolved).
* Application of annotations or data constraints (e.g. for `CHOICE` data types or other modifiers).
## Implementation of the transformation of Structured Test Objectives to TDL Test Descriptions
### Implementation of the transformation of Structured Test Objectives to TDL Test Descriptions
The transformation of Structured Test Objectives into TDL Test Descriptions currently supports:
* Transforming of inline data descriptions within `EventOccurrences` into corresponding data types.
* Generation of `TestConfigurations` based on the `EventSequences` within the Structured Test Objective.
* Generation of `TestDescription` skeletons based on the `EventSequences` within the Structured Test Objective with references to it.
* Importing of the base package and imported packages.
## Implementation of the TDL mapping to TTCN-3
### Implementation of the TDL mapping to TTCN-3
The TDL mapping to TTCN-3 relies on some functionalities from [TRex2 / T3Tools](https://t3tools.informatik.uni-goettingen.de/trac). Before installing or developing the implementation of the TDL mapping to TTCN-3, the corresponding components need to be installed from the following update site:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment