TestRunConfiguration Class

Article
03/28/2012

Provides the configuration of the test job that is currently being executed. This class cannot be inherited.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.TestTools.Common.TestRunConfiguration

Namespace: Microsoft.VisualStudio.TestTools.Common
Assembly: Microsoft.VisualStudio.QualityTools.Common (in Microsoft.VisualStudio.QualityTools.Common.dll)

Syntax

'Declaration
<SerializableAttribute> _
Public Class TestRunConfiguration _
    Implements ICloneable, IVerifiable, IVisiblePropertyProvider, ISerializable,  _
    IXmlTestStore, IXmlTestStoreCustom

[SerializableAttribute]
public class TestRunConfiguration : ICloneable, 
    IVerifiable, IVisiblePropertyProvider, ISerializable, IXmlTestStore, IXmlTestStoreCustom

[SerializableAttribute]
public ref class TestRunConfiguration : ICloneable, 
    IVerifiable, IVisiblePropertyProvider, ISerializable, IXmlTestStore, IXmlTestStoreCustom

[<SerializableAttribute>]
type TestRunConfiguration =  
    class
        interface ICloneable
        interface IVerifiable
        interface IVisiblePropertyProvider
        interface ISerializable
        interface IXmlTestStore
        interface IXmlTestStoreCustom
    end

public class TestRunConfiguration implements ICloneable, IVerifiable, IVisiblePropertyProvider, ISerializable, IXmlTestStore, IXmlTestStoreCustom

The TestRunConfiguration type exposes the following members.

Constructors

	Name	Description
	TestRunConfiguration(SerializationInfo, StreamingContext)	Initializes a new instance of the TestRunConfiguration class from XML by using the provided information and context.
	TestRunConfiguration(String, String)	Initializes a new instance of the TestRunConfiguration class by using the name and storage information of the test run configuration.

Top

Properties

	Name	Description
	AbortRunOnError	Gets or sets a Boolean value that indicates whether to stop the test run if an error occurs.
	AgentNotRespondingTimeout	Gets or sets the time limit for non-responding test agents.
	AgentProperties	Gets a hash table that consists of keys and values that represent the properties of the specified agent.
	ApartmentState	Gets the apartment state that is currently set for this run configuration.
	BucketSize	Gets or sets the bucket size for the run configuration.
	CleanupCommand	Gets or sets the command to clean up the run configuration.
	DefaultUserDeploymentRootDirectory	Gets or sets the default deployment root directory for the test runner.
	DeploymentItems	Gets or sets the items to be deployed with a test run.
	DeploymentRootDirectory	Gets or sets the general deployment root directory.
	DeploymentTimeout	Gets or sets the time limit for deployment.
	Description	Gets or sets the description of the test run.
	ElementName	Gets the run configuration that is saved in the test settings format, under the element "TestSettings".
	HostData	Gets or sets the test run configuration data on the active host.
	HostProcessPlatform	Gets or sets the processor architecture of the host system.
	Id	Gets the ID of the run configuration.
	IsCodeCoverageEnabled	Gets or sets a Boolean value that indicates whether code coverage collection is enabled for this test run.
	IsDeploymentEnabled	Gets a Boolean value that indicates whether deployment is enabled. Set accessor is set to internal.
	IsExecutedOutOfProc	Gets a Boolean value that indicates whether the test is executed in a separate process. Set accessor is set to internal.
	IsExecutedRemotely	Gets or sets a Boolean value that indicates whether the test run must be executed remotely.
	IsExecutedUnderDebugger	Gets or sets a Boolean value that indicates whether the test run was executed with the debugger.
	IsRemoteDataCollectionEnabled	Gets a Boolean value that indicates whether any data collectors are enabled.
	Name	Gets or sets the name of the run configuration.
	NamespaceUri	Gets the uniform resource identifier (URI) of the current namespace.
	RelativePathRootDirectory	Gets or sets the directory that is used when relative file paths occur.
	RunDeploymentInDirectory	Gets the directory that receives deployed files from the test controller.
	RunDeploymentOutDirectory	Gets the directory that contains files to deploy to the test controller.
	RunTimeout	Gets or sets the time limit for the test run.
	SetupCommand	Gets or sets the setup command for the test run.
	SkipUnhostableTests	Gets or sets a Boolean value that indicates whether the tests that have no host must be skipped.
	Storage	Gets or sets the file name where the run configuration is stored.
	TestTimeout	Gets or sets the time limit for testing.
	UseDefaultDeploymentRootDirectory	Gets or sets a Boolean value that indicates whether to use the default deployment root directory.
	UserDeploymentRootDirectory	Gets or sets the deployment root directory that will be used when UseDefaultDeploymentRootDirectory is false.
	VisibleProperties	Gets the description of a property.

Top

Methods

	Name	Description
	Clone	Returns a clone whose data is the same as this object.
	Equals	Determines whether the provided TestRunConfiguration object is equal to the current object. (Overrides Object.Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code of the ID of the run configuration. (Overrides Object.GetHashCode().)
	GetObjectData	Populates a SerializationInfo with the data required to serialize the target object.
	GetTestElementTimeout	Returns the time-out that is specified for the given test.
	GetTestTypeSpecificData	Returns test type−specific run configuration extension data (clone) for the specified test type.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsValid	Returns a Boolean value that indicates whether the run configuration is valid.
	Load	Loads an instance of this class from the provided XML element by using the provided parameters.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Save	Saves this object in the provided XML element by using the provided parameters.
	SetTestEnvironment	Sets the test environment to use in a test run by using these test settings and the controller that hosts the test environment.
	SetTestTypeSpecificData	Sets type-specific run configuration extension data for the specified test type.
	ToString	Returns a string representation of the run configuration. (Overrides Object.ToString().)

Top

Fields

	Name	Description
	DefaultDeploymentRootDirectory	Provides a default directory for local deployment.
	DefaultRelativePathRoot	Provides the default root path for relative deployment items.

Top

Remarks

This class implements [T:System.ICloneable,] IVerifiable, and IVisiblePropertyProvider.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.