ConnectionReset.java

/*
 * Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/**
 * @test
 * @run testng ConnectionReset
 * @summary Test behavior of SocketChannel.read and the Socket adaptor read
 *          and available methods when a connection is reset
 */

import java.io.InputStream;
import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.nio.ByteBuffer;
import java.nio.channels.SocketChannel;
import java.lang.reflect.Method;

import org.testng.annotations.Test;
import static org.testng.Assert.*;

@Test
public class ConnectionReset {

    static final int REPEAT_COUNT = 5;

    /**
     * Tests SocketChannel.read when the connection is reset and there are no
     * bytes to read.
     */
    public void testSocketChannelReadNoData() throws IOException {
        System.out.println("testSocketChannelReadNoData");
        withResetConnection(null, sc -> {
            ByteBuffer bb = ByteBuffer.allocate(100);
            for (int i=0; i<REPEAT_COUNT; i++) {
                try {
                    sc.read(bb);
                    assertTrue(false);
                } catch (IOException ioe) {
                    System.out.format("read => %s (expected)%n", ioe);
                }
            }
        });
    }

    /**
     * Tests SocketChannel.read when the connection is reset and there are bytes
     * to read.
     */
    public void testSocketChannelReadData() throws IOException {
        System.out.println("testSocketChannelReadData");
        byte[] data = { 1, 2, 3 };
        withResetConnection(data, sc -> {
            int remaining = data.length;
            ByteBuffer bb = ByteBuffer.allocate(remaining + 100);
            for (int i=0; i<REPEAT_COUNT; i++) {
                try {
                    int bytesRead = sc.read(bb);
                    if (bytesRead == -1) {
                        System.out.println("read => EOF");
                    } else {
                        System.out.println("read => " + bytesRead + " byte(s)");
                    }
                    assertTrue(bytesRead > 0);
                    remaining -= bytesRead;
                    assertTrue(remaining >= 0);
                } catch (IOException ioe) {
                    System.out.format("read => %s%n", ioe);
                    remaining = 0;
                }
            }
        });
    }


    /**
     * Tests available before Socket read when the connection is reset and there
     * are no bytes to read.
     */
    public void testAvailableBeforeSocketReadNoData() throws IOException {
        System.out.println("testAvailableBeforeSocketReadNoData");
        withResetConnection(null, sc -> {
            Socket s = sc.socket();
            InputStream in = s.getInputStream();
            for (int i=0; i<REPEAT_COUNT; i++) {
                int bytesAvailable = in.available();
                System.out.format("available => %d%n", bytesAvailable);
                assertTrue(bytesAvailable == 0);
                try {
                    int bytesRead = in.read();
                    if (bytesRead == -1) {
                        System.out.println("read => EOF");
                    } else {
                        System.out.println("read => 1 byte");
                    }
                    assertTrue(false);
                } catch (IOException ioe) {
                    System.out.format("read => %s (expected)%n", ioe);
                }
            }
        });
    }

    /**
     * Tests available before Socket read when the connection is reset and there
     * are bytes to read.
     */
    public void testAvailableBeforeSocketReadData() throws IOException {
        System.out.println("testAvailableBeforeSocketReadData");
        byte[] data = { 1, 2, 3 };
        withResetConnection(data, sc -> {
            Socket s = sc.socket();
            InputStream in = s.getInputStream();
            int remaining = data.length;
            for (int i=0; i<REPEAT_COUNT; i++) {
                int bytesAvailable = in.available();
                System.out.format("available => %d%n", bytesAvailable);
                assertTrue(bytesAvailable <= remaining);
                try {
                    int bytesRead = in.read();
                    if (bytesRead == -1) {
                        System.out.println("read => EOF");
                        assertTrue(false);
                    } else {
                        System.out.println("read => 1 byte");
                        assertTrue(remaining > 0);
                        remaining--;
                    }
                } catch (IOException ioe) {
                    System.out.format("read => %s%n", ioe);
                    remaining = 0;
                }
            }
        });
    }

    /**
     * Tests Socket read before available when the connection is reset and there
     * are no bytes to read.
     */
    public void testSocketReadNoDataBeforeAvailable() throws IOException {
        System.out.println("testSocketReadNoDataBeforeAvailable");
        withResetConnection(null, sc -> {
            Socket s = sc.socket();
            InputStream in = s.getInputStream();
            for (int i=0; i<REPEAT_COUNT; i++) {
                try {
                    int bytesRead = in.read();
                    if (bytesRead == -1) {
                        System.out.println("read => EOF");
                    } else {
                        System.out.println("read => 1 byte");
                    }
                    assertTrue(false);
                } catch (IOException ioe) {
                    System.out.format("read => %s (expected)%n", ioe);
                }
                int bytesAvailable = in.available();
                System.out.format("available => %d%n", bytesAvailable);
                assertTrue(bytesAvailable == 0);
            }
        });
    }

    /**
     * Tests Socket read before available when the connection is reset and there
     * are bytes to read.
     */
    public void testSocketReadDataBeforeAvailable() throws IOException {
        System.out.println("testSocketReadDataBeforeAvailable");
        byte[] data = { 1, 2, 3 };
        withResetConnection(data, sc -> {
            Socket s = sc.socket();
            InputStream in = s.getInputStream();
            int remaining = data.length;
            for (int i=0; i<REPEAT_COUNT; i++) {
                try {
                    int bytesRead = in.read();
                    if (bytesRead == -1) {
                        System.out.println("read => EOF");
                        assertTrue(false);
                    } else {
                        System.out.println("read => 1 byte");
                        assertTrue(remaining > 0);
                        remaining--;
                    }
                } catch (IOException ioe) {
                    System.out.format("read => %s%n", ioe);
                    remaining = 0;
                }
                int bytesAvailable = in.available();
                System.out.format("available => %d%n", bytesAvailable);
                assertTrue(bytesAvailable <= remaining);
            }
        });
    }

    interface ThrowingConsumer<T> {
        void accept(T t) throws IOException;
    }

    /**
     * Invokes a consumer with a SocketChannel connected to a peer that has closed
     * the connection with a "connection reset". The peer sends the given data
     * bytes before closing (when data is not null).
     */
    static void withResetConnection(byte[] data, ThrowingConsumer<SocketChannel> consumer)
        throws IOException
    {
        var loopback = InetAddress.getLoopbackAddress();
        try (var listener = new ServerSocket()) {
            listener.bind(new InetSocketAddress(loopback, 0));
            try (var sc = SocketChannel.open()) {
                sc.connect(listener.getLocalSocketAddress());
                try (Socket peer = listener.accept()) {
                    if (data != null) {
                        peer.getOutputStream().write(data);
                    }
                    peer.setSoLinger(true, 0);
                }
                consumer.accept(sc);
            }
        }
    }
}