io.netty5.testsuite.transport.AbstractSingleThreadEventLoopTest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of netty5-testsuite Show documentation
There is a newer version: 5.0.0.Alpha5
/*
 * Copyright 2019 The Netty Project
 *
 * The Netty Project licenses this file to you 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.netty5.testsuite.transport;

import io.netty5.bootstrap.ServerBootstrap;
import io.netty5.channel.Channel;
import io.netty5.channel.ChannelHandler;
import io.netty5.channel.EventLoop;
import io.netty5.channel.EventLoopGroup;
import io.netty5.channel.IoHandlerFactory;
import io.netty5.channel.MultithreadEventLoopGroup;
import io.netty5.channel.ServerChannel;
import io.netty5.channel.local.LocalAddress;
import io.netty5.channel.local.LocalServerChannel;
import io.netty5.util.concurrent.EventExecutor;
import io.netty5.util.concurrent.Future;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Timeout;

import java.util.concurrent.CountDownLatch;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.TimeUnit;

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

public abstract class AbstractSingleThreadEventLoopTest {

    @Test
    public void shutdownBeforeStart() throws Exception {
        EventLoopGroup group = new MultithreadEventLoopGroup(newIoHandlerFactory());
        assertFalse(group.awaitTermination(2, TimeUnit.MILLISECONDS));
        group.shutdownGracefully(0, 0, TimeUnit.MILLISECONDS);
        assertTrue(group.awaitTermination(200, TimeUnit.MILLISECONDS));
    }

    @Test
    public void shutdownGracefullyZeroQuietBeforeStart() throws Exception {
        EventLoopGroup group =  new MultithreadEventLoopGroup(newIoHandlerFactory());
        assertTrue(group.shutdownGracefully(0L, 2L, TimeUnit.SECONDS).asStage().await(200, TimeUnit.MILLISECONDS));
    }

    // Copied from AbstractEventLoopTest
    @Test
    @Timeout(value = 5000, unit = TimeUnit.MILLISECONDS)
    public void testShutdownGracefullyNoQuietPeriod() throws Exception {
        EventLoopGroup loop = new MultithreadEventLoopGroup(newIoHandlerFactory());
        ServerBootstrap b = new ServerBootstrap();
        b.group(loop)
                .channel(serverChannelClass())
                .childHandler(new ChannelHandler() { });

        // Not close the Channel to ensure the EventLoop is still shutdown in time.
        Future cf = serverChannelClass() == LocalServerChannel.class
                ? b.bind(new LocalAddress(getClass())) : b.bind(0);
        cf.asStage().sync();

        Future f = loop.shutdownGracefully(0, 1, TimeUnit.MINUTES);
        assertTrue(loop.awaitTermination(600, TimeUnit.MILLISECONDS));
        assertTrue(f.asStage().sync().isSuccess());
        assertTrue(loop.isShutdown());
        assertTrue(loop.isTerminated());
    }

    @Test
    public void shutdownGracefullyBeforeStart() throws Exception {
        EventLoopGroup group = new MultithreadEventLoopGroup(newIoHandlerFactory());
        assertTrue(group.shutdownGracefully(200L, 1000L, TimeUnit.MILLISECONDS).asStage()
                        .await(500, TimeUnit.MILLISECONDS));
    }

    @Test
    public void gracefulShutdownAfterStart() throws Exception {
        EventLoop loop = new MultithreadEventLoopGroup(newIoHandlerFactory()).next();
        final CountDownLatch latch = new CountDownLatch(1);
        loop.execute(latch::countDown);

        // Wait for the event loop thread to start.
        latch.await();

        // Request the event loop thread to stop.
        loop.shutdownGracefully(200L, 3000L, TimeUnit.MILLISECONDS);

        // Wait until the event loop is terminated.
        assertTrue(loop.awaitTermination(500L, TimeUnit.MILLISECONDS));

        assertRejection(loop);
    }

    private static final Runnable NOOP = () -> { };

    private static void assertRejection(EventExecutor loop) {
        try {
            loop.execute(NOOP);
            fail("A task must be rejected after shutdown() is called.");
        } catch (RejectedExecutionException e) {
            // Expected
        }
    }

    @Test
    public void testDoesNotSupportChannelType() {
        EventLoopGroup group = new MultithreadEventLoopGroup(newIoHandlerFactory());
        try {
            assertFalse(group.isCompatible(Channel.class));
        } finally {
            group.shutdownGracefully();
        }
    }

    @Test
    public void testDoesSupportChannelType() {
        EventLoopGroup group = new MultithreadEventLoopGroup(newIoHandlerFactory());
        try {
            assertTrue(group.isCompatible(serverChannelClass()));
        } finally {
            group.shutdownGracefully();
        }
    }

    protected abstract IoHandlerFactory newIoHandlerFactory();
    protected abstract Class serverChannelClass();
}