Merge branch '5.1.x'
This commit is contained in:
@@ -383,6 +383,15 @@ public class StompSubProtocolHandlerTests {
|
||||
Principal user = SimpMessageHeaderAccessor.getUser(message.getHeaders());
|
||||
assertThat(user).isNotNull();
|
||||
assertThat(user.getName()).isEqualTo("__pete__@gmail.com");
|
||||
|
||||
StompHeaderAccessor accessor = StompHeaderAccessor.create(StompCommand.CONNECTED);
|
||||
message = MessageBuilder.createMessage(EMPTY_PAYLOAD, accessor.getMessageHeaders());
|
||||
handler.handleMessageToClient(this.session, message);
|
||||
|
||||
assertThat(this.session.getSentMessages()).hasSize(1);
|
||||
WebSocketMessage<?> textMessage = this.session.getSentMessages().get(0);
|
||||
assertThat(textMessage.getPayload())
|
||||
.isEqualTo("CONNECTED\n" + "user-name:__pete__@gmail.com\n" + "\n" + "\u0000");
|
||||
}
|
||||
|
||||
@Test
|
||||
|
||||
@@ -23,6 +23,7 @@ import java.util.Map;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.web.socket.AbstractHttpRequestTests;
|
||||
import org.springframework.web.socket.SubProtocolCapable;
|
||||
import org.springframework.web.socket.WebSocketExtension;
|
||||
@@ -51,14 +52,9 @@ public class DefaultHandshakeHandlerTests extends AbstractHttpRequestTests {
|
||||
public void supportedSubProtocols() {
|
||||
this.handshakeHandler.setSupportedProtocols("stomp", "mqtt");
|
||||
given(this.upgradeStrategy.getSupportedVersions()).willReturn(new String[] {"13"});
|
||||
this.servletRequest.setMethod("GET");
|
||||
|
||||
WebSocketHttpHeaders headers = new WebSocketHttpHeaders(this.request.getHeaders());
|
||||
headers.setUpgrade("WebSocket");
|
||||
headers.setConnection("Upgrade");
|
||||
headers.setSecWebSocketVersion("13");
|
||||
headers.setSecWebSocketKey("82/ZS2YHjEnUN97HLL8tbw==");
|
||||
headers.setSecWebSocketProtocol("STOMP");
|
||||
this.servletRequest.setMethod("GET");
|
||||
initHeaders(this.request.getHeaders()).setSecWebSocketProtocol("STOMP");
|
||||
|
||||
WebSocketHandler handler = new TextWebSocketHandler();
|
||||
Map<String, Object> attributes = Collections.emptyMap();
|
||||
@@ -77,16 +73,10 @@ public class DefaultHandshakeHandlerTests extends AbstractHttpRequestTests {
|
||||
given(this.upgradeStrategy.getSupportedExtensions(this.request)).willReturn(Collections.singletonList(extension1));
|
||||
|
||||
this.servletRequest.setMethod("GET");
|
||||
|
||||
WebSocketHttpHeaders headers = new WebSocketHttpHeaders(this.request.getHeaders());
|
||||
headers.setUpgrade("WebSocket");
|
||||
headers.setConnection("Upgrade");
|
||||
headers.setSecWebSocketVersion("13");
|
||||
headers.setSecWebSocketKey("82/ZS2YHjEnUN97HLL8tbw==");
|
||||
headers.setSecWebSocketExtensions(Arrays.asList(extension1, extension2));
|
||||
initHeaders(this.request.getHeaders()).setSecWebSocketExtensions(Arrays.asList(extension1, extension2));
|
||||
|
||||
WebSocketHandler handler = new TextWebSocketHandler();
|
||||
Map<String, Object> attributes = Collections.<String, Object>emptyMap();
|
||||
Map<String, Object> attributes = Collections.emptyMap();
|
||||
this.handshakeHandler.doHandshake(this.request, this.response, handler, attributes);
|
||||
|
||||
verify(this.upgradeStrategy).upgrade(this.request, this.response, null,
|
||||
@@ -98,16 +88,10 @@ public class DefaultHandshakeHandlerTests extends AbstractHttpRequestTests {
|
||||
given(this.upgradeStrategy.getSupportedVersions()).willReturn(new String[] {"13"});
|
||||
|
||||
this.servletRequest.setMethod("GET");
|
||||
|
||||
WebSocketHttpHeaders headers = new WebSocketHttpHeaders(this.request.getHeaders());
|
||||
headers.setUpgrade("WebSocket");
|
||||
headers.setConnection("Upgrade");
|
||||
headers.setSecWebSocketVersion("13");
|
||||
headers.setSecWebSocketKey("82/ZS2YHjEnUN97HLL8tbw==");
|
||||
headers.setSecWebSocketProtocol("v11.stomp");
|
||||
initHeaders(this.request.getHeaders()).setSecWebSocketProtocol("v11.stomp");
|
||||
|
||||
WebSocketHandler handler = new SubProtocolCapableHandler("v12.stomp", "v11.stomp");
|
||||
Map<String, Object> attributes = Collections.<String, Object>emptyMap();
|
||||
Map<String, Object> attributes = Collections.emptyMap();
|
||||
this.handshakeHandler.doHandshake(this.request, this.response, handler, attributes);
|
||||
|
||||
verify(this.upgradeStrategy).upgrade(this.request, this.response, "v11.stomp",
|
||||
@@ -119,22 +103,25 @@ public class DefaultHandshakeHandlerTests extends AbstractHttpRequestTests {
|
||||
given(this.upgradeStrategy.getSupportedVersions()).willReturn(new String[] {"13"});
|
||||
|
||||
this.servletRequest.setMethod("GET");
|
||||
|
||||
WebSocketHttpHeaders headers = new WebSocketHttpHeaders(this.request.getHeaders());
|
||||
headers.setUpgrade("WebSocket");
|
||||
headers.setConnection("Upgrade");
|
||||
headers.setSecWebSocketVersion("13");
|
||||
headers.setSecWebSocketKey("82/ZS2YHjEnUN97HLL8tbw==");
|
||||
headers.setSecWebSocketProtocol("v10.stomp");
|
||||
initHeaders(this.request.getHeaders()).setSecWebSocketProtocol("v10.stomp");
|
||||
|
||||
WebSocketHandler handler = new SubProtocolCapableHandler("v12.stomp", "v11.stomp");
|
||||
Map<String, Object> attributes = Collections.<String, Object>emptyMap();
|
||||
Map<String, Object> attributes = Collections.emptyMap();
|
||||
this.handshakeHandler.doHandshake(this.request, this.response, handler, attributes);
|
||||
|
||||
verify(this.upgradeStrategy).upgrade(this.request, this.response, null,
|
||||
Collections.emptyList(), null, handler, attributes);
|
||||
}
|
||||
|
||||
private WebSocketHttpHeaders initHeaders(HttpHeaders httpHeaders) {
|
||||
WebSocketHttpHeaders headers = new WebSocketHttpHeaders(httpHeaders);
|
||||
headers.setUpgrade("WebSocket");
|
||||
headers.setConnection("Upgrade");
|
||||
headers.setSecWebSocketVersion("13");
|
||||
headers.setSecWebSocketKey("82/ZS2YHjEnUN97HLL8tbw==");
|
||||
return headers;
|
||||
}
|
||||
|
||||
|
||||
private static class SubProtocolCapableHandler extends TextWebSocketHandler implements SubProtocolCapable {
|
||||
|
||||
|
||||
@@ -0,0 +1,138 @@
|
||||
/*
|
||||
* Copyright 2002-2019 the original author or authors.
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* 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 org.springframework.web.socket.server.support;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.Collections;
|
||||
import java.util.Map;
|
||||
import javax.servlet.ServletException;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.http.server.ServerHttpRequest;
|
||||
import org.springframework.http.server.ServerHttpResponse;
|
||||
import org.springframework.mock.web.test.MockHttpServletRequest;
|
||||
import org.springframework.mock.web.test.MockHttpServletResponse;
|
||||
import org.springframework.web.socket.WebSocketHandler;
|
||||
import org.springframework.web.socket.server.HandshakeFailureException;
|
||||
import org.springframework.web.socket.server.HandshakeHandler;
|
||||
import org.springframework.web.socket.server.HandshakeInterceptor;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.assertj.core.api.Assertions.assertThatThrownBy;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.BDDMockito.when;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.mockito.Mockito.verifyNoMoreInteractions;
|
||||
|
||||
/**
|
||||
* Unit tests for {@link WebSocketHttpRequestHandler}.
|
||||
* @author Rossen Stoyanchev
|
||||
* @since 5.1.9
|
||||
*/
|
||||
public class WebSocketHttpRequestHandlerTests {
|
||||
|
||||
private HandshakeHandler handshakeHandler;
|
||||
|
||||
private WebSocketHttpRequestHandler requestHandler;
|
||||
|
||||
private MockHttpServletResponse response;
|
||||
|
||||
|
||||
@Before
|
||||
public void setUp() {
|
||||
this.handshakeHandler = mock(HandshakeHandler.class);
|
||||
this.requestHandler = new WebSocketHttpRequestHandler(mock(WebSocketHandler.class), this.handshakeHandler);
|
||||
this.response = new MockHttpServletResponse();
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void success() throws ServletException, IOException {
|
||||
TestInterceptor interceptor = new TestInterceptor(true);
|
||||
this.requestHandler.setHandshakeInterceptors(Collections.singletonList(interceptor));
|
||||
this.requestHandler.handleRequest(new MockHttpServletRequest(), this.response);
|
||||
|
||||
verify(this.handshakeHandler).doHandshake(any(), any(), any(), any());
|
||||
assertThat(this.response.getHeader("headerName")).isEqualTo("headerValue");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void failure() {
|
||||
TestInterceptor interceptor = new TestInterceptor(true);
|
||||
this.requestHandler.setHandshakeInterceptors(Collections.singletonList(interceptor));
|
||||
|
||||
when(this.handshakeHandler.doHandshake(any(), any(), any(), any()))
|
||||
.thenThrow(new IllegalStateException("bad state"));
|
||||
|
||||
assertThatThrownBy(() -> this.requestHandler.handleRequest(new MockHttpServletRequest(), this.response))
|
||||
.isInstanceOf(HandshakeFailureException.class)
|
||||
.hasRootCauseInstanceOf(IllegalStateException.class)
|
||||
.hasMessageEndingWith("bad state");
|
||||
|
||||
assertThat(this.response.getHeader("headerName")).isEqualTo("headerValue");
|
||||
assertThat(this.response.getHeader("exceptionHeaderName")).isEqualTo("exceptionHeaderValue");
|
||||
}
|
||||
|
||||
@Test // gh-23179
|
||||
public void handshakeNotAllowed() throws ServletException, IOException {
|
||||
TestInterceptor interceptor = new TestInterceptor(false);
|
||||
this.requestHandler.setHandshakeInterceptors(Collections.singletonList(interceptor));
|
||||
|
||||
this.requestHandler.handleRequest(new MockHttpServletRequest(), this.response);
|
||||
|
||||
verifyNoMoreInteractions(this.handshakeHandler);
|
||||
assertThat(this.response.getHeader("headerName")).isEqualTo("headerValue");
|
||||
}
|
||||
|
||||
|
||||
private static class TestInterceptor implements HandshakeInterceptor {
|
||||
|
||||
private final boolean allowHandshake;
|
||||
|
||||
private Exception exception;
|
||||
|
||||
|
||||
private TestInterceptor(boolean allowHandshake) {
|
||||
this.allowHandshake = allowHandshake;
|
||||
}
|
||||
|
||||
|
||||
public Exception getException() {
|
||||
return this.exception;
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response,
|
||||
WebSocketHandler wsHandler, Map<String, Object> attributes) {
|
||||
|
||||
response.getHeaders().add("headerName", "headerValue");
|
||||
return this.allowHandshake;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response,
|
||||
WebSocketHandler wsHandler, Exception exception) {
|
||||
|
||||
response.getHeaders().add("exceptionHeaderName", "exceptionHeaderValue");
|
||||
this.exception = exception;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user