Skip to content

Commit

Permalink
make test more robust
Browse files Browse the repository at this point in the history 
Signed-off-by: Ceki Gulcu <[email protected]>
  • Loading branch information
@ceki
ceki committed Aug 5, 2021
1 parent bcd9b51 commit 684ca1f
Showing 1 changed file with 128 additions and 127 deletions.
255 changes: 128 additions & 127 deletions logback-core/src/test/java/ch/qos/logback/core/net/DefaultSocketConnectorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,156 +13,157 @@
*/
package ch.qos.logback.core.net;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.net.ConnectException;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.SocketAddress;

import java.util.concurrent.BrokenBarrierException;
import java.util.concurrent.CyclicBarrier;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.locks.Condition;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;

import org.junit.After;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;

import ch.qos.logback.core.net.SocketConnector.ExceptionHandler;
import ch.qos.logback.core.net.server.test.ServerSocketUtil;

import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

/**
* Unit tests for {@link DefaultSocketConnector}.
*
* @author Carl Harris
*/
@Ignore
public class DefaultSocketConnectorTest {

private static final int DELAY = 1000;
private static final int SHORT_DELAY = 10;
private static final int RETRY_DELAY = 10;

private MockExceptionHandler exceptionHandler = new MockExceptionHandler();

private ServerSocket serverSocket;
private DefaultSocketConnector connector;

ExecutorService executor = Executors.newSingleThreadExecutor();

@Before
public void setUp() throws Exception {
serverSocket = ServerSocketUtil.createServerSocket();
connector = new DefaultSocketConnector(serverSocket.getInetAddress(), serverSocket.getLocalPort(), 0, RETRY_DELAY);
connector.setExceptionHandler(exceptionHandler);
}

@After
public void tearDown() throws Exception {
if (serverSocket != null) {
serverSocket.close();
}
}

@Test
public void testConnect() throws Exception {
Future<Socket> connectorTask = executor.submit(connector);

Socket socket = connectorTask.get(2 * DELAY, TimeUnit.MILLISECONDS);
assertNotNull(socket);
connectorTask.cancel(true);

assertTrue(connectorTask.isDone());
socket.close();
}

@Test
public void testConnectionFails() throws Exception {
serverSocket.close();
Future<Socket> connectorTask = executor.submit(connector);

// this connection attempt will always timeout
try {
connectorTask.get(SHORT_DELAY, TimeUnit.MILLISECONDS);
fail();
} catch (TimeoutException e) {
}
Exception lastException = exceptionHandler.awaitConnectionFailed(DELAY);
assertTrue(lastException instanceof ConnectException);
assertFalse(connectorTask.isDone());
connectorTask.cancel(true);

// thread.join(4 * DELAY);
assertTrue(connectorTask.isCancelled());
}

@Test(timeout = 5000)
public void testConnectEventually() throws Exception {
serverSocket.close();

Future<Socket> connectorTask = executor.submit(connector);
// this connection attempt will always timeout
try {
connectorTask.get(SHORT_DELAY, TimeUnit.MILLISECONDS);
fail();
} catch (TimeoutException e) {
}

// on Ceki's machine (Windows 7) this always takes 1second regardless of the value of DELAY
Exception lastException = exceptionHandler.awaitConnectionFailed(DELAY);
assertNotNull(lastException);
assertTrue(lastException instanceof ConnectException);

// now rebind to the same local address
SocketAddress address = serverSocket.getLocalSocketAddress();
serverSocket = new ServerSocket();
serverSocket.setReuseAddress(true);
serverSocket.bind(address);

// now we should be able to connect
Socket socket = connectorTask.get(2 * DELAY, TimeUnit.MILLISECONDS);

assertNotNull(socket);

assertFalse(connectorTask.isCancelled());
socket.close();
}

private static class MockExceptionHandler implements ExceptionHandler {

private final Lock lock = new ReentrantLock();
private final Condition failedCondition = lock.newCondition();

private Exception lastException;

public void connectionFailed(SocketConnector connector, Exception ex) {
lastException = ex;
}

public Exception awaitConnectionFailed(long delay) throws InterruptedException {
lock.lock();
try {
long increment = 10;
while (lastException == null && delay > 0) {
boolean success = failedCondition.await(increment, TimeUnit.MILLISECONDS);
delay -= increment;
if (success)
break;

}
return lastException;
} finally {
lock.unlock();
}
}

}
private static final int DELAY = 1000;
private static final int SHORT_DELAY = 10;
private static final int RETRY_DELAY = 10;

private MockExceptionHandler exceptionHandler = new MockExceptionHandler();

private ServerSocket serverSocket;
private DefaultSocketConnector connector;

ExecutorService executor = Executors.newSingleThreadExecutor();

@Before
public void setUp() throws Exception {
serverSocket = ServerSocketUtil.createServerSocket();
connector = new DefaultSocketConnector(serverSocket.getInetAddress(), serverSocket.getLocalPort(), 0,
RETRY_DELAY);
connector.setExceptionHandler(exceptionHandler);
}

@After
public void tearDown() throws Exception {
if (serverSocket != null) {
serverSocket.close();
}
}

@Test
public void testConnect() throws Exception {
Future<Socket> connectorTask = executor.submit(connector);

Socket socket = connectorTask.get(DELAY, TimeUnit.MILLISECONDS);
assertNotNull(socket);
connectorTask.cancel(true);

assertTrue(connectorTask.isDone());
socket.close();
}

@Test
public void testConnectionFails() throws Exception {
serverSocket.close();
Future<Socket> connectorTask = executor.submit(connector);

// this connection attempt will always timeout
try {
connectorTask.get(SHORT_DELAY, TimeUnit.MILLISECONDS);
fail();
} catch (TimeoutException e) {
}
Exception lastException = exceptionHandler.awaitConnectionFailed();
assertTrue(lastException instanceof ConnectException);
assertFalse(connectorTask.isDone());
connectorTask.cancel(true);

// thread.join(4 * DELAY);
assertTrue(connectorTask.isCancelled());
}

@Test(timeout = 5000)
public void testConnectEventually() throws Exception {
serverSocket.close();

Future<Socket> connectorTask = executor.submit(connector);
// this connection attempt will always timeout
try {
connectorTask.get(SHORT_DELAY, TimeUnit.MILLISECONDS);
fail();
} catch (TimeoutException e) {
}

// the following call requries over 1000 millis
Exception lastException = exceptionHandler.awaitConnectionFailed();
assertNotNull(lastException);
assertTrue(lastException instanceof ConnectException);

// now rebind to the same local address
SocketAddress address = serverSocket.getLocalSocketAddress();
serverSocket = new ServerSocket();
serverSocket.setReuseAddress(true);
serverSocket.bind(address);

// now we should be able to connect
Socket socket = connectorTask.get(2 * DELAY, TimeUnit.MILLISECONDS);

assertNotNull(socket);

assertFalse(connectorTask.isCancelled());
socket.close();
}

private static class MockExceptionHandler implements ExceptionHandler {

private final CyclicBarrier failureBarrier = new CyclicBarrier(2);

private Exception lastException;

public void connectionFailed(SocketConnector connector, Exception ex) {
lastException = ex;
try {
failureBarrier.await();
} catch (InterruptedException | BrokenBarrierException e) {
e.printStackTrace();
}
}

public Exception awaitConnectionFailed() throws InterruptedException {
if (lastException != null) {
return lastException;
}

try {
failureBarrier.await();
} catch (InterruptedException | BrokenBarrierException e) {
e.printStackTrace();
}
return lastException;
}

}

}

0 comments on commit 684ca1f

Please sign in to comment.