-/*
- * ============LICENSE_START===================================================
- * Copyright (c) 2018 Amdocs
- * ============================================================================
+/**
+ * ============LICENSE_START=======================================================
+ * org.onap.aai
+ * ================================================================================
+ * Copyright (c) 2018-2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (c) 2018-2019 European Software Marketing Ltd.
+ * ================================================================================
* 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
+ * 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=====================================================
+ * ============LICENSE_END=========================================================
*/
+
package org.onap.aai.validation.logging;
import java.io.BufferedReader;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Comparator;
-import java.util.HashMap;
-import java.util.Map;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
import org.apache.commons.lang.time.StopWatch;
-import org.junit.Assert;
public class LogReader {
- private Map<String, Path> cachedLogMap = new HashMap<>();
- private Map<String, BufferedReader> readersMap = new HashMap<>();
private BufferedReader cachedReader;
+ private Path cachedLog;
public LogReader(String logDirectory, String logFilePrefix) throws IOException {
cachedReader = getReader(logDirectory, logFilePrefix);
}
private BufferedReader getReader(String logDirectory, String logFilePrefix) throws IOException {
- BufferedReader reader = readersMap.get(logFilePrefix);
- if (reader == null) {
- reader = new BufferedReader(new FileReader(getLogFile(logDirectory, logFilePrefix)));
- while (reader.readLine() != null) {
- // Consume all lines
- }
- readersMap.put(logFilePrefix, reader);
+ BufferedReader reader = new BufferedReader(new FileReader(getLogFile(logDirectory, logFilePrefix)));
+ while (reader.readLine() != null) {
+ // Consume all lines
}
return reader;
}
* @return the most recently created log file.
* @throws IOException
*/
- public File getLogFile(String logDirectory, String filenamePrefix) throws IOException {
- Path cachedLog = cachedLogMap.get(filenamePrefix);
-
- if (cachedLog == null) {
- Optional<Path> latestFilePath = Files.list(Paths.get(logDirectory))
- .filter(f -> Files.isDirectory(f) == false && f.getFileName().toString().startsWith(filenamePrefix))
- .max(Comparator.comparingLong(f -> f.toFile().lastModified()));
- if (latestFilePath.isPresent()) {
- cachedLog = latestFilePath.get();
- } else {
- throw new IOException("No validation log files were found!");
- }
+ private File getLogFile(String logDirectory, String filenamePrefix) throws IOException {
+ Optional<Path> latestFilePath = Files.list(Paths.get(logDirectory))
+ .filter(f -> Files.isDirectory(f) == false //
+ && f.getFileName().toString().startsWith(filenamePrefix)
+ && !f.getFileName().toString().endsWith(".zip"))
+ .max(Comparator.comparingLong(f -> f.toFile().lastModified()));
+ if (latestFilePath.isPresent()) {
+ cachedLog = latestFilePath.get();
+ } else {
+ throw new IOException("No validation log files were found!");
}
return cachedLog.toFile();
}
/**
+ * Read newly appended lines from the log.
+ *
* @return new lines appended to the log file
* @throws IOException
*/
stopwatch.start();
while (!cachedReader.ready()) {
- if (stopwatch.getTime() > TimeUnit.SECONDS.toMillis(30)) {
- Assert.fail("Test took too long");
+ if (stopwatch.getTime() > TimeUnit.SECONDS.toMillis(10)) {
+ throw new IOException("Test took too long - waiting on " + cachedLog);
}
// else keep waiting
}
* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
- * Copyright © 2018-2019 AT&T Intellectual Property. All rights reserved.
- * Copyright © 2018-2019 European Software Marketing Ltd.
+ * Copyright (c) 2018-2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (c) 2018-2019 European Software Marketing Ltd.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
-import static org.hamcrest.CoreMatchers.startsWith;
import static org.hamcrest.MatcherAssert.assertThat;
import java.io.IOException;
-import java.nio.file.Paths;
import java.util.Arrays;
import org.apache.commons.lang.time.StopWatch;
+import org.junit.Before;
+import org.junit.Rule;
import org.junit.Test;
+import org.junit.rules.TestName;
import org.mockito.Mockito;
import org.onap.aai.cl.api.LogFields;
import org.onap.aai.cl.api.Logger;
/**
* Simple test to log each of the validation messages in turn.
- *
+ *
* This version tests only the error logger at INFO level.
*
*/
public class TestApplicationLogger {
+ @Rule
+ public TestName name = new TestName();
+
static {
System.setProperty("APP_HOME", ".");
}
+ /**
+ * Ensure that all of the EELF log files exist (and any log file rollover takes place) so that we can successfully
+ * read from the log files (during the Test method).
+ */
+ @Before
+ public void createLogFiles() {
+ final String startMessage = "begin testing " + name.getMethodName();
+ LogHelper.INSTANCE.debug(startMessage);
+ LogHelper.INSTANCE.info(ApplicationMsgs.MESSAGE_AUDIT, startMessage);
+ LogHelper.INSTANCE.logMetrics(startMessage);
+ LogHelper.INSTANCE.logAuditSuccess(startMessage);
+ }
+
/**
* Check that each message can be logged and that (by implication of successful logging) there is a corresponding
* resource (message format).
- *
+ *
* @throws IOException
*/
@Test
public void logAllMessages() throws IOException {
Logger logger = LogHelper.INSTANCE;
- String logDirectory = getLogDirectory();
+ String logDirectory = LogHelper.getLogDirectory();
LogReader errorReader = new LogReader(logDirectory, "error");
LogReader debugReader = new LogReader(logDirectory, "debug");
String[] args = {"1", "2", "3", "4"};
validateLoggedMessage(msg, errorReader, "WARN");
}
- logger.debug(msg, args);
- validateLoggedMessage(msg, debugReader, "DEBUG");
+ if (logger.isDebugEnabled()) {
+ logger.debug(msg, args);
+ validateLoggedMessage(msg, debugReader, "DEBUG");
+ }
// The trace level is not enabled
logger.trace(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
*/
@Test
public void logDebugMessages() throws IOException {
- LogReader reader = new LogReader(getLogDirectory(), "debug");
+ org.junit.Assume.assumeTrue(LogHelper.INSTANCE.isDebugEnabled());
+ 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
*/
@Test
public void logAuditMessage() throws IOException {
- LogHelper logger = LogHelper.INSTANCE;
- LogReader reader = new LogReader(getLogDirectory(), "audit");
+ final LogHelper logger = LogHelper.INSTANCE;
+ final LogReader reader = new LogReader(LogHelper.getLogDirectory(), "audit");
HttpHeaders headers = Mockito.mock(HttpHeaders.class);
Mockito.when(headers.getFirst("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
*/
@Test
public void logAuditMessageWithoutHeaders() throws IOException {
LogHelper logger = LogHelper.INSTANCE;
- LogReader reader = new LogReader(getLogDirectory(), "audit");
+ 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
*/
@Test
public void logMetricsMessage() throws IOException {
- LogReader reader = new LogReader(getLogDirectory(), "metrics");
+ 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
public void logMetricsMessageWithStopwatch() throws IOException {
- LogReader reader = new LogReader(getLogDirectory(), "metrics");
+ LogReader reader = new LogReader(LogHelper.getLogDirectory(), "metrics");
LogHelper logger = LogHelper.INSTANCE;
StopWatch stopWatch = new StopWatch();
stopWatch.start();
}
}
- private String getLogDirectory() {
- String logDirectory = LogHelper.getLogDirectory();
- assertThat(Paths.get(logDirectory).toAbsolutePath().toString(),
- startsWith(Paths.get(System.getProperty("APP_HOME")).toAbsolutePath().toString()));
- return logDirectory;
- }
-
/**
* Call a logger method which is expected to throw an UnsupportedOperationException
- *
+ *
* @param logMethod
* @param dummyMsg
*/
/**
* Assert that a log message was logged to the expected log file at the expected severity
- *
+ *
* @param msg
* @param reader
* @param severity
* @throws IOException
*/
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));
}
}
Code Review / aai / validation.git / commitdiff