/*
* Copyright 2011-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.springframework.data.redis.listener.adapter;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertSame;
import static org.mockito.Mockito.*;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.springframework.data.redis.connection.DefaultMessage;
import org.springframework.data.redis.connection.Message;
import org.springframework.data.redis.connection.MessageListener;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.SerializationException;
import org.springframework.data.redis.serializer.StringRedisSerializer;
/**
* Unit test for MessageListenerAdapter.
*
* @author Costin Leau
* @author Greg Turnquist
* @author Thomas Darimont
*/
public class MessageListenerTest {
private static final StringRedisSerializer serializer = new StringRedisSerializer();
private static final String CHANNEL = "some::test:";
private static final byte[] RAW_CHANNEL = serializer.serialize(CHANNEL);
private static final String PAYLOAD = "do re mi";
private static final byte[] RAW_PAYLOAD = serializer.serialize(PAYLOAD);
private static final Message STRING_MSG = new DefaultMessage(RAW_CHANNEL, RAW_PAYLOAD);
private MessageListenerAdapter adapter;
public static interface Delegate {
void handleMessage(String argument);
void customMethod(String arg);
void customMethodWithChannel(String arg, String channel);
}
@Mock private Delegate target;
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
this.adapter = new MessageListenerAdapter();
}
@Test
public void testThatWhenNoDelegateIsSuppliedTheDelegateIsAssumedToBeTheMessageListenerAdapterItself()
throws Exception {
assertSame(adapter, adapter.getDelegate());
}
@Test
public void testThatTheDefaultMessageHandlingMethodNameIsTheConstantDefault() throws Exception {
assertEquals(MessageListenerAdapter.ORIGINAL_DEFAULT_LISTENER_METHOD, adapter.getDefaultListenerMethod());
}
public void testAdapterWithListenerAndDefaultMessage() throws Exception {
MessageListener mock = mock(MessageListener.class);
MessageListenerAdapter adapter = new MessageListenerAdapter(mock) {
protected void handleListenerException(Throwable ex) {
throw new IllegalStateException(ex);
}
};
adapter.onMessage(STRING_MSG, null);
verify(mock).onMessage(STRING_MSG, null);
}
@Test
public void testRawMessage() throws Exception {
MessageListenerAdapter adapter = new MessageListenerAdapter(target);
adapter.afterPropertiesSet();
adapter.onMessage(STRING_MSG, null);
verify(target).handleMessage(PAYLOAD);
}
@Test
public void testCustomMethod() throws Exception {
MessageListenerAdapter adapter = new MessageListenerAdapter(target);
adapter.setDefaultListenerMethod("customMethod");
adapter.afterPropertiesSet();
adapter.onMessage(STRING_MSG, null);
verify(target).customMethod(PAYLOAD);
}
@Test
public void testCustomMethodWithAlternateConstructor() throws Exception {
MessageListenerAdapter adapter = new MessageListenerAdapter(target, "customMethod");
adapter.afterPropertiesSet();
adapter.onMessage(STRING_MSG, null);
verify(target).customMethod(PAYLOAD);
}
@Test
public void testCustomMethodWithChannel() throws Exception {
MessageListenerAdapter adapter = new MessageListenerAdapter(target);
adapter.setDefaultListenerMethod("customMethodWithChannel");
adapter.afterPropertiesSet();
adapter.onMessage(STRING_MSG, RAW_CHANNEL);
verify(target).customMethodWithChannel(PAYLOAD, CHANNEL);
}
@Test
public void testCustomMethodWithChannelAndAlternateConstructor() throws Exception {
MessageListenerAdapter adapter = new MessageListenerAdapter(target, "customMethodWithChannel");
adapter.afterPropertiesSet();
adapter.onMessage(STRING_MSG, RAW_CHANNEL);
verify(target).customMethodWithChannel(PAYLOAD, CHANNEL);
}
@Test // DATAREDIS-92
public void triggersListenerImplementingInterfaceCorrectly() {
SampleListener listener = new SampleListener();
MessageListener listenerAdapter = new MessageListenerAdapter(listener) {
@Override
public void setDefaultListenerMethod(String defaultListenerMethod) {
throw new RuntimeException("Boom!");
}
};
listenerAdapter.onMessage(STRING_MSG, RAW_CHANNEL);
assertEquals(1, listener.count);
}
@Test // DATAREDIS-337
public void defaultConcreteHandlerMethodShouldOnlyBeInvokedOnce() {
ConcreteMessageHandler listener = spy(new ConcreteMessageHandler());
MessageListenerAdapter adapter = new MessageListenerAdapter(listener);
adapter.afterPropertiesSet();
adapter.onMessage(new DefaultMessage("channel1".getBytes(), "body".getBytes()), "".getBytes());
verify(listener, times(1)).handleMessage(anyString(), anyString());
}
@Test // DATAREDIS-337
public void defaultConcreteHandlerMethodWithoutSerializerShouldOnlyBeInvokedOnce() {
ConcreteMessageHandler listener = spy(new ConcreteMessageHandler());
MessageListenerAdapter adapter = new MessageListenerAdapter(listener);
adapter.setSerializer(null);
adapter.afterPropertiesSet();
adapter.onMessage(new DefaultMessage("channel1".getBytes(), "body".getBytes()), "".getBytes());
verify(listener, times(1)).handleMessage(any(byte[].class), anyString());
}
@Test // DATAREDIS-337
public void defaultConcreteHandlerMethodWithCustomSerializerShouldOnlyBeInvokedOnce() {
ConcreteMessageHandler listener = spy(new ConcreteMessageHandler());
MessageListenerAdapter adapter = new MessageListenerAdapter(listener);
adapter.setSerializer(new PojoRedisSerializer());
adapter.afterPropertiesSet();
adapter.onMessage(new DefaultMessage(new byte[0], "body".getBytes()), "".getBytes());
verify(listener, times(1)).handleMessage(any(Pojo.class), anyString());
}
@Test // DATAREDIS-337
public void customConcreteHandlerMethodShouldOnlyBeInvokedOnce() {
ConcreteMessageHandler listener = spy(new ConcreteMessageHandler());
MessageListenerAdapter adapter = new MessageListenerAdapter(listener);
adapter.setDefaultListenerMethod("handle");
adapter.afterPropertiesSet();
adapter.onMessage(new DefaultMessage("channel1".getBytes(), "body".getBytes()), "".getBytes());
verify(listener, times(1)).handle(anyString(), anyString());
}
@Test // DATAREDIS-337
public void customConcreteMessageOnlyHandlerMethodShouldOnlyBeInvokedOnce() {
ConcreteMessageHandler listener = spy(new ConcreteMessageHandler());
MessageListenerAdapter adapter = new MessageListenerAdapter(listener);
adapter.setDefaultListenerMethod("handleMessageOnly");
adapter.afterPropertiesSet();
adapter.onMessage(new DefaultMessage("channel1".getBytes(), "body".getBytes()), "".getBytes());
verify(listener, times(1)).handleMessageOnly(anyString());
}
@Test // DATAREDIS-337
public void customConcreteHandlerMethodWithoutSerializerShouldOnlyBeInvokedOnce() {
ConcreteMessageHandler listener = spy(new ConcreteMessageHandler());
MessageListenerAdapter adapter = new MessageListenerAdapter(listener);
adapter.setDefaultListenerMethod("handle");
adapter.setSerializer(null);
adapter.afterPropertiesSet();
adapter.onMessage(new DefaultMessage("channel1".getBytes(), "body".getBytes()), "".getBytes());
verify(listener, times(1)).handle(any(byte[].class), anyString());
}
@Test // DATAREDIS-337
public void customConcreteHandlerMethodWithCustomSerializerShouldOnlyBeInvokedOnce() {
ConcreteMessageHandler listener = spy(new ConcreteMessageHandler());
MessageListenerAdapter adapter = new MessageListenerAdapter(listener);
adapter.setDefaultListenerMethod("handle");
adapter.setSerializer(new PojoRedisSerializer());
adapter.afterPropertiesSet();
adapter.onMessage(new DefaultMessage(new byte[0], "body".getBytes()), "".getBytes());
verify(listener, times(1)).handle(any(Pojo.class), anyString());
}
class SampleListener implements MessageListener {
int count;
public void onMessage(Message message, byte[] pattern) {
count++;
}
}
/**
* @author Thomas Darimont
*/
static class AbstractMessageHandler {
public void handleMessage(Pojo message, String channel) {}
public void handleMessage(byte[] message, String channel) {}
public void handleMessage(String message, String channel) {}
public void handle(Pojo message, String channel) {}
public void handle(String message, String channel) {}
public void handle(byte[] message, String channel) {}
public void handleMessageOnly(String message) {}
}
/**
* @author Thomas Darimont
*/
static class ConcreteMessageHandler extends AbstractMessageHandler {
public void handleMessage(Pojo message, String channel) {}
public void handleMessage(byte[] message, String channel) {}
public void handleMessage(String message, String channel) {}
public void handle(Pojo message, String channel) {}
public void handle(String message, String channel) {}
public void handle(byte[] message, String channel) {}
public void handleMessageOnly(String message) {}
}
static class Pojo {}
static class PojoRedisSerializer implements RedisSerializer<Pojo> {
@Override
public byte[] serialize(Pojo t) throws SerializationException {
return new byte[0];
}
@Override
public Pojo deserialize(byte[] bytes) throws SerializationException {
return new Pojo();
}
}
}