Class Pipeline

Namespace

Xping.Sdk.Core.Components

Assembly

Xping.Sdk.Core.dll

The Pipeline class is a concrete implementation of the CompositeTests class that is designed to run and manage the test components that have been added.

public class Pipeline : CompositeTests, ITestComponent

Inheritance

object

TestComponent

CompositeTests

Pipeline

Implements

ITestComponent

Inherited Members

CompositeTests.AddComponent(ITestComponent)

CompositeTests.RemoveComponent(ITestComponent)

CompositeTests.Clear()

CompositeTests.Components

TestComponent.Name

TestComponent.Type

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

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Pipeline(string?, params ITestComponent[])

Initializes a new instance of the Pipeline class with the specified name and components.

public Pipeline(string? name = null, params ITestComponent[] components)

Parameters

name string

The optional name of the pipeline. If null, the StepName constant is used.

components ITestComponent[]

The test components that make up the pipeline.

Remarks

The Pipeline class inherits from the CompositeTests class and represents a sequence of tests that can be executed as a single unit.

Fields

StepName

The name of the test component that represents a pipeline of tests.

public const string StepName = "Pipeline"

Field Value

string

Remarks

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

Methods

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

This method is designed to perform the test components that have been included in the current object.

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