changeset 629:bc879863f84e

Add tests for command channel client bits. This attempts to make sure fireComplete() events are properly delivered. There is one unit test verifying that an exception event is passed on in RequestEncoder. Another test is to ensure fireComplete() is called in ResponseHandler. Reviewed-by: neugens Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2012-September/003261.html
author Severin Gehwolf <sgehwolf@redhat.com>
date Tue, 18 Sep 2012 15:23:50 +0200
parents b3f8bfcea78b
children fda64c331b67
files client/command/src/main/java/com/redhat/thermostat/client/command/internal/RequestEncoder.java client/command/src/test/java/com/redhat/thermostat/client/command/internal/RequestEncoderTest.java client/command/src/test/java/com/redhat/thermostat/client/command/internal/ResponseHandlerTest.java
diffstat 3 files changed, 187 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/client/command/src/main/java/com/redhat/thermostat/client/command/internal/RequestEncoder.java	Wed Sep 19 13:11:57 2012 +0200
+++ b/client/command/src/main/java/com/redhat/thermostat/client/command/internal/RequestEncoder.java	Tue Sep 18 15:23:50 2012 +0200
@@ -36,7 +36,12 @@
 
 package com.redhat.thermostat.client.command.internal;
 
+import static org.jboss.netty.buffer.ChannelBuffers.dynamicBuffer;
+import static org.jboss.netty.buffer.ChannelBuffers.wrappedBuffer;
+
 import java.util.Collection;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 import org.jboss.netty.buffer.ChannelBuffer;
 import org.jboss.netty.channel.ChannelHandlerContext;
@@ -48,11 +53,10 @@
 import com.redhat.thermostat.common.command.MessageEncoder;
 import com.redhat.thermostat.common.command.Request;
 
-import static org.jboss.netty.buffer.ChannelBuffers.dynamicBuffer;
-import static org.jboss.netty.buffer.ChannelBuffers.wrappedBuffer;
-
 class RequestEncoder extends MessageEncoder {
 
+    private static final Logger logger = Logger.getLogger(RequestEncoder.class.getName());
+    
     @Override
     public void writeRequested(ChannelHandlerContext ctx, MessageEvent e) {
 
@@ -76,11 +80,12 @@
         ChannelBuffer buf = wrappedBuffer(typeBuffer, parmsBuffer);
         Channels.write(ctx, e.getFuture(), buf);
     }
-
+    
     // This must be implemented, even though we are simply passing on the exception.  If
     // not implemented, this exception ends up going uncaught which causes problems.
     @Override
     public void exceptionCaught(ChannelHandlerContext ctx, ExceptionEvent e) {
-    	Channels.fireExceptionCaught(ctx, e.getCause());
+        logger.log(Level.WARNING, "Forwarding exception ", e.getCause());
+        Channels.fireExceptionCaught(ctx, e.getCause());
     }
 }
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/client/command/src/test/java/com/redhat/thermostat/client/command/internal/RequestEncoderTest.java	Tue Sep 18 15:23:50 2012 +0200
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2012 Red Hat, Inc.
+ *
+ * This file is part of Thermostat.
+ *
+ * Thermostat is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published
+ * by the Free Software Foundation; either version 2, or (at your
+ * option) any later version.
+ *
+ * Thermostat is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Thermostat; see the file COPYING.  If not see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * Linking this code with other modules is making a combined work
+ * based on this code.  Thus, the terms and conditions of the GNU
+ * General Public License cover the whole combination.
+ *
+ * As a special exception, the copyright holders of this code give
+ * you permission to link this code with independent modules to
+ * produce an executable, regardless of the license terms of these
+ * independent modules, and to copy and distribute the resulting
+ * executable under terms of your choice, provided that you also
+ * meet, for each linked independent module, the terms and conditions
+ * of the license of that module.  An independent module is a module
+ * which is not derived from or based on this code.  If you modify
+ * this code, you may extend this exception to your version of the
+ * library, but you are not obligated to do so.  If you do not wish
+ * to do so, delete this exception statement from your version.
+ */
+
+package com.redhat.thermostat.client.command.internal;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import static org.mockito.Matchers.isA;
+
+import org.jboss.netty.channel.Channel;
+import org.jboss.netty.channel.ChannelHandlerContext;
+import org.jboss.netty.channel.ExceptionEvent;
+import org.junit.Test;
+
+public class RequestEncoderTest {
+
+    /**
+     * This test verifies that exception events are forwarded upstream. This is to ensure that
+     * fireComplete() events get delivered in case of Exceptions.
+     * 
+     * @throws Exception
+     */
+    @Test
+    public void exceptionCaughtCallsFireComplete() throws Exception {
+        RequestEncoder encoder = new RequestEncoder();
+        ChannelHandlerContext ctx = mock(ChannelHandlerContext.class);
+        ExceptionEvent evt = mock(ExceptionEvent.class);
+        when(evt.getCause()).thenReturn(new Exception());
+        Channel channel = mock(Channel.class);
+        when(ctx.getChannel()).thenReturn(channel);
+        encoder.exceptionCaught(ctx, evt);
+        // Channels.fireExceptionCaught implicitly calls this
+        verify(ctx).sendUpstream(isA(ExceptionEvent.class));
+    }
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/client/command/src/test/java/com/redhat/thermostat/client/command/internal/ResponseHandlerTest.java	Tue Sep 18 15:23:50 2012 +0200
@@ -0,0 +1,108 @@
+/*
+ * Copyright 2012 Red Hat, Inc.
+ *
+ * This file is part of Thermostat.
+ *
+ * Thermostat is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published
+ * by the Free Software Foundation; either version 2, or (at your
+ * option) any later version.
+ *
+ * Thermostat is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Thermostat; see the file COPYING.  If not see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * Linking this code with other modules is making a combined work
+ * based on this code.  Thus, the terms and conditions of the GNU
+ * General Public License cover the whole combination.
+ *
+ * As a special exception, the copyright holders of this code give
+ * you permission to link this code with independent modules to
+ * produce an executable, regardless of the license terms of these
+ * independent modules, and to copy and distribute the resulting
+ * executable under terms of your choice, provided that you also
+ * meet, for each linked independent module, the terms and conditions
+ * of the license of that module.  An independent module is a module
+ * which is not derived from or based on this code.  If you modify
+ * this code, you may extend this exception to your version of the
+ * library, but you are not obligated to do so.  If you do not wish
+ * to do so, delete this exception statement from your version.
+ */
+
+package com.redhat.thermostat.client.command.internal;
+
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.jboss.netty.channel.Channel;
+import org.jboss.netty.channel.ChannelHandlerContext;
+import org.jboss.netty.channel.ChannelPipeline;
+import org.jboss.netty.channel.ExceptionEvent;
+import org.jboss.netty.channel.MessageEvent;
+import org.junit.Test;
+
+import com.redhat.thermostat.common.command.Request;
+import com.redhat.thermostat.common.command.RequestResponseListener;
+import com.redhat.thermostat.common.command.Response;
+import com.redhat.thermostat.common.command.Response.ResponseType;
+
+public class ResponseHandlerTest {
+
+    @Test
+    public void messageReceivedCallsFireComplete() throws Exception {
+        Request req = mock(Request.class);
+        List<RequestResponseListener> listeners = new ArrayList<>();
+        ResponseListenerFixture fixture = new ResponseListenerFixture();
+        listeners.add(fixture);
+        when(req.getListeners()).thenReturn(listeners);
+        ResponseHandler handler = new ResponseHandler(req);
+        ChannelHandlerContext ctxt = mock(ChannelHandlerContext.class);
+        ChannelPipeline pipeline = mock(ChannelPipeline.class);
+        when(ctxt.getPipeline()).thenReturn(pipeline);
+        Channel channel = mock(Channel.class);
+        MessageEvent e = mock(MessageEvent.class);
+        when(e.getChannel()).thenReturn(channel);
+        Response response = mock(Response.class);
+        when(response.getType()).thenReturn(ResponseType.OK);
+        when(e.getMessage()).thenReturn(response);
+        
+        handler.messageReceived(ctxt, e);
+        assertTrue(fixture.isCalled());
+    }
+    
+    @Test
+    public void exceptionCaughtCallsFireComplete() throws Exception {
+        Request req = mock(Request.class);
+        List<RequestResponseListener> listeners = new ArrayList<>();
+        ResponseListenerFixture fixture = new ResponseListenerFixture();
+        listeners.add(fixture);
+        when(req.getListeners()).thenReturn(listeners);
+        ResponseHandler handler = new ResponseHandler(req);
+        handler.exceptionCaught(mock(ChannelHandlerContext.class), mock(ExceptionEvent.class));
+        assertTrue(fixture.isCalled());
+    }
+    
+    private class ResponseListenerFixture implements RequestResponseListener {
+
+        public boolean called = false;
+        
+        public boolean isCalled() {
+            return called;
+        }
+
+        @Override
+        public void fireComplete(Request request, Response response) {
+            called = true;
+        }
+        
+    }
+}