Microsoft.VisualStudio.TestTools.WebTesting Namespace

  • Article

The Microsoft.VisualStudio.TestTools.WebTesting namespace supplies classes that enable Web performance testing. This namespace includes the WebTest class which is the base class for all Web performance tests. The WebTestRequest and WebTestResponse classes simulate the HTTP requests and responses of the Web pages under test. These classes use the FormPostHttpBody class to simulate the use of form post parameters. Microsoft.VisualStudio.TestTools.WebTesting also includes classes for data binding, test rules, identifying work items, query strings, HTTP context, and plug-ins that provide testing features.

Classes

  Class Description
Public class AlwaysExecuteRecorderPluginAttribute Attribute to indicate that the recorder plug-in should always be executed.
Public class BaseEnumStringConverter<T> Helper class that helps with conversions between enum values and strings.
Public class BinaryHttpBody Represents an HTTP body that contains binary data.
Public class Comment Represents a comment that the test designer adds to a Web performance test.
Public class ConditionalEventArgs Represents the event arguments that are used for conditional loops and statements.
Public class ConditionalRule Condition rules are executed in a conditional loop or statement. These rules are intended to decide whether the body of the loop or statement must be executed.
Public class ConditionalRuleException Represents the exception that is thrown when an exception occurs during execution of any one of the three methods of a conditional rule.
Public class ConditionalRuleReference Base class for a reference to a particular conditional rule.
Public class ConditionalRuleReferenceCollection Represents a strongly typed container for Web-test conditional rule references.
Public class ConditionConditionalRuleReference Represents a reference to a conditional rule that will be used in a condition.
Public class ConnectionFailedWebTestException No content here will be updated; please do not add material here.
Public class ContextParameter Represents a single parameter in the Web performance testing context that has a name and value.
Public class ContextParameterCollection Contains a strongly typed collection of ContextParameter objects.
Public class CssIterationAttribute Represents the project iteration to which this test corresponds. This class cannot be inherited.
Public class CssProjectStructureAttribute Represents the node in the team project hierarchy to which this test corresponds.
Public class DataBindingAttribute Contains information that defines data binding properties for a Web performance test. This class cannot be inherited.
Public class DataSource Defines a data source for a Web performance test.
Public class DataSourceAttribute Contains information that describes a data source for a Web performance test. This class cannot be inherited.
Public class DataSourceCollection Contains a strongly typed collection of DataSourceCollection objects.
Public class DataSourceTable An object that represents a table in a data source that you can use in a Web performance test.
Public class DataSourceTableCollection Contains a strongly typed collection of DataSourceTableCollection objects.
Public class DeclarativeWebTest Represents a declarative, XML-based Web performance test.
Public class DeclarativeWebTestSerializer Loads the contents of a .webtest file into an instance of the DeclarativeWebTest class.
Public class DeploymentItemAttribute Used to specify deployment items such as a file or directory for per-test-deployment. This class cannot be inherited.
Public class ExtractHtmlSelectTag Represents a rule that is used to extract the selected option from an HTML select tag.
Public class ExtractHtmlTagInnerText Represents a rule that is used to extract the inner text from an HTML tag.
Public class ExtractionEventArgs Provides data for the ExtractValues event.
Public class ExtractionRule Base class used to define rules for obtaining data from a Web response that is generated by a Web performance test.
Public class ExtractionRuleReference The ExtractionRuleReference class encapsulates the metadata about an ExtractionRule and the parameter values to use when an instance of the ExtractionRule is created when the Web performance test that uses the ExtractionRule is run.
Public class ExtractionRuleReferenceCollection Contains a strongly typed collection of ExtractionRuleReferenceCollection objects.
Public class FileUploadParameter No content here will be updated; please do not add material here.
Public class ForLoopComparisonOperatorConverter Helper class that helps with conversions between enum values and strings.
Public class FormPostHttpBody Represents an HTML form post body with a collection of form parameters.
Public class FormPostParameter Represents an HTML form POST parameter.
Public class FormPostParameterCollection Represents a strongly typed container for form post parameters.
Public class HtmlAttribute Represents an HTML attribute.
Public class HtmlAttributeWithOffsets Extends the basic HtmlAttribute and tracks the beginning and ending offsets within an HTML document.
Public class HtmlDocument Provides access to the set of HTML tags in an HTML response body.
Public class HtmlTag The HtmlTag object is the foundation of the HTML document and holds the parsed structure of the document.
Public class HtmlTagInnerText Represents the inner text of an HTML tag, and contains the beginning and ending offset of the inner text location in the whole document.
Public class HtmlTagInnerTextParser A specialized parser that is used to extract the inner text from HTML tags that are located in an HTML document.
Public class HtmlTagWithOffsets Extends the basic HtmlTag by tracking the beginning and ending tag offsets within the HTML document.
Public class IncludeCodedWebTestAttribute Contains information that defines a coded Web performance test that is included in another Web performance test.
Public class IncludeDeclarativeWebTestAttribute Contains information that defines a coded Web performance test that is included in another Web performance test. This class cannot be inherited.
Public class IncludedWebTest Represents a Web performance test that is included in another Web performance test.
Public class LoopConditionalRuleReference Class to contain a reference to a particular conditional rule that will be used in a loop.
Public class NumericalComparisonOperatorConverter Helper class that helps with conversions between enum values and strings.
Public class OutcomeConverter Helper class that helps with conversions between enum values and strings.
Public class OwnerAttribute Used to specify the person responsible for maintaining, running, and/or debugging the test. This class cannot be inherited.
Public class Parameter Represents an HTTP parameter base class.
Public class PluginOrRuleProperty Represents the name and value of a single property for a rule or a plug-in.
Public class PostPageEventArgs Provides data for the WebTest.PostPage event.
Public class PostRequestEventArgs Provides data for the WebTestRequest.PostRequest and WebTest.PostRequest events.
Public class PostTransactionEventArgs Provides data for the WebTest.PostTransaction event.
Public class PostWebTestEventArgs Provides data for the WebTest.PostWebTest event.
Public class PostWebTestRecordingEventArgs No content here will be updated; please do not add material here.
Public class PrePageEventArgs Provides data for the WebTest.PrePage event.
Public class PreRequestDataBindingEventArgs
Public class PreRequestEventArgs Provides data for the WebTest.PreRequest event.
Public class PreTransactionEventArgs Provides data for the WebTest.PreTransaction event.
Public class PreWebTestEventArgs Provides data for the WebTest.PreWebTest event.
Public class PriorityAttribute Used to specify the priority of a unit test. This class cannot be inherited.
Public class PropertyCollection Represents a strongly typed container for Web performance test rule properties.
Public class QueryStringParameter Represents an HTTP querystring parameter.
Public class QueryStringParameterCollection Represents a strongly typed container for query string parameters.
Public class RequestBodyEditorPluginReference Represents a plug-in for an HTTP request object.
Public class SharepointInformation
Public class StringComparisonOperatorConverter Helper class that helps with conversions between enum values and strings.
Public class StringHttpBody Represents an HTTP body in string form used for SOAP support.
Public class TestDescriptionAttribute Used to specify the description of the test. This class cannot be inherited.
Public class ThreadedWebTest Represents a base class for a coded Web performance test that uses a single thread per Web performance test iteration.
Public class TimeoutAttribute Use this attribute to specify the time-out period of a Web performance test.
Public class TransactionTimer Represents a timed transaction in a Web performance test. This part of the Web performance test may include Web performance test requests, calls to included Web performance tests, or other Web performance test transactions.
Public class ValidationEventArgs Provides data for the ValidateResponse event.
Public class ValidationRule Verifies that requests return valid HTTP responses and that the contents of the response match the expected results. This class must be inherited.
Public class ValidationRuleReference The ValidationRuleReference class encapsulates the metadata about an ValidationRule and the parameter values to use when an instance of the ValidationRule is created when the Web performance test that uses the ValidationRule is run.
Public class ValidationRuleReferenceCollection Represents a serializable, strongly typed container for Web performance test validation rules.
Public class WebTest No content here will be updated; please do not add material here.
Public class WebTestBaseCollection<T> An abstract base class that is used to store a variety of Web performance tests.
Public class WebTestCondition This class represents the conditional statement constructs. It contains a collection of Web performance test items that are executed when the conditional rule is met.
Public class WebTestConditionalConstruct Base class for the conditional loop and the conditional statement constructs.
Public class WebTestContext Represents the context available to a WebTest.
Public class WebTestCorrelationResult Class to contain the result of a correlation that is applied when a Web performance test is executed in correlation mode.
Public class WebTestEmptyTableException Represents an Exception that occurs when data binding is being performed on an empty table.
Public class WebTestEndOfDataException The exception that is thrown when data binding is being performed on a table with the UniqueDataBindingAccessMethod when there are no more rows of data in the table.
Public class WebTestError Class to encapsulate errors that occur during Web performance test execution.
Public class WebTestException The exception that is thrown by the test engine for errors that occur while a test is running.
Public class WebTestItem Represents a base class for WebTestRequest.
Public class WebTestItemCollection Represents a strongly typed container for Web performance test items.
Public class WebTestLoop Represents a conditional loop that contains a collection of Web performance test items that are executed as long as the conditional rule is met.
Public class WebTestPageStatistics Contains statistics about the execution of the page.
Public class WebTestPlugin Provides a means to run code and access a WebTest before and after the Web performance test is run. This class must be inherited.
Public class WebTestPluginReference The WebTestPluginReference class encapsulates the metadata about a WebTestRequestPlugin and the parameter values to use when an instance of the WebTestRequestPlugin is created when the Web performance test that uses the WebTestRequestPlugin is run.
Public class WebTestPluginReferenceCollection Represents a serializable strongly typed container for Web performance test plug-in references.
Public class WebTestRecorderPlugin Plug-in interface for a Web performance test recorder.
Public class WebTestRecorderPluginReference Represents a Web performance test rule for a reference to an executable plug-in.
Public class WebTestRecorderUtilities Provides methods to parse requests. This class cannot be inherited.
Public class WebTestRequest No content here will be updated; please do not add material here.
Public class WebTestRequestCollection A strongly typed container for Web performance test request headers.
Public class WebTestRequestHeader Represents an HTTP header.
Public class WebTestRequestHeaderCollection A serializable strongly typed container for Web performance test request headers.
Public class WebTestRequestPlugin Receives notifications before and after a request is processed.
Public class WebTestRequestPluginConverter Class to convert webtests from Visual Studio 2005. Not intended for use by user written code.
Public class WebTestRequestPluginReference The WebTestRequestPluginReference class encapsulates the metadata about a WebTestRequestPlugin and the parameter values to use when an instance of the WebTestRequestPlugin is created when the Web performance test that uses the WebTestRequestPlugin is run.
Public class WebTestRequestPluginReferenceCollection Represents a strongly typed container for Web performance test request plug-in references.
Public class WebTestRequestResult Class to contain all result information for a completed Web performance test request.
Public class WebTestRequestStatistics Used to track key information that is gathered when the request is run.
Public class WebTestResponse Represents an HTTP response.
Public class WebTestResponseCodeConverter Helper class that helps with conversions between enum values and strings.
Public class WebTestResultComment Represents the comment body of a Web performance test result.
Public class WebTestResultCondition Represents a Web performance test result condition.
Public class WebTestResultDetails Class to contain the result details of Web performance tests.
Public class WebTestResultDetailsSerializer Saves and loads a WebTestResultDetails to and from a file in binary format.
Public class WebTestResultGroup Abstracts a group of results in the Web performance test result, such as a loop or condition.
Public class WebTestResultIteration Represents the current iteration of a Web performance test.
Public class WebTestResultLoop Class to contain the loop result of a Web performance test.
Public class WebTestResultLoopIteration Class to contain the result of a Web performance test loop iteration.
Public class WebTestResultPage Retrieves a top-level page result.
Public class WebTestResultTransaction Stores the results of a transaction in a Web performance test.
Public class WebTestResultUnit Represents a page or a request object in the Web performance test result.
Public class WebTestRuleBase An abstract base class extended by rule and reference classes in the Microsoft.VisualStudio.TestTools.WebTesting namespace.
Public class WebTestStoppedException Represents the exception that is thrown when data binding is performed on a table with a unique AccessMethod when there are no more rows of data in the table.
Public class WorkItemAttribute Use this attribute to specify a work item that is associated with a test.

Interfaces

  Interface Description
Public interface IBinaryHttpBodyEditorPlugin Provides an interface for a binary HTTP body plug-in.
Public interface IHttpBody Provides a common interface for accessing an HTTP body.
Public interface IStringHttpBodyEditorPlugin Provides an interface for a string HTTP body plug-in.

Enumerations

  Enumeration Description
Public enumeration ConditionalConstructType Enumerates all possible conditional construct types.
Public enumeration ConditionalRuleType Enumerates all possible condition rule types.
Public enumeration DataBindingAccessMethod Enumeration for the access method that is used for data binding.
Public enumeration DataBindingSelectColumns Specifies the column filters that are used for data binding.
Public enumeration ForLoopComparisonOperator Enumerates all possible numeric comparison operators for the for loop conditional rule.
Public enumeration NumericalComparisonOperator Enumerates the numeric comparison operators that are available.
Public enumeration Outcome Describes the outcome of a Web performance test.
Public enumeration RequestType Enumerates the request types that are available.
Public enumeration RuleExecutionOrder Enumerates the possible order-of-execution for validation rules.
Public enumeration StringComparisonOperator Enumerates the string comparison operators that are available.
Public enumeration ValidationLevel Used to identify the importance of a validation rule that is run in a load test.
Public enumeration WebTestErrorType Enumerates the types of errors that can be included in a WebTestError object.
Public enumeration WebTestExecutionInstruction Used to denote how to handle an operation.
Public enumeration WebTestResponseCode Enumerates the HTTP response codes that are defined in RFC 2616 for HTTP 1.1.
Public enumeration WebTestResultStatus Enumeration for the status of a Web performance test result.

See Also

Reference

Other Resources

Working with Web Tests Overview

Creating a Web Test

About the Web Test Editor

[retired] Running Web Performance Tests

[retired] Run web performance tests from the command line

[retired] How to: Create a Coded Web Performance Test

[retired] Walkthrough: Recording and Running a Web Performance Test

Generate and run a coded web performance test

Performing Advanced Web Test Tasks