Closes keycloak#30616. Added database suppliers.

Signed-off-by: Miquel Simon <[email protected]>

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;
+    }
+}

test-poc/framework/src/main/java/org/keycloak/test/framework/database/DatabaseSupplier.java

@@ -0,0 +1,37 @@
+package org.keycloak.test.framework.database;
+
+import org.keycloak.test.framework.injection.InstanceWrapper;
+import org.keycloak.test.framework.injection.LifeCycle;
+import org.keycloak.test.framework.injection.Registry;
+import org.keycloak.test.framework.injection.Supplier;
+
+import java.lang.annotation.Annotation;
+
+public abstract class DatabaseSupplier implements Supplier<TestDatabase, Annotation> {
+
+    protected static TestDatabase testDatabase = new TestDatabase(new DevMemDatabaseConfig());
+
+    @Override
+    public Class<Annotation> getAnnotationClass() {
+        return null;
+    }
+
+    @Override
+    public Class<TestDatabase> getValueType() {
+        return TestDatabase.class;
+    }
+
+    @Override
+    public InstanceWrapper<TestDatabase, Annotation> getValue(Registry registry, Annotation annotation) {
+        return new InstanceWrapper<>(this, annotation, testDatabase, LifeCycle.GLOBAL);
+    }
+
+    @Override
+    public boolean compatible(InstanceWrapper<TestDatabase, Annotation> a, InstanceWrapper<TestDatabase, Annotation> b) {
+        return true;
+    }
+
+    public TestDatabase getTestDatabase() {
+        return testDatabase;
+    }
+}

test-poc/framework/src/main/java/org/keycloak/test/framework/database/DevMemDatabaseConfig.java

@@ -0,0 +1,4 @@
+package org.keycloak.test.framework.database;
+
+public class DevMemDatabaseConfig implements DatabaseConfig {
+}

test-poc/framework/src/main/java/org/keycloak/test/framework/database/DevMemDatabaseSupplier.java

@@ -0,0 +1,4 @@
+package org.keycloak.test.framework.database;
+
+public class DevMemDatabaseSupplier extends DatabaseSupplier {
+}

test-poc/framework/src/main/java/org/keycloak/test/framework/database/ExternalDatabaseConfig.java

@@ -0,0 +1,8 @@
+package org.keycloak.test.framework.database;
+
+public class ExternalDatabaseConfig implements DatabaseConfig {
+    @Override
+    public boolean isExternal() {
+        return true;
+    }
+}

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;
+    }
+}

test-poc/framework/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.database.DatabaseSupplier;
+import org.keycloak.test.framework.database.DevMemDatabaseSupplier;
 import org.keycloak.test.framework.injection.InstanceWrapper;
 import org.keycloak.test.framework.injection.LifeCycle;
 import org.keycloak.test.framework.injection.Registry;
@@ -22,10 +24,11 @@ public Class<KeycloakIntegrationTest> getAnnotationClass() {
     @Override
     public InstanceWrapper<KeycloakTestServer, KeycloakIntegrationTest> getValue(Registry registry, KeycloakIntegrationTest annotation) {
         KeycloakTestServerConfig serverConfig = SupplierHelpers.getInstance(annotation.config());
+        DatabaseSupplier databaseSupplier = new DevMemDatabaseSupplier();
 
         KeycloakTestServer keycloakTestServer = getServer();
 
-        keycloakTestServer.start(serverConfig);
+        keycloakTestServer.start(serverConfig, databaseSupplier.getTestDatabase());
 
         return new InstanceWrapper<>(this, annotation, keycloakTestServer, LifeCycle.GLOBAL);
     }

test-poc/framework/src/main/java/org/keycloak/test/framework/server/DistributionKeycloakTestServer.java

@@ -1,9 +1,11 @@
 package org.keycloak.test.framework.server;
 
+import org.keycloak.test.framework.database.TestDatabase;
+
 public class DistributionKeycloakTestServer implements KeycloakTestServer {
 
     @Override
-    public void start(KeycloakTestServerConfig serverConfig) {
+    public void start(KeycloakTestServerConfig serverConfig, TestDatabase testDatabase) {
         throw new RuntimeException("Method not implemented!");
     }
 

test-poc/framework/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;
@@ -11,20 +13,34 @@ public class EmbeddedKeycloakTestServer implements KeycloakTestServer {
 
     private Keycloak keycloak;
 
+    private TestDatabase database;
+
     @Override
-    public void start(KeycloakTestServerConfig serverConfig) {
+    public void start(KeycloakTestServerConfig serverConfig, TestDatabase testDatabase) {
+        database = testDatabase;
         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()));
         }
 
+        DatabaseConfig databaseConfig = database.getDatabaseConfig();
+
+        //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());
+        } else {
+            testDatabase.start();
+        }
+
+
         serverConfig.options().forEach((key, value) -> rawOptions.add("--" + key + "=" + value));
 
         keycloak = Keycloak.builder()
@@ -36,6 +52,9 @@ public void start(KeycloakTestServerConfig serverConfig) {
     public void stop() {
         try {
             keycloak.stop();
+            if (!database.getDatabaseConfig().isExternal()) {
+                database.stop();
+            }
         } catch (TimeoutException e) {
             throw new RuntimeException(e);
         }

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, TestDatabase testDatabase);
 
     void stop();
 

test-poc/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, TestDatabase testDatabase) {
 
     }