Closes keycloak#30616. Added database suppliers.

Signed-off-by: Miquel Simon <[email protected]>
miquelsi · Jul 12, 2024 · 173da6f · 173da6f
1 parent 2bd17cd
commit 173da6f
Show file tree

Hide file tree

Showing 12 changed files with 149 additions and 7 deletions.
diff --git a/test-poc/framework/src/main/java/org/keycloak/test/framework/KeycloakTestDatabase.java b/test-poc/framework/src/main/java/org/keycloak/test/framework/KeycloakTestDatabase.java
@@ -0,0 +1,19 @@
+package org.keycloak.test.framework;
+
+import org.keycloak.test.framework.database.DatabaseConfig;
+import org.keycloak.test.framework.injection.LifeCycle;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+public @interface KeycloakTestDatabase {
+
+    Class<? extends DatabaseConfig> config() default DatabaseConfig.class;
+
+    LifeCycle lifecycle() default LifeCycle.GLOBAL;
+
+}
diff --git a/test-poc/framework/src/main/java/org/keycloak/test/framework/database/DatabaseConfig.java b/test-poc/framework/src/main/java/org/keycloak/test/framework/database/DatabaseConfig.java
@@ -0,0 +1,31 @@
+package org.keycloak.test.framework.database;
+
+import java.util.Collections;
+import java.util.Map;
+
+public interface DatabaseConfig {
+
+    default String vendor() {
+        return "";
+    }
+
+    default String containerImage() {
+        return "";
+    }
+
+    default String urlHost() {
+        return "";
+    }
+
+    default String username() {
+        return "";
+    }
+
+    default String password() {
+        return "";
+    }
+
+    default boolean isExternal() {
+        return false;
+    }
+}
diff --git a/test-poc/framework/src/main/java/org/keycloak/test/framework/database/DatabaseSupplier.java b/test-poc/framework/src/main/java/org/keycloak/test/framework/database/DatabaseSupplier.java
@@ -0,0 +1,38 @@
+package org.keycloak.test.framework.database;
+
+import org.keycloak.test.framework.KeycloakTestDatabase;
+import org.keycloak.test.framework.injection.InstanceWrapper;
+import org.keycloak.test.framework.injection.Registry;
+import org.keycloak.test.framework.injection.Supplier;
+
+public abstract class DatabaseSupplier implements Supplier<TestDatabase, KeycloakTestDatabase> {
+
+    protected static TestDatabase testDatabase;
+
+    @Override
+    public Class<KeycloakTestDatabase> getAnnotationClass() {
+        return KeycloakTestDatabase.class;
+    }
+
+    @Override
+    public Class<TestDatabase> getValueType() {
+        return TestDatabase.class;
+    }
+
+    @Override
+    public InstanceWrapper<TestDatabase, KeycloakTestDatabase> getValue(Registry registry, KeycloakTestDatabase annotation) {
+        InstanceWrapper<TestDatabase, KeycloakTestDatabase> wrapper = new InstanceWrapper<>(this, annotation);
+        testDatabase = registry.getDependency(TestDatabase.class, wrapper);
+        testDatabase.start();
+        return wrapper;
+    }
+
+    @Override
+    public boolean compatible(InstanceWrapper<TestDatabase, KeycloakTestDatabase> a, InstanceWrapper<TestDatabase, KeycloakTestDatabase> b) {
+        return true;
+    }
+
+    public TestDatabase getTestDatabase() {
+        return testDatabase;
+    }
+}
diff --git a/...c/framework/src/main/java/org/keycloak/test/framework/database/DefaultDatabaseConfig.java b/...c/framework/src/main/java/org/keycloak/test/framework/database/DefaultDatabaseConfig.java
@@ -0,0 +1,4 @@
+package org.keycloak.test.framework.database;
+
+public class DefaultDatabaseConfig implements DatabaseConfig {
+}
diff --git a/...framework/src/main/java/org/keycloak/test/framework/database/DefaultDatabaseSupplier.java b/...framework/src/main/java/org/keycloak/test/framework/database/DefaultDatabaseSupplier.java
@@ -0,0 +1,4 @@
+package org.keycloak.test.framework.database;
+
+public class DefaultDatabaseSupplier extends DatabaseSupplier {
+}
diff --git a/test-poc/framework/src/main/java/org/keycloak/test/framework/database/TestDatabase.java b/test-poc/framework/src/main/java/org/keycloak/test/framework/database/TestDatabase.java
@@ -0,0 +1,22 @@
+package org.keycloak.test.framework.database;
+
+public class TestDatabase {
+
+    private DatabaseConfig databaseConfig;
+
+    public TestDatabase(DatabaseConfig config) {
+        databaseConfig = config;
+    }
+
+    public void start() {
+
+    }
+
+    public void stop() {
+
+    }
+
+    public DatabaseConfig getDatabaseConfig() {
+        return databaseConfig;
+    }
+}
diff --git a/.../src/main/java/org/keycloak/test/framework/server/AbstractKeycloakTestServerSupplier.java b/.../src/main/java/org/keycloak/test/framework/server/AbstractKeycloakTestServerSupplier.java
@@ -1,6 +1,8 @@
 package org.keycloak.test.framework.server;
 
 import org.keycloak.test.framework.KeycloakIntegrationTest;
+import org.keycloak.test.framework.KeycloakTestDatabase;
+import org.keycloak.test.framework.database.TestDatabase;
 import org.keycloak.test.framework.injection.InstanceWrapper;
 import org.keycloak.test.framework.injection.LifeCycle;
 import org.keycloak.test.framework.injection.Registry;
@@ -22,12 +24,15 @@ public Class<KeycloakIntegrationTest> getAnnotationClass() {
     @Override
     public InstanceWrapper<KeycloakTestServer, KeycloakIntegrationTest> getValue(Registry registry, KeycloakIntegrationTest annotation) {
         KeycloakTestServerConfig serverConfig = SupplierHelpers.getInstance(annotation.config());
+        InstanceWrapper<KeycloakTestServer, KeycloakIntegrationTest> wrapper = new InstanceWrapper<>(this, annotation);
+        TestDatabase testDatabase = registry.getDependency(TestDatabase.class, wrapper);
 
         KeycloakTestServer keycloakTestServer = getServer();
 
-        keycloakTestServer.start(serverConfig);
+        keycloakTestServer.start(serverConfig, testDatabase.getDatabaseConfig());
+        wrapper.setValue(keycloakTestServer, LifeCycle.GLOBAL);
 
-        return new InstanceWrapper<>(this, annotation, keycloakTestServer, LifeCycle.GLOBAL);
+        return wrapper;
     }
 
     @Override

diff --git a/...work/src/main/java/org/keycloak/test/framework/server/DistributionKeycloakTestServer.java b/...work/src/main/java/org/keycloak/test/framework/server/DistributionKeycloakTestServer.java
@@ -1,9 +1,12 @@
 package org.keycloak.test.framework.server;
 
+import org.keycloak.test.framework.database.DatabaseConfig;
+import org.keycloak.test.framework.database.TestDatabase;
+
 public class DistributionKeycloakTestServer implements KeycloakTestServer {
 
     @Override
-    public void start(KeycloakTestServerConfig serverConfig) {
+    public void start(KeycloakTestServerConfig serverConfig, DatabaseConfig databaseConfig) {
         throw new RuntimeException("Method not implemented!");
     }
 

diff --git a/...ramework/src/main/java/org/keycloak/test/framework/server/EmbeddedKeycloakTestServer.java b/...ramework/src/main/java/org/keycloak/test/framework/server/EmbeddedKeycloakTestServer.java
@@ -2,6 +2,8 @@
 
 import org.keycloak.Keycloak;
 import org.keycloak.common.Version;
+import org.keycloak.test.framework.database.DatabaseConfig;
+import org.keycloak.test.framework.database.TestDatabase;
 
 import java.util.LinkedList;
 import java.util.List;
@@ -12,19 +14,26 @@ public class EmbeddedKeycloakTestServer implements KeycloakTestServer {
     private Keycloak keycloak;
 
     @Override
-    public void start(KeycloakTestServerConfig serverConfig) {
+    public void start(KeycloakTestServerConfig serverConfig, DatabaseConfig databaseConfig) {
         serverConfig.adminUserName().ifPresent(username -> System.setProperty("keycloakAdmin", username));
         serverConfig.adminUserPassword().ifPresent(password -> System.setProperty("keycloakAdminPassword", password));
 
         List<String> rawOptions = new LinkedList<>();
         rawOptions.add("start-dev");
-//        rawOptions.add("--db=dev-mem"); // TODO With dev-mem there's an issue as the H2 DB isn't stopped when restarting embedded server
         rawOptions.add("--cache=local");
 
         if (!serverConfig.features().isEmpty()) {
             rawOptions.add("--features=" + String.join(",", serverConfig.features()));
         }
 
+        //rawOptions.add("--db=" + databaseConfig.vendor()); // TODO With dev-mem there's an issue as the H2 DB isn't stopped when restarting embedded server
+        if (databaseConfig.isExternal()) {
+            rawOptions.add("--db-url-host=" + databaseConfig.urlHost());
+            rawOptions.add("--db-username=" + databaseConfig.username());
+            rawOptions.add("--db-password=" + databaseConfig.password());
+        }
+
+
         serverConfig.options().forEach((key, value) -> rawOptions.add("--" + key + "=" + value));
 
         keycloak = Keycloak.builder()

diff --git a/test-poc/framework/src/main/java/org/keycloak/test/framework/server/KeycloakTestServer.java b/test-poc/framework/src/main/java/org/keycloak/test/framework/server/KeycloakTestServer.java
@@ -1,8 +1,11 @@
 package org.keycloak.test.framework.server;
 
+import org.keycloak.test.framework.database.DatabaseConfig;
+import org.keycloak.test.framework.database.TestDatabase;
+
 public interface KeycloakTestServer {
 
-    void start(KeycloakTestServerConfig serverConfig);
+    void start(KeycloakTestServerConfig serverConfig, DatabaseConfig databaseConfig);
 
     void stop();
 

diff --git a/.../framework/src/main/java/org/keycloak/test/framework/server/RemoteKeycloakTestServer.java b/.../framework/src/main/java/org/keycloak/test/framework/server/RemoteKeycloakTestServer.java
@@ -1,9 +1,12 @@
 package org.keycloak.test.framework.server;
 
+import org.keycloak.test.framework.database.DatabaseConfig;
+import org.keycloak.test.framework.database.TestDatabase;
+
 public class RemoteKeycloakTestServer implements KeycloakTestServer {
 
     @Override
-    public void start(KeycloakTestServerConfig serverConfig) {
+    public void start(KeycloakTestServerConfig serverConfig, DatabaseConfig databaseConfig) {
 
     }
 

diff --git a/...ework/src/main/resources/META-INF/services/org.keycloak.test.framework.injection.Supplier b/...ework/src/main/resources/META-INF/services/org.keycloak.test.framework.injection.Supplier
@@ -7,3 +7,4 @@ org.keycloak.test.framework.server.DistributionKeycloakTestServerSupplier
 org.keycloak.test.framework.server.RemoteKeycloakTestServerSupplier
 org.keycloak.test.framework.webdriver.ChromeWebDriverSupplier
 org.keycloak.test.framework.webdriver.FirefoxWebDriverSupplier
+org.keycloak.test.framework.database.DefaultDatabaseSupplier