TestStartingEventArgs Class

  • Article

Contains the arguments for the TestStarting event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.VisualStudio.TestTools.LoadTesting.TestStartingEventArgs

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

Syntax

'Declaration
Public Class TestStartingEventArgs _
    Inherits EventArgs

public class TestStartingEventArgs : EventArgs

public ref class TestStartingEventArgs : public EventArgs

type TestStartingEventArgs =  
    class
        inherit EventArgs
    end

public class TestStartingEventArgs extends EventArgs

The TestStartingEventArgs type exposes the following members.

Properties

  Name Description
Public property IsInitializeTest Gets a value that indicates whether the test that is starting is the InitializeTest that was specified in the load test scenario's test mix.
Public property IsTerminateTest Gets a value that indicates whether the test that is starting is the TerminateTest that was specified in the load test scenario's test mix.
Public property ScenarioName Gets the scenario name that contains the test that is starting.
Public property TestContextProperties Gets an IDictionary<TKey, TValue> that contains data available to individual tests in a load test.
Public property TestIterationNumber Gets a value that represents the number of tests that have run within the load test on a particular agent.
Public property TestName Gets the name of the test that is starting.
Public property UserContext Gets the LoadTestUserContext that represents the virtual user that is running the test that is starting.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from 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 Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

TestStartingEventArgs establishes an additional pathway for providing data to tests that are contained in a load test. An event handler for the TestStarting event can contain code to add data to the individual tests in the load test. The data is added to the WebTestContext in a Web test or the TestContext in a unit test.

Examples

The following code snippet gives a simple example of how to use the TestStartingEventArgs to add data to the starting test iteration in the load test. You write this code in a load test plug-in.

private void TestStarting(object source, TestStartingEventArgs testStartingEventArgs)
{
    testStartingEventArgs.TestContextProperties.Add("WebUser", GetNextWebUser());
}
private MyWebUser GetNextWebUser()
{
    /// Insert code here to read a user definition from some data source

    /// construct user object with data read from data source
    return new MyWebUser( ... );
}

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.LoadTesting Namespace

Other Resources

How to: Create a Load Test Plug-In

Working with Load Tests Overview