Class CompositeTests

Namespace

Xping.Sdk.Core.Components

Assembly

Xping.Sdk.Core.dll

Represents an abstract class that is used to execute a composite test component.

public abstract class CompositeTests : TestComponent, ITestComponent

Inheritance

object

TestComponent

CompositeTests

Implements

ITestComponent

Derived

Pipeline

Inherited Members

TestComponent.Name

TestComponent.Type

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

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

CompositeTests(string)

Initializes a new instance of the CompositeTests class with the specified name and test step type.

protected CompositeTests(string name)

Parameters

name string

The name of the composite test component.

Properties

Components

Gets a read-only collection of the child TestComponent instances of the current object.

public IReadOnlyCollection<ITestComponent> Components { get; }

Property Value

IReadOnlyCollection<ITestComponent>

Methods

AddComponent(ITestComponent)

Adds a new instance of the TestComponent class to the current object.

public void AddComponent(ITestComponent component)

Parameters

component ITestComponent

The TestComponent instance to add.

Clear()

Clears all the components from the current instance.

public void Clear()

Remarks

This method is called to clean up the test components. It ensures that the components collection is emptied, preventing cross-contamination of state between tests.

RemoveComponent(ITestComponent)

Removes the specified instance of the TestComponent class from the current object.

public bool RemoveComponent(ITestComponent component)

Parameters

component ITestComponent

The TestComponent instance to remove.

Returns

bool

true if component is successfully removed; otherwise, false. This method also returns false when component was not found.