/*
* Copyright (c) 2008-2017 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.cometd.tests;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import javax.websocket.ContainerProvider;
import javax.websocket.WebSocketContainer;
import org.cometd.bayeux.server.BayeuxServer;
import org.cometd.client.BayeuxClient;
import org.cometd.client.transport.ClientTransport;
import org.cometd.client.transport.LongPollingTransport;
import org.cometd.server.BayeuxServerImpl;
import org.cometd.server.CometDServlet;
import org.cometd.server.transport.AsyncJSONTransport;
import org.cometd.server.transport.JSONTransport;
import org.cometd.websocket.client.JettyWebSocketTransport;
import org.cometd.websocket.client.WebSocketTransport;
import org.eclipse.jetty.client.HttpClient;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.ServerConnector;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.servlet.ServletHolder;
import org.eclipse.jetty.util.component.LifeCycle;
import org.eclipse.jetty.websocket.client.WebSocketClient;
import org.eclipse.jetty.websocket.client.masks.ZeroMasker;
import org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer;
import org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter;
import org.junit.After;
import org.junit.Rule;
import org.junit.rules.TestWatcher;
import org.junit.runner.Description;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
@RunWith(Parameterized.class)
public abstract class AbstractClientServerTest {
@Parameterized.Parameters(name = "{0}")
public static Object[] data() {
return Transport.values();
}
@Rule
public final TestWatcher testName = new TestWatcher() {
@Override
protected void starting(Description description) {
super.starting(description);
System.err.printf("Running %s.%s%n", description.getTestClass().getName(), description.getMethodName());
}
};
private final Transport transport;
protected Server server;
protected ServerConnector connector;
protected ServletContextHandler context;
protected String cometdServletPath;
protected String cometdURL;
protected BayeuxServer bayeux;
private ScheduledExecutorService scheduler;
private HttpClient httpClient;
private WebSocketContainer wsContainer;
private WebSocketClient wsClient;
protected AbstractClientServerTest(Transport transport) {
this.transport = transport;
this.cometdServletPath = "/cometd";
}
public void startServer(Map<String, String> initParams) throws Exception {
server = new Server();
connector = new ServerConnector(server);
connector.setIdleTimeout(30000);
server.addConnector(connector);
context = new ServletContextHandler(server, "/");
switch (transport) {
case JAVAX_WEBSOCKET:
WebSocketServerContainerInitializer.configureContext(context);
break;
case JETTY_WEBSOCKET:
WebSocketUpgradeFilter.configureContext(context);
break;
default:
break;
}
// CometD servlet
ServletHolder cometdServletHolder = new ServletHolder(CometDServlet.class);
cometdServletHolder.setInitParameter("timeout", "10000");
cometdServletHolder.setInitOrder(1);
if (initParams != null) {
for (Map.Entry<String, String> entry : initParams.entrySet()) {
cometdServletHolder.setInitParameter(entry.getKey(), entry.getValue());
}
}
context.addServlet(cometdServletHolder, cometdServletPath + "/*");
server.start();
int port = connector.getLocalPort();
cometdURL = "http://localhost:" + port + cometdServletPath;
bayeux = (BayeuxServer)context.getServletContext().getAttribute(BayeuxServer.ATTRIBUTE);
startClient();
}
protected void startClient() throws Exception {
scheduler = Executors.newSingleThreadScheduledExecutor();
switch (transport) {
case LONG_POLLING:
case ASYNC_LONG_POLLING:
httpClient = new HttpClient();
httpClient.start();
break;
case JAVAX_WEBSOCKET:
wsContainer = ContainerProvider.getWebSocketContainer();
break;
case JETTY_WEBSOCKET:
wsClient = new WebSocketClient();
wsClient.setMasker(new ZeroMasker());
wsClient.start();
break;
default:
throw new IllegalArgumentException();
}
}
protected Map<String, String> serverOptions() {
Map<String, String> options = new HashMap<>();
options.put(BayeuxServerImpl.TRANSPORTS_OPTION, serverTransport());
options.put("ws.cometdURLMapping", cometdServletPath + "/*");
return options;
}
protected String serverTransport() {
switch (transport) {
case LONG_POLLING:
return JSONTransport.class.getName();
case ASYNC_LONG_POLLING:
return AsyncJSONTransport.class.getName();
case JAVAX_WEBSOCKET:
return org.cometd.websocket.server.WebSocketTransport.class.getName();
case JETTY_WEBSOCKET:
return org.cometd.websocket.server.JettyWebSocketTransport.class.getName();
default:
throw new IllegalArgumentException();
}
}
protected BayeuxClient newBayeuxClient() {
return new BayeuxClient(cometdURL, newClientTransport(null));
}
protected ClientTransport newClientTransport(Map<String, Object> options) {
switch (transport) {
case LONG_POLLING:
case ASYNC_LONG_POLLING:
return new LongPollingTransport(options, httpClient);
case JAVAX_WEBSOCKET:
return new WebSocketTransport(options, scheduler, wsContainer);
case JETTY_WEBSOCKET:
return new JettyWebSocketTransport(options, scheduler, wsClient);
default:
throw new IllegalArgumentException();
}
}
protected void disconnectBayeuxClient(BayeuxClient client) {
client.disconnect(1000);
}
@After
public void dispose() throws Exception {
stopClient();
if (server != null) {
server.stop();
}
}
private void stopClient() throws Exception {
if (wsClient != null) {
wsClient.stop();
}
if (wsContainer instanceof LifeCycle) {
((LifeCycle)wsContainer).stop();
}
if (httpClient != null) {
httpClient.stop();
}
}
public enum Transport {
LONG_POLLING, ASYNC_LONG_POLLING, JAVAX_WEBSOCKET, JETTY_WEBSOCKET
}
}