Testsuite PoC - Injection framework support for multiple instances #31293
Conversation
This file contains hidden or 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
c6cc311 to
b06a5f2
Compare
stianst
reviewed
Jul 18, 2024
test-poc/framework/src/main/java/org/keycloak/test/framework/injection/Supplier.java
Outdated
Show resolved
Hide resolved
stianst
reviewed
Jul 18, 2024
Contributor
stianst
left a comment
There was a problem hiding this comment.
I think this can be implemented a bit more cleanly, especially with some of the changes in #31406.
- RequestedInstance can have a ref added to it
- InstanceContext can have a ref added to it
- Supplier can have a default method that returns the ref from the annotation if present in a generic way (https://github.com/keycloak/keycloak/pull/31406/files#diff-d888c9866793d97a2ae142800245479b0701fc4e41697164b24f553c8bfc2c2cR16)
b06a5f2 to
6194637
Compare
Closes keycloak#30613 Signed-off-by: Simon Vacek <[email protected]>
6194637 to
4ec1321
Compare
stianst
reviewed
Jul 23, 2024
Comment on lines
150
to
153
| if (getDeployedInstance(requestedInstance) != null) { | ||
| throw new RuntimeException("Instance ref redefinition: " + requestedInstance.getRef()); | ||
| } | ||
|
|
Contributor
There was a problem hiding this comment.
Could you elaborate on this? When/why would this happen?
Contributor
Author
There was a problem hiding this comment.
It could happen whenever someone uses the same ref or when they don't use ref at all. This check can probably be moved elsewhere, I find it comfortable here, in this loop.
@KeycloakIntegrationTest
public class MyTestClass {
@TestRealm
RealmResource realm1;
@TestRealm
RealmResource realm2;
}
Contributor
There was a problem hiding this comment.
As we discussed on the chat, there's nothing wrong in doing that, and it should just end up with realm1 == realm2.
Contributor
There was a problem hiding this comment.
I think it's not necessary too, but it may be useful for debugging to just print some warning instead throwing exception. WDYT?
Signed-off-by: stianst <[email protected]>
Signed-off-by: Simon Vacek <[email protected]>
stianst
approved these changes
Jul 23, 2024
jonkoops
approved these changes
Jul 23, 2024
Comment on lines
+34
to
+41
| Assertions.assertEquals("default", realm1.toRepresentation().getRealm()); | ||
| Assertions.assertEquals("default", realm2.toRepresentation().getRealm()); | ||
| Assertions.assertEquals(realm1, realm2); | ||
|
|
||
| Assertions.assertEquals("another", realm3.toRepresentation().getRealm()); | ||
|
|
||
| Assertions.assertEquals("client1", client.toRepresentation().getClientId()); | ||
| Assertions.assertEquals("default", client2.toRepresentation().getClientId()); |
Contributor
There was a problem hiding this comment.
This seems to make assertions about the internals of the framework, perhaps this should be part of the framework module?
stianst
added a commit
to stianst/keycloak
that referenced
this pull request
Jul 25, 2024
…eycloak#31293) * Testsuite PoC - Injection framework support for multiple instances Closes keycloak#30613 Signed-off-by: Simon Vacek <[email protected]> * Add unit tests for multiple instances Signed-off-by: stianst <[email protected]> * Remove check for ref redefinitions Signed-off-by: Simon Vacek <[email protected]> --------- Signed-off-by: Simon Vacek <[email protected]> Signed-off-by: stianst <[email protected]> Co-authored-by: stianst <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The test framework supports injecting multiple instances of the same resource type. These instances must have a different
ref(an identifier for instances). If an instance does not have a ref, a "default" value is assigned. There can be only one instance of a given type without a specifiedrefin the test class.The
refidentifiers are unique only to the type of an instance. That means this is valid:In this case realm == realm3
If there is a deployed instance found that could fit the requested instance, the Registry has the following behavior to the deployed instance:
TestWebDriver,TestAdminClient,KeycloakIntegrationTest, andTestPageare ignored in this PR.Realms, clients, and users have their names set to their
ref.As this should lay down the basic concept of multiple instances of the same type being deployed within the framework, other issues may follow, for example:
realm-refattribute in the annotation@TestUser(realm-ref="realmWithUsers")Closes #30613