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.

Sign up for GitHub

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

Jump to bottom

Automate TCK documentation #332

Merged
merged 3 commits into from
Oct 4, 2023
Merged

Automate TCK documentation #332

merged 3 commits into from
Oct 4, 2023

Conversation

KyleAure
Copy link
Contributor

Automate the creation of 4 sections of the TCK Distribution guide:

  1. Test Counts
    Screenshot 2023-08-23 at 12 14 48

  2. Expected output (Junit)
    Screenshot 2023-08-23 at 12 15 16

  3. Expected output (signature)
    Screenshot 2023-08-23 at 12 15 29

  4. TCK Challenges
    Screenshot 2023-08-23 at 12 19 41

Fixes #217
Fixes #269

@KyleAure KyleAure self-assigned this Aug 23, 2023
@KyleAure KyleAure force-pushed the 217-tck-dist-automate-sections branch from d205f78 to 60984e4 Compare August 23, 2023 19:08
njr-11
njr-11 approved these changes Oct 4, 2023
View reviewed changes
Copy link
Contributor

@njr-11 njr-11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing all of this Kyle. It looks good. I spotted a few grammar errors in the test strategies that were copied over, but the originals had the same, so that is not something to be addressed in this pull.

tck/src/main/java/ee/jakarta/tck/concurrent/framework/junit/anno/Assertion.java
/**
* A longer description of the assertion being made to keep method names concise
*/
String strategy() default "";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making this attribute required would force developers to supply a test strategy when writing new tests, which seems like a good idea to me unless there are legacy tests that lack it which would fail to compile.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion. I'll update that in a future pull

@KyleAure KyleAure merged commit 1ab15d4 into jakartaee:main Oct 4, 2023
2 checks passed
@KyleAure KyleAure deleted the 217-tck-dist-automate-sections branch October 4, 2023 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@njr-11 njr-11 njr-11 approved these changes

Assignees

@KyleAure KyleAure

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

TCK Improvements for 3.1 TCK jar test code source and consistent totals of results
2 participants
@KyleAure @njr-11