Share via


TestRunConfiguration Class

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

Inheritance Hierarchy

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

Top

Methods

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

Top

Fields

  Name Description
Public fieldStatic member DefaultDeploymentRootDirectory Provides a default directory for local deployment.
Public fieldStatic member 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.

See Also

Reference

Microsoft.VisualStudio.TestTools.Common Namespace

ICloneable

IVerifiable

IVisiblePropertyProvider