8000 Test update-compatibility without building or starting Quarkus to save little time by michalvavrik · Pull Request #48662 · keycloak/keycloak · GitHub
[go: up one dir, main page]
Skip to content

Test update-compatibility without building or starting Quarkus to save little time #48662

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 1 commit into from
May 7, 2026
Merged

Test update-compatibility without building or starting Quarkus to save little time #48662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
81 changes: 81 additions & 0 deletions quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/cli/NonRunningPicocli.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
package org.keycloak.quarkus.runtime.cli;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Properties;

import org.keycloak.quarkus.runtime.Environment;
import org.keycloak.quarkus.runtime.KeycloakMain;
import org.keycloak.quarkus.runtime.cli.command.AbstractCommand;
import org.keycloak.quarkus.runtime.configuration.Configuration;
import org.keycloak.quarkus.runtime.configuration.PersistedConfigSource;

import io.smallrye.config.SmallRyeConfig;

// TODO: could utilize CLIResult
class NonRunningPicocli extends Picocli {

final StringWriter err = new StringWriter();
final StringWriter out = new StringWriter();
SmallRyeConfig config;
int exitCode = Integer.MAX_VALUE;
boolean reaug;
private Properties buildProps;

String getErrString() {
return normalize(err);
}

private String normalize(StringWriter writer) {
return System.lineSeparator().equals("\n") ? writer.toString()
: writer.toString().replace(System.lineSeparator(), "\n");
}

String getOutString() {
return normalize(out);
}

@Override
public PrintWriter getErrWriter() {
return new PrintWriter(err, true);
}

@Override
public PrintWriter getOutWriter() {
return new PrintWriter(out, true);
}

@Override
public void exit(int exitCode) {
this.exitCode = exitCode;
}

@Override
public void start() {
}

@Override
public void initConfig(AbstractCommand command) {
boolean checkBuild = Environment.isRebuildCheck();
super.initConfig(command);
if (!checkBuild && PersistedConfigSource.getInstance().getConfigValueProperties().isEmpty()) {
System.getProperties().remove(Environment.KC_CONFIG_REBUILD_CHECK);
}
config = Configuration.getConfig();
}

@Override
public void build() throws Throwable {
reaug = true;
this.buildProps = getNonPersistedBuildTimeOptions();
}

Properties getBuildProps() {
return buildProps;
}

NonRunningPicocli launch(String... args) {
KeycloakMain.main(args, this);
return this;
}
}
92 changes: 4 additions & 88 deletions quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/cli/PicocliTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,10 @@
package org.keycloak.quarkus.runtime.cli;

import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Map;
import java.util.Properties;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Stream;
Expand All @@ -35,12 +32,9 @@
import org.keycloak.quarkus.runtime.Environment;
import org.keycloak.quarkus.runtime.KeycloakMain;
import org.keycloak.quarkus.runtime.cli.command.AbstractAutoBuildCommand;
import org.keycloak.quarkus.runtime.cli.command.AbstractCommand;
import org.keycloak.quarkus.runtime.configuration.AbstractConfigurationTest;
import org.keycloak.quarkus.runtime.configuration.Configuration;
import org.keycloak.quarkus.runtime.configuration.PersistedConfigSource;

import io.smallrye.config.SmallRyeConfig;
import org.apache.commons.io.FileUtils;
import org.junit.Ignore;
import org.junit.Test;
Expand All @@ -61,73 +55,8 @@

public class PicocliTest extends AbstractConfigurationTest {

// TODO: could utilize CLIResult
private class NonRunningPicocli extends Picocli {

final StringWriter err = new StringWriter();
final StringWriter out = new StringWriter();
SmallRyeConfig config;
int exitCode = Integer.MAX_VALUE;
boolean reaug;
private Properties buildProps;

String getErrString() {
return normalize(err);
}

// normalize line endings - TODO: could also normalize non-printable chars
// but for now those are part of the expected output
String normalize(StringWriter writer) {
return System.lineSeparator().equals("\n") ? writer.toString()
: writer.toString().replace(System.lineSeparator(), "\n");
}

String getOutString() {
return normalize(out);
}

@Override
public PrintWriter getErrWriter() {
return new PrintWriter(err, true);
}

@Override
public PrintWriter getOutWriter() {
return new PrintWriter(out, true);
}

@Override
public void exit(int exitCode) {
this.exitCode = exitCode;
}

@Override
public void start() {
// skip
}

@Override
public void initConfig(AbstractCommand command) {
boolean checkBuild = Environment.isRebuildCheck();
super.initConfig(command);
if (!checkBuild && PersistedConfigSource.getInstance().getConfigValueProperties().isEmpty()) {
System.getProperties().remove(Environment.KC_CONFIG_REBUILD_CHECK);
}
config = Configuration.getConfig();
}

@Override
public void build() throws Throwable {
reaug = true;
this.buildProps = getNonPersistedBuildTimeOptions();
}

};

NonRunningPicocli pseudoLaunch(String... args) {
NonRunningPicocli nonRunningPicocli = new NonRunningPicocli();
KeycloakMain.main(args, nonRunningPicocli);
return nonRunningPicocli;
return new NonRunningPicocli().launch(args);
}

private void assertError(NonRunningPicocli picocli, String message) {
Expand Down Expand Up @@ -401,7 +330,7 @@ public void testReaugFromProdToDev() {
NonRunningPicocli nonRunningPicocli = pseudoLaunch("start-dev", "--hostname=name", "--http-enabled=true");
assertEquals(AbstractAutoBuildCommand.REBUILT_EXIT_CODE, nonRunningPicocli.exitCode);
assertTrue(nonRunningPicocli.reaug);
assertEquals("dev", nonRunningPicocli.buildProps.getProperty(org.keycloak.common.util.Environment.PROFILE));
assertEquals("dev", nonRunningPicocli.getBuildProps().getProperty(org.keycloak.common.util.Environment.PROFILE));
}

/**
Expand All @@ -426,7 +355,7 @@ private NonRunningPicocli build(Consumer<String> outChecker, String... args) {
assertEquals(nonRunningPicocli.getErrString(), code, nonRunningPicocli.exitCode);
outChecker.accept(nonRunningPicocli.getOutString());
onAfter();
addPersistedConfigValues((Map)nonRunningPicocli.buildProps);
addPersistedConfigValues((Map)nonRunningPicocli.getBuildProps());
return nonRunningPicocli;
}

Expand Down Expand Up @@ -482,7 +411,7 @@ public void testReaugFromDevToProdExport() {
NonRunningPicocli nonRunningPicocli = pseudoLaunch("export", "--db=dev-file", "--file=file");
assertEquals(AbstractAutoBuildCommand.REBUILT_EXIT_CODE, nonRunningPicocli.exitCode);
assertTrue(nonRunningPicocli.reaug);
assertEquals("prod", nonRunningPicocli.buildProps.getProperty(org.keycloak.common.util.Environment.PROFILE));
assertEquals("prod", nonRunningPicocli.getBuildProps().getProperty(org.keycloak.common.util.Environment.PROFILE));
}

@Test
Expand Down Expand Up @@ -945,13 +874,6 @@ public void datasourcesNotAllowedChar(){
assertThat(nonRunningPicocli.getErrString(), containsString("Unknown option: '--db-kind-<default>'"));
}

@Test
public void updateCommandValidation(){
NonRunningPicocli nonRunningPicocli = pseudoLaunch("update-compatibility","check");
assertEquals(CommandLine.ExitCode.USAGE, nonRunningPicocli.exitCode);
assertThat(nonRunningPicocli.getErrString(), containsString("Missing required argument: --file"));
}

@Test
public void testNoKcDirWarning() {
putEnvVar("KC_DIR", "dir");
Expand All @@ -960,12 +882,6 @@ public void testNoKcDirWarning() {
assertFalse(picocli.getOutString(), picocli.getOutString().contains("kc.dir"));
}

@Test
public void testUpdatesFileValidation() {
NonRunningPicocli picocli = pseudoLaunch("update-compatibility","check", "--file=not-found");
assertTrue(picocli.getErrString().contains("Incorrect argument --file."));
}

@Test
public void errorSpiBuildtimeChanged() {
putEnvVar("KC_SPI_EVENTS_LISTENER__PROVIDER", "jboss-logging");
Expand Down
Loading
Loading
0