Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix flaky test ClientCloseTest.testStopLifecycle() in jetty 9.4.x (#3990) 

* fix flaky test ClientCloseTest.testStopLifecycle() in 9.4.x

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>

* test code cleanups in ClientCloseTest

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
Lachlan 2019-08-20 12:49:52 +10:00 committed by GitHub
parent 95f7fddc59
commit 44986be6c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 82 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
jetty-websocket/jetty-websocket-tests/src/test/java/org/eclipse/jetty/websocket/tests/client/ClientCloseTest.java
View File

@ -49,6 +49,7 @@ import org.eclipse.jetty.websocket.api.util.WSURI;
import org.eclipse.jetty.websocket.client.WebSocketClient; import org.eclipse.jetty.websocket.client.WebSocketClient;
import org.eclipse.jetty.websocket.common.CloseInfo; import org.eclipse.jetty.websocket.common.CloseInfo;
import org.eclipse.jetty.websocket.common.OpCode; import org.eclipse.jetty.websocket.common.OpCode;
import org.eclipse.jetty.websocket.server.NativeWebSocketServletContainerInitializer;
import org.eclipse.jetty.websocket.servlet.WebSocketServlet; import org.eclipse.jetty.websocket.servlet.WebSocketServlet;
import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory; import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory;
import org.eclipse.jetty.websocket.tests.CloseTrackingEndpoint; import org.eclipse.jetty.websocket.tests.CloseTrackingEndpoint;
@ -60,7 +61,6 @@ import static java.nio.charset.StandardCharsets.UTF_8;
import static java.time.Duration.ofSeconds; import static java.time.Duration.ofSeconds;
import static java.util.concurrent.TimeUnit.SECONDS; import static java.util.concurrent.TimeUnit.SECONDS;
import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.anyOf;
import static org.hamcrest.Matchers.containsString; import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.instanceOf; import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.Matchers.is; import static org.hamcrest.Matchers.is;
@ -83,10 +83,7 @@ public class ClientCloseTest
{ {
// Send message from client to server // Send message from client to server
final String echoMsg = "echo-test"; final String echoMsg = "echo-test";
Future<Void> testFut = clientSocket.getRemote().sendStringByFuture(echoMsg); clientSocket.getRemote().sendString(echoMsg);
// Wait for send future
testFut.get(5, SECONDS);
// Verify received message // Verify received message
String recvMsg = clientSocket.messageQueue.poll(5, SECONDS); String recvMsg = clientSocket.messageQueue.poll(5, SECONDS);
@ -108,7 +105,6 @@ public class ClientCloseTest
{ {
client = new WebSocketClient(); client = new WebSocketClient();
client.setMaxTextMessageBufferSize(1024); client.setMaxTextMessageBufferSize(1024);
client.getPolicy().setMaxTextMessageSize(1024);
client.start(); client.start();
} }
@ -143,6 +139,7 @@ public class ClientCloseTest
handlers.addHandler(context); handlers.addHandler(context);
handlers.addHandler(new DefaultHandler()); handlers.addHandler(new DefaultHandler());
server.setHandler(handlers); server.setHandler(handlers);
NativeWebSocketServletContainerInitializer.configure(context, null);
server.start(); server.start();
} }
@ -174,27 +171,24 @@ public class ClientCloseTest
CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint(); CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
Future<Session> clientConnectFuture = client.connect(clientSocket, wsUri); Future<Session> clientConnectFuture = client.connect(clientSocket, wsUri);
try (Session session = confirmConnection(clientSocket, clientConnectFuture)) // client confirms connection via echo
{ confirmConnection(clientSocket, clientConnectFuture);
// client confirms connection via echo
// client sends close frame (code 1000, normal) // client sends close frame (code 1000, normal)
final String origCloseReason = "send-more-frames"; final String origCloseReason = "send-more-frames";
clientSocket.getSession().close(StatusCode.NORMAL, origCloseReason); clientSocket.getSession().close(StatusCode.NORMAL, origCloseReason);
// Verify received messages // Verify received messages
String recvMsg = clientSocket.messageQueue.poll(5, SECONDS); String recvMsg = clientSocket.messageQueue.poll(5, SECONDS);
assertThat("Received message 1", recvMsg, is("Hello")); assertThat("Received message 1", recvMsg, is("Hello"));
recvMsg = clientSocket.messageQueue.poll(5, SECONDS); recvMsg = clientSocket.messageQueue.poll(5, SECONDS);
assertThat("Received message 2", recvMsg, is("World")); assertThat("Received message 2", recvMsg, is("World"));
// Verify that there are no errors // Verify that there are no errors
assertThat("Error events", clientSocket.error.get(), nullValue()); assertThat("Error events", clientSocket.error.get(), nullValue());
// client close event on ws-endpoint
clientSocket.assertReceivedCloseEvent(timeout, is(StatusCode.NORMAL), containsString(""));
}
// client close event on ws-endpoint
clientSocket.assertReceivedCloseEvent(timeout, is(StatusCode.NORMAL), containsString(""));
clientSessionTracker.assertClosedProperly(client); clientSessionTracker.assertClosedProperly(client);
} }
@ -213,18 +207,15 @@ public class ClientCloseTest
CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint(); CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
Future<Session> clientConnectFuture = client.connect(clientSocket, wsUri); Future<Session> clientConnectFuture = client.connect(clientSocket, wsUri);
try (Session session = confirmConnection(clientSocket, clientConnectFuture)) // client confirms connection via echo
{ confirmConnection(clientSocket, clientConnectFuture);
// client confirms connection via echo
session.getRemote().sendString("too-large-message"); clientSocket.getSession().getRemote().sendString("too-large-message");
clientSocket.assertReceivedCloseEvent(timeout, is(StatusCode.MESSAGE_TOO_LARGE), containsString("exceeds maximum size"));
clientSocket.assertReceivedCloseEvent(timeout, is(StatusCode.MESSAGE_TOO_LARGE), containsString("exceeds maximum size")); // client should have noticed the error
assertThat("OnError Latch", clientSocket.errorLatch.await(2, SECONDS), is(true));
// client should have noticed the error assertThat("OnError", clientSocket.error.get(), instanceOf(MessageTooLargeException.class));
assertThat("OnError Latch", clientSocket.errorLatch.await(2, SECONDS), is(true));
assertThat("OnError", clientSocket.error.get(), instanceOf(MessageTooLargeException.class));
}
// client triggers close event on client ws-endpoint // client triggers close event on client ws-endpoint
clientSessionTracker.assertClosedProperly(client); clientSessionTracker.assertClosedProperly(client);
@ -234,7 +225,7 @@ public class ClientCloseTest
public void testRemoteDisconnect() throws Exception public void testRemoteDisconnect() throws Exception
{ {
// Set client timeout // Set client timeout
final int clientTimeout = 1000; final int clientTimeout = 3000;
client.setMaxIdleTimeout(clientTimeout); client.setMaxIdleTimeout(clientTimeout);
ClientOpenSessionTracker clientSessionTracker = new ClientOpenSessionTracker(1); ClientOpenSessionTracker clientSessionTracker = new ClientOpenSessionTracker(1);
@ -245,19 +236,19 @@ public class ClientCloseTest
CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint(); CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
Future<Session> clientConnectFuture = client.connect(clientSocket, wsUri); Future<Session> clientConnectFuture = client.connect(clientSocket, wsUri);
try (Session ignored = confirmConnection(clientSocket, clientConnectFuture)) // client confirms connection via echo
{ confirmConnection(clientSocket, clientConnectFuture);
// client confirms connection via echo
// client sends close frame (triggering server connection abort) // client sends close frame (triggering server connection abort)
final String origCloseReason = "abort"; final String origCloseReason = "abort";
clientSocket.getSession().close(StatusCode.NORMAL, origCloseReason); clientSocket.getSession().close(StatusCode.NORMAL, origCloseReason);
// client reads -1 (EOF) // client reads -1 (EOF)
// client triggers close event on client ws-endpoint // client triggers hard close event on client ws-endpoint
// assert - close code==1006 (abnormal) or code==1001 (shutdown) // assert - close code==1006 (abnormal)
clientSocket.assertReceivedCloseEvent(clientTimeout * 2, anyOf(is(StatusCode.SHUTDOWN), is(StatusCode.ABNORMAL))); clientSocket.assertReceivedCloseEvent(2000,
} is(StatusCode.ABNORMAL),
containsString("Disconnected"));
clientSessionTracker.assertClosedProperly(client); clientSessionTracker.assertClosedProperly(client);
} }
@ -277,25 +268,22 @@ public class ClientCloseTest
CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint(); CloseTrackingEndpoint clientSocket = new CloseTrackingEndpoint();
Future<Session> clientConnectFuture = client.connect(clientSocket, wsUri); Future<Session> clientConnectFuture = client.connect(clientSocket, wsUri);
try (Session ignored = confirmConnection(clientSocket, clientConnectFuture)) // client confirms connection via echo
{ confirmConnection(clientSocket, clientConnectFuture);
// client confirms connection via echo
// client sends close frame // client sends close frame
final String origCloseReason = "sleep|5000"; final String origCloseReason = "sleep|2500";
clientSocket.getSession().close(StatusCode.NORMAL, origCloseReason); clientSocket.getSession().close(StatusCode.NORMAL, origCloseReason);
// client close should occur // client close should occur
clientSocket.assertReceivedCloseEvent(clientTimeout * 2, clientSocket.assertReceivedCloseEvent(clientTimeout * 2,
is(StatusCode.SHUTDOWN), is(StatusCode.SHUTDOWN),
containsString("timeout")); containsString("timeout"));
// client idle timeout triggers close event on client ws-endpoint
assertThat("OnError Latch", clientSocket.errorLatch.await(2, SECONDS), is(true));
assertThat("OnError", clientSocket.error.get(), instanceOf(CloseException.class));
assertThat("OnError.cause", clientSocket.error.get().getCause(), instanceOf(TimeoutException.class));
}
// client idle timeout triggers close event on client ws-endpoint
assertThat("OnError Latch", clientSocket.errorLatch.await(2, SECONDS), is(true));
assertThat("OnError", clientSocket.error.get(), instanceOf(CloseException.class));
assertThat("OnError.cause", clientSocket.error.get().getCause(), instanceOf(TimeoutException.class));
clientSessionTracker.assertClosedProperly(client); clientSessionTracker.assertClosedProperly(client);
} }
@ -303,7 +291,7 @@ public class ClientCloseTest
public void testStopLifecycle() throws Exception public void testStopLifecycle() throws Exception
{ {
// Set client timeout // Set client timeout
final int timeout = 1000; final int timeout = 3000;
client.setMaxIdleTimeout(timeout); client.setMaxIdleTimeout(timeout);
int sessionCount = 3; int sessionCount = 3;
@ -325,21 +313,41 @@ public class ClientCloseTest
confirmConnection(clientSocket, clientConnectFuture); confirmConnection(clientSocket, clientConnectFuture);
} }
assertTimeoutPreemptively(ofSeconds(5), () -> assertThat(serverEndpoints.size(), is(sessionCount));
{
// client lifecycle stop (the meat of this test)
client.stop();
});
// clients disconnect try
for (int i = 0; i < sessionCount; i++)
{ {
clientSockets.get(i).assertReceivedCloseEvent(timeout, is(StatusCode.ABNORMAL), containsString("Disconnected")); // block all the server threads
for (int i = 0; i < sessionCount; i++)
{
clientSockets.get(i).getSession().getRemote().sendString("block");
}
assertTimeoutPreemptively(ofSeconds(5), () ->
{
// client lifecycle stop (the meat of this test)
client.stop();
});
// clients disconnect
for (int i = 0; i < sessionCount; i++)
{
// The Disconnect callback is succeeded directly after sending the SHUTDOWN close frame so we get ABNORMAL close
clientSockets.get(i).assertReceivedCloseEvent(2000, is(StatusCode.ABNORMAL), containsString("Disconnected"));
}
// ensure all Sessions are gone. connections are gone. etc. (client and server)
// ensure ConnectionListener onClose is called 3 times
clientSessionTracker.assertClosedProperly(client);
assertThat(serverEndpoints.size(), is(sessionCount));
}
finally
{
for (int i = 0; i < sessionCount; i++)
{
serverEndpoints.get(i).block.countDown();
}
} }
// ensure all Sessions are gone. connections are gone. etc. (client and server)
// ensure ConnectionListener onClose is called 3 times
clientSessionTracker.assertClosedProperly(client);
} }
@Test @Test