Command

Test-BenchmarkGate

Module: PSPublishModule
Inputs: None
Outputs: PowerForge.BenchmarkGateResult

Tests normalized benchmark summaries against a JSON baseline.

Syntax

Test-BenchmarkGate
[-AbsoluteToleranceMs <Double>]
[-AllowNew]
-BaselinePath <String>
[-GroupBy <String[]>]
[-Metric <String>]
[-MetricDirection <Auto|LowerIsBetter|HigherIsBetter>]
[-RelativeTolerance <Double>]
-SummaryPath <String>
[-Update]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Verify a benchmark summary against a baseline

Test-BenchmarkGate -SummaryPath .\Build\Benchmarks\summary.json -BaselinePath .\Build\Benchmarks\baseline.json -Metric MedianMs

Parameters

-AbsoluteToleranceMs Double optional: Absolute tolerance in milliseconds.
-AllowNew SwitchParameter optional: Allows new metrics missing from baseline.
-BaselinePath String required: Baseline JSON path.
-GroupBy String[] optional: Fields used to construct stable metric keys.
-Metric String optional: Metric name to evaluate.
-MetricDirection BenchmarkMetricDirection optional: Metric direction for regression checks.; Possible values: Auto, LowerIsBetter, HigherIsBetter
-RelativeTolerance Double optional: Relative tolerance.
-SummaryPath String required: Summary JSON path.
-Update SwitchParameter optional: Updates the baseline instead of verifying it.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.