org.newsclub.net.unix.AcceptTimeoutTest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of junixsocket-selftest Show documentation
Show all versions of junixsocket-selftest Show documentation
Runs junixsocket's unit tests as a selftest
The newest version!
/*
* junixsocket
*
* Copyright 2009-2024 Christian Kohlschütter
*
* 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
*
* http://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 org.newsclub.net.unix;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTimeoutPreemptively;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import java.io.IOException;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.SocketAddress;
import java.net.SocketException;
import java.net.SocketTimeoutException;
import java.time.Duration;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import org.junit.jupiter.api.Test;
import org.opentest4j.AssertionFailedError;
import com.kohlschutter.annotations.compiletime.SuppressFBWarnings;
import com.kohlschutter.testutil.TestAbortedWithImportantMessageException;
import com.kohlschutter.testutil.TestAbortedWithImportantMessageException.MessageType;
import com.kohlschutter.testutil.TestAsyncUtil;
import com.kohlschutter.testutil.TestStackTraceUtil;
/**
* Verifies that accept properly times out when an soTimeout was specified.
*
* @author Christian Kohlschütter
*/
@SuppressFBWarnings({
"THROWS_METHOD_THROWS_CLAUSE_THROWABLE", "THROWS_METHOD_THROWS_CLAUSE_BASIC_EXCEPTION"})
public abstract class AcceptTimeoutTest extends SocketTestBase {
private static final int TIMING_INACCURACY_MILLIS = 5000;
protected AcceptTimeoutTest(AddressSpecifics asp) {
super(asp);
}
@Test
public void testCatchTimeout() throws Exception {
final int timeoutMillis = 500;
assertTimeoutPreemptively(Duration.ofMillis(5 * timeoutMillis), () -> {
try (ServerSocket sock = startServer()) {
long time = System.currentTimeMillis();
sock.setSoTimeout(timeoutMillis);
long actualTimeout = sock.getSoTimeout();
if (actualTimeout == 0) {
// timeout not supported. So far we know this is only true for z/OS
if ("z/OS".equals(System.getProperty("os.name"))) {
return;
}
}
assertTrue(Math.abs(timeoutMillis - actualTimeout) <= TIMING_INACCURACY_MILLIS,
"We should roughly get the same timeout back that we set before, but was "
+ actualTimeout + " instead of " + timeoutMillis);
try (Socket socket = sock.accept()) {
fail("Did not receive " + SocketTimeoutException.class.getName() + "; socket=" + socket);
} catch (SocketException | SocketTimeoutException e) {
// expected
time = System.currentTimeMillis() - time;
assertTrue(Math.abs(time - timeoutMillis) <= TIMING_INACCURACY_MILLIS,
"Timeout not properly honored. Exception thrown after " + time + "ms vs. expected "
+ timeoutMillis + "ms");
}
}
});
}
@Test
@SuppressWarnings({"PMD.CognitiveComplexity", "PMD.ExcessiveMethodLength"})
@SuppressFBWarnings("NP_NONNULL_PARAM_VIOLATION")
public void testTimeoutAfterDelay() throws Exception {
final int timeoutMillis = 5000;
AtomicBoolean keepRunning = new AtomicBoolean(true);
CompletableFuture serverAddressCF = new CompletableFuture<>();
try {
assertTimeoutPreemptively(Duration.ofMillis(2 * timeoutMillis), () -> {
try (ServerSocket serverSock = startServer()) {
final int connectDelayMillis = 50;
serverSock.setSoTimeout(timeoutMillis);
long actualTimeout = serverSock.getSoTimeout();
if (actualTimeout == 0) {
// timeout not supported. So far we know this is only true for z/OS
if ("z/OS".equals(System.getProperty("os.name"))) {
return;
}
}
assertTrue(Math.abs(timeoutMillis - actualTimeout) <= 10,
"We should roughly get the same timeout back that we set before, but was "
+ actualTimeout + " instead of " + timeoutMillis);
final AtomicBoolean accepted = new AtomicBoolean(false);
final CompletableFuture runtimeExceptionCF = new CompletableFuture<>();
SocketAddress serverAddress = serverSock.getLocalSocketAddress();
serverAddressCF.complete(serverAddress);
final Socket threadSocket = newSocket();
Thread t = new Thread(() -> {
int i = 0;
while (keepRunning.get()) {
i++;
try {
Thread.sleep(connectDelayMillis);
} catch (InterruptedException e) {
return;
}
try {
connectSocket(threadSocket, serverAddress);
runtimeExceptionCF.complete(null);
} catch (SocketTimeoutException e) {
if (!keepRunning.get()) {
return;
}
System.out.println("SocketTimeout, trying connect again (" + i + ")");
continue;
} catch (TestAbortedWithImportantMessageException e) {
runtimeExceptionCF.complete(e);
} catch (IOException e) {
// ignore "connection reset by peer", etc. after connection was accepted
if (!accepted.get()) {
e.printStackTrace();
}
}
break; // NOPMD.AvoidBranchingStatementAsLastInLoop
}
});
t.setDaemon(true);
t.start();
long time = System.currentTimeMillis();
try (Socket socket = serverSock.accept();) {
assertNotNull(socket);
accepted.set(true);
} catch (SocketTimeoutException e) {
String msg = checkKnownBugAcceptTimeout(e);
if (msg == null) {
throw e;
} else {
throw new TestAbortedWithImportantMessageException(
MessageType.TEST_ABORTED_SHORT_WITH_ISSUES, msg, summaryImportantMessage(msg), e);
}
}
time = System.currentTimeMillis() - time;
RuntimeException re = runtimeExceptionCF.get();
if (re != null) {
throw re;
}
assertTrue(time >= connectDelayMillis && (time < timeoutMillis || (time
- connectDelayMillis) <= TIMING_INACCURACY_MILLIS),
"Timeout not properly honored. Accept succeeded after " + time + "ms vs. expected "
+ timeoutMillis + "ms");
}
});
} catch (AssertionFailedError e) {
String msg = checkKnownBugAcceptTimeout(serverAddressCF.getNow(null));
if (msg == null) {
throw e;
} else {
throw new TestAbortedWithImportantMessageException(
MessageType.TEST_ABORTED_SHORT_WITH_ISSUES, msg, summaryImportantMessage(msg), e);
}
} finally {
keepRunning.set(false);
}
}
/**
* Subclasses may override this to tell that there is a known issue with "Accept timeout after
* delay" when a SocketTimeoutException was thrown.
*
* @param e The exception
* @return An explanation iff this should not cause a test failure but trigger "With issues".
*/
protected String checkKnownBugAcceptTimeout(SocketTimeoutException e) {
return null;
}
/**
* Subclasses may override this to tell that there is a known issue with "Accept timeout after
* delay".
*
* @param serverAddr The server address.
* @return An explanation iff this should not cause a test failure but trigger "With issues".
*/
protected String checkKnownBugAcceptTimeout(SocketAddress serverAddr) {
return null;
}
@Test
public void testAcceptWithoutBindToService() throws Exception {
ServerSocket ss = newServerSocket();
assertThrows(SocketException.class, () -> {
try (Socket unused = ss.accept()) {
fail("Should not be reached");
}
});
}
@Test
public void testPendingAcceptCloseServerSocketImmediately() throws Exception {
testPendingAcceptCloseServerSocket(false);
}
@Test
public void testPendingAcceptCloseServerSocketDelayed() throws Exception {
testPendingAcceptCloseServerSocket(true);
}
private void testPendingAcceptCloseServerSocket(boolean delayed) throws Exception {
SocketAddress addr = newTempAddress();
ServerSocket ss = newServerSocketBindOn(addr);
Runnable doClose = () -> {
try {
ss.close();
} catch (IOException e) {
TestStackTraceUtil.printStackTrace(e);
}
};
if (delayed) {
TestAsyncUtil.runAsyncDelayed(1, TimeUnit.SECONDS, doClose);
} else {
doClose.run();
}
try {
assertTimeoutPreemptively(Duration.ofSeconds(5), () -> {
// Should be SocketClosedException or InvalidArgumentSocketException, but no guarantee
assertThrows(SocketException.class, () -> {
try (Socket unused = ss.accept()) {
fail("Should not be reached");
} catch (SocketException e) {
throw e;
}
});
});
} catch (AssertionFailedError e) {
String msg = checkKnownBugAcceptTimeout(addr);
if (msg == null) {
throw e;
} else {
throw new TestAbortedWithImportantMessageException(
MessageType.TEST_ABORTED_SHORT_WITH_ISSUES, msg, summaryImportantMessage(msg), e);
}
}
}
}