io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension Maven / Gradle / Ivy
Show all versions of opentelemetry-testing-common Show documentation
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.instrumentation.testing.internal;
import java.util.ArrayList;
import java.util.List;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;
import org.junit.jupiter.api.extension.AfterEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
/**
* A small utility extension that allows deferring executing cleanup code in {@code @Test} methods
* until the test has finished. All cleanup callbacks added during the test will always be executed
* after it finishes, no matter the outcome. Inspired by Spock's {@code cleanup:} block.
*
* This class is internal and is hence not for public use. Its APIs are unstable and can change
* at any time.
*/
public final class AutoCleanupExtension implements AfterEachCallback {
private final Queue thingsToCleanUp = new ConcurrentLinkedQueue<>();
private AutoCleanupExtension() {}
public static AutoCleanupExtension create() {
return new AutoCleanupExtension();
}
/** Add a {@code cleanupAction} to execute after the test finishes. */
public void deferCleanup(AutoCloseable cleanupAction) {
thingsToCleanUp.add(cleanupAction);
}
@Override
public void afterEach(ExtensionContext extensionContext) throws Exception {
List exceptions = new ArrayList<>();
while (!thingsToCleanUp.isEmpty()) {
try {
thingsToCleanUp.poll().close();
} catch (Exception e) {
exceptions.add(e);
}
}
switch (exceptions.size()) {
case 0:
return;
case 1:
throw exceptions.get(0);
default:
AssertionError allFailures = new AssertionError("Multiple cleanup errors occurred");
exceptions.forEach(allFailures::addSuppressed);
throw allFailures;
}
}
}