DoxRunner
Macquarie University Student Accommodation
Overview
There are seven sections in a test case that are devoted to describing the Test Case and its script. All are optional.
A skeleton of these seven sections appear on the first page of the Test Case Template.
When the test case is created from the template using the Create Test Case operation, they are included on the first page of the new test case.
The scripter can then use them to describe the test case in as much detail as needed.
The Process Raw operation automatically copies five of these sections into vuser_init so that the scripter doesn't need to.
​
These five sections are expected to be relatively brief and are identified by the Process Raw operation via specific bookmarks.
The other two sections may be relatively long, so they aren't automatically copied into vuser_init, and there are no bookmarks associated with them.
Additional sections can be added for documentation purposes, but they will be ignored by the Process Raw operation.
​
If deleting any of these five sections, make sure you delete its associated bookmark too.
If you think that you will never use one or more of the sections, then delete it/them from the Test Case Template (including its bookmark).
Similarly if you think you will always need a section that isn't represented, then add it to the Test Case Template. If adding a section, remember that it will be copied into any new Test Case, but it won't be copied into the vuser_init file by the Process Raw operation.
​
Unlike other sections, none of these description sections are represented in the Solution document outside of the test cases. Nor do they contain a table.
How it works
As mentioned above, the Process Raw operation copies five of the seven sections into vuser_init.
Below is an example of a test case illustrating all seven sections, and how five are represented in vuser_init when the Process Raw operation is executed.
​
The above test case page is inserted into vuser_init.c as shown below
Note that and aren't copied.
Brief Description
All text typed here will be copied into the vuser_init script file by the Process Raw operation, so avoid diagrams and tables here. Try to keep the details brief and appropriate for script documentation.
Although this section is optional, it is strongly recommended.
The bookmark to the title in the Test Case Template is P_BriefDescription.
When a Test Case is created from the Test Case Template, the bookmark is changed to include the Test Case ID.
For example Test Case with ID TC001: P_BriefDescription becomes P_TC001_BriefDescription.
Description
This is where you put diagrams and/or tables if necessary to describe a complex Test Case in detail.
Try to separate Test Case details from script details, which should be described in the Scripting Notes section (illustrated below).
It is optional , however its use is highly recommended.
Because this section may be long and complicated, it isn't copied into the vuser_init script file by the Process Raw operation.
Therefore there is no bookmark.
​
Purpose
A script or test case can have more than one purpose. For example, it may only be for load testing, or it could be used to create data only and therefore not included in any test.
All text typed here will be copied into the vuser_init by the Process Raw operation.
Try to keep the details brief and appropriate for script documentation.
​
It is optional and can be deleted from the Test Case or Test Case Template (make sure you delete the bookmark too).
​
The bookmark to the title in the Test Case Template is P_Purpose.
When a test case is created from the template, the bookmark is changed to include the Test Case ID (example: P_TC001_Purpose).
Tip: The Test Case Template contains several lines that represent examples, so review them, choose one, and delete the remainder, or replace them altogether, to save time when updating the Test Case after it is created.
Success Criteria
Whether a script is successfully executed or not may be important.
This section is where you define what must happen for the script to be deemed functionally correct.
​
All text typed here will be copied into vuser_init by the Process Raw operation.
Try to keep the details brief and appropriate for script documentation.
​
It is optional and can be deleted from the Test Case or Test Case Template (make sure you delete the bookmark too).
The bookmark to the heading in the Test Case Template is P_SuccessCriteria.
​
When a Test Case is created from the template, the bookmark is changed to include Test Case ID (example: P_TC001_SuccessCriteria).
​
Tip: The Test Case Template contains an example, so review it and replace it with something that is relevant to your organisation to save time when updating the test case after it is created.
​
Script History
Typically a script's history is only maintained when a script is modified.
When it is re-scripted it is highly unlikely that the original author and subsequent maintainers will be included.
By putting the history into the Test Case rather than the script, all history will be captured and automatically copied into any new script by the Process Raw operation, saving the scripter's time.
The bookmark to the title in the Test Case Template is P_ScriptHistory.
When a Test Case is created from the template, the bookmark is changed to include the Test Case ID (example: P_TC001_ScriptHistory).
At a minimum, type in who did what, when it was done, and, more importantly, why. Too often the why is left out, leaving future maintainers scratching their heads.
​
Release Notes
This section is used to document what needs to be done to get this script working in a scenario.
That is, the script per se may be working fine, but it may need application configuration, additional attributes to be set up, special test data, special access, etc. This is where all of those elements are documented so that following testers can quickly set up a test.
​
It is optional, so for simple scripts it can be deleted, making sure you delete the bookmark as well.
The bookmark to the heading in the Test Case Template is P_ReleaseNotes.
When a Test Case is created from the template, the bookmark is changed to include the Test Case ID (example: P_TC001_ReleaseNotes).
​
Scripting Notes
This is where you put diagrams and/or tables if necessary to describe a complex script in detail.
Try to separate Test Case details from script details, which should be described in the Description section (illustrated above).
Because this section may be long and complicated, it isn't copied into the vuser_init script file by the Process Raw operation.
Therefore there is no bookmark.
​
It is optional , however its use is highly recommended.
As the script is developed, build up all of the gotchas, tips, and hints that are unique to the script, and document them clearly here, using diagrams, code examples, and tables where appropriate.
Tip: For notes that cover multiple scripts, place the note in a separate section of the Solution document and place a link to it here. For complex scripts, use sub-headings as shown in the illustration below.
The example illustrated here shows an extremely complex script, and shows why it's not copied into vuser_init:
​
Documentation
Each of the seven Description sections are described below.
​
