Test configuration editor

../../../_images/TestconfigurationEditor.png

The test configuration editor

The test configuration editor is used to create and edit a test configuration. The editor is structured into different tabs.

Tab “Common”

On the tab Common the name of the tester must be indicated. This can be done either by a direct entry (the name is fixed in the configuration), by a prompt at the start of the configuration, ,or by automatically using the Windows username. The name of the computer is inserted automatically and cannot be changed.

A file with mapping entries can be selected by means of the Global mapping file. This makes it easy to exchange the list of mapping entries and/or make it available to others. For creation click on Open symbol and indicate a file name. The storage location does not matter, but it is recommended to store the file within the data directory.

Tab “Bus access”

The tab Bus access provides access to various buses. The left part shows the management of bus systems. It allows entering and deleting bus systems as well as shifting between them. In the right part the bus database can be selected. The file contains a database comprising all kinds of information processed in a bus network as well as their interrelations.

DBC, ARXML and FIBEX files are supported. FIBEX databases can contain several channels so that, when a FIBEX file is specified, it is necessary to select also the channel to be used (e.g. FlexRay).

Tab “Report”

The tab Report contains the settings for documenting test results.

The upper sector shows the folder in which test results are stored.

Info

During test execution trace.check writes all results into a database. The settings on the tab have no influence on setup and contents of the database. It may rather be determined if and which report documents (e.g. HTML) should be generated from the database.

At Output format the required output formats can be set up. Output formats combine report generators with various options and filters. trace.check already comes with the default report generators HTML, JSON, EXCEL and TXT.

A check box in front of a given output format serves to engage or disengage automatic generation. If a tick is put there the report concerned will be generated automatically after every test run. If the box is not ticked generation must be started manually in the report viewer. The report viewer presents report databases (TRF files). It opens automatically after every trace analysis or is shown when a report database is opened via the menu File ‣ Open ‣ Test report.

In order to create, for example, a new HTML-based test report format click on the first of the three symbols and select HTML.

First insert into the dialog a name for the output format. Then you can choose if the test report should, or should not, always be automatically generated at the end of a trace analysis (this corresponds to the tick put, or not put, in the box as above). By means of the project filter and the trace analysis filter various filters can be applied to the test report to be generated. The filters correspond to the filters for display in the report viewer. At last it can be defined if Java script should be used and a separate HTML file should be generated for every subpackage. While in case of “false” all subpackages are put in a common HTML file, with “true” separate files are set up for the subpackages and linked among each other. If separate HTML files are used they are smaller in size and the presentation of large test reports with many subpackages is effected much faster.

It is determined by means of the check box Copy trace.check log files into report folder if trace.check should automatically copy the respective log files into the corresponding test report folder.

Custom report generators

In trace.check report generators are realized as plugins. So the user can customize the default report generators (e.g. HTML or TXT) or complement or replace them with custom report generators. All report generators (including the default ones) are located in the trace.check program directory at Templates/Report. There is a separate folder for each report generator. The folder name determines the name of the report generator. To create a new report generator based on an existing one, copy the corresponding folder. Afterwards the copy can be edited and adapted to specific requirements.

Report generators are implemented either as mako templates (similar to the supplied HTML report generator) or as Python scripts (like the supplied TXT report generator).

Info

For rendering mako templates, trace.check uses the mako template engine. Information about the structure and contents of mako templates can be found at http://www.makotemplates.org/docs/syntax.html.

The technical implementation of report generators is described in the Report API. In this context, the term report generator is also used synonymously for format templates and mako templates.

Tab “Global constants”

This tab serves to define constants with values that remain available throughout the entire trace analysis execution without changing their values. A new constant can be generated by means of the button New. The usual conventions for variables apply (no special characters, no spaces). Within Python-based trace steps it is possible to access the values.

If global constants are renamed, it can be specified whether trace.check should rename the constants in other packages or configurations, too. For that purpose the corresponding boxes in the changing dialog must be ticked.