io.aeron.test.InterruptingTestCallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aeron-test-support Show documentation
Efficient reliable UDP unicast, UDP multicast, and IPC transport protocol.
The newest version!
/*
 * Copyright 2014-2024 Real Logic Limited.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.aeron.test;

import org.junit.jupiter.api.Timeout;
import org.junit.jupiter.api.extension.AfterEachCallback;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.platform.commons.util.RuntimeUtils;

import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;

public class InterruptingTestCallback implements BeforeEachCallback, AfterEachCallback
{
    private static final boolean TIMEOUT_DISABLED_ON_DEBUG =
        !"enabled".equals(System.getProperty(Timeout.TIMEOUT_MODE_PROPERTY_NAME));

    private static final ScheduledExecutorService SCHEDULER = Executors.newSingleThreadScheduledExecutor(
        (runnable) ->
        {
            final Thread thread = new Thread(runnable);
            thread.setDaemon(true);
            thread.setName("interrupting-test-callback");

            return thread;
        });

    private ScheduledFuture timer = null;

    public void afterEach(final ExtensionContext context)
    {
        if (null != timer)
        {
            timer.cancel(false);
            if (!timer.isDone())
            {
                try
                {
                    timer.get();
                }
                catch (final InterruptedException | ExecutionException ignore)
                {
                }
            }

            timer = null;
        }
    }

    public void beforeEach(final ExtensionContext context)
    {
        timer = null;
        final InterruptAfter annotation = context.getRequiredTestMethod().getAnnotation(InterruptAfter.class);

        if (null != annotation && !(RuntimeUtils.isDebugMode() && TIMEOUT_DISABLED_ON_DEBUG))
        {
            final Thread testThread = Thread.currentThread();

            long delayMs = annotation.unit().toMillis(annotation.value());
            if (SystemTestConfig.DRIVER_AWAIT_COUNTER_CLOSE)
            {
                delayMs = Math.max(delayMs, SystemTestConfig.MIN_COUNTER_CLOSE_INTERRUPT_TIMEOUT_MS);
            }

            timer = SCHEDULER.schedule(testThread::interrupt, delayMs, TimeUnit.MILLISECONDS);
        }
    }
}