IPipelineScenario

NexusLabs.Needlr.AgentFramework.Testing

IPipelineScenario Interface

Defines a pipeline scenario for multi-stage agent workflow testing. Extends the single-agent scenario pattern with pipeline stage construction and pipeline-specific verification.

public interface IPipelineScenario

Remarks

Each scenario declares its own workspace seed data, pipeline stages, and verification logic. The PipelineScenarioRunner handles workspace creation, pipeline execution via NexusLabs.Needlr.AgentFramework.Workflows.Sequential.SequentialPipelineRunner, and invokes Verify(IWorkspace, IPipelineRunResult) after execution.

Properties

IPipelineScenario.Description Property

Gets a human-readable description of what this scenario tests.

string Description { get; }

Property Value

System.String

IPipelineScenario.Name Property

Gets the scenario name (used for selection and reporting).

string Name { get; }

Property Value

System.String

Methods

IPipelineScenario.BuildPipeline(IServiceProvider) Method

Builds the ordered list of pipeline stages for this scenario.

System.Collections.Generic.IReadOnlyList<NexusLabs.Needlr.AgentFramework.Workflows.Sequential.PipelineStage> BuildPipeline(System.IServiceProvider services);

Parameters

services System.IServiceProvider

The service provider for resolving agents and other dependencies needed to construct stage executors.

Returns

System.Collections.Generic.IReadOnlyList<NexusLabs.Needlr.AgentFramework.Workflows.Sequential.PipelineStage>
An ordered list of stages to execute sequentially.

IPipelineScenario.GetOptions() Method

Returns optional pipeline configuration such as completion gates and total token budgets. Returns null to use defaults.

NexusLabs.Needlr.AgentFramework.Workflows.Sequential.SequentialPipelineOptions? GetOptions();

Returns

NexusLabs.Needlr.AgentFramework.Workflows.Sequential.SequentialPipelineOptions
Pipeline options, or null.

IPipelineScenario.SeedWorkspace(IWorkspace) Method

Populates the workspace with files needed before the pipeline runs. Called by the runner before execution begins.

void SeedWorkspace(NexusLabs.Needlr.AgentFramework.Workspace.IWorkspace workspace);

Parameters

workspace NexusLabs.Needlr.AgentFramework.Workspace.IWorkspace

The workspace to seed with test data.

IPipelineScenario.Verify(IWorkspace, IPipelineRunResult) Method

Verifies the pipeline results after execution. Throw an exception (e.g., ScenarioVerificationException) to indicate failure.

void Verify(NexusLabs.Needlr.AgentFramework.Workspace.IWorkspace workspace, NexusLabs.Needlr.AgentFramework.Diagnostics.IPipelineRunResult result);

Parameters

workspace NexusLabs.Needlr.AgentFramework.Workspace.IWorkspace

The workspace after pipeline execution.

result NexusLabs.Needlr.AgentFramework.Diagnostics.IPipelineRunResult

The pipeline run result containing per-stage diagnostics.