camunda / camunda/api-test-generator

How do we reason our way to a Message publishing test?

Open
#302 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

OCA
Dominant language
TypeScript
Stars
0
Forks
3
Avg merge
13h 41m
Merged PRs (30d)
23

Description

Testing the message publishing endpoint requires a sophisticated chain.

  1. It needs a model with a message catch event (model characteristic dependency).
  2. The test has to deploy the model and create a process instance.
  3. It needs to publish a message with the correct message name.
  4. It needs to assert that the process instance completes.

This looks very similar to the testing logic for Job Activation / Completion:

  • Same prereqs: A model characteristic and specific value (job type / message name).
  • Same preconditions: deploy, create.
  • Similar action: publish / correlate (vs activate + complete).
  • Same assertion: process completes.

This seems like it generalises is a similar way to activateJobs / completeJob.

Correlation is more sophisticated. It needs to start the process instance with a specific variable name + value, then it needs to populate the correlation call with the variable value.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing testing logic for Job Activation / Completion and compare its model-characteristic, deployment, process-instance, action, and completion assertions with message publishing. Then determine how message names and correlation variables fit the generated test flow; done means an implementable path for publishing and correlation tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.