Manual

56
Doctags

Beside node attributes, QF-Test provides another way to influence the behavior of nodes during test-execution or during report generation. That can be achieved by utilizing so-called doctags. Doctags represent text which you can specify in the 'Comment' attribute of nodes and parse parameters to them, e.g. @teststep or @noreport node.

Note In the 'Comment' attribute of the node, doctags must be inserted after the description you want to display in the report.

56.1
Doctags for reporting and documentation

Doctags used for formatting test documentation of 'Test-sets' and 'Test-cases' are described in section 20.2, doctags for formatting of the documentation of 'Packages' and 'Procedures' in section 20.3.

The doctags described below influence the reprensation of nodes in the report.

Doctag Nodes Description
@teststep [name] All nodes If this doctag is set, the node will be treated as 'Test-step' in the report. You can specify an optional name.
@report 'Check' nodes, 'Sequence with time limit' and 'Server HTTP request' nodes If this is set the node will be reported as check in the report in any case.
@noreport [type],[errorlevel] All sequences like 'Test-case', 'Test-set' or 'Test-step', all Checks, Sequence with time-limit or request steps If this doctag is set, the node won't be mentioned in the report. See subsection 56.1.1 for details.
Table 56.1:  Doctags for reporting and documentation
4.2+56.1.1
@noreport Doctag

You can use the @noreport doctag to filter several nodes from the reports. You can make use of two parameters to specify the filtering. Those parameters are [type] and errorlevel.

type
You can use either 'tree' or 'node'. 'tree' is the default in case nothing is specified. Using 'tree' filters the entire node and all children from the report. 'node' filters just that particular node from the report. The children will be in the report.
errorlevel
This parameter is only activate for sequence nodes like 'Test-set','Test-case' or 'Test-step'. Using this parameter enables you to filter nodes only if dedicated error level have been reached. You can configure the error levels EXCEPTION, ERROR, WARNING or MESSAGE. For comparison you can either use =,>,<,<= or >=. errorlevel<ERROR filters the node only if no error and no exception occurred. That's the default setting. errorlevel>=MESSAGE filters the node in any case. That's very dangerous of course and should only be used if there are very good reasons.
56.2
Doctags for test execution

Using those doctags influences the execution of tests.

Doctag Nodes Description
@rerun [parameters] All nodes You can configure the instant re-run in case of errors. Please see subsection 21.3.2 for details.
Table 56.2:  Doctags for test execution
56.3
Doctags for Editing

Using those doctags can influence the behavior of QF-Test during editing.

Doctag Nodes Description
@blue All nodes Add a blue mark when loading the test-suite the next time.
@breakpoint All nodes Add a breakpoint when loading the test-suite the next time.
@green All nodes Add a green mark when loading the test-suite the next time.
@red All nodes Add a red mark when loading the test-suite the next time.
@yellow All nodes Add a yellow mark when loading the test-suite the next time.
Table 56.3:  Doctags for editing
56.4
Doctags influencing the procedure builder

The doctags for use in the definition file for the procedure builder are described in chapter 50. In chapter 23 you will find general information on the procedure builder.