LUTF Document Generation

Video Transcript

The LUTF Documentation Block

Let's continue with our documentation discussion and dive into some LUTF details

Each test script should include a documentation block. Not all elements shown here are needed. But the more complete it is the more complete the generated document will be.

"""
@PRIMARY: Primary Requirement ID
@PRIMARY_DESC: Textual description of the primary requirement
@SECONDARY: Secondary Requirement IDs if applicable
@DESIGN: Design details
@TESTCASE: Test case description
"""

Let's look at a concrete example.

Each test case in our sample suite has a documentation block.

The LUTF can generate documentation with the create_docs() command.

suites['samples'].create_docs("samples")

This will generate three csv files, one for the requirement document, the second for the design document and the third for the test plan document.

Requirement Document

HLD

Test Plan

NOTE: The secondary field lists the requirement ids which the test case might touch on.

The csv files can then be imported directly into the Confluence wiki or embedded in a document.