AutoGenerateResult element

Article
03/28/2018

Designates the custom diagnostic test as a test that validates whether the result of the test matches an expected value or if it is consistent for all nodes in the HPC cluster. It also indicates that the diagnostic service should automatically generate a report for the test that is appropriate for these types of tests.

Usage

<AutoGenerateResult
  TestType = "enumeration"
  ExpectedValue = "character_string"/>

Attributes

Attribute	Type	Required	Description
ExpectedValue	character_string	No	Specifies the name of the global parameter that contains the value that the results of the test should match, when the value of the TestType attribute is Comparison. This attribute is required if the value of the TestType attribute is Comparison. If the value of the TestType attribute is Consistency, the ExpectedValue attribute is ignored. The definition for the parameter that the ExpectedValue attribute names cannot contain a value for the Format attribute of the Parameter element unless that value is the default value of -{0}:{1}.
TestType	enumeration	Yes	Specifies the type of the diagnostic test and the kind of report that the test should generate. This attribute can have one of the following values: Consistency The diagnostic test checks that the results of the RunStep stage of the test are identical for all of the nodes that the user runs the test on. The test succeeds if all of the results are identical, and the test fails if any of the results differ from one another. The diagnostic service automatically generates a report for the test that indicates whether the results were identical, and the report lists the output of test for each node. Comparison The diagnostic test checks that the results of the RunStep stage for each node in the test match the value that the user supplied for the global parameter that is named by the ExpectedValue attribute. The test succeeds if the results for all of the nodes match the expected value, and the test fails if the result for any of the nodes differs from the expected value. The diagnostic service automatically generates a report for the test that indicates whether the results for all of the nodes matched the expected value, and the report lists the output of test for each node.

ExpectedValue

character_string

Specifies the name of the global parameter that contains the value that the results of the test should match, when the value of the TestType attribute is Comparison.

This attribute is required if the value of the TestType attribute is Comparison. If the value of the TestType attribute is Consistency, the ExpectedValue attribute is ignored.

The definition for the parameter that the ExpectedValue attribute names cannot contain a value for the Format attribute of the Parameter element unless that value is the default value of -{0}:{1}.

TestType

enumeration

Yes

Specifies the type of the diagnostic test and the kind of report that the test should generate. This attribute can have one of the following values:

Consistency

The diagnostic test checks that the results of the RunStep stage of the test are identical for all of the nodes that the user runs the test on. The test succeeds if all of the results are identical, and the test fails if any of the results differ from one another.

The diagnostic service automatically generates a report for the test that indicates whether the results were identical, and the report lists the output of test for each node.

Comparison

The diagnostic test checks that the results of the RunStep stage for each node in the test match the value that the user supplied for the global parameter that is named by the ExpectedValue attribute. The test succeeds if the results for all of the nodes match the expected value, and the test fails if the result for any of the nodes differs from the expected value.

The diagnostic service automatically generates a report for the test that indicates whether the results for all of the nodes matched the expected value, and the report lists the output of test for each node.

Child elements

There are no child elements.

Parent elements

Element	Description
DiagnosticTest	Defines a custom diagnostic test, including the metadata, parameters, environment variables, and commands for the test.

DiagnosticTest

Defines a custom diagnostic test, including the metadata, parameters, environment variables, and commands for the test.

Remarks

You can include the AutoGenerateResult element or the PostStep element in the XML file that define a custom diagnostic test, but do not include both elements. If the definition of the test includes a PostStep element, the AutoGenerateResult element is ignored.

Element information

Schema file	DiagnosticTests.xsd
Can be empty	Yes