Documentation / Runner Builder

Runner Builder

Compose runs with LoadStrikeRunner.Create, AddScenario(s), BuildContext, and argument-based Run overloads.

Builder Pattern

Use LoadStrikeRunner.Create() to start fluent composition, then AddScenario/AddScenarios and Configure(...) to apply context options before Run(). Java, Python, and TypeScript/JavaScript all mutate the same runner/context instance through fluent builders and static helper wrappers. TypeScript/JavaScript also support Configure(ctx => ...) builder flow in addition to direct options objects.

BuildContext

Use BuildContext() when you want a reusable configured LoadStrikeContext and run it multiple times with different CLI overrides. Java and Python BuildContext() retain the registered scenario set so LoadStrikeContext.Run() / RunDetailed() and LoadStrikeRunner.Run(context) execute directly. Java `configure(ctx -> ...)` and fluent `with*` builder calls compose before scenarios are added; Python also preserves those scenarios when the context is reapplied through LoadStrikeRunner.Create().ConfigureContext(context).Run() or Configure(context).Run(). TypeScript/JavaScript reusable contexts follow the same model.

Run Overloads

Use Run() for configured execution and Run(string[] args) or Run(params string[] args) for command-line style overrides. Java and Python service-layer runs project LoadStrikeNodeStats and fail fast when a runner has no registered scenarios or a target-selection filter resolves to none. Reusable `LoadStrikeContext` instances keep CLI-applied overrides after Run(args), while runner-level Run(args) calls remain one-shot per execution. In Java, use RunDetailed() / LoadStrikeContext.RunDetailed(...) when you need raw detailed artifacts such as reportFiles, sinkErrors, disabledSinks, or correlation rows. TypeScript/JavaScript also support LoadStrikeContext.Run() / RunDetailed() and direct array or variadic Run override flows (`context.Run(["--Key=value"])`, `context.Run("--Key=value", ...)`) with case-insensitive keys, malformed-token ignoring, numeric NodeType enum tokens, execution-time `--config` / `--infraconfig` file loading, and additive PascalCase result aliases such as AllRequestCount, NodeInfo, Metrics, PluginsData, and ScenarioStats.

var runner = LoadStrikeRunner.Create()
    .AddScenario(scenario)
    .Configure(ctx => ctx.WithReportFolder("./reports").WithRunnerKey("rkl_your_local_runner_key"));

var context = runner.BuildContext();
var stats = context.Run("--testsuite=builder-smoke");

import com.loadstrike.runtime.LoadStrikeRuntime.LoadStrikeRunner;

var runner = LoadStrikeRunner.create()
    .addScenario(scenario)
    .configure(context -> context
        .withReportFolder("./reports")
        .withRunnerKey("rkl_your_local_runner_key"));

var context = runner.buildContext();
var stats = context.run("--testsuite=builder-smoke");

from loadstrike_sdk import LoadStrikeRunner

runner = (
    LoadStrikeRunner.create()
    .add_scenario(scenario)
    .configure(lambda context: context.with_report_folder("./reports").with_runner_key("rkl_your_local_runner_key"))
)

context = runner.build_context()
stats = context.run("--testsuite=builder-smoke")

import { LoadStrikeRunner } from "@loadstrike/loadstrike-sdk";

const runner = LoadStrikeRunner
  .create()
  .addScenario(scenario)
  .configure((context) => context.withReportFolder("./reports").withRunnerKey("rkl_your_local_runner_key"));

const context = runner.BuildContext();
const stats = await context.run("--testsuite=builder-smoke");

const { LoadStrikeRunner } = require("@loadstrike/loadstrike-sdk");

const runner = LoadStrikeRunner
  .create()
  .addScenario(scenario)
  .configure((context) => context.withReportFolder("./reports").withRunnerKey("rkl_your_local_runner_key"));

const context = runner.BuildContext();
const stats = await context.run("--testsuite=builder-smoke");