* limitations under the License.
* ============LICENSE_END=========================================================
*/
+
package org.onap.aai.babel.logging;
import static org.hamcrest.CoreMatchers.containsString;
import java.io.IOException;
import java.util.Arrays;
import javax.ws.rs.core.HttpHeaders;
-import org.apache.commons.lang.time.StopWatch;
+import org.apache.commons.lang3.time.StopWatch;
import org.junit.BeforeClass;
import org.junit.Test;
import org.mockito.Mockito;
/**
* Simple test to log each of the validation messages in turn.
- *
+ *
* This version tests only the error logger at INFO level.
*
*/
@BeforeClass
public static void setupClass() {
- System.setProperty("AJSC_HOME", ".");
+ System.setProperty("APP_HOME", ".");
}
/**
* Check that each message can be logged and that (by implication of successful logging) there is a corresponding
* resource (message format).
- *
- * @throws IOException
+ *
+ * @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);
/**
* Check that each message can be logged and that (by implication of successful logging) there is a corresponding
* resource (message format).
- *
- * @throws IOException
+ *
+ * @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
- *
- * @throws IOException
+ * Check logAudit with HTTP headers.
+ *
+ * @throws IOException if the log file cannot be read
*/
@Test
public void logAuditMessage() throws IOException {
- LogHelper logger = LogHelper.INSTANCE;
- LogReader reader = new LogReader(LogHelper.getLogDirectory(), "audit");
+ final LogHelper logger = LogHelper.INSTANCE;
+ final LogReader reader = new LogReader(LogHelper.getLogDirectory(), "audit");
HttpHeaders headers = Mockito.mock(HttpHeaders.class);
Mockito.when(headers.getHeaderString("X-ECOMP-RequestID")).thenReturn("ecomp-request-id");
// Call logAudit without first calling startAudit
logger.logAuditSuccess("first call: bob");
- String s = reader.getNewLines();
- assertThat(s, is(notNullValue()));
- assertThat("audit message log level", s, containsString("INFO"));
- assertThat("audit message content", s, containsString("bob"));
+ String str = reader.getNewLines();
+ assertThat(str, is(notNullValue()));
+ assertThat("audit message log level", str, containsString("INFO"));
+ assertThat("audit message content", str, containsString("bob"));
// This time call the start method
logger.startAudit(headers, null);
logger.logAuditSuccess("second call: foo");
- s = reader.getNewLines();
- assertThat(s, is(notNullValue()));
- assertThat("audit message log level", s, containsString("INFO"));
- assertThat("audit message content", s, containsString("foo"));
- assertThat("audit message content", s, containsString("ecomp-request-id"));
- assertThat("audit message content", s, containsString("app-id"));
+ str = reader.getNewLines();
+ assertThat(str, is(notNullValue()));
+ assertThat("audit message log level", str, containsString("INFO"));
+ assertThat("audit message content", str, containsString("foo"));
+ assertThat("audit message content", str, containsString("ecomp-request-id"));
+ assertThat("audit message content", str, containsString("app-id"));
}
/**
- * Check logAudit with no HTTP headers
- *
- * @throws IOException
+ * Check logAudit with no HTTP headers.
+ *
+ * @throws IOException if the log file cannot be read
*/
@Test
public void logAuditMessageWithoutHeaders() throws IOException {
LogReader reader = new LogReader(LogHelper.getLogDirectory(), "audit");
logger.startAudit(null, null);
logger.logAuditSuccess("foo");
- String s = reader.getNewLines();
- assertThat(s, is(notNullValue()));
- assertThat("audit message log level", s, containsString("INFO"));
- assertThat("audit message content", s, containsString("foo"));
+ String str = reader.getNewLines();
+ assertThat(str, is(notNullValue()));
+ assertThat("audit message log level", str, containsString("INFO"));
+ assertThat("audit message content", str, containsString("foo"));
}
/**
- * Check logMetrics
- *
- * @throws IOException
+ * Check logMetrics.
+ *
+ * @throws IOException if the log file cannot be read
*/
@Test
public void logMetricsMessage() throws IOException {
LogReader reader = new LogReader(LogHelper.getLogDirectory(), "metrics");
LogHelper logger = LogHelper.INSTANCE;
logger.logMetrics("metrics: fred");
- String s = reader.getNewLines();
- assertThat(s, is(notNullValue()));
- assertThat("metrics message log level", s, containsString("INFO"));
- assertThat("metrics message content", s, containsString("fred"));
+ String str = reader.getNewLines();
+ assertThat(str, is(notNullValue()));
+ assertThat("metrics message log level", str, containsString("INFO"));
+ assertThat("metrics message content", str, containsString("fred"));
}
@Test
}
/**
- * Call a logger method which is expected to throw an UnsupportedOperationException
- *
- * @param logMethod
- * @param dummyMsg
+ * 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
}
/**
- * Assert that a log message was logged to the expected log file at the expected severity
- *
- * @param msg
- * @param reader
- * @param severity
- * @throws IOException
+ * 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 s = reader.getNewLines();
- assertThat(s, is(notNullValue()));
- assertThat(msg.toString() + " log level", s, containsString(severity));
+ String str = reader.getNewLines();
+ assertThat(str, is(notNullValue()));
+ assertThat(msg.toString() + " log level", str, containsString(severity));
}
}