<< Documentation Home
PTS Suite Specification

Phoronix Test Suite 1.0 Suite Specification

This document describes the XML tags for writing a test suite.

PhoronixTestSuite/SuiteInformation/

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.

PhoronixTestSuite/RunTest/
NOTE: Multiple instances of these tags are allowed for multiple tests in a suite

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.

Phoronix-Test-Suite.com
Copyright © 2008 by Phoronix Media.