Package org.mockserver.load

Class LoadCheck

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.load.LoadCheck

public class LoadCheck
extends ObjectWithJsonToString

A per-step response assertion for a LoadStep (the load-injection equivalent of a k6 check). After a step's response returns, each check extracts a value from that response and compares it against an expected value with a LoadCheck.Comparator. Every evaluated check is recorded as a pass or a fail — surfacing correctness problems (e.g. a 200 carrying the wrong body) that latency/error metrics alone hide, because a load run only ever flags 5xx/connection errors otherwise.

Checks are observational: a failing check never fails an individual request or stops dispatch. Instead the pass/fail counts feed the mock_server_load_checks metric and the end-of-run report, and can trip a LoadThreshold.Metric.CHECK_FAILURE_RATE threshold (which, with abortOnFail, can abort the run and drive a non-zero CI exit code).

Extraction reuses the shared LoadResponseExtractor primitives (the same code LoadCapture correlation uses). A default (no checks) leaves behaviour unchanged.

• getSource() — where to read the observed value from (STATUS, HEADER, BODY_JSONPATH)
• getHeaderName() — the header name (required for HEADER)
• getJsonPath() — the JSONPath (required for BODY_JSONPATH)
• getComparator() — how the observed value is compared to getValue()
• getValue() — the expected value / comparand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LoadCheck.Comparator	How the observed value is compared to the expected getValue().
static enum	LoadCheck.Source	Where in the step's response a LoadCheck reads its observed value from.

Constructor Summary

Constructors

Constructor	Description
LoadCheck()

Method Summary

Modifier and Type	Method	Description
boolean	evaluate(HttpResponse response)	Evaluate this check against response: extract the observed value and compare it to value with the comparator.
String	extract(HttpResponse response)	Extract the observed value from response per this check's source, using the shared LoadResponseExtractor primitives.
LoadCheck.Comparator	getComparator()
String	getHeaderName()
String	getJsonPath()
LoadCheck.Source	getSource()
String	getValue()
boolean	isValid()	True when this check is complete enough to evaluate (a source and comparator are set).
static LoadCheck	loadCheck()
LoadCheck	withComparator(LoadCheck.Comparator comparator)
LoadCheck	withHeaderName(String headerName)
LoadCheck	withJsonPath(String jsonPath)
LoadCheck	withSource(LoadCheck.Source source)
LoadCheck	withValue(String value)

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

equals, fieldsExcludedFromEqualsAndHashCode, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LoadCheck

public LoadCheck()

Method Details

loadCheck

public static LoadCheck loadCheck()

getSource

public LoadCheck.Source getSource()

withSource

public LoadCheck withSource(LoadCheck.Source source)

getHeaderName

public String getHeaderName()

withHeaderName

public LoadCheck withHeaderName(String headerName)

getJsonPath

public String getJsonPath()

withJsonPath

public LoadCheck withJsonPath(String jsonPath)

getComparator

public LoadCheck.Comparator getComparator()

withComparator

public LoadCheck withComparator(LoadCheck.Comparator comparator)

getValue

public String getValue()

withValue

public LoadCheck withValue(String value)

extract

public String extract(HttpResponse response)

Extract the observed value from response per this check's source, using the shared LoadResponseExtractor primitives. Returns null when the source is unset or nothing matches. May throw for a malformed JSONPath — callers evaluate best-effort.

evaluate

public boolean evaluate(HttpResponse response)

Evaluate this check against response: extract the observed value and compare it to value with the comparator. A null comparator (nothing to assert) passes. May throw for a malformed JSONPath/regex — the orchestrator runs this inside a try/catch and treats a throw as a fail.

isValid

public boolean isValid()

True when this check is complete enough to evaluate (a source and comparator are set).