feat: Add TestSequenceDiagram annotation #108
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mkollenstart
requested review from
jimmarino,
paullatzelsperger and
wolf4ood
as code owners
jimmarino
reviewed
Nov 19, 2024
| @@ -0,0 +1,41 @@ | |||
| /* | |||
There was a problem hiding this comment.
I think you need to. change this to TNO
jimmarino
approved these changes
Nov 19, 2024
jimmarino
added
documentation
|
@mkollenstart Just some checkstyle cleanup needed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR changes/adds
This PR adds the
TestSequenceDiagramannotation, that allows to input a string that contains a sequence diagram in the form of MermaidJS.In the examples around the tests, I've omitted the
sequenceDiagrampart, since that can be added to all strings when parsing these with an annotation processor.These sequence diagrams can be injected into documentation via an annotation processor to provide a clear overview of all tests and the expected flows from the TCK and CUT. Also for CUT developers having the sequence diagrams inline with the tests will help in debugging issues.