Skip to content

mock

Module Step Summary
— mock/api Register a mock HTTP endpoint that returns a canned response.
— mock/discovery Register a BPN Discovery Finder mock returning configured EDC endpoints.
— mock/dtr Register a protocol-aware AAS Digital Twin Registry mock.
wait/dataplane mock/wait/dataplane/http_request Wait for an inbound HTTP request that arrives through the engine connector's data plane.
wait mock/wait/http_request Wait for an inbound HTTP request on a previously-registered mock endpoint.

mock/api

Register a mock HTTP endpoint that returns a canned response.

full_mock_url is what a test hands to the system under test as its callback address; mock is what it hands to mock/wait/http_request, which then blocks until the SUT calls it.

Inputs

Parameter Type Required Default Also accepts Description
id string no '' — Identifier for the registered mock; also the variable its URL is stored under.
path string yes — — URL path to register, e.g. '/companycertificate/request'.
method string no 'POST' — HTTP method the mock answers on.
response_status integer no 200 — Status code the mock returns.
response_body any no {} — JSON body the mock returns. References are written the usual way, '${{ ... }}', and are resolved before the step runs.
response_headers object no {} — Headers the mock returns alongside the body.

Output — the value assertions and returns: read

The mock that now exists, and the two URLs a test needs from it.

Field Type Description
mock MockInstance The registered mock, as 'mock/wait/http_request' takes it.
base_mock_url string Root URL of the testlab mock server.
full_mock_url string Address to hand the system under test — root plus the mock's path.

mock/discovery

Register a BPN Discovery Finder mock returning configured EDC endpoints.

A consumer step can then resolve a counter-party's DSP endpoint from its BPN exactly as it would against the real service — the mock answers only for the BPNs it was asked about.

Inputs

Parameter Type Required Default Also accepts Description
id string yes — — Unique identifier for the registered mock.
mappings object yes — — BPN to EDC endpoint mapping, or a list of {bpn, endpoint} entries.

Output — the value assertions and returns: read

This step produces no value — it acts, and there is nothing to read back.

Type: NoneType

mock/dtr

Register a protocol-aware AAS Digital Twin Registry mock.

Shells registered through the mock's own POST /shell-descriptors become retrievable the same way the pre-configured ones are, so a test can exercise the write path and the read path against one registry. It answers the AAS v3 API as a real registry does, which is what makes it worth testing against: GET /lookup/shells takes one assetIds value per criterion, each a base64url-encoded SpecificAssetId object, and a value holding the whole list is refused with a 400 that says so. The consumer-side steps already send it that way, so a test that uses them needs to know none of this.

Inputs

Parameter Type Required Default Also accepts Description
id string yes — — Unique identifier for the registered mock.
shells list of object no [] — Shell descriptors the registry starts with, each carrying an 'id' and optionally 'specificAssetIds'.

Output — the value assertions and returns: read

This step produces no value — it acts, and there is nothing to read back.

Type: NoneType

Nested objects

MockInstance

A registered mock, as the steps that use it later need to see it.

Field Type Required Default Also accepts Description
endpoint_id string no '' — Identifier the mock was registered under, when it was given one.
path string yes — — Path the mock listens on.
method string yes — — HTTP method the mock answers.
base_mock_url string yes — — Root URL of the testlab mock server.
full_mock_url string yes — — Address the system under test calls — root plus path.