libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases Packages Activity Actions

Supply databases with Testcontainers. (#31321)

Browse source 
Signed-off-by: Miquel Simon <msimonma@redhat.com>
This commit is contained in:
Miquel Simon 2024-07-17 14:58:04 +02:00 committed by GitHub
parent e5848bdcf9
commit def6ea3620
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 170 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
test-poc/base/pom.xml
View file

@ -48,6 +48,11 @@
<groupId>org.jboss.logmanager</groupId>
<artifactId>jboss-logmanager</artifactId>
</dependency>
<!-- JDBC Drivers -->
<dependency>
<groupId>com.microsoft.sqlserver</groupId>
<artifactId>mssql-jdbc</artifactId>
</dependency>
</dependencies>
<build>

1
test-poc/base/src/test/resources/container-license-acceptance.txt Normal file
View file

@ -0,0 +1 @@
mcr.microsoft.com/mssql/server:latest

21
test-poc/framework/pom.xml
View file

@ -66,6 +66,25 @@
<version>${selenium.version}</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>junit-jupiter</artifactId>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>postgresql</artifactId>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>mariadb</artifactId>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>mysql</artifactId>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>mssqlserver</artifactId>
</dependency>
</dependencies>
</project>

5
test-poc/framework/src/main/java/org/junit/rules/TestRule.java Normal file
View file

@ -0,0 +1,5 @@
package org.junit.rules;
@SuppressWarnings("unused")
public interface TestRule {
}

5
test-poc/framework/src/main/java/org/junit/runners/model/Statement.java Normal file
View file

@ -0,0 +1,5 @@
package org.junit.runners.model;
@SuppressWarnings("unused")
public class Statement {
}

3
test-poc/framework/src/main/java/org/keycloak/test/framework/database/AbstractDatabaseSupplier.java
View file

@ -9,6 +9,9 @@ import org.keycloak.test.framework.injection.Supplier;
public abstract class AbstractDatabaseSupplier implements Supplier<TestDatabase, KeycloakTestDatabase> {
protected static final String DEFAULT_DB_USERNAME = "keycloak";
protected static final String DEFAULT_DB_PASSWORD = "Password1!";
@Override
public Class<KeycloakTestDatabase> getAnnotationClass() {
return KeycloakTestDatabase.class;

14
test-poc/framework/src/main/java/org/keycloak/test/framework/database/DatabaseConfig.java
View file

@ -7,7 +7,7 @@ public class DatabaseConfig {
private String vendor;
private String containerImage;
private String urlHost;
private String url;
private String username;
private String password;
@ -29,12 +29,12 @@ public class DatabaseConfig {
return this;
}
public String getUrlHost() {
return urlHost;
public String getUrl() {
return url;
}
public DatabaseConfig urlHost(String urlHost) {
this.urlHost = urlHost;
public DatabaseConfig url(String url) {
this.url = url;
return this;
}
@ -61,8 +61,8 @@ public class DatabaseConfig {
if (vendor != null) {
config.put("db", vendor);
}
if (urlHost != null) {
config.put("db-url-host", urlHost);
if (url != null) {
config.put("db-url", url);
}
if (username != null) {
config.put("db-username", username);

18
test-poc/framework/src/main/java/org/keycloak/test/framework/database/MSSQLServerDatabaseSupplier.java Normal file
View file

@ -0,0 +1,18 @@
package org.keycloak.test.framework.database;
public class MSSQLServerDatabaseSupplier extends AbstractDatabaseSupplier {
public static final String VENDOR = "mssql";
@Override
TestDatabase getTestDatabase() {
DatabaseConfig databaseConfig = new DatabaseConfig()
.vendor(VENDOR)
.containerImage("mcr.microsoft.com/mssql/server:latest");
return new TestDatabase(databaseConfig);
}
@Override
public String getAlias() {
return VENDOR;
}
}

20
test-poc/framework/src/main/java/org/keycloak/test/framework/database/MariaDBDatabaseSupplier.java Normal file
View file

@ -0,0 +1,20 @@
package org.keycloak.test.framework.database;
public class MariaDBDatabaseSupplier extends AbstractDatabaseSupplier {
public static final String VENDOR = "mariadb";
@Override
TestDatabase getTestDatabase() {
DatabaseConfig databaseConfig = new DatabaseConfig()
.vendor(VENDOR)
.username(DEFAULT_DB_USERNAME)
.password(DEFAULT_DB_PASSWORD)
.containerImage("mariadb:latest");
return new TestDatabase(databaseConfig);
}
@Override
public String getAlias() {
return VENDOR;
}
}

21
test-poc/framework/src/main/java/org/keycloak/test/framework/database/MySQLDatabaseSupplier.java Normal file
View file

@ -0,0 +1,21 @@
package org.keycloak.test.framework.database;
public class MySQLDatabaseSupplier extends AbstractDatabaseSupplier {
public static final String VENDOR = "mysql";
@Override
TestDatabase getTestDatabase() {
DatabaseConfig databaseConfig = new DatabaseConfig()
.vendor(VENDOR)
.username(DEFAULT_DB_USERNAME)
.password(DEFAULT_DB_PASSWORD)
.containerImage("mysql:latest");
return new TestDatabase(databaseConfig);
}
@Override
public String getAlias() {
return VENDOR;
}
}

6
test-poc/framework/src/main/java/org/keycloak/test/framework/database/PostgresDatabaseSupplier.java
View file

@ -8,9 +8,9 @@ public class PostgresDatabaseSupplier extends AbstractDatabaseSupplier {
TestDatabase getTestDatabase() {
DatabaseConfig databaseConfig = new DatabaseConfig()
.vendor(VENDOR)
.username("keycloak")
.password("keycloak")
.containerImage("the-postgres-container:the-version");
.username(DEFAULT_DB_USERNAME)
.password(DEFAULT_DB_PASSWORD)
.containerImage("postgres:latest");
return new TestDatabase(databaseConfig);
}

63
test-poc/framework/src/main/java/org/keycloak/test/framework/database/TestDatabase.java
View file

@ -1,10 +1,21 @@
package org.keycloak.test.framework.database;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.containers.JdbcDatabaseContainer;
import org.testcontainers.containers.MSSQLServerContainer;
import org.testcontainers.containers.MariaDBContainer;
import org.testcontainers.containers.MySQLContainer;
import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.utility.DockerImageName;
import java.time.Duration;
import java.util.Map;
public class TestDatabase {
private DatabaseConfig databaseConfig;
private final DatabaseConfig databaseConfig;
private GenericContainer<?> container;
public TestDatabase(DatabaseConfig databaseConfig) {
this.databaseConfig = databaseConfig;
@ -12,14 +23,21 @@ public class TestDatabase {
public void start() {
if (databaseConfig.getContainerImage() != null) {
// TODO Start container
container = createContainer();
container.withStartupTimeout(Duration.ofMinutes(5)).start();
databaseConfig.url(getJdbcUrl());
if (container instanceof MSSQLServerContainer) {
databaseConfig.username(((JdbcDatabaseContainer<?>) container).getUsername());
databaseConfig.password(((JdbcDatabaseContainer<?>) container).getPassword());
}
}
}
public void stop() {
if (databaseConfig.getContainerImage() != null) {
// TODO Stop container
} else if (databaseConfig.getVendor().equals("dev-mem")) {
container.stop();
container = null;
} else if ("dev-mem".equals(databaseConfig.getVendor())) {
// TODO Stop in-mem H2 database
}
}
@ -28,4 +46,41 @@ public class TestDatabase {
return databaseConfig.toConfig();
}
public String getJdbcUrl() {
return ((JdbcDatabaseContainer<?>)container).getJdbcUrl();
}
private JdbcDatabaseContainer<?> configureJdbcContainer(JdbcDatabaseContainer<?> jdbcDatabaseContainer) {
if (jdbcDatabaseContainer instanceof MSSQLServerContainer) {
return jdbcDatabaseContainer;
}
return jdbcDatabaseContainer
.withDatabaseName("keycloak")
.withUsername(databaseConfig.getUsername())
.withPassword(databaseConfig.getPassword());
}
private GenericContainer<?> createContainer() {
return switch (databaseConfig.getVendor()) {
case PostgresDatabaseSupplier.VENDOR -> {
DockerImageName POSTGRES = DockerImageName.parse(databaseConfig.getContainerImage()).asCompatibleSubstituteFor("postgres");
yield configureJdbcContainer(new PostgreSQLContainer<>(POSTGRES));
}
case MariaDBDatabaseSupplier.VENDOR -> {
DockerImageName MARIADB = DockerImageName.parse(databaseConfig.getContainerImage()).asCompatibleSubstituteFor("mariadb");
yield configureJdbcContainer(new MariaDBContainer<>(MARIADB));
}
case MySQLDatabaseSupplier.VENDOR -> {
DockerImageName MYSQL = DockerImageName.parse(databaseConfig.getContainerImage()).asCompatibleSubstituteFor("mysql");
yield configureJdbcContainer(new MySQLContainer<>(MYSQL));
}
case MSSQLServerDatabaseSupplier.VENDOR -> {
DockerImageName MSSQL = DockerImageName.parse(databaseConfig.getContainerImage()).asCompatibleSubstituteFor("sqlserver");
yield configureJdbcContainer(new MSSQLServerContainer<>(MSSQL));
}
default -> throw new RuntimeException("Unsupported database: " + databaseConfig.getVendor());
};
}
}

3
test-poc/framework/src/main/resources/META-INF/services/org.keycloak.test.framework.injection.Supplier
View file

@ -9,5 +9,8 @@ org.keycloak.test.framework.webdriver.ChromeWebDriverSupplier
org.keycloak.test.framework.webdriver.FirefoxWebDriverSupplier
org.keycloak.test.framework.database.DevMemDatabaseSupplier
org.keycloak.test.framework.database.DevFileDatabaseSupplier
org.keycloak.test.framework.database.MySQLDatabaseSupplier
org.keycloak.test.framework.database.PostgresDatabaseSupplier
org.keycloak.test.framework.database.MariaDBDatabaseSupplier
org.keycloak.test.framework.database.MSSQLServerDatabaseSupplier
org.keycloak.test.framework.page.PageSupplier