Add header support to WebSocketConnectionManager

Issue: SPR-10796

spring-websocket/src/test/java/org/springframework/web/socket/client/AbstractWebSocketClientTests.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2002-2013 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
+ *
+ * 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.springframework.web.socket.client;
+
+
+/**
+ * Test fixture for {@link AbstractWebSocketClient}.
+ * @author Rossen Stoyanchev
+ */
+public class AbstractWebSocketClientTests {
+
+}

spring-websocket/src/test/java/org/springframework/web/socket/client/WebSocketConnectionManagerTests.java

@@ -44,14 +44,12 @@ public class WebSocketConnectionManagerTests {
 	public void openConnection() throws Exception {
 
 		List<String> subprotocols = Arrays.asList("abc");
-		HttpHeaders headers = new HttpHeaders();
-		headers.setSecWebSocketProtocol(subprotocols);
 
 		WebSocketClient client = mock(WebSocketClient.class);
 		WebSocketHandler handler = new WebSocketHandlerAdapter();
 
 		WebSocketConnectionManager manager = new WebSocketConnectionManager(client, handler , "/path/{id}", "123");
-		manager.setSupportedProtocols(subprotocols);
+		manager.setSubProtocols(subprotocols);
 		manager.openConnection();
 
 		ArgumentCaptor<WebSocketHandlerDecorator> captor = ArgumentCaptor.forClass(WebSocketHandlerDecorator.class);
@@ -60,7 +58,10 @@ public class WebSocketConnectionManagerTests {
 
 		verify(client).doHandshake(captor.capture(), headersCaptor.capture(), uriCaptor.capture());
 
-		assertEquals(headers, headersCaptor.getValue());
+		HttpHeaders expectedHeaders = new HttpHeaders();
+		expectedHeaders.setSecWebSocketProtocol(subprotocols);
+
+		assertEquals(expectedHeaders, headersCaptor.getValue());
 		assertEquals(new URI("/path/123"), uriCaptor.getValue());
 
 		WebSocketHandlerDecorator loggingHandler = captor.getValue();

spring-websocket/src/test/java/org/springframework/web/socket/client/jetty/JettyWebSocketClientTests.java

@@ -0,0 +1,133 @@
+/*
+ * Copyright 2002-2013 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
+ *
+ * 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.springframework.web.socket.client.jetty;
+
+import java.net.URI;
+import java.util.Arrays;
+
+import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.server.ServerConnector;
+import org.eclipse.jetty.websocket.api.UpgradeRequest;
+import org.eclipse.jetty.websocket.api.UpgradeResponse;
+import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
+import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.springframework.http.HttpHeaders;
+import org.springframework.util.CollectionUtils;
+import org.springframework.util.SocketUtils;
+import org.springframework.web.socket.WebSocketHandler;
+import org.springframework.web.socket.WebSocketSession;
+import org.springframework.web.socket.adapter.JettyWebSocketListenerAdapter;
+import org.springframework.web.socket.adapter.JettyWebSocketSessionAdapter;
+import org.springframework.web.socket.adapter.TextWebSocketHandlerAdapter;
+
+import static org.junit.Assert.*;
+
+
+/**
+ * Tests for {@link JettyWebSocketClient}.
+ * @author Rossen Stoyanchev
+ */
+public class JettyWebSocketClientTests {
+
+	private JettyWebSocketClient client;
+
+	private TestJettyWebSocketServer server;
+
+	private String wsUrl;
+
+	private WebSocketSession wsSession;
+
+
+	@Before
+	public void setup() throws Exception {
+
+		int port = SocketUtils.findAvailableTcpPort();
+
+		this.server = new TestJettyWebSocketServer(port, new TextWebSocketHandlerAdapter());
+		this.server.start();
+
+		this.client = new JettyWebSocketClient();
+		this.client.start();
+
+		this.wsUrl = "ws://localhost:" + port + "/test";
+	}
+
+	@After
+	public void teardown() throws Exception {
+		this.wsSession.close();
+		this.client.stop();
+		this.server.stop();
+	}
+
+
+	@Test
+	public void doHandshake() throws Exception {
+
+		HttpHeaders headers = new HttpHeaders();
+		headers.setSecWebSocketProtocol(Arrays.asList("echo"));
+
+		this.wsSession = this.client.doHandshake(new TextWebSocketHandlerAdapter(), headers, new URI(this.wsUrl));
+
+		assertEquals(this.wsUrl, this.wsSession.getUri().toString());
+		assertEquals("echo", this.wsSession.getAcceptedProtocol());
+	}
+
+
+	private static class TestJettyWebSocketServer {
+
+		private final Server server;
+
+
+		public TestJettyWebSocketServer(int port, final WebSocketHandler webSocketHandler) {
+
+			this.server = new Server();
+			ServerConnector connector = new ServerConnector(this.server);
+			connector.setPort(port);
+
+			this.server.addConnector(connector);
+			this.server.setHandler(new org.eclipse.jetty.websocket.server.WebSocketHandler() {
+				@Override
+				public void configure(WebSocketServletFactory factory) {
+					factory.setCreator(new WebSocketCreator() {
+						@Override
+						public Object createWebSocket(UpgradeRequest req, UpgradeResponse resp) {
+
+							if (!CollectionUtils.isEmpty(req.getSubProtocols())) {
+								resp.setAcceptedSubProtocol(req.getSubProtocols().get(0));
+							}
+
+							JettyWebSocketSessionAdapter session = new JettyWebSocketSessionAdapter();
+							return new JettyWebSocketListenerAdapter(webSocketHandler, session);
+						}
+					});
+				}
+			});
+		}
+
+		public void start() throws Exception {
+			this.server.start();
+		}
+
+		public void stop() throws Exception {
+			this.server.stop();
+		}
+	}
+
+}