Wiki - User contributions [en-gb]

Get started

2017-10-10T15:17:35Z

Makedonski: /* Setting up a local environment for development and testing */

__TOC__

= Installing the plug-ins =

The TDL tools are available as a set of Eclipse plug-ins. You need to first be able to run Eclipse. The [http://www.eclipse.org/downloads/packages/eclipse-modeling-tools/neon3 Eclipse Neon Modeling Tools] distribution contains most of the necessary prerequisites for the TDL tools. You will also need to install [https://www.eclipse.org/sirius/ Sirius] and [http://www.eclipse.org/Xtext Xtext] from the Eclipse Marketplace as the TDL tools depend on them.

Once Eclipse is up and running, you need to add the [http://build.tdl.etsi.org update site] for the TDL tools: [http://build.tdl.etsi.org http://build.tdl.etsi.org]

After the update site is added, the list of plug-ins and features shall be shown in the installation dialog (menu item Install New Software..). Select the desired features and proceed with the installation, which will require Eclipse to be restarted once the installation is finished.

= Using the plug-ins =

* To create a new TDL model by means of the TDLan2 textual representation, right click on a project or a folder in the package explorer and select New -> File, type the filename ending with '''.tdlan2''' and the corresponding editor shall be automatically opened.
* To create a new TDL model by means of the TDPan2 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 the corresponding editor shall be automatically opened.
* 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 "T" 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.

= Connecting to the repository =

== Setting up your Gerrit profile ==

In order to use Gerrit to contribute and review code you will need to add your credentials.
Both SSH and HTTPS are supported, the latter is recommend for starters and its usage will be explained below.

# Navigate to Gerrit at [https://tdl.etsi.org/gerrit https://tdl.etsi.org/gerrit].
# Sign in (link in the top right corner) entering your EOL or TDL External credentials.
# Your user name will appear on the top right of the page. Click on it, the select Settings.
# In the menu on the left, select HTTP Password.
# Click on "Generate password" button.

Gerrit has a secure password for your HTTP access. When cloning a repository you will be asked to insert username and password:
use the password copied from the Gerrit settings, not your EOL password. Don't worry, you will need to insert that only once.

== Clone your project ==

This is a procedure that should work in most of the cases and is good for starters with Git and Gerrit. Experienced users can rely on their preferred cloning procedures.

# Navigate to the project general page ([https://tdl.etsi.org/gerrit/#/admin/projects/ List of all the projects]), for example the [https://tdl.etsi.org/gerrit/#/admin/projects/top-gerrit-test TOP test project].

# Now select the options "Clone with commit hook" and "anonymous http" (we suggest anonymous since it seems the only way to make it work with Windows Credential helper).

# Copy the command shown in the page into the clipboard.

=== On Windows ===

The following assumes you are working with [https://git-for-windows.github.io Git-for-windows] and [https://tortoisegit.org/ TortoiseGit].

# Open the folder on your PC where you want the files to be put.
# Right click on the white space and select "Git Bash Here".
# Paste the command that you copied from Gerrit and hit "Enter"
# You will be asked to insert user name and password by the Windows Credential Helper. Insert your EOL user name and '''the HTTP password you generated in the Gerrit Settings'''. Check the "Git Bash". If it says "Unauthorized": try again the command (hit the Up key and it will be shown), this time in the Windows Credential Helper click "Cancel", then a new window will pop up where you should put again the EOL user name and the HTTP password.

'''Note''':
* You can find all the project repository URLs on '''[https://tdl.etsi.org/rep/ Gitweb]''' or on '''[https://tdl.etsi.org/gerrit/ Gerrit]'''
** On Gitweb
**# Click on '''Gitweb''' menu on the portal menu bar.
**# Select a project to see the available cloning URLs
** On Gerrit
**# Click on '''Gerrit''' menu on the portal menu bar.
**# Click on "Projects" menu on the Gerrit menu bar.
**# Click on "List" menu.
**# Select a project to see the available cloning URLs.

= Setting up a local environment for development and testing =

* Install following additional components
** Sirius Specifier Environment
** Sirius Properties Views - Specifier Support
** Xtext Complete SDK
* Check out the repository
* Import the plug-ins in the Eclipse workspace
* Generate the meta-model code
** Open the '''tdl.genmodel'''
** Right click on the top-node and generate model code
* Generate textual editor code
** Open the '''GenerateTDLan2.mwe'''
** Right click and select Run As -> MWE2 Workflow
** Optionally (or alternatively) repeat the same steps for the '''GenerateTPLan2.mwe''' (for editing structured test objectives)
** Optionally (or alternatively) repeat the same steps for the '''GenerateData.mwe''' (for the graphical viewer)

Get started

2017-10-09T16:12:56Z

Makedonski:

__TOC__

= Installing the plug-ins =

The TDL tools are available as a set of Eclipse plug-ins. You need to first be able to run Eclipse. The [http://www.eclipse.org/downloads/packages/eclipse-modeling-tools/neon3 Eclipse Neon Modeling Tools] distribution contains most of the necessary prerequisites for the TDL tools. You will also need to install [https://www.eclipse.org/sirius/ Sirius] and [http://www.eclipse.org/Xtext Xtext] from the Eclipse Marketplace as the TDL tools depend on them.

Once Eclipse is up and running, you need to add the [http://build.tdl.etsi.org update site] for the TDL tools: [http://build.tdl.etsi.org http://build.tdl.etsi.org]

After the update site is added, the list of plug-ins and features shall be shown in the installation dialog (menu item Install New Software..). Select the desired features and proceed with the installation, which will require Eclipse to be restarted once the installation is finished.

= Using the plug-ins =

* To create a new TDL model by means of the TDLan2 textual representation, right click on a project or a folder in the package explorer and select New -> File, type the filename ending with '''.tdlan2''' and the corresponding editor shall be automatically opened.
* To create a new TDL model by means of the TDPan2 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 the corresponding editor shall be automatically opened.
* 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 "T" 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.

= Connecting to the repository =

== Setting up your Gerrit profile ==

In order to use Gerrit to contribute and review code you will need to add your credentials.
Both SSH and HTTPS are supported, the latter is recommend for starters and its usage will be explained below.

# Navigate to Gerrit at [https://tdl.etsi.org/gerrit https://tdl.etsi.org/gerrit].
# Sign in (link in the top right corner) entering your EOL or TDL External credentials.
# Your user name will appear on the top right of the page. Click on it, the select Settings.
# In the menu on the left, select HTTP Password.
# Click on "Generate password" button.

Gerrit has a secure password for your HTTP access. When cloning a repository you will be asked to insert username and password:
use the password copied from the Gerrit settings, not your EOL password. Don't worry, you will need to insert that only once.

== Clone your project ==

This is a procedure that should work in most of the cases and is good for starters with Git and Gerrit. Experienced users can rely on their preferred cloning procedures.

# Navigate to the project general page ([https://tdl.etsi.org/gerrit/#/admin/projects/ List of all the projects]), for example the [https://tdl.etsi.org/gerrit/#/admin/projects/top-gerrit-test TOP test project].

# Now select the options "Clone with commit hook" and "anonymous http" (we suggest anonymous since it seems the only way to make it work with Windows Credential helper).

# Copy the command shown in the page into the clipboard.

=== On Windows ===

The following assumes you are working with [https://git-for-windows.github.io Git-for-windows] and [https://tortoisegit.org/ TortoiseGit].

# Open the folder on your PC where you want the files to be put.
# Right click on the white space and select "Git Bash Here".
# Paste the command that you copied from Gerrit and hit "Enter"
# You will be asked to insert user name and password by the Windows Credential Helper. Insert your EOL user name and '''the HTTP password you generated in the Gerrit Settings'''. Check the "Git Bash". If it says "Unauthorized": try again the command (hit the Up key and it will be shown), this time in the Windows Credential Helper click "Cancel", then a new window will pop up where you should put again the EOL user name and the HTTP password.

'''Note''':
* You can find all the project repository URLs on '''[https://tdl.etsi.org/rep/ Gitweb]''' or on '''[https://tdl.etsi.org/gerrit/ Gerrit]'''
** On Gitweb
**# Click on '''Gitweb''' menu on the portal menu bar.
**# Select a project to see the available cloning URLs
** On Gerrit
**# Click on '''Gerrit''' menu on the portal menu bar.
**# Click on "Projects" menu on the Gerrit menu bar.
**# Click on "List" menu.
**# Select a project to see the available cloning URLs.

= Setting up a local environment for development and testing =

* Check out the repository
* Import the plug-ins in the Eclipse workspace
* Generate the meta-model code
** Open the '''tdl.genmodel'''
** Right click on the top-node and generate model code
* Generate textual editor code
** Open the '''GenerateTDLan2.mwe'''
** Right click and select Run As -> MWE2 Workflow
** Optionally (or alternatively) repeat the same steps for the '''GenerateTPLan2.mwe''' (for editing structured test objectives)
** Optionally (or alternatively) repeat the same steps for the '''GenerateData.mwe''' (for the graphical viewer)

Main Page

2017-10-05T12:12:58Z

Makedonski: /* Development Tools */

<div style="font-size:200%">
<center>'''Welcome to TOP - TDL Open source Project!'''</center>
</div>

The TDL Open Source Project (TOP) fosters the shared development and testing of contributed tools to manage TDL files, generate documentation and code.

The project is an initiative of ETSI TC MTS – the ETSI committee that standardizes methods for testing and specification.

== Software ==

=== TDL Open Source Implementation ===

To accelerate the adoption of TDL, TC MTS has commissioned an open-source reference implementation of TDL in order to lower the barrier to entry for both users and tool vendors in getting started with using TDL. The reference implementation comprises graphical and textual editors, validation facilities, as well as a UML profile for TDL to enable the application of TDL in UML-based working environments. It will be made available later in 2017 as an ETSI open source software project accessible from the TDL website and enabling contributions from the community.

The reference implementation is based on the Eclipse XText toolset to provide a set of Java libraries and Eclipse plugins to support development of TDL specifications. Navigate the source at the git repository and find more information on the project wiki.

=== How to contribute ===

Are you a test designer, a test developer or a tool vendor? Your contribution is most welcome! Active contributions to the TDL standardisation require an ETSI membership. Any interested company can find how to become an ETSI member here.

The TOP source base is openly accessible. Its usage is governed by the Eclipse Public License (EPLv1). A source code contribution to TOP (merge request) requires adhering to EPLv1 and signing a Contributor Agreement between the developer and ETSI TC MTS beforehand. Find out more about TOP governance on the Governance wiki page.
Find out more information on how to contribute here.

=== Development Tools ===

TOP is developed using tools that are well known, developer friendly and open source.

* Navigate repositories
* Issue tracker
* Review tracker

* [[Project Governance]]
* [[How to contribute]]
* [[ Get started]]
* [[Legal framework]]
* [[Learn about TDL]]