LeakPresenceExtension Class — netty Architecture

Source Code

testsuite-common/src/main/java/io/netty/util/test/LeakPresenceExtension.java lines 45–133

public final class LeakPresenceExtension
        implements BeforeAllCallback, BeforeEachCallback, AfterEachCallback, AfterAllCallback {

    private static final Object SCOPE_KEY = new Object();
    private static final Object PREVIOUS_SCOPE_KEY = new Object();

    static {
        System.setProperty("io.netty.customResourceLeakDetector", WithTransferableScope.class.getName());
    }

    @Override
    public void beforeAll(ExtensionContext context) {
        ExtensionContext.Store store = context.getStore(ExtensionContext.Namespace.GLOBAL);
        if (store.get(SCOPE_KEY) != null) {
            throw new IllegalStateException("Weird context lifecycle");
        }
        LeakPresenceDetector.ResourceScope scope = new LeakPresenceDetector.ResourceScope(context.getDisplayName());
        store.put(SCOPE_KEY, scope);

        WithTransferableScope.SCOPE.set(scope);
    }

    @Override
    public void beforeEach(ExtensionContext context) {
        LeakPresenceDetector.ResourceScope outerScope;
        ExtensionContext outerContext = context;
        while (true) {
            outerScope = (LeakPresenceDetector.ResourceScope)
                    outerContext.getStore(ExtensionContext.Namespace.GLOBAL).get(SCOPE_KEY);
            if (outerScope != null) {
                break;
            }
            outerContext = outerContext.getParent()
                    .orElseThrow(() -> new IllegalStateException("No resource scope found"));
        }

        LeakPresenceDetector.ResourceScope previousScope = WithTransferableScope.SCOPE.get();
        WithTransferableScope.SCOPE.set(outerScope);
        if (previousScope != null) {
            context.getStore(ExtensionContext.Namespace.GLOBAL).put(PREVIOUS_SCOPE_KEY, previousScope);
        }
    }

    @Override
    public void afterEach(ExtensionContext context) {
        LeakPresenceDetector.ResourceScope previousScope = (LeakPresenceDetector.ResourceScope)
                context.getStore(ExtensionContext.Namespace.GLOBAL).get(PREVIOUS_SCOPE_KEY);
        if (previousScope != null) {
            WithTransferableScope.SCOPE.set(previousScope);
        }
    }

    @Override
    public void afterAll(ExtensionContext context) throws InterruptedException {
        LeakPresenceDetector.ResourceScope scope =
                (LeakPresenceDetector.ResourceScope) context.getStore(ExtensionContext.Namespace.GLOBAL).get(SCOPE_KEY);

        // Wait some time for resources to close. Many tests do loop.shutdownGracefully without waiting, and that's ok.
        long start = System.nanoTime();
        while (scope.hasOpenResources() && System.nanoTime() - start < TimeUnit.SECONDS.toNanos(5)) {
            TimeUnit.MILLISECONDS.sleep(100);
        }

        scope.close();
    }

    public static final class WithTransferableScope<T> extends LeakPresenceDetector<T> {
        static final InheritableThreadLocal<ResourceScope> SCOPE = new InheritableThreadLocal<>();

        @SuppressWarnings("unused")
        public WithTransferableScope(Class<?> resourceType, int samplingInterval) {
            super(resourceType);
        }

        @SuppressWarnings("unused")
        public WithTransferableScope(Class<?> resourceType, int samplingInterval, long maxActive) {
            super(resourceType);
        }

        @Override
        protected ResourceScope currentScope() throws AllocationProhibitedException {