From f8ca25d4a45b6f723cd70eee7de9af33396019af Mon Sep 17 00:00:00 2001 From: vramik Date: Fri, 22 Apr 2022 21:43:01 +0200 Subject: [PATCH] Add a profiles testsuite for jpa-map storage Closes #12045 --- .../integration-arquillian/tests/base/pom.xml | 41 +++++++ testsuite/model/pom.xml | 16 +++ .../model/KeycloakModelParameters.java | 2 + .../testsuite/model/ClientModelTest.java | 6 +- .../model/parameters/HotRodMapStorage.java | 2 - .../model/parameters/JpaMapStorage.java | 100 ++++++++++++++++++ testsuite/model/test-all-profiles.sh | 5 + testsuite/pom.xml | 6 ++ 8 files changed, 172 insertions(+), 6 deletions(-) create mode 100644 testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorage.java diff --git a/testsuite/integration-arquillian/tests/base/pom.xml b/testsuite/integration-arquillian/tests/base/pom.xml index a2d25e7f4e..0fc5b91455 100644 --- a/testsuite/integration-arquillian/tests/base/pom.xml +++ b/testsuite/integration-arquillian/tests/base/pom.xml @@ -852,6 +852,47 @@ + + + map-storage-jpa + + + + maven-enforcer-plugin + + enforce + + + + + map-storage + map-storage profile not active + + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + ${keycloak.map.storage.connectionsJpa.url} + ${keycloak.map.storage.connectionsJpa.user} + ${keycloak.map.storage.connectionsJpa.password} + + jpa-map-storage + jpa-map-storage + jpa-map-storage + jpa-map-storage + jpa-map-storage + jpa-map-storage + jpa-map-storage + + + + + + diff --git a/testsuite/model/pom.xml b/testsuite/model/pom.xml index 0c725a1102..1683aaccc5 100644 --- a/testsuite/model/pom.xml +++ b/testsuite/model/pom.xml @@ -109,6 +109,11 @@ infinispan-component-annotations ${infinispan.version} + + org.postgresql + postgresql + ${postgresql.driver.version} + @@ -152,6 +157,9 @@ ${keycloak.connectionsJpa.user} ${keycloak.connectionsJpa.password} ${keycloak.connectionsJpa.url} + ${keycloak.map.storage.connectionsJpa.url} + ${keycloak.map.storage.connectionsJpa.user} + ${keycloak.map.storage.connectionsJpa.password} file:${project.build.directory}/test-classes/log4j.properties ${keycloak.profile.feature.map_storage} ${keycloak.userSessions.infinispan.preloadOfflineSessionsFromDatabase} @@ -308,6 +316,14 @@ + + map-jpa + + enabled + Map,JpaMapStorage + + + .asyncProfiler diff --git a/testsuite/model/src/main/java/org/keycloak/testsuite/model/KeycloakModelParameters.java b/testsuite/model/src/main/java/org/keycloak/testsuite/model/KeycloakModelParameters.java index 2e9d786dc9..5285642a68 100644 --- a/testsuite/model/src/main/java/org/keycloak/testsuite/model/KeycloakModelParameters.java +++ b/testsuite/model/src/main/java/org/keycloak/testsuite/model/KeycloakModelParameters.java @@ -32,6 +32,8 @@ public class KeycloakModelParameters { private final Set> allowedSpis; private final Set> allowedFactories; + protected static final String STORAGE_CONFIG = "storage.provider"; + public KeycloakModelParameters(Set> allowedSpis, Set> allowedFactories) { this.allowedSpis = allowedSpis; this.allowedFactories = allowedFactories; diff --git a/testsuite/model/src/test/java/org/keycloak/testsuite/model/ClientModelTest.java b/testsuite/model/src/test/java/org/keycloak/testsuite/model/ClientModelTest.java index 3021aec946..934d3d48f6 100644 --- a/testsuite/model/src/test/java/org/keycloak/testsuite/model/ClientModelTest.java +++ b/testsuite/model/src/test/java/org/keycloak/testsuite/model/ClientModelTest.java @@ -122,10 +122,8 @@ public class ClientModelTest extends KeycloakModelTest { }); withRealm(realmId, (session, realm) -> { - ClientModel client = session.clients().searchClientsByClientIdStream(realm, "%", 0, 10).findFirst().orElse(null); - assertThat(client, notNullValue()); - assertThat(client.getId(), is(equalTo(searchClient.getId()))); - assertThat(client.getClientId(), is(equalTo(searchClientId))); + // when searching by "%" all entries are expected + assertThat(session.clients().searchClientsByClientIdStream(realm, "%", 0, 10).count(), is(equalTo(2L))); return null; }); } diff --git a/testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/HotRodMapStorage.java b/testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/HotRodMapStorage.java index b6442289df..035f641c58 100644 --- a/testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/HotRodMapStorage.java +++ b/testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/HotRodMapStorage.java @@ -68,8 +68,6 @@ public class HotRodMapStorage extends KeycloakModelParameters { .add(ConcurrentHashMapStorageProviderFactory.class) // TODO: this should be removed when we have a HotRod implementation for each area .build(); - private static final String STORAGE_CONFIG = "storage.provider"; - private HotRodServerRule hotRodServerRule = new HotRodServerRule(); @Override diff --git a/testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorage.java b/testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorage.java new file mode 100644 index 0000000000..222ebd2fa4 --- /dev/null +++ b/testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorage.java @@ -0,0 +1,100 @@ +/* + * Copyright 2020 Red Hat, Inc. and/or its affiliates + * and other contributors as indicated by the @author tags. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.keycloak.testsuite.model.parameters; + +import com.google.common.collect.ImmutableSet; +import java.util.Set; +import org.jboss.logging.Logger; +import org.keycloak.authorization.store.StoreFactorySpi; +import org.keycloak.models.DeploymentStateSpi; +import org.keycloak.models.UserLoginFailureSpi; +import org.keycloak.models.UserSessionSpi; +import org.keycloak.models.dblock.NoLockingDBLockProviderFactory; +import org.keycloak.models.map.authSession.MapRootAuthenticationSessionProviderFactory; +import org.keycloak.models.map.authorization.MapAuthorizationStoreFactory; +import org.keycloak.models.map.client.MapClientProviderFactory; +import org.keycloak.models.map.clientscope.MapClientScopeProviderFactory; +import org.keycloak.models.map.deploymentState.MapDeploymentStateProviderFactory; +import org.keycloak.models.map.group.MapGroupProviderFactory; +import org.keycloak.models.map.loginFailure.MapUserLoginFailureProviderFactory; +import org.keycloak.models.map.realm.MapRealmProviderFactory; +import org.keycloak.models.map.role.MapRoleProviderFactory; +import org.keycloak.models.map.storage.MapStorageSpi; +import org.keycloak.models.map.storage.chm.ConcurrentHashMapStorageProviderFactory; +import org.keycloak.models.map.storage.jpa.JpaMapStorageProviderFactory; +import org.keycloak.models.map.storage.jpa.liquibase.connection.MapLiquibaseConnectionProviderFactory; +import org.keycloak.models.map.storage.jpa.liquibase.connection.MapLiquibaseConnectionSpi; +import org.keycloak.models.map.storage.jpa.updater.MapJpaUpdaterProviderFactory; +import org.keycloak.models.map.storage.jpa.updater.MapJpaUpdaterSpi; +import org.keycloak.models.map.user.MapUserProviderFactory; +import org.keycloak.models.map.userSession.MapUserSessionProviderFactory; +import org.keycloak.provider.ProviderFactory; +import org.keycloak.provider.Spi; +import org.keycloak.sessions.AuthenticationSessionSpi; +import org.keycloak.testsuite.model.Config; +import org.keycloak.testsuite.model.KeycloakModelParameters; + +public class JpaMapStorage extends KeycloakModelParameters { + + private static final Logger LOG = Logger.getLogger(JpaMapStorage.class.getName()); + + static final Set> ALLOWED_SPIS = ImmutableSet.>builder() + .add(MapJpaUpdaterSpi.class) + .add(MapLiquibaseConnectionSpi.class) + .build(); + + static final Set> ALLOWED_FACTORIES = ImmutableSet.>builder() + .add(ConcurrentHashMapStorageProviderFactory.class) + .add(JpaMapStorageProviderFactory.class) + .add(MapJpaUpdaterProviderFactory.class) + .add(MapLiquibaseConnectionProviderFactory.class) + .build(); + + public JpaMapStorage() { + super(ALLOWED_SPIS, ALLOWED_FACTORIES); + } + + @Override + public void updateConfig(Config cf) { + cf.spi(MapStorageSpi.NAME) + .provider(ConcurrentHashMapStorageProviderFactory.PROVIDER_ID) + .config("dir", "${project.build.directory:target}"); + + cf.spi(MapStorageSpi.NAME) + .provider(JpaMapStorageProviderFactory.PROVIDER_ID) + .config("url", System.getProperty("keycloak.map.storage.connectionsJpa.url")) + .config("user", System.getProperty("keycloak.map.storage.connectionsJpa.user")) + .config("password", System.getProperty("keycloak.map.storage.connectionsJpa.password")) + .config("driver", "org.postgresql.Driver") + .config("driverDialect", "org.keycloak.models.map.storage.jpa.hibernate.dialect.JsonbPostgreSQL95Dialect"); + + cf.spi(AuthenticationSessionSpi.PROVIDER_ID).provider(MapRootAuthenticationSessionProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID) + .spi("client").provider(MapClientProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID) + .spi("clientScope").provider(MapClientScopeProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID) + .spi("group").provider(MapGroupProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID) + .spi("realm").provider(MapRealmProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID) + .spi("role").provider(MapRoleProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID) + .spi(DeploymentStateSpi.NAME).provider(MapDeploymentStateProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, ConcurrentHashMapStorageProviderFactory.PROVIDER_ID) + .spi(StoreFactorySpi.NAME).provider(MapAuthorizationStoreFactory.PROVIDER_ID) .config(STORAGE_CONFIG, ConcurrentHashMapStorageProviderFactory.PROVIDER_ID) + .spi("user").provider(MapUserProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, ConcurrentHashMapStorageProviderFactory.PROVIDER_ID) + .spi(UserLoginFailureSpi.NAME).provider(MapUserLoginFailureProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID) + .spi("dblock").provider(NoLockingDBLockProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, ConcurrentHashMapStorageProviderFactory.PROVIDER_ID) + .spi(UserSessionSpi.NAME).provider(MapUserSessionProviderFactory.PROVIDER_ID) .config("storage-user-sessions.provider", ConcurrentHashMapStorageProviderFactory.PROVIDER_ID) + .config("storage-client-sessions.provider", ConcurrentHashMapStorageProviderFactory.PROVIDER_ID); + + } +} diff --git a/testsuite/model/test-all-profiles.sh b/testsuite/model/test-all-profiles.sh index 5d21c6ad2f..939979809e 100755 --- a/testsuite/model/test-all-profiles.sh +++ b/testsuite/model/test-all-profiles.sh @@ -12,6 +12,11 @@ mvn -version EXIT_CODE=0 mvn clean for I in `perl -ne 'print "$1\n" if (m,([^.<]+),)' pom.xml`; do + + ## skip map-jpa for GHA + if [[ $I == 'map-jpa' ]]; then + continue + fi echo "========" echo "======== Start of Profile $I" echo "========" diff --git a/testsuite/pom.xml b/testsuite/pom.xml index 79d131d98c..70fd954269 100755 --- a/testsuite/pom.xml +++ b/testsuite/pom.xml @@ -31,6 +31,12 @@ Keycloak TestSuite + + jdbc:postgresql://localhost:5432/keycloak + keycloak + pass + +