<html xmlns="http://www.w3.org/1999/xhtml"> <head> <Title>Phoronix Test Suite - XML Suite Syntax</Title> <link href="includes/pts-documentation.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="pts_doc_header"><div class="pts_doc_fixed"><a href="http://www.phoronix-test-suite.com/"><div id="pts_doc_logo"></div></a></div></div> <div class="pts_doc_fixed"> <div class="pts_doc_notice"><div style="float: left"><a href="index.html"><< Documentation Home</a></div><div style="float: right;">PTS Suite Specification</div></div> <div class="pts_doc_main"> <!-- PTS AREA --> <h1>Phoronix Test Suite 1.0 Suite Specification</h1> <p>This document describes the XML tags for writing a test suite.</p> <h2>PhoronixTestSuite/SuiteInformation/</h2> <p><strong>Tag:</strong> Title<br> <strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br> <strong>Internal Reference:</strong> P_SUITE_TITLE<br> <strong>Required:</strong> Yes<br> <strong>Description:</strong> The full string title of the suite.</p> <p><strong>Tag:</strong> Version<br> <strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br> <strong>Internal Reference:</strong> P_SUITE_VERSION<br> <strong>Required:</strong> Yes<br> <strong>Description:</strong> The version of the test suite.<br> <strong>Supported Values:</strong> ( Formatted: x.x.x )</p> <p><strong>Tag:</strong> Description<br> <strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br> <strong>Internal Reference:</strong> P_SUITE_DESCRIPTION<br> <strong>Required:</strong> Recommended<br> <strong>Description:</strong> A short description of the test suite.</p> <p><strong>Tag:</strong> TestType<br> <strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br> <strong>Internal Reference:</strong> P_SUITE_TYPE<br> <strong>Required:</strong> Recommended<br> <strong>Description:</strong> The hardware area of the system that this suite is designed to stress.<br> <strong>Supported Values:</strong> System, Processor, Graphics, Disk, Memory, Motherboard</p> <p><strong>Tag:</strong> PreRunMessage<br> <strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br> <strong>Internal Reference:</strong> P_SUITE_PRERUNMSG<br> <strong>Required:</strong> No<br> <strong>Description:</strong> 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.</p> <p><strong>Tag:</strong> PostRunMessage<br> <strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br> <strong>Internal Reference:</strong> P_SUITE_POSTRUNMSG<br> <strong>Required:</strong> No<br> <strong>Description:</strong> 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.</p> <p><strong>Tag:</strong> ReferenceSystems<br> <strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br> <strong>Internal Reference:</strong> P_SUITE_REFERENCE_SYSTEMS<br> <strong>Required:</strong> No<br> <strong>Description:</strong> To provide reference test results for comparison purposes, supply Phoronix Global IDs to this tag.<br> <strong>Supported Values:</strong> ( Values must be valid Phoronix Global IDs. Multiple IDs can be delimited by a comma. )</p> <h2>PhoronixTestSuite/RunTest/<br> NOTE: Multiple instances of these tags are allowed for multiple tests in a suite</h2> <p><strong>Tag:</strong> Test<br> <strong>Location:</strong> PhoronixTestSuite/RunTest/<br> <strong>Internal Reference:</strong> P_SUITE_TEST_NAME<br> <strong>Required:</strong> Yes<br> <strong>Description:</strong> The name (identifier) of the test to run.</p> <p><strong>Tag:</strong> Arguments<br> <strong>Location:</strong> PhoronixTestSuite/RunTest/<br> <strong>Internal Reference:</strong> P_SUITE_TEST_ARGUMENTS<br> <strong>Required:</strong> No<br> <strong>Description:</strong> 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.</p> <p><strong>Tag:</strong> Description<br> <strong>Location:</strong> PhoronixTestSuite/RunTest/<br> <strong>Internal Reference:</strong> P_SUITE_TEST_DESCRIPTION<br> <strong>Required:</strong> No<br> <strong>Description:</strong> A short description describing this test and its options, which is displayed on the graph in the PTS Results Viewer.</p> <p><strong>Tag:</strong> Mode<br> <strong>Location:</strong> PhoronixTestSuite/RunTest/<br> <strong>Internal Reference:</strong> P_SUITE_TEST_MODE<br> <strong>Required:</strong> No<br> <strong>Description:</strong> If this tag is set to BATCH, it will run the test mentioned in the <em>Test</em> tag in batch mode. If this tag is set to DEFAULTS, it will run the test mentioned in the <em>Test</em> tag in the defaults mode. The <em>Description</em> and <em>Arguments</em> tags are ignored when setting one of these modes. This tag doesn't affect the mode for other test runs within the specified suite.</p> <p><strong>Tag:</strong> OverrideTestOptions<br> <strong>Location:</strong> PhoronixTestSuite/RunTest/<br> <strong>Internal Reference:</strong> P_SUITE_TEST_OVERRIDE_OPTIONS<br> <strong>Required:</strong> No<br> <strong>Description:</strong> 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.</p> <!-- END OF PTS AREA --> </div></div><div class="pts_doc_fixed"><div class="pts_doc_bottom"><div style="float: left;"><a href="http://www.phoronix-test-suite.com/">Phoronix-Test-Suite.com</a></div><div style="float: right;">Copyright © 2008 by <a href="http://www.phoronix-media.com/">Phoronix Media</a>.</div></div></div> </body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
30aff0bf82d1773eb25f0ec41a679faa
>
files
>
20
