Microsoft.VisualStudio.QualityTools.ExecutionCommon

The enumeration is used by the testing framework to indicate the success or failure of a test run.

The enumeration value is 1. The test run failed.

The enumeration value is 0. The test run succeeded.

Encapsulates the context of the agent environment.

Initializes a new instance of the class by using the provided parameters.

The name of the agent. The display name for the agent. The machine name of the agent and the port on which it listens for incoming connections. true if the agent is accessed remotely; otherwise, false.

Gets the machine name of the agent and the port on which it listens for incoming connections.

A string that contains the machine name and port.

Returns a new for a locally hosted agent.

A new for a locally hosted agent.

Gets or sets the display name of the agent, which is unique throughout an environment.

A string that contains the display name of the agent.

Gets a value that indicates whether this agent context is executed remotely.

true if this agent context is executed remotely; otherwise, false.

Gets or sets the fully qualified name of the agent as registered with the test controller.

The fully qualified name of the agent as registered with the T:Microsoft.TeamFoundation.TestManagement.Client.ITestController.

Collects information that is required to request a file or stream transfer from a diagnostic data adapter.

Initializes a new instance of the class by using the provided context.

A object.

Gets the path and name of the file on the client.

The path and name of the file on the client.

Gets or sets the context for the diagnostic data adapter.

The context for the diagnostic data adapter.

Gets or sets a short description of the data that is sent.

A short description of the data that is sent.

Gets a value that indicates whether a cleanup should be performed after the transfer.

true if a cleanup should be performed after the transfer; otherwise, false.

Gets or sets the ID of the request that is associated with the transferred data.

The ID of the request that is associated with the transferred data.

Gets or sets a token that can be used with a notification when an asynchronous transfer is completed to uniquely identify this transfer.

A token that can be used with a notification when an asynchronous transfer is completed to uniquely identify this transfer.

Represents the current context for a test controller.

Initializes a new instance of the class by using the provided name, display name, and connection string.

The fully qualified name of the controller. The display name for the controller. Typically, this is the Domain Name Server (DNS) host name of the controller machine, excluding the domain suffix. The name of the controller. This includes the port number.

Gets the name of the controller. This includes the port number. The set accessor is for internal use only.

The name of the controller. This includes the port number.

Creates a new controller context that is initialized for a locally hosted controller.

A new instance of this class.

Gets the display name for the controller. The set accessor is for internal use only.

The display name for the controller.

Gets the fully qualified name of the controller. The set accessor is for internal use only.

The fully qualified name of the controller. Returns .

Provides a base class for event argument classes that are used in custom diagnostic data adapters.

Initializes a new instance of the class for sending a custom notification for the testing session.

Initializes a new instance of the class for sending a custom notification for a test case by using the provided test execution ID.

The for the current test case.

Represents the context in which data collection occurs.

Initializes a new instance of the class by using the provided session ID.

A object.

Initializes a new instance of the class by using the provided session ID and test execution ID.

A object. A object.

Determines whether the specified matches the current .

true if the specified matches the current ; otherwise, false. The to compare with the current .

Serves as a hash function for a .

A hash code for the current .

Gets a value that indicates whether an executing test case is associated with this context.

true if an associated test case is being executed; otherwise, false.

Returns a value that indicates whether two instances of match.

true if and match; otherwise, false. A . A .

Returns a value that indicates whether two instances of do not match.

true if and do not match; otherwise, false. A . A .

Gets the for the session under which the data collection occurs. Will not be null.

A object.

Gets a that identifies the test execution under which the data collection occurs.

A object, or null if no executing test is associated with this context.

Encapsulates the environment where a diagnostic data adapter is hosted.

Initializes a new instance of the class by using the provided agent context, controller context, and session data collection context.

The for the agent. The for the controller. The for the diagnostic data adapter.

Initializes a new instance of the class by using the provided agent context, controller context, session data collection context, and test case manager context.

The for the agent. The for the controller. The for the diagnostic data adapter. The for the test case manager.

Gets the agent context. The set accessor is for internal use only.

The agent context.

Gets the test controller context. The set accessor is for internal use only.

The test controller context.

Returns a data collection environment context for a locally hosted agent and controller.

A data collection environment context.

Returns a data collection environment context for a locally hosted agent and controller by using the provided session data collection context.

A data collection environment context for a locally hosted agent and controller. A object.

Gets the session context for a diagnostic data adapter. The set accessor is for internal use only.

The session context for a diagnostic data adapter.

Gets the context for the test case manager.

The context for the test case manager.

The base class for all execution event arguments.

Initializes the instance by storing the given information.

Context information for the event.

Gets or sets the context information for the event.

Returns the context information for the event.

Defines the execution events that diagnostic data adapters can register.

Occurs in response to a custom notification.

Raised to request intermediate data.

Raised when a test session ends.

Raised when a test session pauses.

Raised when a test session resumes.

Raised when a test session starts.

Raised when a test case ends.

Raised when a test case pauses.

Raised when a test case resets.

Raised when a test case resumes.

Raised when a test case starts.

Raised when a test step ends.

Raised when a test step starts.

Sends error messages for diagnostic data adapters to the client, which can be the test runner, Visual Studio IDE, or Visual Studio Test Professional.

Logs an error message for an exception.

The in which the message is sent. The exception. Cannot be null.

Logs an error message.

The in which the message is sent. The error text. Cannot be null.

Logs an error message for an exception.

The in which the message is sent. Text that explains the exception. Cannot be null. The exception. Cannot be null.

Logs a warning message.

The in which the message is sent. The warning text. Cannot be null.

Diagnostic data adapters use a to store files and XML data for later attachment to bugs and test reports.

Initializes a new instance of the class.

Sends a file asynchronously to the by using the parameters that are specified for this method.

An that describes the context within which the test is running. Cannot be null. The local path where the file exists. true to automatically delete the file after sending it; otherwise, false. The does not exist.

Sends an intermediate file asynchronously to the by using the parameters that are specified for this method.

An that describes the context within which the test is running. Cannot be null. The local path where the file exists. A short description of the file. true to automatically delete the file after sending it; otherwise, false.

Sends an intermediate file asynchronously to the by using the provided file transfer information object.

A object.

Occurs when a file has been sent to the .

Sends a stream to the by using the parameters that are specified for this method.

An that describes the context within which the test is running. Cannot be null. The to send. The file name to use for the data on the client. true to automatically close the stream when sending is completed; otherwise, false. The is null, is empty, is a reserved file name, or contains invalid characters. The cannot be read.

Sends a stream to the by using the parameters that are specified for this method.

An that describes the context within which the test is running. Cannot be null. The System.IO.Stream to send. The file name to use for the data on the client. Must not be null or empty and cannot contain illegal characters. Do not include a complete path. A short description for the file. true to automatically close the stream when sending is completed; otherwise, false. The is null, is empty, is a reserved file name, or contains invalid characters. The cannot be read.

Sends a stream to the by using the parameters that are specified for this method.

A object.

Occurs when a stream has been sent to the .

Provides a base class for custom diagnostic data adapters.

Initializes a new instance of the class.

Releases all resources that are used by the .

Releases the unmanaged resources that are used by the and optionally releases the managed resources.

true to release the managed resources.

Called by the testing framework to initialize the internal objects and data for a custom diagnostic data adapter.

An that has test configuration data. A object that has the events for which your custom diagnostic data adapter can register. A object that your custom diagnostic data adapter can use to save files and data. A object that your custom diagnostic data adapter can use to log information during a test. A that has information about the context of the current test.

Specifies the configuration editor that the testing framework should use to configure the diagnostic data adapter.

Initializes a new instance of the class by using the provided editor type.

A uniform resource identifier (URI) that indicates the type of the editor that must derive from the interface.

Gets or sets the URI for the help content for the configuration editor.

The URI for the help content for the configuration editor.

Gets a URI that indicates the type of the editor.

A URI that indicates the type of the editor.

Identifies a diagnostic data adapter configuration editor in the form of a uniform resource identifier (URI).

Initializes an instance of the by using the provided URI for the type of the diagnostic data adapter configuration editor.

URI of the data collector configuration editor. Cannot be null.

Gets the URI that uniquely identifies the type of the diagnostic data adapter configuration editor.

A string that contains the URI for the type of the diagnostic data adapter configuration editor.

Attaches a description to a custom diagnostic data adapter.

Initializes an instance of the by using the provided description of the diagnostic data adapter.

A string that contains a description of the diagnostic data adapter.

Initializes a by using the description of the data collector.

Description of the diagnostic data adapter or resource name that contains the description. true to indicate that the string that is provided for the description is a resource name; false to indicate that the string that is provided should be used directly as the description for the data collector.

Gets the description of the diagnostic data adapter.

A string that contains the description of the diagnostic data adapter.

Indicates whether the string that is provided for the description is a resource name or the actual description for the diagnostic data adapter.

true if the provided string for the description is a resource name;false if the provided string should be used directly as the description for the diagnostic data adapter.

Designates that the diagnostic data adapter class is enabled by default when the adapter is listed in the Test Manager user interface (UI).

Initializes an instance of the class, which is enabled by default.

Initializes an instance of the class by using the provided value to determine whether the adapter is enabled by default.

true to enable the collector by default; otherwise, false.

Gets or sets the enabled-by-default state.

A bool value that indicates whether the diagnostic data adapter is enabled by default.

Defines a friendly name for the diagnostic data adapter.

Initializes an instance of the class with the provided friendly name for the diagnostic data adapter.

Friendly name of the diagnostic data adapter.

Initializes an instance of the class with the friendly name and indicates whether the string is a resource name.

Friendly name of the diagnostic data adapter or resource name that contains the friendly name. true indicates that the string that is provided for the friendly name is a resource name. false indicates that the string that is provided should be used directly as the friendly name for the adapter.

Gets the user-friendly name for the diagnostic data adapter.

A string that contains the user-friendly name for the collector.

Gets the value that indicates whether the friendly name is a resource name.

A bool value that indicates whether the provided string for the friendly name is a resource name. A value of false indicates that the provided string should be used directly as the friendly name for the data collector; otherwise, the friendly name is extracted from a resource that depends on the current language setting.

Used by custom test adapters to raise events for diagnostic data adapters.

Initializes a new instance of the class.

Raised by the testing framework when a diagnostic data adapter has finished handling an asynchronous event.

Raises a custom event by using the provided event arguments.

A custom class that is derived from .

Raises a custom event by using the provided event arguments and indication of broadcast level.

A custom class that is derived from . A member of the enumeration.

Asynchronously raises a custom event by using the provided event arguments.

A custom class that is derived from .

Asynchronously raises a custom event by using the provided event arguments and indication of broadcast level.

A custom class that is derived from . A member of the enumeration.

Asynchronously raises a custom event by using the provided event arguments, indication of broadcast level, and user token.

A custom class that is derived from . A member of the enumeration. A token that can be returned in the event to identify this custom notification.

Raises a event to notify diagnostic data adapters that the test case has failed.

An object that represents the current test case. One of the values.

Reads and updates the configuration settings and static data for a diagnostic data adapter.

Gets or sets the configuration for the diagnostic data adapter.

An XML element that contains the configuration for the diagnostic data adapter.

Gets the default configuration of the diagnostic data adapter.

An XML element that contains the default configuration of the diagnostic data adapter.

Gets or sets a value to enable or disable the diagnostic data adapter.

A bool value that indicates whether the diagnostic data adapter is enabled. Returns . Returns .

Uses a URI to uniquely identify the type of a diagnostic data adapter.

Creates an instance of the class by using the provided string as the URI for the diagnostic data adapter.

URI of the diagnostic data adapter type.

Gets the URI that uniquely identifies the type of the diagnostic data adapter.

A string that contains the URI that uniquely identifies the type of the diagnostic data adapter. Returns . Returns . Returns .

Event arguments class for events.

Gets or sets the that uniquely identifies this request context.

The that uniquely identifies this request context.

Provides utility methods to help execute and debug tests.

Requests a debug operation for a test.

A object that contains the result of the debug operation. The IResultSink to which you send the debug request. The GUID identifier for the test run. A DebugTargetInfo object that contains information about the debug operation. The to wait for the debugger to perform the debug operation.

Represents information that is required to request a file transfer.

Initializes a new instance of the class.

A object. The path of the file on the client file system. true to delete the file after the transfer is completed.

Gets the path and file name of the file on the client file system.

The path and file name of the file on the client file system.

Gets a value that indicates whether to delete the local file when the transfer is completed.

true to delete the file after the transfer; otherwise, false.

Gets or sets the path and file name of the file on the client file system.

The path and file name of the file on the client file system.

Gets a value that indicates whether a cleanup process should be performed after the transfer.

true to perform cleanup; otherwise, false.

Provides an interface to use as a base for a custom test adapter.

Called when an internal error occurs during a test run. This method should behave similarly to the method.

Called when a test run is completed.

Called when the user requests to pause a test run.

Called when the user requests to resume a test run.

Called to execute a test case.

The test element that describes which adapter to load.  The context for the adapter. 

Called when the user requests to stop a test run.

Provides an interface that the test adapter uses to communicate with the test execution framework.

Sends a request to pause the test run.

Gets an object used to send test results to the test execution framework.

Returns the for this run context.

Gets information about the test run.

An that contains the execution run configuration.

Sends a request to stop the test run.

Provides an interface that the test adapter uses to run one or more inner tests.

An object.

Interface to use to build a helper class to store and retrieve values from contexts.

Adds an element by using the specified key and value.

A string that represents the key of the element to add. A double value to add.

Adds an element with the specified key and value.

A string that represents the key of the element to add. An int value to add.

Adds an element with the specified key and value.

A string that represents the key of the element to add. An object value to add.

Adds an element with the specified key and value.

A string that represents the key of the element to add. A string value to add.

Gets the total number of values that are stored.

An int that indicates the number of values that are stored.

Retrieves the value that is associated with the specified key.

The retrieved double value. A string that represents the key of the element to retrieve.

Returns an that iterates through the .

An for the .

Retrieves the value that is associated with the specified key.

The retrieved int value. A string that represents the key of the element to retrieve.

Retrieves the object that is associated with the specified key.

The retrieved object value. A string that represents the key for the value to retrieve.

Retrieves a string that is associated with the specified key.

The retrieved string value. The key for the string to retrieve.

Removes the element with the specified key.

 The key for the element to remove.

Provides an interface that adds the ability to raise events for diagnostic data adapters to custom test adapters.

Gets or sets a object that can raise events for diagnostic data adapters.

A diagnostic data adapter (data collector) notifications object.

Interface for an object that encapsulates the current environment for custom diagnostic data adapters.

Gets an object that saves the results from a test on the Test Manager server.

An object.

Gets an object that enables access to each value in the context.

An object.

Gets a reference to the test run object.

A object.

Provides an interface that creates custom configuration editors of diagnostic data adapters.

Initializes the configuration editor with a service provider and the configuration settings for a diagnostic data adapter.

An that allows the consumer to query the parent for any services that it may provide. A object that has the current settings of the diagnostic data adapter.

Resets the configuration editor to the default settings.

Saves the data in the configuration editor.

A object for the diagnostic data adapter.

Verifies whether any errors have occurred. Typically called by the framework before closing the data collector configuration editor.

true if no errors have occurred; otherwise, false.

Interface for test run information.

Gets the list of test elements in the run.

Returns the list of test elements in the test run.

Gets a object.

Returns a object.

Interface to provide support for test execution in a host application.

Loads and returns the test adapter for the given test element and run context.

The current . An that describes which test adapter to load. The for the test adapter.

Provides an interface for a host adapter agent to publish on a remoting channel.

Verifies connectivity if no error results from a call to this method.

Registers the .

The to register.

Interface to send messages, results, and notifications.

Adds the message to the result sink.

The to add to the result sink.

Provides an interface for test adapters to retrieve information about a test run.

Gets the name of the computer that is running the test.

The name of the computer that is running the test.

Gets the run context variables.

An object that contains the named values for the context.

A context interface definition for a test context that is passed to a method during the test run process.

Gets the properties for this test context.

An object that contains the properties for this test context.

Gets the result sink for this test context, which contains the pass or fail result of the test.

An object for this test context.

Gets the run context variables.

An object that contains the run context variables.

Gets the test context variables.

An object that contains the test context variables.

Pluggable interface that is used to execute code in the test execution framework.

This method is called after all tests have been completed, signifying that the test run is finished,.

The test run that is currently processed and for which a special action is required. An object that is used to send data. An object that represents the context for the test.

This method is called after the test has completed.

An object that represents the context for the test. The test ID. 

This method is called before a test run execution starts.

The test run that is currently processed and for which a special action is required. An object that is used to send data. An object that represents the context for the test.

This method is called before a test starts.

true if the agent should continue to run the test; false if the agent should not run the test.NoteWhen false is returned, the agent assumes that the plug-in reported a test failure for that test and does not record a result. Even when false is returned, the plug-in will still raise a event for that test. An object that represents the context for the test. The test ID. 

Provides an interface between the controller and the agent to enable a suite adapter to call back and execute a list of test cases.

Runs a load test case.

A member of the enumeration that indicates the success or failure of each test. Array of objects to execute. An to store the results of the tests. An IDictionary object that contains the context properties for the test.

Runs a test case.

A member of the enumeration that indicates the success or failure of each test. Array of objects to execute. An to store the results of the tests.

Returns . Returns . Returns .

Enumerates the scope of diagnostic data adapters to which test adapters can broadcast custom notification events.

Broadcast notification events to all diagnostic data adapters, both local and remote.

Broadcast notification events only to local diagnostic data adapters.

Uniquely identifies a request and can be used with messages and events.

Compares this instance with the provided .

A 32-bit signed integer that indicates the relative order of the s that are being compared. The return value has these meanings:Less than zeroThis instance is less than .ZeroThis instance is equal to .Larger than zeroThis instance is greater than . The for comparison.

Compares this instance with the provided object.

A 32-bit signed integer that indicates the relative order of the objects that are being compared. The return value has these meanings:Less than zeroThis instance is less than .ZeroThis instance is equal to .Larger than zeroThis instance is greater than . The object for comparison. Object is not of type .

A with an empty GUID.

Compares this instance with the provided for value equality.

true if equal; otherwise, false. The for comparison.

Compares this instance with the provided object for value equality.

true if equal; otherwise, false. The object of type for comparison.

Gets a hash code for this instance.

The underlying hash code for this .

Gets or sets the underlying GUID that represents the .

A GUID that represents the .

Compares two s for value equality.

true if equal; otherwise, false. The on the left-hand side of the equality operator. The on the right-hand side of the equality operator.

Compares two s for value inequality.

true if not equal; otherwise, false. The on the left-hand side of the inequality operator. The on the right-hand side of the inequality operator.

Converts the instance to a string in lowercase registry format.

A lowercase string in registry format that represents the underlying .

Encapsulates context information about the role in which a diagnostic data adapter is being configured.

Initializes a new instance of the class by using the provided indicators for remote role and execution role.

true if this context is for a diagnostic data adapter that is configured for a remote role; false if for a local role. true if this context is for a diagnostic data adapter that is configured for the execution role; otherwise, false.

Gets a value that indicates whether this context is for a diagnostic data adapter that is configured for the execution role.

true if this context is for a diagnostic data adapter that is configured for the execution role; otherwise, false.

Gets a value that indicates whether this context is for a diagnostic data adapter that is configured for a remote role.

true if this context is for a diagnostic data adapter that is configured for a remote role; false if for a local role.

Class to manage test run configuration data and objects.

Initializes a new object with a new .

The to use to initialize this .

Reports whether the is valid.

true if the is valid and this contains objects; otherwise, false.

Gets the number of objects in this .

The number of objects in this .

Gets all objects in the .

An array of objects.

Gets the for this .

A object.

Represents the event arguments for the event.

Represents the event arguments for the event.

Represents the event arguments for the event.

Represents the event arguments for the event.

Represents information that is required to request a stream transfer.

Initializes a new instance of the class by using the provided arguments.

A object. A object. The path and file name to use on the client. true to close the stream after the transfer.

Gets the path and file name of the file on the client.

The path and file name of the file on the client.

Gets or sets a value that indicates whether to close the stream after the transfer.

true to close the stream after the transfer; otherwise, false.

Gets the path and file name of the file on the client.

The path and file name of the file on the client.

Gets a value that indicates whether to perform cleanup after the transfer.

true to perform cleanup after the transfer; otherwise, false.

Gets or sets the stream for the transfer.

The stream for the transfer.

Represents the event arguments for the event.

Gets or sets the of the test.

The outcome of the test.

Provides a base class for all event argument classes that are used in test case events.

Initializes a new instance of the class by using the provided information.

A object. The current test element that is represented by a object. A object that is used to obtain further data about the test from the Test Manager.

Initializes a new instance of the class by using the given information.

A object. The current test case ID that is represented by an object. A object that is used to obtain further data about the test from the Test Manager. The name of the test case. true if the current test case is a child of another test case.

Gets or sets a value that indicates whether the test case is a child of another test case.

true if this is a child test case, and false if this is a top-level test case.

Gets the object that contains information that can be used to obtain further data about the test case from the Test Manager server.

An information object, or null if the test did not originate in the Test Manager.

Gets or sets the test case identifier.

The test case ID.

Gets or sets the name of the test case.

The name of the test case.

Gets the current test.

The current test.

Represents the arguments that are provided for a event.

Initializes a new instance of the class by using the provided parameter values.

A object containing current context information. The associated object. A containing information about the test case manager. One of the values.

Gets or sets the type of failure, if any.

One of the values.

This enumeration represents the types of failure for a test case as used in the class.

An assertion failed.

An exception was missing.

No failure.

An unknown failure type occurred.

An unexpected exception was encountered.

An exception was not handled.

Represents the event arguments for the event.

Represents the event arguments for the event.

Represents the event arguments for the event.

Represents the event arguments for the event.

Represents the configuration settings for the execution section of the app.config configuration file.

Initializes a new instance of the class.

Reads the app.config file and populates the properties of this object by using values from the test execution section of the file.

An object. true to deserialize only the key property values; otherwise, false.

Reads the app.config file and populates the properties of this object by using values from the test execution section of the file.

true if the serialization was successful; otherwise, false. An object. true to serialize only the key property values; otherwise, false.

Serializes the settings to the provided XML element name.

true if the serialization was successful; otherwise, false. An object. The name of the XML element section to which to serialize the values.

Represents the event arguments for the event.

Base class for all test step event arguments.

Gets or sets the description of the test step.

Returns a description of the test step.

Gets or sets the ID of the test step.

Returns the ID of the test step.

Represents the event arguments for the event.

Provides session-level configuration information that is used by data collection aggregators.

Initializes a new instance of the class by using the default settings.

Initializes a new instance of the class by using the output directory that is used by the session.

Output directory that is used by the session.

Gets the output directory of the current session.

Output directory of the current session.

Interface to be implemented by load test adapters.

Thread-safe Run method.

The test element. The test context.

Interface to be implemented by all test adapters.

Called when test adapter is loaded to execute a test run.

The context for this test run.

Called when a test run is completed to allow test adapters to clean up.

The context for this test run.

Receives a downstream message from the user interface, a controller, or an agent.

The message.

Interface for test adapters to request time-out notifications for tests.

Called by the agent to stop an individual test instead of stopping the whole run. Called when the test times out.

The test to stop.