Wiki - User contributions [en-gb]

Legal framework

2019-09-06T15:58:05Z

Kristofferse:

== Intellectual Properties ==

The content shared within the TOP project is covered by the [https://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1], as decided by ETSI TC MTS.

== Contributor agreements ==

=== Corporate Contribution License Agreement ===
The Contributor License Agreements (CLA) define terms and conditions for any contribution to the TOP project.

Contributions in name of a company (which should be a member of ETSI TC MTS) are covered by the Corporate CLA. This document is to be signed once by the company and covers the contribution from any employee.

[https://tdl.etsi.org/files/CCLA_TC-MTS_29-May-2017.pdf Download the CCLA here]

=== Individual Contributor License Agreement ===

Covers people contributing in their own name, employees are still allowed to register both under corporate and as individuals.

[https://tdl.etsi.org/files/ICLA_TC-MTS_29-May-2017.pdf Download the ICLA here]

=== How to submit the Agreement ===

CCLA should be filled in and sent to this email address.

ICLA is to be accepted during the registration phase for individual accounts.

Installation

2019-09-06T15:51:52Z

Kristofferse:

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.

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

http://tdl.etsi.org/eclipse/neon

To add the new repository to Eclipse, follow these steps:

# Open the menu item "Help" and select the item "Install new software"
# Click "Add..." button to add a new repository
# Insert the required information:
#* Name: TOP Plugins
#* Location: http://tdl.etsi.org/eclipse/neon
# Click Ok. In the window, a new set of plugins called TDL should appear
# Click on the checkbox to select all the plugins, then click "Next".
# Now follow the instructions to complete the installation

After the installation Eclipse will need to be restarted.

<big>'''Next step: [[Usage|Usage of the installed plugins.]]'''</big>

Get started

2019-09-05T08:50:51Z

Kristofferse:

__TOC__

= 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/gitweb/gitweb.cgi/ 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)

Main Page

2019-09-04T12:18:52Z

Kristofferse:

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

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.

<big>Subscribe [https://tdl.etsi.org/index.php/community here] TDL public mailing list to keep in touch with TDL community, receive news and find support on the TDL public mailing list.</big>

</center>
</div>

== Quick links ==

<big>
<table style="width:100%">
<tr>
<td>

'''Discover the project'''

* [[Governance | Project Governance]]
* [[Legal framework]]
* [[Learn about TDL]]

</td>
<td>

'''Users'''

* [[Installation]]
* [[Usage]]

</td>
<td>

'''Developers'''

* [[How to contribute]]
* [[Get started|Get started as contributor]]

</td>
</tr>
</table>

</big>

== Meetings ==

[[1st TDL Open Source Meeting]]

== Software ==

=== TDL Open Source Implementation ===

To accelerate the adoption of TDL, TC MTS has commissioned an open source implementation of TDL in order to lower the barrier to entry for both users and tool vendors in getting started with using TDL. The open source 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 open source implementation is based on the Eclipse XText toolset to provide a set of Java libraries and Eclipse plugins to support development of TDL specifications.

=== 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.

How to contribute

2019-09-04T09:48:52Z

Kristofferse:

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
[http://www.etsi.org/membership/apply 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|Governance wiki page]]. Find out more information on how to contribute here.

Governance

2019-09-03T21:48:25Z

Kristofferse:

The TOP project has been created to grow a community around TDL the test description language. The language is specified by ETSI Methods for Testing and Specification committe (TC MTS) as an independent, extensible testing language.

You can find more information about ETSI (European Telecommunication Standards Institute) at [http://www.etsi.org/ www.etsi.org] and the information and work program of TC MTS [https://portal.etsi.org/tb.aspx?tbid=97&SubTB=97 here].

The governing rules are decided within TC MTS itself.

__TOC__

== TOP Governing groups ==

=== Project lead (PL) ===

This is a small group of people from from TC MTS and ETSI CTI that deals with:

* Providing project timeline and roadmap,
* Ensuring IP compliance of code base,
* Deciding on TOP roles assignement.

=== Steering Group (SG) ===

TOP Steering Group is formed by the people in the TDL Steering Group. Its tasks:

* To coordinate TOP's technical activities
* To provide guidelines for future development
* To resolve conflicts at technical level
* To guarantee neutrality from contributors

=== Advisory group (AG) ===

The Advisory Group for TOP is ETSI TC MTS itself. Decisions regarding TOP are taken at MTS meetings, held usually every 3 months. The advisory groups goals are:
* To set the policies of the project
* To make administrative decisions
* To coordinate marketing efforts

Find out [mailto:membership@etsi.org how to participate in TC MTS].

== Roles ==

=== User ===

* Browse and download code base.
* Join the mailing list or forum, access to wiki

=== Contributor ===

Same as user plus:
* Create a new issue / bug report
* Provide bug fixes as code patches
* Create new feature requests
* Provide code and tests for new features
* Contribute to the TOP wiki

Anybody is welcome to contribute code and ideas to the TOP project. To do so, use our Gerrit platform and send your contributions using Git.

Find out [[How to contribute]].

=== Committer ===

Same as contributor plus:
* Consolidate code changes
* Ensure software quality and validate bug fixes
* Manage new versions and branches

Installation

2019-09-03T16:54:21Z

Kristofferse:

Usage

2019-09-03T16:47:04Z

Kristofferse:

= TDL editor plugin =
To create a new TDL model by means of the TDLan2 textual representation, follow these steps:

* right click on a project or a folder in the package explorer and select New -> File,
* type the filename ending with '''.tdlan2'''
* the corresponding editor shall be automatically opened.

= TDL-TO editor plugin =

To create a new TDL model by means of the TPlan2 textual representation for structured test objectives, follow this steps:

* right click on a project or a folder in the package explorer and select New -> File,
* type the filename ending with '''.tplan2''' ,
* the corresponding editor shall be automatically opened.

= Convert the text into XF Format =

* 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.

= Export TDL Test Objectives as Word tables =

== Install the plugin ==

Make sure that the TDL Word export plugin is installed. Find here [[Installation|how to install the plugins]].
After the plugin is installed, you will be asked to restart the Eclipse environment.

After Eclipse restarts, you should be able to see a <code>W</code> button in the toolbar below the main menu.

[[File:Toolbar.PNG|frame|center]]

== Use the export button! ==

# Open a '''tplan2''' document in Eclipse like this
[[File:Tdlan example.PNG|thumb|center]]
# Click on the <code>W</code> button in the toolbar and wait for a few seconds. It may happen that the Eclipse window is not responsive to clicks during the export
execution, it does not mean that it is an error.
# When the processing is done, the newly created Word document will be in the same folder of the tplan file and should appear in the Project explorer
# * If the file is not shown, select the project, right click and select ''Refresh'' (or hit F5 on the keyboard)

The result will look like:
[[File:Word.PNG|thumb|center]]

How to contribute

2017-10-09T07:20:46Z

Kristofferse:

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
[http://www.etsi.org/membership/apply 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.

Main Page

2017-10-08T16:29:18Z

Kristofferse:

<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 implementation of TDL in order to lower the barrier to entry for both users and tool vendors in getting started with using TDL. The open source 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 open source 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 [https://tdl.etsi.org/gitweb/?p=tdl.git;a=summary git repository] and find more information on the
[https://tdl.etsi.org/wiki/index.php/Main_Page 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]]

Main Page

2017-10-05T10:21:57Z

Kristofferse:

<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
* eview tracker

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

Main Page

2017-10-05T10:12:21Z

Kristofferse:

Governance

2017-10-05T07:57:16Z

Kristofferse:

The TOP project has been created to grow a community around TDL the test description language. The language is specified by ETSI Methods for Testing and Specification committe (TC MTS) as an independent, extensible testing language.

You can find more information about ETSI (European Telecommunication Standards Institute) at [http://www.etsi.org/ www.etsi.org] and the information and work program of TC MTS [https://portal.etsi.org/tb.aspx?tbid=97&SubTB=97 here].

The governing rules are decided within TC MTS itself.

__TOC__

== TOP Governing groups ==

=== Project lead (PL) ===

This is a small group of people from from TC MTS and ETSI CTI that deals with:

* Providing project timeline and roadmap,
* Ensuring IP compliance of code base,
* Deciding on TOP roles assignement.

=== Steering Group (SG) ===

TOP Steering Group is formed by the people in the TDL Steering Group. Its tasks:

* To coordinate TOP's technical activities
* To provide guidelines for future development
* To resolve conflicts at technical level
* To guarantee neutrality from contributors

=== Advisory group (AG) ===

The Advisory Group for TOP is ETSI TC MTS itself. Decisions regarding TOP are taken at MTS meetings, held usually every 3 months. The advisory groups goals are:
* To set the policies of the project
* To make administrative decisions
* To coordinate marketing efforts

Find out [mailto:membership@etsi.org how to participate in TC MTS].

== Roles ==

=== User ===

* Browse and download code base.
* Join the mailing list or forum, access to wiki

=== Contributor ===

Same as guest plus:
* Create a new issue / bug report
* Provide bug fixes as code patches
* Create new feature requests
* Provide code and tests for new features
* Contribute to the TOP wiki

Anybody is welcome to contribute code and ideas to the TOP project. To do so, use our Gerrit platform and send your contributions using Git.

Find out [[How to contribute]].

=== Committer ===

Same as contributor plus:
* Consolidate code changes
* Ensure software quality and validate bug fixes
* Manage new versions and branches

Governance

2017-10-05T06:24:06Z

Kristofferse:

The TOP project has been created to grow a community around TDL the test description language. The language is specified by ETSI Methods for Testing and Specification committe (TC MTS) as an independent, extensible testing language.

You can find more information about ETSI (European Telecommunication Standards Institute) at [http://www.etsi.org/ www.etsi.org] and the information and work program of TC MTS [https://portal.etsi.org/tb.aspx?tbid=97&SubTB=97 here].

The governing rules are decided within TC MTS itself.

__TOC__

== TOP Governing groups ==

=== Project lead (PL) ===

This is a small group of people from from TC MTS and ETSI CTI that deals with:

* Providing project timeline and roadmap,
* Ensuring IP compliance of code base,
* Deciding on TOP roles assignement.

=== Steering Group (SG) ===

TOP Steering Group is formed by the people in the TDL Steering Group. Its tasks:

* To coordinate TOP's technical activities
* To provide guidelines for future development
* To resolve conflicts at technical level
* To guarantee neutrality from contributors

=== Advisory group (AG) ===

The Advisory Group for TOP is ETSI TC MTS itself. Decisions regardin TOP are taken at MTS meetings, held usually every 3 months. The advisory groups goals are:
* To set the policies of the project
* To make administrative decisions
* To coordinate marketing efforts

Find out [mailto:membership@etsi.org how to participate in TC MTS].

== Roles ==

=== User ===

* Browse and download code base.
* Join the mailing list or forum, access to wiki

=== Contributor ===

Same as guest plus:
* Create a new issue / bug report
* Provide bug fixes as code patches
* Create new feature requests
* Provide code and tests for new features
* Contribute to the TOP wiki

Anybody is welcome to contribute code and ideas to the TOP project. To do so, use our Gerrit platform and send your contributions using Git.

Find out [[How to contribute]].

=== Committer ===

Same as contributor plus:
* Consolidate code changes
* Ensure software quality and validate bug fixes
* Manage new versions and branches