From 265f24eb2a14ec15f397501212cb7eb887cc1f26 Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Fri, 1 Mar 2019 14:13:11 -0500 Subject: Add various listener classes Added various listener classes to support dispatch by message type and request id. The listeners are intended to form a pipeline: TopicSource => MessageTypeDispatcher => RequestIdDispatcher => TypedMessageListener Removed "PAP" from license. Changed "handler" to "listener" in most places. Simplified a test case. Verified that no error message logged on success cases. Removed println from test. Updated some comments. Change-Id: Ife265d14a6c5c8531601d9ce1343b88c1f8986a8 Issue-ID: POLICY-1444 Signed-off-by: Jim Hahn --- .../endpoints/listeners/JsonListenerTest.java | 120 ++++++++ .../listeners/MessageTypeDispatcherTest.java | 180 ++++++++++++ .../listeners/RequestIdDispatcherTest.java | 309 +++++++++++++++++++++ .../endpoints/listeners/ScoListenerTest.java | 194 +++++++++++++ 4 files changed, 803 insertions(+) create mode 100644 policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/JsonListenerTest.java create mode 100644 policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/MessageTypeDispatcherTest.java create mode 100644 policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/RequestIdDispatcherTest.java create mode 100644 policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/ScoListenerTest.java (limited to 'policy-endpoints/src/test/java/org/onap') diff --git a/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/JsonListenerTest.java b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/JsonListenerTest.java new file mode 100644 index 00000000..39fc9d8f --- /dev/null +++ b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/JsonListenerTest.java @@ -0,0 +1,120 @@ +/* + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.endpoints.listeners; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import static org.mockito.Matchers.any; +import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.Logger; +import org.junit.After; +import org.junit.AfterClass; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; +import org.onap.policy.common.utils.coder.StandardCoderObject; +import org.onap.policy.common.utils.test.log.logback.ExtractAppender; +import org.slf4j.LoggerFactory; + +public class JsonListenerTest { + + /** + * Used to attach an appender to the class' logger. + */ + private static final Logger logger = (Logger) LoggerFactory.getLogger(JsonListener.class); + private static final ExtractAppender appender = new ExtractAppender(); + + /** + * Original logging level for the logger. + */ + private static Level saveLevel; + + private static final CommInfrastructure INFRA = CommInfrastructure.NOOP; + private static final String TOPIC = "my-topic"; + private static final String JSON = "{'abc':'def'}".replace('\'', '"'); + + private JsonListener primary; + + /** + * Initializes statics. + */ + @BeforeClass + public static void setUpBeforeClass() { + saveLevel = logger.getLevel(); + logger.setLevel(Level.INFO); + + appender.setContext(logger.getLoggerContext()); + appender.start(); + } + + @AfterClass + public static void tearDownAfterClass() { + logger.setLevel(saveLevel); + appender.stop(); + } + + /** + * Initializes mocks and a listener. + */ + @Before + public void setUp() { + appender.clearExtractions(); + + primary = new JsonListener() { + @Override + public void onTopicEvent(CommInfrastructure infra, String topic, StandardCoderObject sco) {} + }; + } + + @After + public void tearDown() { + logger.detachAppender(appender); + } + + @Test + public void testOnTopicEvent() { + logger.addAppender(appender); + + primary = spy(primary); + + // success + primary.onTopicEvent(INFRA, TOPIC, JSON); + verify(primary).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + + // repeat + primary.onTopicEvent(INFRA, TOPIC, JSON); + verify(primary, times(2)).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + + assertFalse(appender.getExtracted().toString().contains("unable to decode")); + + // invalid json - decode fails + appender.clearExtractions(); + primary.onTopicEvent(INFRA, TOPIC, "["); + assertTrue(appender.getExtracted().toString().contains("unable to decode")); + verify(primary, times(2)).onTopicEvent(any(), any(), any(StandardCoderObject.class)); + } +} diff --git a/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/MessageTypeDispatcherTest.java b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/MessageTypeDispatcherTest.java new file mode 100644 index 00000000..0edcfe12 --- /dev/null +++ b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/MessageTypeDispatcherTest.java @@ -0,0 +1,180 @@ +/* + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.endpoints.listeners; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import static org.mockito.Matchers.any; +import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.Logger; +import org.junit.After; +import org.junit.AfterClass; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; +import org.onap.policy.common.endpoints.listeners.MessageTypeDispatcher; +import org.onap.policy.common.endpoints.listeners.ScoListener; +import org.onap.policy.common.utils.coder.StandardCoderObject; +import org.onap.policy.common.utils.test.log.logback.ExtractAppender; +import org.slf4j.LoggerFactory; + +public class MessageTypeDispatcherTest { + + /** + * Used to attach an appender to the class' logger. + */ + private static final Logger logger = (Logger) LoggerFactory.getLogger(MessageTypeDispatcher.class); + private static final ExtractAppender appender = new ExtractAppender(); + + /** + * Original logging level for the logger. + */ + private static Level saveLevel; + + private static final CommInfrastructure INFRA = CommInfrastructure.NOOP; + private static final String TYPE_FIELD = "msg-type"; + private static final String TOPIC = "my-topic"; + private static final String TYPE1 = "msg-type-1"; + private static final String TYPE2 = "msg-type-2"; + + private MessageTypeDispatcher primary; + + private ScoListener secondary1; + private ScoListener secondary2; + + /** + * Initializes statics. + */ + @BeforeClass + public static void setUpBeforeClass() { + saveLevel = logger.getLevel(); + logger.setLevel(Level.INFO); + + appender.setContext(logger.getLoggerContext()); + appender.start(); + } + + @AfterClass + public static void tearDownAfterClass() { + logger.setLevel(saveLevel); + appender.stop(); + } + + /** + * Initializes mocks and a listener. + */ + @Before + @SuppressWarnings("unchecked") + public void setUp() { + appender.clearExtractions(); + + secondary1 = mock(ScoListener.class); + secondary2 = mock(ScoListener.class); + + primary = new MessageTypeDispatcher(TYPE_FIELD); + } + + @After + public void tearDown() { + logger.detachAppender(appender); + } + + @Test + public void testRegister_testUnregister() { + primary.register(TYPE1, secondary1); + primary.register(TYPE2, secondary2); + + primary.onTopicEvent(INFRA, TOPIC, makeMessage(TYPE1)); + verify(secondary1).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + verify(secondary2, never()).onTopicEvent(any(), any(), any()); + + primary.onTopicEvent(INFRA, TOPIC, makeMessage(TYPE1)); + verify(secondary1, times(2)).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + verify(secondary2, never()).onTopicEvent(any(), any(), any()); + + primary.unregister(TYPE1); + primary.onTopicEvent(INFRA, TOPIC, makeMessage(TYPE1)); + verify(secondary1, times(2)).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + verify(secondary2, never()).onTopicEvent(any(), any(), any()); + + primary.onTopicEvent(INFRA, TOPIC, makeMessage(TYPE2)); + verify(secondary1, times(2)).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + verify(secondary2).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + + // unregister again + primary.unregister(TYPE1); + + // unregister second type + primary.unregister(TYPE2); + primary.onTopicEvent(INFRA, TOPIC, makeMessage(TYPE1)); + primary.onTopicEvent(INFRA, TOPIC, makeMessage(TYPE2)); + verify(secondary1, times(2)).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + verify(secondary2, times(1)).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + } + + @Test + public void testOnTopicEvent() { + primary.register(TYPE1, secondary1); + + logger.addAppender(appender); + + // success + primary.onTopicEvent(INFRA, TOPIC, makeMessage(TYPE1)); + verify(secondary1).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + + // repeat + primary.onTopicEvent(INFRA, TOPIC, makeMessage(TYPE1)); + verify(secondary1, times(2)).onTopicEvent(eq(INFRA), eq(TOPIC), any(StandardCoderObject.class)); + + assertFalse(appender.getExtracted().toString().contains("unable to extract")); + assertFalse(appender.getExtracted().toString().contains("discarding event of type")); + + // no message type + appender.clearExtractions(); + primary.onTopicEvent(INFRA, TOPIC, "{}"); + assertTrue(appender.getExtracted().toString().contains("unable to extract")); + verify(secondary1, times(2)).onTopicEvent(any(), any(), any()); + + // unknown type + appender.clearExtractions(); + primary.onTopicEvent(INFRA, TOPIC, makeMessage(TYPE2)); + assertTrue(appender.getExtracted().toString().contains("discarding event of type")); + verify(secondary1, times(2)).onTopicEvent(any(), any(), any()); + } + + /** + * Makes a JSON message of the given type. + * + * @param msgType the message type + * @return a JSON message of the given type + */ + private String makeMessage(String msgType) { + String json = "{'" + TYPE_FIELD + "':'" + msgType + "', 'abc':'def'}"; + return json.replace('\'', '"'); + } +} diff --git a/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/RequestIdDispatcherTest.java b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/RequestIdDispatcherTest.java new file mode 100644 index 00000000..6115a57e --- /dev/null +++ b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/RequestIdDispatcherTest.java @@ -0,0 +1,309 @@ +/* + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.endpoints.listeners; + +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.Logger; +import org.junit.After; +import org.junit.AfterClass; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; +import org.onap.policy.common.utils.coder.Coder; +import org.onap.policy.common.utils.coder.CoderException; +import org.onap.policy.common.utils.coder.StandardCoder; +import org.onap.policy.common.utils.coder.StandardCoderObject; +import org.onap.policy.common.utils.test.log.logback.ExtractAppender; +import org.slf4j.LoggerFactory; + +public class RequestIdDispatcherTest { + + /** + * Used to attach an appender to the class' logger. + */ + private static final Logger logger = (Logger) LoggerFactory.getLogger(RequestIdDispatcher.class); + private static final ExtractAppender appender = new ExtractAppender(); + + /** + * Original logging level for the logger. + */ + private static Level saveLevel; + + private static final CommInfrastructure INFRA = CommInfrastructure.NOOP; + private static final String REQID_FIELD = "requestId"; + private static final String TOPIC = "my-topic"; + private static final String REQID1 = "request-1"; + private static final String REQID2 = "request-2"; + + private static final Coder coder = new StandardCoder(); + + private RequestIdDispatcher primary; + private TypedMessageListener secondary1; + private TypedMessageListener secondary2; + private TypedMessageListener secondary3; + private TypedMessageListener secondary4; + private MyMessage status; + + /** + * Initializes statics. + */ + @BeforeClass + public static void setUpBeforeClass() { + saveLevel = logger.getLevel(); + logger.setLevel(Level.INFO); + + appender.setContext(logger.getLoggerContext()); + appender.start(); + } + + @AfterClass + public static void tearDownAfterClass() { + logger.setLevel(saveLevel); + appender.stop(); + } + + /** + * Create various mocks and primary listener. + */ + @SuppressWarnings("unchecked") + @Before + public void setUp() { + appender.clearExtractions(); + + secondary1 = mock(TypedMessageListener.class); + secondary2 = mock(TypedMessageListener.class); + secondary3 = mock(TypedMessageListener.class); + secondary4 = mock(TypedMessageListener.class); + + primary = new RequestIdDispatcher<>(MyMessage.class, REQID_FIELD); + } + + @After + public void tearDown() { + logger.detachAppender(appender); + } + + @Test + public void testRegisterMessageListener() { + primary.register(secondary1); + + // should process message that does not have a request id + status = new MyMessage(); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + // should process again + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1, times(2)).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + // should NOT process a message that has a request id + status = new MyMessage(REQID1); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1, never()).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + } + + @Test + public void testRegisterStringMessageListener() { + primary.register(REQID1, secondary1); + + // should NOT process message that does not have a request id + status = new MyMessage(); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1, never()).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + // should process a message that has the desired request id + status = new MyMessage(REQID1); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + // should process again + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1, times(2)).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + // should NOT process a message that does NOT have the desired request id + status = new MyMessage(REQID2); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1, never()).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + // null request id => exception + assertThatIllegalArgumentException().isThrownBy(() -> primary.register(null, secondary1)); + + // empty request id => exception + assertThatIllegalArgumentException().isThrownBy(() -> primary.register("", secondary1)); + } + + @Test + public void testUnregisterMessageListener() { + primary.register(secondary1); + primary.register(secondary2); + + // should process message + status = new MyMessage(); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + verify(secondary2).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + primary.unregister(secondary1); + + // should NOT process again + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1, times(1)).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + // other listener should still have processed it + verify(secondary2, times(2)).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + } + + @Test + public void testUnregisterString() { + primary.register(REQID1, secondary1); + primary.register(REQID2, secondary2); + + // should process a message that has the desired request id + status = new MyMessage(REQID1); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + primary.unregister(REQID1); + + // should NOT re-process + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1, times(1)).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + // secondary should still be able to process + status = new MyMessage(REQID2); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary2).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + } + + @Test + public void testOnTopicEvent() { + primary.register(REQID1, secondary1); + primary.register(REQID2, secondary2); + primary.register(secondary3); + primary.register(secondary4); + + // without request id + status = new MyMessage(); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1, never()).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + verify(secondary2, never()).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + verify(secondary3).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + verify(secondary4).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + + // with request id + status = new MyMessage(REQID1); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + verify(secondary1).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + verify(secondary2, never()).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + verify(secondary3, never()).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + verify(secondary4, never()).onTopicEvent(eq(INFRA), eq(TOPIC), eq(status)); + } + + @Test + public void testOfferToListener() { + logger.addAppender(appender); + + // no listener for this + status = new MyMessage(REQID1); + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + + assertFalse(appender.getExtracted().toString().contains("failed to process message")); + + // listener throws an exception + primary.register(secondary1); + + status = new MyMessage(); + + RuntimeException ex = new RuntimeException("expected exception"); + doThrow(ex).when(secondary1).onTopicEvent(INFRA, TOPIC, status); + + primary.onTopicEvent(INFRA, TOPIC, makeSco(status)); + assertTrue(appender.getExtracted().toString().contains("failed to process message")); + } + + /** + * Makes a standard object from a status message. + * + * @param source message to be converted + * @return a standard object representing the message + */ + private StandardCoderObject makeSco(MyMessage source) { + try { + return coder.toStandard(source); + + } catch (CoderException e) { + throw new RuntimeException(e); + } + } + + protected static class MyMessage { + private String requestId; + + public MyMessage() { + super(); + } + + public MyMessage(String requestId) { + this.requestId = requestId; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((requestId == null) ? 0 : requestId.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + MyMessage other = (MyMessage) obj; + if (requestId == null) { + if (other.requestId != null) { + return false; + } + } else if (!requestId.equals(other.requestId)) { + return false; + } + return true; + } + } +} diff --git a/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/ScoListenerTest.java b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/ScoListenerTest.java new file mode 100644 index 00000000..0749f891 --- /dev/null +++ b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/listeners/ScoListenerTest.java @@ -0,0 +1,194 @@ +/* + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.endpoints.listeners; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.Logger; +import org.junit.After; +import org.junit.AfterClass; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; +import org.onap.policy.common.utils.coder.Coder; +import org.onap.policy.common.utils.coder.CoderException; +import org.onap.policy.common.utils.coder.StandardCoder; +import org.onap.policy.common.utils.coder.StandardCoderObject; +import org.onap.policy.common.utils.test.log.logback.ExtractAppender; +import org.slf4j.LoggerFactory; + +public class ScoListenerTest { + + /** + * Used to attach an appender to the class' logger. + */ + private static final Logger logger = (Logger) LoggerFactory.getLogger(ScoListener.class); + private static final ExtractAppender appender = new ExtractAppender(); + + /** + * Original logging level for the logger. + */ + private static Level saveLevel; + + private static final CommInfrastructure INFRA = CommInfrastructure.NOOP; + private static final String TOPIC = "my-topic"; + private static final String NAME = "pdp_1"; + + private static final Coder coder = new StandardCoder(); + + private ScoListener primary; + private MyMessage status; + private StandardCoderObject sco; + + /** + * Initializes statics. + */ + @BeforeClass + public static void setUpBeforeClass() { + saveLevel = logger.getLevel(); + logger.setLevel(Level.INFO); + + appender.setContext(logger.getLoggerContext()); + appender.start(); + } + + @AfterClass + public static void tearDownAfterClass() { + logger.setLevel(saveLevel); + appender.stop(); + } + + /** + * Create various mocks and primary handler. + */ + @Before + public void setUp() { + appender.clearExtractions(); + + primary = new ScoListener(MyMessage.class) { + @Override + public void onTopicEvent(CommInfrastructure infra, String topic, StandardCoderObject sco, + MyMessage message) {} + }; + } + + @After + public void tearDown() { + logger.detachAppender(appender); + } + + @Test + public void testOnTopicEvent() { + primary = spy(primary); + + status = new MyMessage(NAME); + sco = makeSco(status); + primary.onTopicEvent(INFRA, TOPIC, sco); + verify(primary).onTopicEvent(eq(INFRA), eq(TOPIC), eq(sco), eq(status)); + + assertFalse(appender.getExtracted().toString().contains("unable to decode")); + + // undecodable message + logger.addAppender(appender); + primary.onTopicEvent(INFRA, TOPIC, makeSco("[]")); + verify(primary, times(1)).onTopicEvent(eq(INFRA), eq(TOPIC), eq(sco), eq(status)); + assertTrue(appender.getExtracted().toString().contains("unable to decode")); + } + + /** + * Makes a standard object from a JSON string. + * + * @param source message to be converted + * @return a standard object representing the message + */ + private StandardCoderObject makeSco(String source) { + try { + return coder.decode(source, StandardCoderObject.class); + + } catch (CoderException e) { + throw new RuntimeException(e); + } + } + + /** + * Makes a standard object from a status message. + * + * @param source message to be converted + * @return a standard object representing the message + */ + private StandardCoderObject makeSco(MyMessage source) { + try { + return coder.toStandard(source); + + } catch (CoderException e) { + throw new RuntimeException(e); + } + } + + protected static class MyMessage { + private String name; + + public MyMessage() { + super(); + } + + public MyMessage(String name) { + this.name = name; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((name == null) ? 0 : name.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + MyMessage other = (MyMessage) obj; + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + return true; + } + } +} -- cgit 1.2.3-korg