Skip to content
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.

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

QuarkusTestProfile overrides in a high ordinal application.properties #41957

Merged
merged 1 commit into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import static io.quarkus.test.common.PathTestHelper.getAppClassLocationForTestLocation;
import static io.quarkus.test.common.PathTestHelper.getTestClassesLocation;

import java.io.FileOutputStream;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.nio.file.Files;
Expand All @@ -15,6 +16,7 @@
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.Properties;
import java.util.function.Consumer;
import java.util.stream.Collectors;

Expand All @@ -40,7 +42,6 @@
import io.quarkus.runtime.LaunchMode;
import io.quarkus.test.common.PathTestHelper;
import io.quarkus.test.common.QuarkusTestResource;
import io.quarkus.test.common.RestorableSystemProperties;
import io.quarkus.test.common.TestClassIndexer;
import io.quarkus.test.common.WithTestResource;

Expand Down Expand Up @@ -147,31 +148,59 @@ protected PrepareResult createAugmentor(ExtensionContext context, Class<? extend

// clear the test.url system property as the value leaks into the run when using different profiles
System.clearProperty("test.url");
Map<String, String> additional = new HashMap<>();

QuarkusTestProfile profileInstance = null;
if (profile != null) {
profileInstance = profile.getConstructor().newInstance();
additional.putAll(profileInstance.getConfigOverrides());

Map<String, String> overrides = new HashMap<>(profileInstance.getConfigOverrides());
if (!profileInstance.getEnabledAlternatives().isEmpty()) {
additional.put("quarkus.arc.selected-alternatives", profileInstance.getEnabledAlternatives().stream()
.peek((c) -> {
if (!c.isAnnotationPresent(Alternative.class)) {
throw new RuntimeException(
"Enabled alternative " + c + " is not annotated with @Alternative");
}
})
.map(Class::getName).collect(Collectors.joining(",")));
overrides.put("quarkus.arc.selected-alternatives",
profileInstance.getEnabledAlternatives()
.stream()
.peek((c) -> {
if (!c.isAnnotationPresent(Alternative.class)) {
throw new RuntimeException(
"Enabled alternative " + c + " is not annotated with " +
"@Alternative");
}
})
.map(Class::getName)
.collect(Collectors.joining(",")));
}
if (profileInstance.disableApplicationLifecycleObservers()) {
additional.put("quarkus.arc.test.disable-application-lifecycle-observers", "true");
overrides.put("quarkus.arc.test.disable-application-lifecycle-observers", "true");
}
if (profileInstance.getConfigProfile() != null) {
additional.put(LaunchMode.TEST.getProfileKey(), profileInstance.getConfigProfile());
overrides.put(LaunchMode.TEST.getProfileKey(), profileInstance.getConfigProfile());
}

// Creates a temporary application.properties file for the test with a high ordinal (build and runtime)
Path tempDirectory = Files.createTempDirectory(testClassLocation, requiredTestClass.getSimpleName());
Path propertiesFile = tempDirectory.resolve("application.properties");
Files.createFile(propertiesFile);
Properties properties = new Properties();
// TODO - radcortez - This should be higher that system properties, but configuration like ports is being
// passed around using system properties, meaning that it cannot be overridden. We cannot use system
// properties to carry that information. See io.quarkus.vertx.http.runtime.PortSystemProperties
properties.put("config_ordinal", "399");
properties.putAll(overrides);
try (FileOutputStream outputStream = new FileOutputStream(propertiesFile.toFile())) {
properties.store(outputStream, "");
}
//we just use system properties for now
//it's a lot simpler
shutdownTasks.add(RestorableSystemProperties.setProperties(additional)::close);
addToBuilderIfConditionMet.accept(tempDirectory);

shutdownTasks.add(new Runnable() {
@Override
public void run() {
try {
Files.deleteIfExists(propertiesFile);
Files.deleteIfExists(tempDirectory);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
});
}

CuratedApplication curatedApplication;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,8 @@ private void ensurePrepared(ExtensionContext extensionContext, Class<? extends Q
prepareResult = null;
}
if (prepareResult == null) {
final LinkedBlockingDeque<Runnable> shutdownTasks = new LinkedBlockingDeque<>();
PrepareResult result = createAugmentor(extensionContext, profile, shutdownTasks);
prepareResult = result;
LinkedBlockingDeque<Runnable> shutdownTasks = new LinkedBlockingDeque<>();
prepareResult = createAugmentor(extensionContext, profile, shutdownTasks);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,12 +205,12 @@ public Thread newThread(Runnable r) {
}
hangTimeout = new DurationConverter().convert(time);
hangTaskKey = hangDetectionExecutor.schedule(hangDetectionTask, hangTimeout.toMillis(), TimeUnit.MILLISECONDS);

quarkusTestProfile = profile;

LinkedBlockingDeque<Runnable> shutdownTasks = new LinkedBlockingDeque<>();
Class<?> requiredTestClass = context.getRequiredTestClass();
Closeable testResourceManager = null;
try {
final LinkedBlockingDeque<Runnable> shutdownTasks = new LinkedBlockingDeque<>();
PrepareResult result = createAugmentor(context, profile, shutdownTasks);
AugmentAction augmentAction = result.augmentAction;
QuarkusTestProfile profileInstance = result.profileInstance;
Expand Down Expand Up @@ -298,8 +298,7 @@ public void close() throws IOException {
}
}
};
ExtensionState state = new ExtensionState(testResourceManager, shutdownTask);
return state;
return new ExtensionState(testResourceManager, shutdownTask);
} catch (Throwable e) {
if (!InitialConfigurator.DELAYED_HANDLER.isActivated()) {
activateLogging();
Expand All @@ -315,6 +314,16 @@ public void close() throws IOException {
effectiveException.addSuppressed(determineEffectiveException(ex));
}

while (!shutdownTasks.isEmpty()) {
shutdownTasks.pop().run();
}

try {
TestClassIndexer.removeIndex(requiredTestClass);
} catch (Exception ignored) {

}

throw effectiveException;
} finally {
if (originalCl != null) {
Expand Down
Loading