Skip to content

Improve documentation on Parallel Test Execution #2669

@bondolo

Description

@bondolo

I have some comments regarding configuring tests for parallel execution following reading: https://junit.org/junit5/docs/snapshot/user-guide/index.html#writing-tests-parallel-execution

Identifying all the relevant properties and the defaults for the properties in junit-platform.properties needs to be more obvious. They can be deduced from the narrative but perhaps should just be stated explicitly.

Also, a gentle approach for enabling parallelism should be suggested along with suggested mitigations when things don't work, as a sequence of steps that projects can evolve upon while still getting some parallelization benefit. An example for the Execution annotation would be useful as well. Non-parallel test execution could be considered a form of technical debt and a suggested approach for whittling away at that debt to make incremental progress towards as-parallel-as-practical execution. ie. help people figure out where they are now and what their next step should be along with necessary validation checks for each step.

Deliverables

  • Add table of relevant configuration parameters
  • Add example for using the @Execution annotation

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions