Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation on Parallel Test Execution in JUnit Vintage engine #4321

Open
2 tasks
YongGoose opened this issue Feb 15, 2025 · 6 comments
Open
2 tasks

Comments

@YongGoose
Copy link
Contributor

YongGoose commented Feb 15, 2025

The current JUnit user guide provides an explanation of test configuration for parallel execution in the JUnit Vintage engine.
However, I believe it should be clearer and more detailed.

In JUnit Vintage, users can configure parallel execution at both the class and method levels independently.
This can lead to various execution scenarios, and it is important to clearly inform users about these possibilities.

Since I implemented this myself, feel free to reach out to me if you have any questions while working on this issue.

Deliverables

  • Add table of relevant configuration parameters (This PR should be helpful)
  • Provide clear examples of parallel execution scenarios for both class and method levels

Related Documents

@etrandafir93
Copy link

hello @marcphilipp - can i work on this issue?

@marcphilipp
Copy link
Member

@etrandafir93 Sure! Before you start, let's clarify a few things, though.

Add table of relevant configuration parameters (This PR should be helpful)

I think the current description list is more readable, especially on small screens, than the table we have for Jupiter's parallel configuration.

@YongGoose Do you think anything is missing from it or what did you have in mind?

@YongGoose
Copy link
Contributor Author

YongGoose commented Feb 21, 2025

I think the current description list is more readable, especially on small screens, than the table we have for Jupiter's parallel configuration.

I didn’t consider small screens.
After checking on my phone, I agree that Vintage’s parallel configuration has better readability than Jupiter’s parallel configuration.

Add table of relevant configuration parameters (This #2946 should be helpful)

Now, I don’t think this task is necessary.

@marcphilipp
Copy link
Member

@etrandafir93 If you're still interested, feel free to go ahead and start working on the remaining "deliverable" in the issue description. 🙂

@etrandafir93
Copy link

@marcphilipp - sounds good, I'll start looking into it and keep you posted 👍

@etrandafir93
Copy link

hello @marcphilipp, @YongGoose - I have added some simple examples with the possible config combinations.
Let me know what you think

etrandafir93 added a commit to etrandafir93/junit5 that referenced this issue Feb 26, 2025
etrandafir93 added a commit to etrandafir93/junit5 that referenced this issue Feb 26, 2025
etrandafir93 added a commit to etrandafir93/junit5 that referenced this issue Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants