When creating reports from a run-log, or package documentation from a test-suite, QF-Test operates in a two-step process. The first step creates an XML document which is transformed to an HTML document in the second step. Both transformations are done using XSLT stylesheets.
Note The term DOM (for Document Object Model) also applies to XML documents, not only to HTML web pages. This section is all about XML and XSLT and not about the DOM of a web SUT.
However, XSLT stylesheets are not very useful when it comes to
parsing plain text. The 'Comment' fields of 'Test-set', 'Test-case',
'Test-step', 'Package' or 'Procedure' nodes often contain some
internal structure that XSLT cannot make use of. Additionally, the
internal structures employed by users may vary, depending on the
conventions used. A typical example is the use of JavaDoc tags to
describe parameters of 'Procedure' nodes. Here's an example
'Comment' for the 'Procedure'
from our standard library after the first step of the
|Example 50.48: Example 'Comment' after first step transformation|
It is very difficult to make use of the
with XSLT alone. This is where DOM processors enter the scene.
Between the first and second transformation, QF-Test can optionally run
an additional transformation directly on the DOM tree of the XML
document generated by the first step.
During that extra transformation, QF-Test traverses the DOM tree,
calling the registered DOM processors for each node to give them a
chance to manipulate the DOM.
Note For JDK 1.4 the XML Document Object Model (DOM) is part of the standard API. For earlier JDK versions it is provided by XML parser xerces (from the Apache project) which QF-Test includes. The API documentation for the DOM is available at http://download.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/package-summary.html.
The interface that must be implemented is
de.qfs.apps.qftest.extensions.DOMProcessor. It is quite trivial:
process method, the processor is free to do
whatever it likes, as long as it constrains itself to the node
passed in and its sub-nodes. The node can be replaced simply by
returning some different element node.
Note To remove an element node from the DOM, the
DOMProcessor must be registered on an ancestor of the
node, its parent node, for example. The current node may not be
removed from the DOM in the
QF-Test provides two example implementations of DOM processors. The
ParagraphProcessor is available in the
misc directory for
illustration. It is used internally to break comments which contain empty lines into
Also to be found in the
misc directory is the
DocTagProcessor which is used to transform JavaDoc tags like
@author to an XML DOM sub-tree. After processing,
the above example would look as follows:
|Example 50.49: Example comment after DOM processing|
Transforming the above into useful HTML during the second stage transformation is now straightforward.
Before a DOM processor can be used, it must be registered for the
kind of node(s) it applies to. This is done through the
There is one
DOMProcessorRegistry instance object per kind of
transformation, each identified by a string. Currently these identifiers are
"report" for report generation and
"pkgdoc" for test-set and package documentation plus their variants for
transforming the respective summary documents named
"pkgdoc-summary". To get hold of a
registry instance, use the static
The rest of the methods consist of the typical set of register/unregister variants:
Exceptions raised during DOM processing by the
process method of a
caught and duly reported, the transformation is stopped in that
|Last update: 5/17/2022|
Copyright © 1999-2022 Quality First Software GmbH