/*******************************************************************************
* Copyright (c) 2012 Michael Mimo Moratti.
*
* Michael Mimo Moratti licenses this file to you 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 ch.mimo.netty.handler.codec.icap.socket;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.UnknownHostException;
import java.util.concurrent.Executor;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import org.jboss.netty.bootstrap.ClientBootstrap;
import org.jboss.netty.bootstrap.ServerBootstrap;
import org.jboss.netty.channel.Channel;
import org.jboss.netty.channel.ChannelFactory;
import org.jboss.netty.channel.ChannelFuture;
import org.jboss.netty.channel.SimpleChannelUpstreamHandler;
import org.jboss.netty.util.internal.ExecutorUtil;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import ch.mimo.netty.handler.codec.icap.AbstractJDKLoggerPreparation;
import ch.mimo.netty.handler.codec.icap.IcapChunkAggregator;
import ch.mimo.netty.handler.codec.icap.IcapChunkSeparator;
import ch.mimo.netty.handler.codec.icap.IcapClientCodec;
import ch.mimo.netty.handler.codec.icap.IcapRequestDecoder;
import ch.mimo.netty.handler.codec.icap.IcapRequestEncoder;
import ch.mimo.netty.handler.codec.icap.IcapResponseDecoder;
import ch.mimo.netty.handler.codec.icap.IcapResponseEncoder;
import ch.mimo.netty.handler.codec.icap.IcapServerCodec;
public abstract class AbstractSocketTest extends AbstractJDKLoggerPreparation {
protected boolean runTrickleTests;
private static final String RUN_TRICKLE_TESTS = "run.trickle.tests";
public enum PipelineType {
CLASSIC,
CODEC,
AGGREGATOR,
SEPARATOR_AGGREGATOR,
TRICKLE
}
private static ExecutorService executor;
private static final InetAddress LOCALHOST;
static {
InetAddress localhost = null;
try {
localhost = InetAddress.getLocalHost();
} catch (UnknownHostException e) {
try {
localhost = InetAddress.getByAddress(new byte[] { 127, 0, 0, 1 });
} catch (UnknownHostException e1) {
try {
localhost = InetAddress.getByAddress(new byte[] { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 });
} catch (UnknownHostException e2) {
System.err.println("Failed to get the localhost.");
e2.printStackTrace();
}
}
}
LOCALHOST = localhost;
}
// @BeforeClass
// public static void log() {
// System.setProperty("icap.test.output","true");
// }
@BeforeClass
public static void init() {
executor = Executors.newCachedThreadPool();
}
@AfterClass
public static void destroy() {
ExecutorUtil.terminate(executor);
}
@Before
public void evaluateRunTrickleTests() {
runTrickleTests = Boolean.valueOf(System.getProperty(RUN_TRICKLE_TESTS));
}
protected abstract ChannelFactory newServerSocketChannelFactory(Executor executor);
protected abstract ChannelFactory newClientSocketChannelFactory(Executor executor);
protected void runSocketTest(Handler serverHandler, Handler clientHandler, Object[] messages, PipelineType pipelineType) {
ServerBootstrap serverBootstrap = new ServerBootstrap(newServerSocketChannelFactory(executor));
ClientBootstrap clientBootstrap = new ClientBootstrap(newClientSocketChannelFactory(executor));
switch (pipelineType) {
case CLASSIC:
setupClassicPipeline(serverBootstrap,clientBootstrap,serverHandler,clientHandler);
break;
case AGGREGATOR:
setupClassicPipelineWithChunkAggregator(serverBootstrap,clientBootstrap,serverHandler,clientHandler);
break;
case SEPARATOR_AGGREGATOR:
setupClassicPipelineWithAggregatorAndSeparator(serverBootstrap,clientBootstrap,serverHandler,clientHandler);
break;
case CODEC:
setupCodecPipeline(serverBootstrap,clientBootstrap,serverHandler,clientHandler);
break;
case TRICKLE:
if(runTrickleTests) {
setupTricklePipeline(serverBootstrap,clientBootstrap,serverHandler,clientHandler);
} else {
setupClassicPipeline(serverBootstrap,clientBootstrap,serverHandler,clientHandler);
}
break;
default:
setupClassicPipeline(serverBootstrap,clientBootstrap,serverHandler,clientHandler);
break;
}
Channel serverChannel = serverBootstrap.bind(new InetSocketAddress(0));
int port = ((InetSocketAddress)serverChannel.getLocalAddress()).getPort();
ChannelFuture channelFuture = clientBootstrap.connect(new InetSocketAddress(LOCALHOST,port));
assertTrue(channelFuture.awaitUninterruptibly().isSuccess());
Channel clientChannel = channelFuture.getChannel();
for(Object message : messages) {
ChannelFuture requestFuture = clientChannel.write(message);
assertTrue(requestFuture.awaitUninterruptibly().isSuccess());
}
while(!clientHandler.isProcessed()) {
if(clientHandler.hasException()) {
break;
}
try {
Thread.sleep(1);
} catch (InterruptedException e) {
// NOOP
}
}
while(!serverHandler.isProcessed()) {
if(serverHandler.hasException()) {
break;
}
try {
Thread.sleep(1);
} catch (InterruptedException e) {
// NOOP
}
}
serverHandler.close();
clientHandler.close();
serverChannel.close().awaitUninterruptibly();
if(serverHandler.hasException()) {
serverHandler.getExceptionCause().printStackTrace();
fail("Server Handler has experienced an exception");
}
if(clientHandler.hasException()) {
clientHandler.getExceptionCause().printStackTrace();
fail("Server Handler has experienced an exception");
}
}
protected void setupClassicPipeline(ServerBootstrap serverBootstrap, ClientBootstrap clientBootstrap, Handler serverHandler, Handler clientHandler) {
serverBootstrap.getPipeline().addLast("decoder",new IcapRequestDecoder());
serverBootstrap.getPipeline().addLast("encoder",new IcapResponseEncoder());
serverBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)serverHandler);
clientBootstrap.getPipeline().addLast("encoder",new IcapRequestEncoder());
clientBootstrap.getPipeline().addLast("decoder",new IcapResponseDecoder());
clientBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)clientHandler);
}
protected void setupClassicPipelineWithChunkAggregator(ServerBootstrap serverBootstrap, ClientBootstrap clientBootstrap, Handler serverHandler, Handler clientHandler) {
serverBootstrap.getPipeline().addLast("decoder",new IcapRequestDecoder());
serverBootstrap.getPipeline().addLast("chunkAggregator",new IcapChunkAggregator(4012));
serverBootstrap.getPipeline().addLast("encoder",new IcapResponseEncoder());
serverBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)serverHandler);
clientBootstrap.getPipeline().addLast("encoder",new IcapRequestEncoder());
clientBootstrap.getPipeline().addLast("decoder",new IcapResponseDecoder());
clientBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)clientHandler);
}
protected void setupCodecPipeline(ServerBootstrap serverBootstrap, ClientBootstrap clientBootstrap, Handler serverHandler, Handler clientHandler) {
serverBootstrap.getPipeline().addLast("codec",new IcapServerCodec());
serverBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)serverHandler);
clientBootstrap.getPipeline().addLast("codec",new IcapClientCodec());
clientBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)clientHandler);
}
protected void setupTricklePipeline(ServerBootstrap serverBootstrap, ClientBootstrap clientBootstrap, Handler serverHandler, Handler clientHandler) {
serverBootstrap.getPipeline().addLast("decoder",new IcapRequestDecoder());
serverBootstrap.getPipeline().addLast("encoder",new IcapResponseEncoder());
serverBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)serverHandler);
clientBootstrap.getPipeline().addLast("trickle",new TrickleDownstreamHandler(20,3));
clientBootstrap.getPipeline().addLast("encoder",new IcapRequestEncoder());
clientBootstrap.getPipeline().addLast("decoder",new IcapResponseDecoder());
clientBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)clientHandler);
}
protected void setupClassicPipelineWithAggregatorAndSeparator(ServerBootstrap serverBootstrap, ClientBootstrap clientBootstrap, Handler serverHandler, Handler clientHandler) {
serverBootstrap.getPipeline().addLast("decoder",new IcapRequestDecoder());
serverBootstrap.getPipeline().addLast("chunkAggregator",new IcapChunkAggregator(4012));
serverBootstrap.getPipeline().addLast("encoder",new IcapResponseEncoder());
serverBootstrap.getPipeline().addLast("chunkSeparator",new IcapChunkSeparator(4012));
serverBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)serverHandler);
clientBootstrap.getPipeline().addLast("encoder",new IcapRequestEncoder());
clientBootstrap.getPipeline().addLast("chunkSeparator",new IcapChunkSeparator(4021));
clientBootstrap.getPipeline().addLast("decoder",new IcapResponseDecoder());
clientBootstrap.getPipeline().addLast("chunkAggregator",new IcapChunkAggregator(4012));
clientBootstrap.getPipeline().addLast("handler",(SimpleChannelUpstreamHandler)clientHandler);
}
}