Skip to content

fix: removing KeycloakApplication usage of keycloak-add-user.json #39460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vmuzikar merged 2 commits into from
May 8, 2025
Merged

fix: removing KeycloakApplication usage of keycloak-add-user.json #39460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dab71a8
fix: removing KeycloakApplication usage of keycloak-add-user.json
shawkins May 5, 2025
4712e8a
Removing the test keycloak-add-user.json
shawkins May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 3 additions & 15 deletions services/src/main/java/org/keycloak/services/ServicesLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,26 +70,14 @@ public interface ServicesLogger extends BasicLogger {
@Message(id=5, value="Unable to import realm %s from %s.")
void unableToImportRealm(@Cause Throwable t, String realmName, String from);

@LogMessage(level = INFO)
@Message(id=6, value="Importing users from '%s'")
void imprtingUsersFrom(Object from);

@LogMessage(level = ERROR)
@Message(id=7, value="Failed to load 'keycloak-add-user.json'")
void failedToLoadUsers(@Cause Throwable t);

@LogMessage(level = ERROR)
@Message(id=8, value="Failed to add user %s to realm %s: realm not found")
void addUserFailedRealmNotFound(String user, String realm);

@LogMessage(level = INFO)
@Message(id=9, value="Added user '%s' to realm '%s'")
void addUserSuccess(String user, String realm);

@LogMessage(level = ERROR)
@Message(id=10, value="Failed to add user '%s' to realm '%s': user with username exists")
void addUserFailedUserExists(String user, String realm);

@LogMessage(level = ERROR)
@Message(id=11, value="Failed to add user '%s' to realm '%s'")
void addUserFailed(@Cause Throwable t, String user, String realm);
Expand Down Expand Up @@ -472,11 +460,11 @@ public interface ServicesLogger extends BasicLogger {
@LogMessage(level = WARN)
@Message(id=108, value="URI '%s' doesn't match any trustedHost or trustedDomain")
void uriDoesntMatch(String uri);

@LogMessage(level = ERROR)
@Message(id=109, value="Failed to add client '%s' to realm '%s': client with client ID exists")
void addClientFailedClientExists(String clientId, String realm);

@LogMessage(level = WARN)
@Message(id=110, value="Environment variable '%s' is deprecated, use '%s' instead")
void usingDeprecatedEnvironmentVariable(String deprecated, String supported);
Expand Down
68 changes: 0 additions & 68 deletions services/src/main/java/org/keycloak/services/resources/KeycloakApplication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,34 +25,18 @@
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;
import org.keycloak.models.KeycloakSessionTask;
import org.keycloak.models.ModelDuplicateException;
import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel;
import org.keycloak.models.UserProvider;
import org.keycloak.models.dblock.DBLockManager;
import org.keycloak.models.dblock.DBLockProvider;
import org.keycloak.models.utils.KeycloakModelUtils;
import org.keycloak.models.utils.PostMigrationEvent;
import org.keycloak.models.utils.RepresentationToModel;
import org.keycloak.platform.Platform;
import org.keycloak.platform.PlatformProvider;
import org.keycloak.representations.idm.RealmRepresentation;
import org.keycloak.representations.idm.UserRepresentation;
import org.keycloak.services.ServicesLogger;
import org.keycloak.services.managers.ApplianceBootstrap;
import org.keycloak.services.managers.RealmManager;
import org.keycloak.transaction.JtaTransactionManagerLookup;
import org.keycloak.util.JsonSerialization;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.ServiceLoader;

import com.fasterxml.jackson.core.type.TypeReference;

import jakarta.transaction.SystemException;
import jakarta.transaction.Transaction;
import jakarta.ws.rs.core.Application;
Expand Down Expand Up @@ -173,8 +157,6 @@ public void run(KeycloakSession session) {
bootstrapState.exportImportManager.runImport();
}

importAddUser();

return bootstrapState.exportImportManager;
}

Expand All @@ -200,54 +182,4 @@ public static KeycloakSessionFactory getSessionFactory() {
return sessionFactory;
}

public void importAddUser() {
String configDir = System.getProperty("jboss.server.config.dir");
if (configDir != null) {
File addUserFile = new File(configDir + File.separator + "keycloak-add-user.json");
if (addUserFile.isFile()) {
ServicesLogger.LOGGER.imprtingUsersFrom(addUserFile);

List<RealmRepresentation> realms;
try {
realms = JsonSerialization.readValue(new FileInputStream(addUserFile), new TypeReference<List<RealmRepresentation>>() {
});
} catch (IOException e) {
ServicesLogger.LOGGER.failedToLoadUsers(e);
return;
}

for (RealmRepresentation realmRep : realms) {
for (UserRepresentation userRep : realmRep.getUsers()) {
try {
KeycloakModelUtils.runJobInTransaction(sessionFactory, session -> {
RealmModel realm = session.realms().getRealmByName(realmRep.getRealm());

if (realm == null) {
ServicesLogger.LOGGER.addUserFailedRealmNotFound(userRep.getUsername(), realmRep.getRealm());
}
session.getContext().setRealm(realm);

UserProvider users = session.users();

if (users.getUserByUsername(realm, userRep.getUsername()) != null) {
ServicesLogger.LOGGER.notCreatingExistingUser(userRep.getUsername());
} else {
UserModel user = RepresentationToModel.createUser(session, realm, userRep);
ServicesLogger.LOGGER.addUserSuccess(userRep.getUsername(), realmRep.getRealm());
}
});
} catch (ModelDuplicateException e) {
ServicesLogger.LOGGER.addUserFailedUserExists(userRep.getUsername(), realmRep.getRealm());
} catch (Throwable t) {
ServicesLogger.LOGGER.addUserFailed(t, userRep.getUsername(), realmRep.getRealm());
}
}
}

if (!addUserFile.delete()) {
ServicesLogger.LOGGER.failedToDeleteFile(addUserFile.getAbsolutePath());
}
}
}
}
}
8 changes: 8 additions & 0 deletions test-framework/core/src/main/java/org/keycloak/testframework/config/Config.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ public static String getAdminClientSecret() {
return "mysecret";
}

public static String getAdminUsername() {
return "admin";
}

public static String getAdminPassword() {
return "admin";
}

public static SmallRyeConfig initConfig() {
SmallRyeConfigBuilder configBuilder = new SmallRyeConfigBuilder()
.addDefaultSources()
Expand Down
3 changes: 2 additions & 1 deletion .../core/src/main/java/org/keycloak/testframework/server/AbstractKeycloakServerSupplier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ public KeycloakServer getValue(InstanceContext<KeycloakServer, KeycloakIntegrati

KeycloakServerConfigBuilder command = KeycloakServerConfigBuilder.startDev()
.cache("local")
.bootstrapAdminClient(Config.getAdminClientId(), Config.getAdminClientSecret());
.bootstrapAdminClient(Config.getAdminClientId(), Config.getAdminClientSecret())
.bootstrapAdminUser(Config.getAdminUsername(), Config.getAdminPassword());

command.log().handlers(KeycloakServerConfigBuilder.LogHandlers.CONSOLE);

Expand Down
5 changes: 5 additions & 0 deletions ...ork/core/src/main/java/org/keycloak/testframework/server/KeycloakServerConfigBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ public KeycloakServerConfigBuilder bootstrapAdminClient(String clientId, String
.option("bootstrap-admin-client-secret", clientSecret);
}

public KeycloakServerConfigBuilder bootstrapAdminUser(String username, String password) {
return option("bootstrap-admin-username", username)
.option("bootstrap-admin-password", password);
}

public KeycloakServerConfigBuilder cache(String cache) {
return option("cache", cache);
}
Expand Down
5 changes: 5 additions & 0 deletions tests/base/src/test/java/org/keycloak/tests/welcomepage/WelcomePageTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ public class WelcomePageTest {
@Test
@Order(1)
public void localAccessNoAdmin() {
// get rid of the bootstrap admin added for db compatibility with the older test framework
// it will get added by in subsequent tests
var users = adminClient.realms().realm("master").users();
users.searchByUsername("admin", true).stream().findFirst().ifPresent(admin -> users.delete(admin.getId()));

welcomePage.navigateTo();

Assertions.assertEquals("Create a temporary administrative user", welcomePage.getWelcomeMessage());
Expand Down
20 changes: 0 additions & 20 deletions testsuite/integration-arquillian/tests/base/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,26 +316,6 @@
</resources>
</configuration>
</execution>
<execution>
<id>copy-admin-user-json-file</id>
<phase>process-resources</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<skip>${skip.add.user.json}</skip>
<outputDirectory>${auth.server.config.dir}</outputDirectory>
<resources>
<resource>
<directory>src/test/resources</directory>
<includes>
<include>keycloak-add-user.json</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>

Expand Down
20 changes: 15 additions & 5 deletions ...java/org/keycloak/testsuite/arquillian/containers/AbstractQuarkusDeployableContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
import org.keycloak.common.crypto.FipsMode;
import org.keycloak.testsuite.ProfileAssume;
import org.keycloak.testsuite.arquillian.SuiteContext;
import org.keycloak.testsuite.auth.page.AuthRealm;
import org.keycloak.testsuite.model.StoreProvider;
import org.keycloak.utils.StringUtil;

Expand Down Expand Up @@ -167,7 +168,7 @@ protected List<String> getArgs(Map<String, String> env) {

commands.add("--http-port=" + configuration.getBindHttpPort());
commands.add("--https-port=" + configuration.getBindHttpsPort());

commands.add("--http-relative-path=/auth");
commands.add("--health-enabled=true"); // expose something to management interface to turn it on

Expand Down Expand Up @@ -209,8 +210,9 @@ protected List<String> getArgs(Map<String, String> env) {
commands.add("--cache-config-file=cluster-" + cacheMode + ".xml");

var stack = System.getProperty("auth.server.quarkus.cluster.stack");
if (stack != null)
if (stack != null) {
commands.add("--cache-stack=" + stack);
}
}

log.debugf("FIPS Mode: %s", configuration.getFipsMode());
Expand All @@ -221,7 +223,7 @@ protected List<String> getArgs(Map<String, String> env) {

addStorageOptions(storeProvider, commands);
addFeaturesOption(commands);

spis.values().forEach(commands::addAll);

var features = getDefaultFeatures();
Expand All @@ -235,13 +237,18 @@ protected List<String> getArgs(Map<String, String> env) {
System.setProperty("kc.cache-remote-create-caches", "true");
}

if (!suiteContext.get().isAuthServerMigrationEnabled()) {
commands.add("--bootstrap-admin-username=" + AuthRealm.ADMIN);
commands.add("--bootstrap-admin-password=" + AuthRealm.ADMIN);
}

return commands;
}

protected void addFeaturesOption(List<String> commands) {
String enabledFeatures = Optional.ofNullable(configuration.getEnabledFeatures()).orElse("");
String disabledFeatures = Optional.ofNullable(configuration.getDisabledFeatures()).orElse("");

var disabled = ProfileAssume.getDisabledFeatures();
// TODO: this is not ideal, we're trying to infer what should be enabled / disabled from what was captured
// as the disabled features. This at least does not understand the profile and may not age well.
Expand Down Expand Up @@ -386,12 +393,15 @@ private HostnameVerifier createInsecureHostnameVerifier() {

private SSLSocketFactory createInsecureSslSocketFactory() throws IOException {
TrustManager[] trustAllCerts = new TrustManager[]{new X509TrustManager() {
@Override
public void checkClientTrusted(final X509Certificate[] chain, final String authType) {
}

@Override
public void checkServerTrusted(final X509Certificate[] chain, final String authType) {
}

@Override
public X509Certificate[] getAcceptedIssuers() {
return null;
}
Expand Down Expand Up @@ -456,7 +466,7 @@ private Collection<String> getDefaultFeatures() {
public void setSpiConfig(String spi, List<String> args) {
this.spis.put(spi, args);
}

public void removeSpiConfig(String spi) {
this.spis.remove(spi);
}
Expand Down
11 changes: 5 additions & 6 deletions ...rg/keycloak/testsuite/arquillian/containers/KeycloakQuarkusServerDeployableContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ private void importRealm() throws IOException, URISyntaxException {
log.infof("Importing realm from file '%s'", importFileName);

final URL url = getClass().getResource("/migration-test/" + importFileName);
if (url == null) throw new IllegalArgumentException("Cannot find migration import file");
if (url == null) {
throw new IllegalArgumentException("Cannot find migration import file");
}

final Path path = Paths.get(url.toURI());
final File wrkDir = configuration.getProvidersPath().resolve("bin").toFile();
Expand Down Expand Up @@ -166,11 +168,6 @@ private Process startContainer() throws IOException {
builder.environment().put("JAVA_OPTS", javaOpts);
}

if (!StoreProvider.JPA.equals(StoreProvider.getCurrentProvider())) {
builder.environment().put("KC_BOOTSTRAP_ADMIN_USERNAME", "admin");
builder.environment().put("KC_BOOTSTRAP_ADMIN_PASSWORD", "admin");
}

if (restart.compareAndSet(false, true)) {
deleteDirectory(configuration.getProvidersPath().resolve("data"));
}
Expand Down Expand Up @@ -245,6 +242,7 @@ private void destroyDescendantsOnWindows(Process parent, boolean force) {
public static void deleteDirectory(final Path directory) throws IOException {
if (Files.isDirectory(directory, new LinkOption[0])) {
Files.walkFileTree(directory, new SimpleFileVisitor<Path>() {
@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
try {
Files.delete(file);
Expand All @@ -254,6 +252,7 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO
return FileVisitResult.CONTINUE;
}

@Override
public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
try {
Files.delete(dir);
Expand Down
13 changes: 0 additions & 13 deletions testsuite/integration-arquillian/tests/base/src/test/resources/keycloak-add-user.json
View file
Open in desktop

This file was deleted.

27 changes: 1 addition & 26 deletions testsuite/integration-arquillian/tests/other/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,38 +59,13 @@
<artifactId>integration-arquillian-tests-base</artifactId>
<version>${project.version}</version>
<classifier>tests</classifier>
<includes>arquillian.xml,wildfly-config.xml,keycloak-add-user.json,test-constants.properties,kerberos/*,keystore/*,password-blacklists/*,log4j.properties,vault/*</includes>
<includes>arquillian.xml,wildfly-config.xml,test-constants.properties,kerberos/*,keystore/*,password-blacklists/*,log4j.properties,vault/*</includes>
</artifactItem>
</artifactItems>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>copy-admin-user-json-file</id>
<phase>process-test-resources</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<skip>${skip.add.user.json}</skip>
<outputDirectory>${auth.server.config.dir}</outputDirectory>
<resources>
<resource>
<directory>${project.build.directory}/dependency</directory>
<includes>
<include>keycloak-add-user.json</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</pluginManagement>
</build>
Expand Down
Loading
Loading