This document describes the XML tags for writing a test suite.
Tag: Title
Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_TITLE
Required: Yes
Description: The full string title of the suite.
Tag: Version
Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_VERSION
Required: Yes
Description: The version of the test suite.
Supported Values: ( Formatted: x.x.x )
Tag: Description
Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_DESCRIPTION
Required: Recommended
Description: A short description of the test suite.
Tag: TestType
Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_TYPE
Required: Recommended
Description: The hardware area of the system that this suite is designed to stress.
Supported Values: System, Processor, Graphics, Disk, Memory, Motherboard
Tag: PreRunMessage
Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_PRERUNMSG
Required: No
Description: If the user needs to be alerted about something dealing with this
suite -- and just not to a specific test -- this tag can contain a string that will be shown to the user before the
tests in the suite are executed.
Tag: PostRunMessage
Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_POSTRUNMSG
Required: No
Description: If the user needs to be alerted about something dealing with this
suite -- and just not to a specific test -- this tag can contain a string that will be shown to the user after the
tests in the suite are executed.
Tag: ReferenceSystems
Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_REFERENCE_SYSTEMS
Required: No
Description: To provide reference test results for comparison purposes, supply Phoronix Global IDs to this tag.
Supported Values: ( Values must be valid Phoronix Global IDs. Multiple IDs can be delimited by a comma. )
Tag: Test
Location: PhoronixTestSuite/RunTest/
Internal Reference: P_SUITE_TEST_NAME
Required: Yes
Description: The name (identifier) of the test to run.
Tag: Arguments
Location: PhoronixTestSuite/RunTest/
Internal Reference: P_SUITE_TEST_ARGUMENTS
Required: No
Description: Only the default arguments are extracted from the test profile. All
other arguments you wish to supply (as the end-user isn't prompted of any options
when running a suite) should be supplied as a value in this tag.
Tag: Description
Location: PhoronixTestSuite/RunTest/
Internal Reference: P_SUITE_TEST_DESCRIPTION
Required: No
Description: A short description describing this test and its options, which is
displayed on the graph in the PTS Results Viewer.
Tag: Mode
Location: PhoronixTestSuite/RunTest/
Internal Reference: P_SUITE_TEST_MODE
Required: No
Description: If this tag is set to BATCH, it will run the test mentioned in the Test tag in batch mode. If this tag is set to
DEFAULTS, it will run the test mentioned in the Test tag in the defaults mode. The Description and Arguments tags are ignored when setting one of these modes. This tag doesn't affect the mode for other test runs within the specified suite.
Tag: OverrideTestOptions
Location: PhoronixTestSuite/RunTest/
Internal Reference: P_SUITE_TEST_OVERRIDE_OPTIONS
Required: No
Description: If this tag is used, it can override XML tags within a test profile, such as to change the number of times that test is run, just only for that instance within the suite. Specify either just the tag name or the entire path to that tag and then specify the forced value when it's delimited by an equal sign. Multiple tags can be forced when each forced option is delimited by a semicolon.
The ability to have weighted test suites that would generate a composite / weighted score off all of the test runs within a suite was introduced in Phoronix Test Suite 2.2. However, the tags for weighted suites are not yet finalized or documented.