There are a few things to note about the script:
The documentation block:
""" @PRIMARY: sample_01 @SECONDARY: sample_01 @DESCRIPTION: Simple Hello Lustre test """ |
It's enclosed in """
.
By specifying these the LUTF can generate automatic documentation for the test scripts. We no longer need to maintain a separate test plan. Our test scripts become our test plan.
One way of working would be to create a skeleton of the scripts which just include the above comment block. Then run the create_docs() command on the suite
suites['samples'].create_docs("samples.csv") |
This will generate a csv file with all the documentation.
This can then be imported directly into the Confluence wiki.
Let's run through this process to show how easy it is.