next up previous contents
Next: A.2 General Information Up: A. Tests Reference Previous: A. Tests Reference   Contents


A.1 Test Documentation Structure

The USBTester tests are documented using the following format:


T.<Test Module ID>.<Test ID>: <Test Name>


OBJECTIVES

Describes the test's objectives, i.e. what the test checks.


APPLICABLE DEVICE STATES

Lists the device states that are applicable to the test.
To fully test your device it is recommended to repeat each test for all applicable states.


PRECONDITIONS

Lists specific preconditions for the test. When a test executes another test, any preconditions of the latter also apply to the executing test.
If there are no specific preconditions, this header is omitted.


TEST PARAMETERS

Describes the test's parameters and their default values.
When the test has no parameters this header is omitted.


TEST SEQUENCE

Describes the sequence of operations performed by the test.
Unless otherwise specified, when a test executes another test it also verifies the expected result for that test.
Each step in the sequence is contingent on the success of the previous steps, unless explicitly specified otherwise.

USBTester logs debug messages to the tests log window during the tests' execution. When a test fails, you can use the log messages to locate the source of the failure.