Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

TestRunConfiguration Class

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

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

Namespace:  Microsoft.VisualStudio.TestTools.Common
Assembly:  Microsoft.VisualStudio.QualityTools.Common (in Microsoft.VisualStudio.QualityTools.Common.dll)
[SerializableAttribute]
public class TestRunConfiguration : ICloneable, 
	IVerifiable, IVisiblePropertyProvider, ISerializable, IXmlTestStore, IXmlTestStoreCustom

The TestRunConfiguration type exposes the following members.

  NameDescription
Protected methodTestRunConfiguration(SerializationInfo, StreamingContext)Initializes a new instance of the TestRunConfiguration class from XML by using the provided information and context.
Public methodTestRunConfiguration(String, String)Initializes a new instance of the TestRunConfiguration class by using the name and storage information of the test run configuration.
Top
  NameDescription
Public propertyAbortRunOnErrorGets or sets a Boolean value that indicates whether to stop the test run if an error occurs.
Public propertyAgentNotRespondingTimeoutGets or sets the time limit for non-responding test agents.
Public propertyAgentPropertiesGets a hash table that consists of keys and values that represent the properties of the specified agent.
Public propertyApartmentStateGets the apartment state that is currently set for this run configuration.
Public propertyBucketSizeGets or sets the bucket size for the run configuration.
Public propertyCleanupCommandGets or sets the command to clean up the run configuration.
Public propertyDefaultUserDeploymentRootDirectoryGets or sets the default deployment root directory for the test runner.
Public propertyDeploymentItemsGets or sets the items to be deployed with a test run.
Public propertyDeploymentRootDirectoryGets or sets the general deployment root directory.
Public propertyDeploymentTimeoutGets or sets the time limit for deployment.
Public propertyDescriptionGets or sets the description of the test run.
Public propertyElementNameGets the run configuration that is saved in the test settings format, under the element "TestSettings".
Public propertyHostDataGets or sets the test run configuration data on the active host.
Public propertyHostProcessPlatformGets or sets the processor architecture of the host system.
Public propertyIdGets the ID of the run configuration.
Public propertyIsCodeCoverageEnabledGets or sets a Boolean value that indicates whether code coverage collection is enabled for this test run.
Public propertyIsDeploymentEnabledGets a Boolean value that indicates whether deployment is enabled. Set accessor is set to internal.
Public propertyIsExecutedOutOfProcGets a Boolean value that indicates whether the test is executed in a separate process. Set accessor is set to internal.
Public propertyIsExecutedRemotelyGets or sets a Boolean value that indicates whether the test run must be executed remotely.
Public propertyIsExecutedUnderDebuggerGets or sets a Boolean value that indicates whether the test run was executed with the debugger.
Public propertyIsRemoteDataCollectionEnabledGets a Boolean value that indicates whether any data collectors are enabled.
Public propertyNameGets or sets the name of the run configuration.
Public propertyNamespaceUriGets the uniform resource identifier (URI) of the current namespace.
Public propertyRelativePathRootDirectoryGets or sets the directory that is used when relative file paths occur.
Public propertyRunDeploymentInDirectoryGets the directory that receives deployed files from the test controller.
Public propertyRunDeploymentOutDirectoryGets the directory that contains files to deploy to the test controller.
Public propertyRunTimeoutGets or sets the time limit for the test run.
Public propertySetupCommandGets or sets the setup command for the test run.
Public propertySkipUnhostableTestsGets or sets a Boolean value that indicates whether the tests that have no host must be skipped.
Public propertyStorageGets or sets the file name where the run configuration is stored.
Public propertyTestTimeoutGets or sets the time limit for testing.
Public propertyUseDefaultDeploymentRootDirectoryGets or sets a Boolean value that indicates whether to use the default deployment root directory.
Public propertyUserDeploymentRootDirectoryGets or sets the deployment root directory that will be used when UseDefaultDeploymentRootDirectory is false.
Public propertyVisiblePropertiesGets the description of a property.
Top
  NameDescription
Public methodCloneReturns a clone whose data is the same as this object.
Public methodEqualsDetermines whether the provided TestRunConfiguration object is equal to the current object. (Overrides Object.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code of the ID of the run configuration. (Overrides Object.GetHashCode().)
Public methodGetObjectDataPopulates a SerializationInfo with the data required to serialize the target object.
Public methodGetTestElementTimeoutReturns the time-out that is specified for the given test.
Public methodGetTestTypeSpecificDataReturns test type−specific run configuration extension data (clone) for the specified test type.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsValidReturns a Boolean value that indicates whether the run configuration is valid.
Public methodLoadLoads an instance of this class from the provided XML element by using the provided parameters.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSaveSaves this object in the provided XML element by using the provided parameters.
Public methodSetTestEnvironmentSets the test environment to use in a test run by using these test settings and the controller that hosts the test environment.
Public methodSetTestTypeSpecificDataSets type-specific run configuration extension data for the specified test type.
Public methodToStringReturns a string representation of the run configuration. (Overrides Object.ToString().)
Top
  NameDescription
Public fieldStatic memberDefaultDeploymentRootDirectoryProvides a default directory for local deployment.
Public fieldStatic memberDefaultRelativePathRootProvides the default root path for relative deployment items.
Top

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.