mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2025-12-16 20:15:46 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add support to use kcw with remote test server

Browse Source 
Closes #44312

Signed-off-by: stianst <stianst@gmail.com>
This commit is contained in:
Stian Thorgersen
2025-11-19 20:43:42 +01:00
committed by GitHub
parent 2a876c143f
commit c089a3a6fe
3 changed files with 70 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
misc/scripts/kcw
View File

@@ -31,6 +31,10 @@ while [ "$1" != "" ]; do
echo " rel install latest release"
echo " rel[=version] install specific version"
echo ""
echo "Environment variables:"
echo " KCW_PROVIDERS comma separated list of providers to install"
echo " KCW_CONFIGS comma separated list of config files to install"
echo ""
echo "Examples:"
echo " Start existing install: kcw start-dev"
echo " Install nightly and start: kcw nightly start-dev --cluster=none"
@@ -125,6 +129,20 @@ if [ "$INSTALL" != "" ]; then
fi
fi
if [ "$KCW_PROVIDERS" != "" ]; then
for PROVIDER in $(echo "$KCW_PROVIDERS" | tr "," "\n"); do
cp "$PROVIDER" $KC_DIR/providers/
echo "Installed provider: $PROVIDER"
done
fi
if [ "$KCW_CONFIGS" != "" ]; then
for CONFIG in $(echo "$KCW_CONFIGS" | tr "," "\n"); do
cp "$CONFIG" $KC_DIR/conf/
echo "Installed config file: $CONFIG"
done
fi
if [ "$ARGS" != "" ]; then
echo ""
echo "-------------------------------------------------------------------------------------------"

7
test-framework/HOW_TO_RUN.md
View File

@@ -101,9 +101,10 @@ Valid values:
Configuration:
| Value | Description |
|---------------------------------------------------|------------------------------------------------------------------------|
| `kc.test.server.config` / `KC_TEST_SERVER_CONFIG` | The name of a KeycloakServerConfig class to use when running the tests |
| Value | Description |
|---------------------------------------------------|----------------------------------------------------------------------------------------|
| `kc.test.server.config` / `KC_TEST_SERVER_CONFIG` | The name of a KeycloakServerConfig class to use when running the tests |
| `kc.test.server.kcw` / `KC_TEST_SERVER_KCW` | Set to a kcw command to use kcw with remote server (see `kcw help` for valid commands) |
### Database

70
test-framework/core/src/main/java/org/keycloak/testframework/server/RemoteKeycloakServer.java
View File

@@ -5,19 +5,32 @@ import java.net.URL;
import java.nio.file.Path;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import javax.net.ssl.SSLException;
import org.keycloak.it.utils.Maven;
import org.keycloak.testframework.config.Config;
import io.quarkus.maven.dependency.Dependency;
import static java.lang.System.out;
public class RemoteKeycloakServer implements KeycloakServer {
private boolean enableTls = false;
private String kcwCommand;
@Override
public void start(KeycloakServerConfigBuilder keycloakServerConfigBuilder) {
enableTls = keycloakServerConfigBuilder.tlsEnabled();
kcwCommand = Config.getValueTypeConfig(KeycloakServer.class, "kcw", null, String.class);
if (!verifyRunningKeycloak()) {
printStartupInstructions(keycloakServerConfigBuilder);
if (kcwCommand != null) {
printStartupInstructionsKcw(keycloakServerConfigBuilder);
} else {
printStartupInstructionsManual(keycloakServerConfigBuilder);
}
waitForStartup();
}
}
@@ -49,36 +62,49 @@ public class RemoteKeycloakServer implements KeycloakServer {
return enableTls;
}
private void printStartupInstructions(KeycloakServerConfigBuilder keycloakServerConfigBuilder) {
StringBuilder sb = new StringBuilder();
private void printStartupInstructionsManual(KeycloakServerConfigBuilder config) {
out.println("Remote Keycloak server is not running on " + getBaseUrl() + ", please start Keycloak with:");
out.println();
out.println(String.join(" \\\n", config.toArgs()));
out.println();
sb.append("Remote Keycloak server is not running on ")
.append(getBaseUrl())
.append(", please start Keycloak with:\n\n");
sb.append(String.join(" \\\n", keycloakServerConfigBuilder.toArgs()));
sb.append("\n\n");
Set<Dependency> dependencies = keycloakServerConfigBuilder.toDependencies();
Set<Dependency> dependencies = config.toDependencies();
if (!dependencies.isEmpty()) {
sb.append("Requested providers:\n");
out.println("Requested providers:");
for (Dependency d : dependencies) {
sb.append("- ");
sb.append(d.getGroupId());
sb.append(":");
sb.append(d.getArtifactId());
sb.append("\n");
out.println("* " + d.getGroupId() + ":" + d.getArtifactId());
}
out.println();
}
Set<Path> configFiles = keycloakServerConfigBuilder.toConfigFiles();
Set<Path> configFiles = config.toConfigFiles();
if (!configFiles.isEmpty()) {
sb.append("Copy following config files to your conf directory:\n");
out.println("Config files:");
for (Path c : configFiles) {
sb.append(c.toAbsolutePath());
sb.append("\n");
out.print("* " + c.toAbsolutePath());
}
out.println();
}
System.out.println(sb);
}
private void printStartupInstructionsKcw(KeycloakServerConfigBuilder config) {
out.println("Remote Keycloak server is not running on " + getBaseUrl() + ", please start Keycloak with:");
out.println();
Set<Dependency> dependencies = config.toDependencies();
if (!dependencies.isEmpty()) {
String dependencyPaths = dependencies.stream().map(d -> Maven.resolveArtifact(d.getGroupId(), d.getArtifactId()).toString()).collect(Collectors.joining(","));
out.println("KCW_PROVIDERS=" + dependencyPaths + " \\");
}
Set<Path> configFiles = config.toConfigFiles();
if (!configFiles.isEmpty()) {
String configPaths = configFiles.stream().map(p -> p.toAbsolutePath().toString()).collect(Collectors.joining(","));
out.println("KCW_CONFIGS=" + configPaths + " \\");
}
out.println("kcw " + kcwCommand + " " + String.join(" \\\n", config.toArgs()));
out.println();
}
private boolean verifyRunningKeycloak() {