Fix outstanding Sonar issues
[aai/babel.git] / src / test / java / org / onap / aai / babel / logging / TestApplicationLogger.java
index 0c350c2..02df4e8 100644 (file)
@@ -18,6 +18,7 @@
  * limitations under the License.
  * ============LICENSE_END=========================================================
  */
+
 package org.onap.aai.babel.logging;
 
 import static org.hamcrest.CoreMatchers.containsString;
@@ -39,7 +40,7 @@ import org.onap.aai.cl.mdc.MdcOverride;
 
 /**
  * Simple test to log each of the validation messages in turn.
- * 
+ *
  * This version tests only the error logger at INFO level.
  *
  */
@@ -53,15 +54,16 @@ public class TestApplicationLogger {
     /**
      * Check that each message can be logged and that (by implication of successful logging) there is a corresponding
      * resource (message format).
-     * 
+     *
      * @throws IOException
+     *             if the log files cannot be read
      */
     @Test
     public void logAllMessages() throws IOException {
         Logger logger = LogHelper.INSTANCE;
         LogReader errorReader = new LogReader(LogHelper.getLogDirectory(), "error");
         LogReader debugReader = new LogReader(LogHelper.getLogDirectory(), "debug");
-        String[] args = { "1", "2", "3", "4" };
+        String[] args = {"1", "2", "3", "4"};
         for (ApplicationMsgs msg : Arrays.asList(ApplicationMsgs.values())) {
             if (msg.name().endsWith("ERROR")) {
                 logger.error(msg, args);
@@ -88,21 +90,23 @@ public class TestApplicationLogger {
     /**
      * Check that each message can be logged and that (by implication of successful logging) there is a corresponding
      * resource (message format).
-     * 
+     *
      * @throws IOException
+     *             if the log file cannot be read
      */
     @Test
     public void logDebugMessages() throws IOException {
         LogReader reader = new LogReader(LogHelper.getLogDirectory(), "debug");
         LogHelper.INSTANCE.debug("a message");
-        String s = reader.getNewLines();
-        assertThat(s, is(notNullValue()));
+        String str = reader.getNewLines();
+        assertThat(str, is(notNullValue()));
     }
 
     /**
-     * Check logAudit with HTTP headers
-     * 
+     * Check logAudit with HTTP headers.
+     *
      * @throws IOException
+     *             if the log file cannot be read
      */
     @Test
     public void logAuditMessage() throws IOException {
@@ -132,9 +136,10 @@ public class TestApplicationLogger {
     }
 
     /**
-     * Check logAudit with no HTTP headers
-     * 
+     * Check logAudit with no HTTP headers.
+     *
      * @throws IOException
+     *             if the log file cannot be read
      */
     @Test
     public void logAuditMessageWithoutHeaders() throws IOException {
@@ -149,9 +154,10 @@ public class TestApplicationLogger {
     }
 
     /**
-     * Check logMetrics
-     * 
+     * Check logMetrics.
+     *
      * @throws IOException
+     *             if the log file cannot be read
      */
     @Test
     public void logMetricsMessage() throws IOException {
@@ -204,15 +210,17 @@ public class TestApplicationLogger {
     }
 
     /**
-     * Call a logger method which is expected to throw an UnsupportedOperationException
-     * 
+     * Call a logger method which is expected to throw an UnsupportedOperationException.
+     *
      * @param logMethod
+     *            the logger method to invoke
      * @param dummyMsg
+     *            any Application Message enumeration value
      */
     private void callUnsupportedOperationMethod(TriConsumer<Enum<?>, LogFields, String[]> logMethod,
             ApplicationMsgs dummyMsg) {
         try {
-            logMethod.accept(dummyMsg, new LogFields(), new String[] { "" });
+            logMethod.accept(dummyMsg, new LogFields(), new String[] {""});
             org.junit.Assert.fail("method should have thrown execption"); // NOSONAR as code not reached
         } catch (UnsupportedOperationException e) {
             // Expected to reach here
@@ -220,12 +228,16 @@ public class TestApplicationLogger {
     }
 
     /**
-     * Assert that a log message was logged to the expected log file at the expected severity
-     * 
+     * Assert that a log message was logged to the expected log file at the expected severity.
+     *
      * @param msg
+     *            the Application Message enumeration value
      * @param reader
+     *            the log reader for the message
      * @param severity
+     *            log level
      * @throws IOException
+     *             if the log file cannot be read
      */
     private void validateLoggedMessage(ApplicationMsgs msg, LogReader reader, String severity) throws IOException {
         String str = reader.getNewLines();