From a3979b8a14f6e67de406b29c3e0ad0c516c3bc54 Mon Sep 17 00:00:00 2001 From: "gregory.hayes" Date: Wed, 9 Dec 2020 20:42:33 +0000 Subject: Prune superfluous log and exception messages Large volume exception messages should not be repeated in log messages or in rethrown exceptions. Jira-Link: https://jira.onap.org/browse/POLICY-2885 Issue-ID: POLICY-2885 Signed-off-by: gregory.hayes Change-Id: I345531d3a7640cc5ad9dbfc367052b9c8cc19387 --- .../plugins/event/carrier/jms/ApexJmsConsumer.java | 1 - .../carrier/restserver/ApexRestServerConsumer.java | 4 ++-- .../event/protocol/xml/Apex2XmlEventConverter.java | 1 - .../protocol/yaml/Apex2YamlEventConverter.java | 6 ++--- .../protocol/yaml/YamlPluginStabilityTest.java | 26 +++++++++++++--------- 5 files changed, 19 insertions(+), 19 deletions(-) (limited to 'plugins') diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsConsumer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsConsumer.java index 9fbc36116..88980762f 100644 --- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsConsumer.java +++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsConsumer.java @@ -179,7 +179,6 @@ public class ApexJmsConsumer extends ApexPluginsEventConsumer implements Message eventReceiver.receiveEvent(new Properties(), jmsMessage); } catch (final Exception e) { final String errorMessage = "failed to receive message from JMS"; - LOGGER.warn(errorMessage, e); throw new ApexEventRuntimeException(errorMessage, e); } } diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restserver/src/main/java/org/onap/policy/apex/plugins/event/carrier/restserver/ApexRestServerConsumer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restserver/src/main/java/org/onap/policy/apex/plugins/event/carrier/restserver/ApexRestServerConsumer.java index 39d0023d2..80ccda729 100644 --- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restserver/src/main/java/org/onap/policy/apex/plugins/event/carrier/restserver/ApexRestServerConsumer.java +++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restserver/src/main/java/org/onap/policy/apex/plugins/event/carrier/restserver/ApexRestServerConsumer.java @@ -160,10 +160,10 @@ public class ApexRestServerConsumer extends ApexPluginsEventConsumer { // Send the event into Apex eventReceiver.receiveEvent(executionId, new Properties(), event); } catch (final Exception e) { - final String errorMessage = "error receiving events on event consumer " + name + ", " + e.getMessage(); + final String errorMessage = "error receiving events on event consumer " + name; LOGGER.warn(errorMessage, e); return Response.status(Response.Status.INTERNAL_SERVER_ERROR.getStatusCode()) - .entity("{'errorMessage', '" + errorMessage + "'}").build(); + .entity("{'errorMessage', '" + errorMessage + ", " + e.getMessage() + "'}").build(); } final SynchronousEventCache synchronousEventCache = diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XmlEventConverter.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XmlEventConverter.java index 44f010cd0..0f6735e0e 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XmlEventConverter.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XmlEventConverter.java @@ -130,7 +130,6 @@ public final class Apex2XmlEventConverter implements ApexEventProtocolConverter final JAXBElement rootElement = unmarshaller.unmarshal(source, XMLApexEvent.class); xmlApexEvent = rootElement.getValue(); } catch (final JAXBException e) { - LOGGER.warn("Unable to unmarshal Apex XML event\n" + xmlEventString, e); throw new ApexEventException("Unable to unmarshal Apex XML event\n" + xmlEventString, e); } diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/main/java/org/onap/policy/apex/plugins/event/protocol/yaml/Apex2YamlEventConverter.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/main/java/org/onap/policy/apex/plugins/event/protocol/yaml/Apex2YamlEventConverter.java index e6ee090e4..59c9c21c1 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/main/java/org/onap/policy/apex/plugins/event/protocol/yaml/Apex2YamlEventConverter.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/main/java/org/onap/policy/apex/plugins/event/protocol/yaml/Apex2YamlEventConverter.java @@ -112,10 +112,8 @@ public class Apex2YamlEventConverter implements ApexEventProtocolConverter { try { eventList.add(yamlMap2ApexEvent(eventName, yamlMap)); } catch (final Exception e) { - final String errorString = "Failed to unmarshal YAML event: " + e.getMessage() + ", event=" - + yamlEventString; - LOGGER.warn(errorString, e); - throw new ApexEventException(errorString, e); + throw new ApexEventException("Failed to unmarshal YAML event, event=" + + yamlEventString, e); } // Return the list of events we have unmarshalled diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/test/java/org/onap/policy/apex/plugins/event/protocol/yaml/YamlPluginStabilityTest.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/test/java/org/onap/policy/apex/plugins/event/protocol/yaml/YamlPluginStabilityTest.java index 398bddb16..0577be703 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/test/java/org/onap/policy/apex/plugins/event/protocol/yaml/YamlPluginStabilityTest.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/test/java/org/onap/policy/apex/plugins/event/protocol/yaml/YamlPluginStabilityTest.java @@ -21,8 +21,11 @@ package org.onap.policy.apex.plugins.event.protocol.yaml; +import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; import java.io.IOException; @@ -118,14 +121,14 @@ public class YamlPluginStabilityTest { converter.init(pars); assertThatThrownBy(() -> converter.toApexEvent("NonExistantEvent", "")) - .hasMessageContaining("Failed to unmarshal YAML event: an event definition for an event named " - + "\"NonExistantEvent\""); + .hasMessageContaining("Failed to unmarshal YAML event") + .getCause().hasMessageStartingWith("an event definition for an event named \"NonExistantEvent\""); assertThatThrownBy(() -> converter.toApexEvent("TestEvent", null)) .hasMessage("event processing failed, event is null"); assertThatThrownBy(() -> converter.toApexEvent("TestEvent", 1)) .hasMessage("error converting event \"1\" to a string"); assertThatThrownBy(() -> converter.toApexEvent("TestEvent", "")) - .hasMessageContaining("Field \"doubleValue\" is missing"); + .getCause().hasMessageContaining("Field \"doubleValue\" is missing"); assertThatThrownBy(() -> converter.fromApexEvent(null)) .hasMessage("event processing failed, Apex event is null"); ApexEvent apexEvent = new ApexEvent(testEvent.getKey().getName(), testEvent.getKey().getVersion(), @@ -142,12 +145,12 @@ public class YamlPluginStabilityTest { assertThatThrownBy(() -> converter.fromApexEvent(apexEvent)) .hasMessageContaining("error parsing TestEvent:0.0.1 event to Json. Field \"intValue\" is missing"); assertThatThrownBy(() -> converter.toApexEvent(null, "")) - .hasMessageContaining("Failed to unmarshal YAML event: event received without mandatory parameter" - + " \"name\""); + .hasMessageStartingWith("Failed to unmarshal YAML event") + .getCause().hasMessageStartingWith("event received without mandatory parameter \"name\""); pars.setNameAlias("TheNameField"); assertThatThrownBy(() -> converter.toApexEvent(null, "")) - .hasMessageContaining("Failed to unmarshal YAML event: event received without mandatory parameter" - + " \"name\""); + .hasMessageStartingWith("Failed to unmarshal YAML event") + .getCause().hasMessageStartingWith("event received without mandatory parameter \"name\""); apexEvent.put("intValue", 123); apexEvent.remove("stringValue"); @@ -184,7 +187,8 @@ public class YamlPluginStabilityTest { pars.setNameSpaceAlias("stringValue"); final String yamlInputStringCopy = yamlInputString; assertThatThrownBy(() -> converter.toApexEvent("TestEvent", yamlInputStringCopy)) - .hasMessageContaining("Failed to unmarshal YAML event: namespace \"org.some.other.namespace\" on event"); + .hasMessageStartingWith("Failed to unmarshal YAML event") + .getCause().hasMessageStartingWith("namespace \"org.some.other.namespace\" on event"); yamlInputString = "doubleValue: 123.45\n" + "intValue: 123\n" + "stringValue: org.onap.policy.apex.plugins.event.protocol.yaml"; eventList = converter.toApexEvent("TestEvent", yamlInputString); @@ -207,11 +211,11 @@ public class YamlPluginStabilityTest { pars.setSourceAlias(null); pars.setTargetAlias("intValue"); assertThatThrownBy(() -> converter.toApexEvent("TestEvent", yamlInputStringCopy)) - .hasMessageContaining("Failed to unmarshal YAML event: field \"target\" with type \"java.lang.Integer\""); + .hasMessageStartingWith("Failed to unmarshal YAML event") + .getCause().hasMessageStartingWith("field \"target\" with type \"java.lang.Integer\""); pars.setTargetAlias(null); assertThatThrownBy(() -> converter.toApexEvent("TestEvent", "doubleValue: 123.45\n" + "intValue: ~\n" - + "stringValue: MyString")) - .hasMessageContaining("mandatory field \"intValue\" is missing"); + + "stringValue: MyString")).getCause().hasMessageStartingWith("mandatory field \"intValue\" is missing"); } } -- cgit 1.2.3-korg