@camunda/task-testing

Validate a single building block of your BPMN diagram by executing it against a connected cluster.

Usage

import TaskTesting from '@camunda/task-testing';

function App() {
  ...

  <TaskTesting
    { ...props }
  >
    <TaskTesting.Tab label="My dynamic tab" render={ ({ output }) => <div>...</div> } />
    <TaskTesting.Tab label="My static tab">My static content</TaskTesting.Tab>
    <TaskTesting.Link href="https://example.com" render={ ({ output }) => <div>...</div> } />
    <TaskTesting.Link href="https://example.com">My static link</TaskTesting.Link>
  </TaskTesting>
}

Props

TaskExecutionApi

The api prop must implement the following methods. Each method should return a { success: true, response } or { success: false, error } object.

onTaskExecutionFinished result

The result parameter is a discriminated union:

• success: true — Task completed successfully. Contains lastPolledResult and processInstanceKey.
• success: false — Task did not complete successfully. Contains reason:
  • 'incident' — An incident occurred (includes incident details)
  • 'terminated' — Process instance was terminated
  • 'user.cancel' — User clicked cancel
  • 'user.selectionChanged' — User selected a different element
  • 'error' — Deployment or start failed (includes error with message)

Plugins

Custom tabs and links can be added as children:

• <TaskTesting.Tab> — Adds a collapsible strip to the run card, below the built-in variables and timeline strips

  • label (string, required) — Strip label
  • render (function) — Render function receiving { output }, for dynamic content
  • children (ReactNode) — Static content (alternative to render)
  • priority (number, default 1000) — Higher priority strips appear first
  • fullBleed (boolean, default false) — Render the content edge to edge in a fixed-height, scroll-isolated body, for foreign HTML
  • onOpenExternal (function) — Adds a button to the strip header that calls it with { element, output, isTaskExecuting, executionLog }, e.g. to open the content in its own window

• <TaskTesting.Link> — Adds a link to the output header

  • href (string, required) — Link URL
  • target (string) — Link target (e.g. '_blank')
  • render (function) — Render function receiving { output }, for dynamic content
  • children (ReactNode) — Static content (alternative to render)
  • priority (number, default 1000) — Higher priority links appear first

See demo

Development

Install the dependencies and spin up a local server at http://localhost:3000:

npm install

npm start

It requires a Camunda 8 instance to run.

We recommend using Camunda 8 Run for development.

Without further setup, the demo connects to a local Camunda 8 Run using the defaults in demo/.env.example. To use another cluster, copy demo/.env.example to demo/.env and fill in your cluster credentials. Machine-specific overrides can go into demo/.env.local. Both files are gitignored — never commit credentials.

Build

Run all tests and build the library:

npm run all

License

MIT