Skip to content

Reference: stub mapping responses

Nicolas edited this page Jan 21, 2025 · 2 revisions

While each response style has some different arguments, all responses are controlled by the command enum in the response.

Command Type DTO Link
Complete https://github.com/nhomble/zeebe-mock/blob/main/zeebe-mock/src/main/java/io/nhomble/zeebemock/CompleteResponse.java
Throw Error https://github.com/nhomble/zeebe-mock/blob/main/zeebe-mock/src/main/java/io/nhomble/zeebemock/ErrorResponse.java
Failure https://github.com/nhomble/zeebe-mock/blob/main/zeebe-mock/src/main/java/io/nhomble/zeebemock/FailureResponse.java

Example stub mapping: Complete

{
  "response": {
    "jsonBody": {
      "command": "COMPLETE",
      "variables": {
        "hello": "world"
      }
    }
  },
  "metadata": {
    "zeebemock": {
      "enabled": true,
      "jobType": "COMPLETE_WORKER"
    }
  }
}

Example stub mapping: Failure

{
  "response": {
    "jsonBody": {
      "command": "FAILURE",
      "retries": 0,
      "errorMessage": "Failure message"
    }
  },
  "metadata": {
    "zeebemock": {
      "enabled": true,
      "jobType": "FAIL_WORKER"
    }
  }
}

Example stub mapping: Throw Error

{
  "response": {
    "jsonBody": {
      "command": "THROW_ERROR",
      "errorCode": "MOCKED",
      "errorMessage": "Error thrown by worker"
    }
  },
  "metadata": {
    "zeebemock": {
      "enabled": true,
      "jobType": "THROW_WORKER"
    }
  }
}