--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * VID
+ * ================================================================================
+ * Copyright (C) 2017 - 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.vid.controller;
+
+import ch.qos.logback.classic.LoggerContext;
+import ch.qos.logback.core.Appender;
+import ch.qos.logback.core.FileAppender;
+import ch.qos.logback.core.spi.AppenderAttachable;
+import com.att.eelf.configuration.Configuration;
+import java.util.stream.Stream;
+import javax.ws.rs.InternalServerErrorException;
+import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
+import org.onap.vid.utils.Streams;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Component;
+
+@Component
+public final class LogfilePathCreator {
+
+ private static final EELFLoggerDelegate LOGGER = EELFLoggerDelegate.getLogger(LogfilePathCreator.class);
+
+ String getLogfilePath(String loggerName) {
+ /*
+ Find the requested logger, and pull all of it's appenders.
+ Find the first of the appenders that is a FileAppender, and return it's
+ write-out filename.
+ */
+ LOGGER.debug("Searching for logfile path with loggerName: ", loggerName);
+ LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();;
+ return context.getLoggerList().stream()
+ .filter(logger -> logger.getName().equals(Configuration.GENERAL_LOGGER_NAME + "." + loggerName))
+ .flatMap(this::pullSubAppenders)
+ .flatMap(appender -> {
+ // Appender might be "attachable", if so - roll-up its sub-appenders
+ return (appender instanceof AppenderAttachable) ?
+ pullSubAppenders((AppenderAttachable<?>) appender) : Stream.of(appender);
+ })
+ .filter(appender -> appender instanceof FileAppender)
+ .map(appender -> (FileAppender<?>) appender)
+ .map(FileAppender::getFile)
+ .findFirst()
+ .orElseThrow(() -> new InternalServerErrorException("logfile for " + loggerName + " not found"));
+ }
+
+ private <T> Stream<Appender<T>> pullSubAppenders(AppenderAttachable<T> logger) {
+ return Streams.fromIterator(logger.iteratorForAppenders());
+ }
+}
\ No newline at end of file
package org.onap.vid.controller;
-import ch.qos.logback.classic.LoggerContext;
-import ch.qos.logback.core.Appender;
-import ch.qos.logback.core.FileAppender;
-import ch.qos.logback.core.spi.AppenderAttachable;
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+import java.util.Objects;
+import java.util.function.Supplier;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.InternalServerErrorException;
+import javax.ws.rs.NotAuthorizedException;
import org.apache.commons.io.input.ReversedLinesFileReader;
import org.apache.commons.lang3.StringUtils;
import org.onap.portalsdk.core.controller.RestrictedBaseController;
import org.onap.vid.roles.Role;
import org.onap.vid.roles.RoleProvider;
import org.onap.vid.utils.Streams;
-import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
-import org.springframework.web.bind.annotation.*;
-
-import javax.servlet.http.HttpServletRequest;
-import javax.ws.rs.InternalServerErrorException;
-import javax.ws.rs.NotAuthorizedException;
-import java.io.File;
-import java.io.IOException;
-import java.util.List;
-import java.util.Objects;
-import java.util.function.Supplier;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-
-import static com.att.eelf.configuration.Configuration.GENERAL_LOGGER_NAME;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.ResponseStatus;
+import org.springframework.web.bind.annotation.RestController;
@RestController
public class LoggerController extends RestrictedBaseController {
private static final EELFLoggerDelegate LOGGER = EELFLoggerDelegate.getLogger(LoggerController.class);
+ private RoleProvider roleProvider;
+ private LogfilePathCreator logfilePathCreator;
@Autowired
- RoleProvider roleProvider;
+ public LoggerController(RoleProvider roleProvider, LogfilePathCreator logfilePathCreator) {
+ this.roleProvider = roleProvider;
+ this.logfilePathCreator = logfilePathCreator;
+ }
- @RequestMapping(value = "/{loggerName:audit|error|metrics}", method = RequestMethod.GET)
+ @GetMapping(value = "/{loggerName:audit|error|metrics}")
public String getLog(@PathVariable String loggerName, HttpServletRequest request,
@RequestParam(value="limit", defaultValue = "5000") Integer limit) throws IOException {
throw new NotAuthorizedException("User not authorized to get logs");
}
- String logfilePath = getLogfilePath(loggerName);
-
+ String logfilePath = logfilePathCreator.getLogfilePath(loggerName);
try (final ReversedLinesFileReader reader = new ReversedLinesFileReader(new File(logfilePath))) {
Supplier<String> reverseLinesSupplier = () -> {
try {
}
}
- private String getLogfilePath(String loggerName) {
- /*
- Find the requested logger, and pull all of it's appenders.
- Find the first of the appenders that is a FileAppender, and return it's
- write-out filename.
- */
- LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
- return context.getLoggerList().stream()
- .filter(logger -> logger.getName().equals(GENERAL_LOGGER_NAME + "." + loggerName))
- .flatMap(this::pullSubAppenders)
- .flatMap(appender -> {
- // Appender might be "attachable", if so - roll-up its sub-appenders
- return (appender instanceof AppenderAttachable) ?
- pullSubAppenders((AppenderAttachable<?>) appender) : Stream.of(appender);
- })
- .filter(appender -> appender instanceof FileAppender)
- .map(appender -> (FileAppender<?>) appender)
- .map(FileAppender::getFile)
- .findFirst()
- .orElseThrow(() -> new InternalServerErrorException("logfile for " + loggerName + " not found"));
- }
-
- private <T> Stream<Appender<T>> pullSubAppenders(AppenderAttachable<T> logger) {
- return Streams.fromIterator(logger.iteratorForAppenders());
- }
-
@ExceptionHandler({ NotAuthorizedException.class })
@ResponseStatus(HttpStatus.UNAUTHORIZED)
public String notAuthorizedHandler(NotAuthorizedException e) {
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * VID
+ * ================================================================================
+ * Copyright (C) 2019 Nokia. 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.vid.controller;
+
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
+
+import javax.ws.rs.InternalServerErrorException;
+import org.junit.Before;
+import org.junit.Test;
+
+public class LogfilePathCreatorTest {
+
+ private static final String AUDIT = "audit";
+ private static final String ERROR = "error";
+ private static final String METRICS = "metrics";
+
+ private LogfilePathCreator creator;
+
+ @Before
+ public void setUp() {
+ creator = new LogfilePathCreator();
+ }
+
+ @Test
+ public void shouldThrowInternalServerErrorException_whenLogfileDoesntExist() {
+ String loggerName = "notExisting";
+ assertThatExceptionOfType(InternalServerErrorException.class)
+ .isThrownBy(() -> creator.getLogfilePath(loggerName))
+ .withMessage(String.format("logfile for %s not found", loggerName));
+ }
+
+ @Test
+ public void shouldReturnAuditPath_whenAuditNameIsGiven() {
+ assertThat(creator.getLogfilePath(AUDIT)).isEqualTo("logs/EELF/audit.log");
+ }
+
+ @Test
+ public void shouldReturnErrorPath_whenErrorNameIsGiven() {
+ assertThat(creator.getLogfilePath(ERROR)).isEqualTo("logs/EELF/error.log");
+ }
+
+ @Test
+ public void shouldReturnMetricsPath_whenMetricsNameIsGiven() {
+ assertThat(creator.getLogfilePath(METRICS)).isEqualTo("logs/EELF/metrics.log");
+ }
+}
\ No newline at end of file
* 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.
package org.onap.vid.controller;
+import static org.mockito.ArgumentMatchers.argThat;
+import static org.mockito.BDDMockito.given;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import com.google.common.collect.ImmutableList;
+import java.util.List;
+import org.apache.log4j.BasicConfigurator;
+import org.junit.Before;
import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+import org.onap.vid.roles.EcompRole;
+import org.onap.vid.roles.Role;
+import org.onap.vid.roles.RoleProvider;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
-import javax.ws.rs.NotAuthorizedException;
+@RunWith(MockitoJUnitRunner.class)
+public class LoggerControllerTest {
+ private static final String ERROR_URL = "/logger/error";
+ private static final String AUDIT_URL = "/logger/audit";
+ private static final String METRICS_URL = "/logger/metrics";
+ private static final String VALID_LOG_PATH = "src/test/resources/loggerFiles/validLog.log";
+ private static final String EMPTY_LOG_PATH = "src/test/resources/loggerFiles/emptyLog.log";
-public class LoggerControllerTest {
+ private MockMvc mockMvc;
+ private LoggerController loggerController;
- private LoggerController createTestSubject() {
- return new LoggerController();
+ @Mock
+ private RoleProvider provider;
+ @Mock
+ private LogfilePathCreator creator;
+
+ @Before
+ public void setUp() {
+ loggerController = new LoggerController(provider, creator);
+ BasicConfigurator.configure();
+ mockMvc = MockMvcBuilders.standaloneSetup(loggerController).build();
}
- /*@Test
- public void testGetLog() throws Exception {
- LoggerController testSubject;
- String loggerName = "";
- HttpServletRequest request = null;
- Integer limit = 0;
- String result;
+ @Test
+ public void shouldThrowNotAuthorizedException_whenUserIsNotAuthorizedToGetLogs() throws Exception {
+ List<Role> list = ImmutableList.of(new Role(EcompRole.READ, "subName1", "servType1", "tenant1"));
+
+ given(provider.getUserRoles(argThat(req -> req.getRequestedSessionId().equals("id1")))).willReturn(list);
+ given(provider.userPermissionIsReadLogs(list)).willReturn(false);
- // default test
- testSubject = createTestSubject();
- result = testSubject.getLog(loggerName, request, limit);
- }*/
+ mockMvc.perform(get(ERROR_URL)
+ .with(req -> {req.setRequestedSessionId("id1");
+ return req;}))
+ .andExpect(content().string("UNAUTHORIZED"))
+ .andExpect(status().isUnauthorized());
+ }
-
@Test
- public void testNotAuthorizedHandler() throws Exception {
- LoggerController testSubject;
- NotAuthorizedException e = null;
- String result;
-
- // default test
- testSubject = createTestSubject();
- result = testSubject.notAuthorizedHandler(e);
+ public void shouldReturnLastAndOneBeforeLogLines_whenLimitIs2() throws Exception {
+ List<Role> list = ImmutableList.of(new Role(EcompRole.READ, "subName1", "servType1", "tenant1"));
+
+ given(provider.getUserRoles(argThat(req -> req.getRequestedSessionId().equals("id1")))).willReturn(list);
+ given(provider.userPermissionIsReadLogs(list)).willReturn(true);
+ given(creator.getLogfilePath("audit")).willReturn(VALID_LOG_PATH);
+
+ mockMvc.perform(get(AUDIT_URL)
+ .with(req -> {req.setRequestedSessionId("id1");
+ return req;})
+ .param("limit", "2"))
+ .andExpect(content().string("and the third line\nthe second line"))
+ .andExpect(status().isOk());
}
- /*@Test
- public void testIoExceptionHandler() throws Exception {
- LoggerController testSubject;
- Exception e = null;
- ExceptionResponse result;
+ @Test
+ public void shouldReturnEmptyString_whenLogFileIsEmpty() throws Exception {
+ List<Role> list = ImmutableList.of(new Role(EcompRole.READ, "subName1", "servType1", "tenant1"));
+
+ given(provider.getUserRoles(argThat(req -> req.getRequestedSessionId().equals("id1")))).willReturn(list);
+ given(provider.userPermissionIsReadLogs(list)).willReturn(true);
+ given(creator.getLogfilePath("metrics")).willReturn(EMPTY_LOG_PATH);
- // default test
- testSubject = createTestSubject();
- result = testSubject.ioExceptionHandler(e);
- }*/
+ mockMvc.perform(get(METRICS_URL)
+ .with(req -> {req.setRequestedSessionId("id1");
+ return req;}))
+ .andExpect(content().string(""))
+ .andExpect(status().isOk());
+ }
}
--- /dev/null
+this is the first line
+the second line
+and the third line
Code Review / vid.git / commitdiff