Class HtmlContentValidator

Namespace

Xping.Sdk.Validations.Content.Html

Assembly

Xping.Sdk.dll

Represents a validator that checks if a html content matches a specified pattern or condition.

public class HtmlContentValidator : BaseContentValidator, ITestComponent

Inheritance

object

TestComponent

BaseContentValidator

HtmlContentValidator

Implements

ITestComponent

Inherited Members

BaseContentValidator.GetHttpResponseMessage(TestContext)

BaseContentValidator.GetBrowserResponseMessage(TestContext)

BaseContentValidator.GetData(TestContext)

BaseContentValidator.GetContent(byte[], HttpContentHeaders)

TestComponent.Name

TestComponent.Type

TestComponent.ProbeAsync(Uri, TestSettings, IServiceProvider, CancellationToken)

TestComponent.AddComponent(ITestComponent)

TestComponent.RemoveComponent(ITestComponent)

TestComponent.Components

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

note

The HtmlContentValidator component requires either the Browser BrowserRequestSender or HttpClient HttpClientRequestSender component to be registered before it in the pipeline, because it depends on the HTTP response results from these components.

Constructors

HtmlContentValidator(Action<IHtmlContent>)

Initializes a new instance of the HtmlContentValidator class.

public HtmlContentValidator(Action<IHtmlContent> validation)

Parameters

validation Action<IHtmlContent>

A function that determines whether the html content matches a specified condition.

Exceptions

ArgumentNullException

Thrown when the validation function is null.

Fields

StepName

The name of the test component that represents a StringContentValidator test operation.

public const string StepName = "HtmlContentValidator"

Field Value

string

Remarks

This constant is used to register the StringContentValidator class in the test framework.

Methods

CreateHtmlContent(string, TestContext, string)

Creates an instance of IHtmlContent by combining the provided HTML data, test context, and a specified test ID attribute.

protected virtual IHtmlContent CreateHtmlContent(string content, TestContext context, string testIdAttribute)

Parameters

content string

The HTML data to include in the content.

context TestContext

The test context.

testIdAttribute string

The attribute to use for identifying test-specific elements.

Returns

IHtmlContent

An instance of IHtmlContent representing the instrumented HTML content.

HandleAsync(Uri, TestSettings, TestContext, IServiceProvider, CancellationToken)

This method performs the test step operation asynchronously.

public override Task HandleAsync(Uri url, TestSettings settings, TestContext context, IServiceProvider serviceProvider, CancellationToken cancellationToken = default)

Parameters

url Uri

A Uri object that represents the URL of the page being validated.

settings TestSettings

A TestSettings object that contains the settings for the test.

context TestContext

A TestContext object that represents the test context.

serviceProvider IServiceProvider

An instance object of a mechanism for retrieving a service object.

cancellationToken CancellationToken

An optional CancellationToken object that can be used to cancel this operation.

Returns

Task

Exceptions

ArgumentNullException

If any of the following parameters: url, settings or context is null.