Initial Client API v2 impl #43395

vmuzikar · 2025-10-13T09:55:07Z

keycloak-github-bot

Unreported flaky test detected, please review

keycloak-github-bot · 2025-10-14T08:31:36Z

Unreported flaky test detected

If the flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR.

org.keycloak.testsuite.webauthn.account.WebAuthnSigningInTest#setUpLinksTest

Keycloak CI - WebAuthn IT (firefox)

java.lang.AssertionError: 
Set up link for "webauthn-passwordless" is not visible
Expected: is <true>
     but: was <false>
	at org.hamcrest.MatcherAssert.assertThat(MatcherAssert.java:20)
...

Report flaky test

keycloak-github-bot

Unreported flaky test detected, please review

keycloak-github-bot · 2025-10-14T08:50:55Z

Unreported flaky test detected

If the flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR.

org.keycloak.testsuite.webauthn.account.WebAuthnSigningInTest#setUpLinksTest

Keycloak CI - WebAuthn IT (firefox)

java.lang.AssertionError: 
Set up link for "webauthn-passwordless" is not visible
Expected: is <true>
     but: was <false>
	at org.hamcrest.MatcherAssert.assertThat(MatcherAssert.java:20)
...

Report flaky test

vmuzikar · 2025-10-14T08:57:56Z

Keeping as individual commits for the sake of review. Will squash it before merge.

mabartos

@vmuzikar LGTM.

When tests passed, I'm ok to merge it. Some polishing and improvement will be done in follow-up tasks.

Not sure if these commits should be squashed, as there are some contextually different pieces of code - but leaving the final decision up to you.

common/src/main/java/org/keycloak/common/Profile.java

mabartos · 2025-10-15T10:03:36Z

@shawkins @Pepo48 Could you please review it to unblock further work? Thanks!

server-spi/src/main/java/org/keycloak/models/KeycloakSession.java

stianst · 2025-10-16T08:58:37Z

pom.xml

+            <dependency>
+                <groupId>org.glassfish.expressly</groupId>
+                <artifactId>expressly</artifactId>
+                <version>${expressly.version}</version>
+            </dependency>


This dependency needs approval from the CNCF since it's EPL 2.0. We can merge without approval from the CNCF, but would need to get an exception at some point, ideally before the release.

Created follow-up task:

Handle GlassFish Expressly dependency for Hibernate Validator #43569

The dependency has been removed for now.

Actually it was not removed as it's a transitive dependency of Hibernate Validator.

stianst · 2025-10-16T09:01:07Z

...g/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt

                     Set the number of users per file. It is used only if 'users' is set to
                       'different_files'. Default: 50.

+OpenAPI configuration (Experimental):


Shouldn't these just be features rather than CLI config options?

Not really IMHO. It's similar to metrics or health endpoints, we do too have config options for those.

Don't get why - we have features that can be enabled/disabled, why is there a need for a separate CLI option to do the same?

This also means these won't be listed on https://www.keycloak.org/server/features; and not consistent with other features/capabilities. What about if we have different versions of this in the future, etc, etc. There are reasons why we have features and want to make this stuff consistent.

Resolved, OpenAPI is a feature but I kept the options (which are not marked as experimental any more).

stianst · 2025-10-16T09:05:39Z

rest/admin-v2/rest/src/main/java/org/keycloak/admin/api/client/ClientApi.java

+                                              @QueryParam("fieldValidation") FieldValidation fieldValidation);
+
+    @PATCH
+    @Consumes({MediaType.APPLICATION_JSON_PATCH_JSON, CONTENT_TYPE_MERGE_PATCH})


So we support only application/json-patch+json, but not a basic patch? Seems the wrong way around when it comes to priorities

but not a basic patch

That's the application/merge-patch+json. We'll need to remove application/json-patch+json as that's the "smart" PATCH that is out of scope of the MVP. I'll create a separate commit to remove it.

cc: @shawkins

I'll create a separate commit to remove it.

Actually, decided to do it rather as a follow-up. Let's keep this PR as close as possible to the prototype.

rest/admin-v2/tests/src/test/java/org/keycloak/tests/admin/client/v2/ClientApiV2Test.java

stianst · 2025-10-16T09:09:03Z

rest/admin-v2/rest/src/main/java/org/keycloak/admin/api/AdminRootV2.java

+    }
+
+    @Path("v2")
+    public AdminApi adminApi() {


We explicitly don't want versioning on the Admin API as whole; but rather on each distinct API.

Created follow-up issue:

Every distinct Admin API should be versioned #43571

But we need to discuss it within our SIG.

This is really not open to discussion; we need to break the massive Admin API into distinct separate and smaller APIs.

mabartos

LGTM as the initial implementation - the main concerns/issues were addressed and for other minor issues, follow-up tasks were created.

…ation (keycloak#41110) Signed-off-by: Martin Bartoš <[email protected]> Signed-off-by: Václav Muzikář <[email protected]>

Signed-off-by: Robin Meese <[email protected]> Signed-off-by: Václav Muzikář <[email protected]> # Conflicts: # quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/PropertyMappers.java # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelpAll.approved.txt

Signed-off-by: Martin Bartoš <[email protected]>

Signed-off-by: Václav Muzikář <[email protected]>

Signed-off-by: Martin Bartoš <[email protected]>

Signed-off-by: Václav Muzikář <[email protected]>

keycloak-github-bot

Unreported flaky test detected, please review

keycloak-github-bot · 2025-11-03T09:28:17Z

Unreported flaky test detected

If the flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR.

org.keycloak.testsuite.actions.RequiredActionUpdateProfileTest#updateProfileWithoutRemoveCustomAttributes

Keycloak CI - Forms IT (firefox)

java.lang.RuntimeException: Could not create statement
	at org.jboss.arquillian.junit.Arquillian.methodBlock(Arquillian.java:307)
	at org.junit.runners.BlockJUnit4ClassRunner$1.evaluate(BlockJUnit4ClassRunner.java:100)
	at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:366)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:103)
...

Report flaky test

Signed-off-by: Václav Muzikář <[email protected]>

vmuzikar · 2025-11-03T11:28:42Z

.github/scripts/find-modules-with-unit-tests.sh


 find . -path '**/src/test/java' -type d \
-  | grep -v -E '\./(docs|distribution|misc|operator|tests|testsuite|test-framework|quarkus)/' \
+  | grep -v -E '\./(docs|distribution|misc|operator|((.+/)?tests)|testsuite|test-framework|quarkus)/' \


This is to exclude the Admin v2 IT from running as UT. Decided to do it in more generic way – I assume if a module is called tests it's somewhere executed as IT.

The output before:

adapters/saml/core,adapters/saml/wildfly/wildfly-subsystem,authz/client,common,core,crypto/default,crypto/elytron,crypto/fips1402,federation/kerberos,federation/ldap,integration/client-cli/admin-cli,model/infinispan,model/jpa,model/storage-private,saml-core,server-spi,server-spi-private,services%

After:

adapters/saml/core,adapters/saml/wildfly/wildfly-subsystem,authz/client,common,core,crypto/default,crypto/elytron,crypto/fips1402,federation/kerberos,federation/ldap,integration/client-cli/admin-cli,model/infinispan,model/jpa,model/storage-private,rest/admin-v2/tests,saml-core,server-spi,server-spi-private,services%

All blocking comments were resolved.

vmuzikar force-pushed the admin-v2-port branch 3 times, most recently from b15fc7c to ade8e04 Compare October 14, 2025 07:15

keycloak-github-bot bot added the flaky-test label Oct 14, 2025

keycloak-github-bot bot reviewed Oct 14, 2025

View reviewed changes

vmuzikar marked this pull request as ready for review October 14, 2025 09:01

vmuzikar requested review from a team as code owners October 14, 2025 09:01

keycloak-github-bot bot added the team/cloud-native label Oct 14, 2025

mabartos previously approved these changes Oct 14, 2025

View reviewed changes

common/src/main/java/org/keycloak/common/Profile.java Show resolved Hide resolved

stianst reviewed Oct 15, 2025

View reviewed changes

server-spi/src/main/java/org/keycloak/models/KeycloakSession.java Outdated Show resolved Hide resolved

stianst requested review from mposolda and pedroigor October 15, 2025 11:16

Pepo48 previously approved these changes Oct 15, 2025

View reviewed changes

stianst reviewed Oct 16, 2025

View reviewed changes

rest/admin-v2/tests/src/test/java/org/keycloak/tests/admin/client/v2/ClientApiV2Test.java Show resolved Hide resolved

stianst reviewed Oct 16, 2025

View reviewed changes

This was referenced Oct 17, 2025

Remove KeycloakServices SPI, rename test vmuzikar/keycloak#18

Merged

Handle GlassFish Expressly dependency for Hibernate Validator #43569

Closed

vmuzikar dismissed stale reviews from Pepo48 and mabartos via fa4ba83 October 17, 2025 12:02

mabartos mentioned this pull request Oct 17, 2025

Every distinct Admin API should be versioned #43571

Open

mabartos previously approved these changes Oct 17, 2025

View reviewed changes

mabartos and others added 19 commits November 3, 2025 09:10

[admin-api-v2] Provide simple validation with Jakarta/Hibernate Valid…

e879e74

…ation (keycloak#41110) Signed-off-by: Martin Bartoš <[email protected]> Signed-off-by: Václav Muzikář <[email protected]>

[admin-api-v2] SPIs for Admin APIs v2 (keycloak#41943)

e01e82c

Signed-off-by: Martin Bartoš <[email protected]>

Manual execution of Jakarta validation (keycloak#42388)

84b8846

Signed-off-by: Martin Bartoš <[email protected]>

Add Client API v2 feature

9447dec

Signed-off-by: Václav Muzikář <[email protected]>

Remove unused imports

f30bb32

Signed-off-by: Václav Muzikář <[email protected]>

Remove KeycloakServices SPI

e8e4ec1

Signed-off-by: Martin Bartoš <[email protected]>

Rename and move Client API v2 test to better place

029fe03

Signed-off-by: Martin Bartoš <[email protected]>

Refactor modules

8acb583

Signed-off-by: Václav Muzikář <[email protected]>

Add auth

38af01f

Signed-off-by: Václav Muzikář <[email protected]>

Conditional tests

746e104

Signed-off-by: Václav Muzikář <[email protected]>

Remove unused import

74b2a17

Signed-off-by: Václav Muzikář <[email protected]>

Feature for OpenAPI

bfb98a0

Signed-off-by: Václav Muzikář <[email protected]>

Remove AdminV2DisabledTest

5d3637f

Signed-off-by: Václav Muzikář <[email protected]>

Remove Expressly

995dd49

Signed-off-by: Václav Muzikář <[email protected]>

Fix CI name

6fb6631

Signed-off-by: Václav Muzikář <[email protected]>

Fix FeatureCompatibilityMetadataProviderTest

c70e398

Signed-off-by: Václav Muzikář <[email protected]>

Revert unintentional change

5d4a020

Signed-off-by: Václav Muzikář <[email protected]>

Add Admin v2 tests as required

be03072

Signed-off-by: Václav Muzikář <[email protected]>

vmuzikar force-pushed the admin-v2-port branch from 8b05860 to be03072 Compare November 3, 2025 08:10

keycloak-github-bot bot reviewed Nov 3, 2025

View reviewed changes

Exclude Admin v2 tests from unit tests

61e21c8

Signed-off-by: Václav Muzikář <[email protected]>

vmuzikar dismissed mabartos’s stale review via 61e21c8 November 3, 2025 11:01

vmuzikar commented Nov 3, 2025

View reviewed changes

mabartos approved these changes Nov 3, 2025

View reviewed changes

stianst approved these changes Nov 3, 2025

View reviewed changes

vmuzikar merged commit 9c86eae into keycloak:main Nov 3, 2025
89 of 92 checks passed

vmuzikar deleted the admin-v2-port branch November 3, 2025 14:04

Initial Client API v2 impl #43395

Initial Client API v2 impl #43395

Uh oh!

Conversation

vmuzikar commented Oct 13, 2025

Uh oh!

keycloak-github-bot bot left a comment

Choose a reason for hiding this comment

Uh oh!

keycloak-github-bot bot commented Oct 14, 2025

Unreported flaky test detected

org.keycloak.testsuite.webauthn.account.WebAuthnSigningInTest#setUpLinksTest

Uh oh!

keycloak-github-bot bot left a comment

Choose a reason for hiding this comment

Uh oh!

keycloak-github-bot bot commented Oct 14, 2025

Unreported flaky test detected

org.keycloak.testsuite.webauthn.account.WebAuthnSigningInTest#setUpLinksTest

Uh oh!

vmuzikar commented Oct 14, 2025

Uh oh!

mabartos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mabartos commented Oct 15, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mabartos Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mabartos left a comment

Choose a reason for hiding this comment

Uh oh!

keycloak-github-bot bot left a comment

Choose a reason for hiding this comment

Uh oh!

keycloak-github-bot bot commented Nov 3, 2025

Unreported flaky test detected

org.keycloak.testsuite.actions.RequiredActionUpdateProfileTest#updateProfileWithoutRemoveCustomAttributes

Uh oh!

vmuzikar Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mabartos Oct 17, 2025 •

edited

Loading

vmuzikar Nov 3, 2025 •

edited

Loading