Preview - Keycloak Test Framework #488
Open
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
lhanusov
force-pushed
the
32399
branch
3 times, most recently
from
2d89793
to
46b3979
Compare
vaceksimon
suggested changes
Aug 29, 2024
vaceksimon
approved these changes
Sep 2, 2024
Signed-off-by: Lukas Hanusovsky <lhanusov@redhat.com>
stianst
reviewed
Sep 27, 2024
|
|
||
| == Brighter Future? | ||
|
|
||
| Keycloak team had started a https://github.com/orgs/keycloak/projects/42[joint effort] between the engineering and quality engineering people to design a new test framework (May 2024). It had been initiated with a prototype to verify if our thoughts were feasible. The prototype was based on the _JUnit5_ testing framework, specifically to implement _JUnit5_ callback classes which extend the default test lifecycle functionality and provide custom inject annotations, like _@KeycloakIntegrationTest_, _@InjectWebDriver_ or _@InjectRealm_. |
There was a problem hiding this comment.
Just say Keycloak team - engineering and quality engineering is a RH thing, and we're all just the Keycloak team :)
stianst
reviewed
Sep 27, 2024
| == Are you curious about where to start? | ||
| We suggest reading the https://github.com/keycloak/keycloak/blob/main/test-framework/README.md[user guide], which will provide a basic overview of how the framework works and should be used. If this is not enough, you can also check https://github.com/keycloak/keycloak/tree/main/test-poc/examples[examples module]. | ||
|
|
||
| For extension developers we recommend to look into the showcase example on how to start _Keycloak_ with their custom provider - link. |
There was a problem hiding this comment.
Just a note that we need to update this before publishing the blog
stianst
reviewed
Sep 27, 2024
|
|
||
| For extension developers we recommend to look into the showcase example on how to start _Keycloak_ with their custom provider - link. | ||
|
|
||
| Once you find a bug, want to discuss something, or propose a new enhancement, please follow this GitHub feedback https://www.github.com/discussion#blabla[discussion] link. |
There was a problem hiding this comment.
Just a note that we need to update this before publishing the blog
stianst
reviewed
Sep 27, 2024
|
|
||
| == Coming Soon | ||
|
|
||
| Preview - https://github.com/keycloak/keycloak/tree/main/test-framework[_Keycloak Test Framework_] will be introduced in _Keycloak Nightly_ builds. We plan to add more features, which will cover 80% of functionalities currently available in the https://github.com/keycloak/keycloak/tree/main/testsuite[integration test suite]. We also plan to introduce some new concepts, e.g. _@KeycloakTest_ annotation, which will add an option to test providers without the _Keycloak_ server running. It should be based on the _KeycloakSession_ class. Other interesting features should be parallel execution on a GitHub runner, adding a custom extension to a Keycloak server, or enabling a Keycloak cluster setup. |
There was a problem hiding this comment.
Is available, not will be ;)
There was a problem hiding this comment.
Remove 80%, and say something like cover enough for most tests...
stianst
reviewed
Sep 27, 2024
|
|
||
| == Brighter Future? | ||
|
|
||
| Keycloak team had started a https://github.com/orgs/keycloak/projects/42[joint effort] between the engineering and quality engineering people to design a new test framework (May 2024). It had been initiated with a prototype to verify if our thoughts were feasible. The prototype was based on the _JUnit5_ testing framework, specifically to implement _JUnit5_ callback classes which extend the default test lifecycle functionality and provide custom inject annotations, like _@KeycloakIntegrationTest_, _@InjectWebDriver_ or _@InjectRealm_. |
There was a problem hiding this comment.
The board is private, and not visible to everyone. So we either remove the link, or cleanup the board and make it public
stianst
reviewed
Sep 27, 2024
|
|
||
| For extension developers we recommend to look into the showcase example on how to start _Keycloak_ with their custom provider - link. | ||
|
|
||
| Once you find a bug, want to discuss something, or propose a new enhancement, please follow this GitHub feedback https://www.github.com/discussion#blabla[discussion] link. |
There was a problem hiding this comment.
Suggested change
| Once you find a bug, want to discuss something, or propose a new enhancement, please follow this GitHub feedback https://www.github.com/discussion#blabla[discussion] link. | |
| If you find a bug, want to discuss something, or propose a new enhancement, please follow this GitHub feedback https://www.github.com/discussion#blabla[discussion] link. |
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.
Closes #32399