X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=datarouter-node%2Fsrc%2Ftest%2Fjava%2Forg%2Fonap%2Fdmaap%2Fdatarouter%2Fnode%2FNodeServletTest.java;h=4340b0186a59bc191c4f6ecd8d24fe83a7956475;hb=8552e04175c7091d0d748e0c0f4b14a0d9321b40;hp=fbdd923078bcfae480ee136bc26ade09073893f6;hpb=46ef61c0fe477483be17dbf9af2ef3b1023da0d8;p=dmaap%2Fdatarouter.git diff --git a/datarouter-node/src/test/java/org/onap/dmaap/datarouter/node/NodeServletTest.java b/datarouter-node/src/test/java/org/onap/dmaap/datarouter/node/NodeServletTest.java index fbdd9230..4340b018 100644 --- a/datarouter-node/src/test/java/org/onap/dmaap/datarouter/node/NodeServletTest.java +++ b/datarouter-node/src/test/java/org/onap/dmaap/datarouter/node/NodeServletTest.java @@ -22,30 +22,47 @@ ******************************************************************************/ package org.onap.dmaap.datarouter.node; +import static org.junit.Assert.assertEquals; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyObject; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.anyString; +import static org.mockito.Mockito.doNothing; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.spi.ILoggingEvent; +import ch.qos.logback.core.read.ListAppender; +import java.io.File; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.Enumeration; +import java.util.List; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; import org.apache.commons.lang3.reflect.FieldUtils; +import org.junit.AfterClass; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.Mock; import org.powermock.api.mockito.PowerMockito; +import org.powermock.core.classloader.annotations.PowerMockIgnore; import org.powermock.core.classloader.annotations.SuppressStaticInitializationFor; import org.powermock.modules.junit4.PowerMockRunner; - -import javax.servlet.ServletOutputStream; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import java.util.*; - -import static org.hamcrest.Matchers.notNullValue; -import static org.mockito.Matchers.eq; -import static org.mockito.Mockito.*; +import org.slf4j.LoggerFactory; @RunWith(PowerMockRunner.class) @SuppressStaticInitializationFor("org.onap.dmaap.datarouter.node.NodeConfigManager") +@PowerMockIgnore({"com.sun.org.apache.xerces.*", "javax.xml.*", "org.xml.*", "org.w3c.*"}) public class NodeServletTest { private NodeServlet nodeServlet; + private Delivery delivery; @Mock private HttpServletRequest request; @@ -53,16 +70,29 @@ public class NodeServletTest { @Mock private HttpServletResponse response; + private ListAppender listAppender; + + private NodeConfigManager config = mock(NodeConfigManager.class); + @Before - public void setUp() throws Exception{ - nodeServlet = new NodeServlet(); + public void setUp() throws Exception { + listAppender = setTestLogger(); setBehalfHeader("Stub_Value"); when(request.getPathInfo()).thenReturn("2"); when(request.isSecure()).thenReturn(true); + createFilesAndDirectories(); setUpConfig(); setUpNodeMainDelivery(); + delivery = mock(Delivery.class); + when(delivery.markTaskSuccess("spool/s/0/1", "dmaap-dr-node.1234567")).thenReturn(true); + nodeServlet = new NodeServlet(delivery); when(request.getHeader("Authorization")).thenReturn("User1"); - when(request.getHeader("X-ATT-DR-PUBLISH-ID")).thenReturn("User1"); + when(request.getHeader("X-DMAAP-DR-PUBLISH-ID")).thenReturn("User1"); + } + + @AfterClass + public static void tearDown() { + deleteCreatedDirectories(); } @Test @@ -70,20 +100,23 @@ public class NodeServletTest { setNodeConfigManagerIsConfiguredToReturnFalse(); nodeServlet.doGet(request, response); verify(response).sendError(eq(HttpServletResponse.SC_SERVICE_UNAVAILABLE)); + verifyEnteringExitCalled(listAppender); } @Test - public void Given_Request_Is_HTTP_GET_And_Endpoint_Is_Internal_FetchProv_Then_No_Content_Response_Is_Generated() throws Exception { + public void Given_Request_Is_HTTP_GET_And_Endpoint_Is_Internal_FetchProv_Then_No_Content_Response_Is_Generated() { when(request.getPathInfo()).thenReturn("/internal/fetchProv"); nodeServlet.doGet(request, response); verify(response).setStatus(eq(HttpServletResponse.SC_NO_CONTENT)); + verifyEnteringExitCalled(listAppender); } @Test - public void Given_Request_Is_HTTP_GET_And_Endpoint_Is_ResetSubscription_Then_No_Content_Response_Is_Generated() throws Exception { + public void Given_Request_Is_HTTP_GET_And_Endpoint_Is_ResetSubscription_Then_No_Content_Response_Is_Generated() { when(request.getPathInfo()).thenReturn("/internal/resetSubscription/1"); nodeServlet.doGet(request, response); verify(response).setStatus(eq(HttpServletResponse.SC_NO_CONTENT)); + verifyEnteringExitCalled(listAppender); } @Test @@ -91,6 +124,7 @@ public class NodeServletTest { when(request.getPathInfo()).thenReturn("/incorrect"); nodeServlet.doGet(request, response); verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND)); + verifyEnteringExitCalled(listAppender); } @Test @@ -98,49 +132,57 @@ public class NodeServletTest { setNodeConfigManagerIsConfiguredToReturnFalse(); nodeServlet.doPut(request, response); verify(response).sendError(eq(HttpServletResponse.SC_SERVICE_UNAVAILABLE)); + verifyEnteringExitCalled(listAppender); } @Test public void Given_Request_Is_HTTP_PUT_And_Endpoint_Is_Incorrect_Then_Not_Found_Response_Is_Generated() throws Exception { when(request.getPathInfo()).thenReturn("/incorrect/"); nodeServlet.doPut(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString()); + verifyEnteringExitCalled(listAppender); } @Test public void Given_Request_Is_HTTP_PUT_And_Request_Is_Not_Secure_Then_Forbidden_Response_Is_Generated() throws Exception { when(request.isSecure()).thenReturn(false); nodeServlet.doPut(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), anyString()); + verifyEnteringExitCalled(listAppender); } @Test public void Given_Request_Is_HTTP_PUT_And_File_Id_Is_Null_Then_Not_Found_Response_Is_Generated() throws Exception { when(request.getPathInfo()).thenReturn(null); nodeServlet.doPut(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString()); + verifyEnteringExitCalled(listAppender); } @Test public void Given_Request_Is_HTTP_PUT_And_Authorization_Is_Null_Then_Forbidden_Response_Is_Generated() throws Exception { when(request.getHeader("Authorization")).thenReturn(null); nodeServlet.doPut(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), anyString()); + verifyEnteringExitCalled(listAppender); } @Test public void Given_Request_Is_HTTP_PUT_And_Publish_Does_Not_Include_File_Id_Then_Not_Found_Response_Is_Generated() throws Exception { when(request.getPathInfo()).thenReturn("/publish/"); nodeServlet.doPut(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString()); + verifyEnteringExitCalled(listAppender); } @Test public void Given_Request_Is_HTTP_PUT_And_Publish_Not_Permitted_Then_Forbidden_Response_Is_Generated() throws Exception { when(request.getPathInfo()).thenReturn("/publish/1/fileName"); + when(request.getRemoteAddr()).thenReturn("1.2.3.4"); setNodeConfigManagerIsPublishPermittedToReturnAReason(); nodeServlet.doPut(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), anyString()); + verifyEnteringExitCalled(listAppender); } @Test @@ -149,21 +191,27 @@ public class NodeServletTest { setNodeConfigManagerIsPublishPermittedToReturnAReason(); nodeServlet.doPut(request, response); verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN)); + verifyEnteringExitCalled(listAppender); } @Test public void Given_Request_Is_HTTP_PUT_And_Internal_Publish_But_Invalid_File_Id_Then_Not_Found_Response_Is_Generated() throws Exception { - when(request.getPathInfo()).thenReturn("/internal/publish/1/"); + when(request.getPathInfo()).thenReturn("/internal/publish/1/blah"); + when(request.getRemoteAddr()).thenReturn("1.2.3.4"); + when(config.isAnotherNode(anyString(), anyString())).thenReturn(true); nodeServlet.doPut(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString()); + verifyEnteringExitCalled(listAppender); } @Test public void Given_Request_Is_HTTP_PUT_On_Publish_And_Ingress_Node_Is_Provided_Then_Request_Is_Redirected() throws Exception { - when(request.getPathInfo()).thenReturn("/publish/1/fileName"); setNodeConfigManagerToAllowRedirectOnIngressNode(); + when(request.getPathInfo()).thenReturn("/publish/1/fileName"); + when(request.getRemoteAddr()).thenReturn("1.2.3.4"); nodeServlet.doPut(request, response); verify(response).sendRedirect(anyString()); + verifyEnteringExitCalled(listAppender); } @Test @@ -171,7 +219,7 @@ public class NodeServletTest { when(request.getPathInfo()).thenReturn("/publish/1/fileName"); setHeadersForValidRequest(true); nodeServlet.doPut(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), anyString()); } @Test @@ -179,7 +227,18 @@ public class NodeServletTest { when(request.getPathInfo()).thenReturn("/publish/1/fileName"); setHeadersForValidRequest(false); nodeServlet.doPut(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), anyString()); + } + + @Test + public void Given_Request_Is_HTTP_PUT_On_Publish_On_AAF_Feed_And_Cadi_Enabled_And_No_Permissions_Then_Forbidden_Response_Is_Generated() throws Exception { + when(config.getCadiEnabled()).thenReturn(true); + when(config.getAafInstance("1")).thenReturn("*"); + when(request.getPathInfo()).thenReturn("/publish/1/fileName"); + setHeadersForValidRequest(true); + nodeServlet.doPut(request, response); + verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), anyString()); + verifyEnteringExitCalled(listAppender); } @Test @@ -187,34 +246,112 @@ public class NodeServletTest { when(request.getPathInfo()).thenReturn("/publish/1/fileName"); setHeadersForValidRequest(false); nodeServlet.doDelete(request, response); - verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class))); + verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), anyString()); + } + + @Test + public void Given_Request_Is_HTTP_DELETE_File_With_Invalid_Endpoint_Then_Not_Found_Response_Is_Generated() throws Exception { + when(request.getPathInfo()).thenReturn("/delete/1"); + nodeServlet.doDelete(request, response); + verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString()); + verifyEnteringExitCalled(listAppender); + } + + @Test + public void Given_Request_Is_HTTP_DELETE_File_And_Is_Not_Privileged_Subscription_Then_Not_Found_Response_Is_Generated() throws Exception { + when(request.getPathInfo()).thenReturn("/delete/1/dmaap-dr-node.1234567"); + setUpConfigToReturnUnprivilegedSubscriber(); + nodeServlet.doDelete(request, response); + verify(response).sendError(eq(HttpServletResponse.SC_UNAUTHORIZED)); + verifyEnteringExitCalled(listAppender); } + @Test + public void Given_Request_Is_HTTP_DELETE_File_And_Subscription_Does_Not_Exist_Then_Not_Found_Response_Is_Generated() throws Exception { + when(request.getPathInfo()).thenReturn("/delete/1/dmaap-dr-node.1234567"); + setUpConfigToReturnNullOnIsDeletePermitted(); + nodeServlet.doDelete(request, response); + verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND)); + verifyEnteringExitCalled(listAppender); + } + + @Test + public void Given_Request_Is_HTTP_DELETE_File_Then_Request_Succeeds() throws Exception { + when(request.getPathInfo()).thenReturn("/delete/1/dmaap-dr-node.1234567"); + createFilesAndDirectories(); + nodeServlet.doDelete(request, response); + verify(response).setStatus(eq(HttpServletResponse.SC_OK)); + verifyEnteringExitCalled(listAppender); + } + + @Test + public void Given_Request_Is_HTTP_DELETE_File_And_File_Does_Not_Exist_Then_Not_Found_Response_Is_Generated() throws IOException { + when(request.getPathInfo()).thenReturn("/delete/1/nonExistingFile"); + nodeServlet.doDelete(request, response); + verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString()); + verifyEnteringExitCalled(listAppender); + } private void setBehalfHeader(String headerValue) { - when(request.getHeader("X-ATT-DR-ON-BEHALF-OF")).thenReturn(headerValue); + when(request.getHeader("X-DMAAP-DR-ON-BEHALF-OF")).thenReturn(headerValue); } - private void setUpConfig() throws IllegalAccessException{ - NodeConfigManager config = mock(NodeConfigManager.class); + private ListAppender setTestLogger() { + Logger Logger = (Logger) LoggerFactory.getLogger(NodeServlet.class); + ListAppender listAppender = new ListAppender<>(); + listAppender.start(); + Logger.addAppender(listAppender); + return listAppender; + } + + private void verifyEnteringExitCalled(ListAppender listAppender) { + assertEquals("EELF0004I Entering data router node component with RequestId and InvocationId", listAppender.list.get(0).getMessage()); + assertEquals("EELF0005I Exiting data router node component with RequestId and InvocationId", listAppender.list.get(listAppender.list.size() -1).getMessage()); + } + + private void setUpConfig() throws IllegalAccessException { PowerMockito.mockStatic(NodeConfigManager.class); when(config.isShutdown()).thenReturn(false); when(config.isConfigured()).thenReturn(true); - when(config.getSpoolDir()).thenReturn("spool/dir"); + when(config.getSpoolDir()).thenReturn("spool/f"); + when(config.getSpoolBase()).thenReturn("spool"); when(config.getLogDir()).thenReturn("log/dir"); when(config.getPublishId()).thenReturn("User1"); - when(config.isAnotherNode(anyString(), anyString())).thenReturn(true); + when(config.isAnotherNode(anyString(), anyString())).thenReturn(false); when(config.getEventLogInterval()).thenReturn("40"); + when(config.isDeletePermitted("1")).thenReturn(true); + when(config.getAllDests()).thenReturn(new DestInfo[0]); FieldUtils.writeDeclaredStaticField(NodeServlet.class, "config", config, true); - FieldUtils.writeDeclaredStaticField(NodeMain.class, "nodeConfigManager", config, true); + FieldUtils.writeDeclaredStaticField(NodeRunner.class, "nodeConfigManager", config, true); PowerMockito.when(NodeConfigManager.getInstance()).thenReturn(config); } + private void setUpConfigToReturnUnprivilegedSubscriber() throws IllegalAccessException { + NodeConfigManager config = mock(NodeConfigManager.class); + PowerMockito.mockStatic(NodeConfigManager.class); + when(config.isShutdown()).thenReturn(false); + when(config.isConfigured()).thenReturn(true); + when(config.isDeletePermitted("1")).thenReturn(false); + FieldUtils.writeDeclaredStaticField(NodeServlet.class, "config", config, true); + FieldUtils.writeDeclaredStaticField(NodeRunner.class, "nodeConfigManager", config, true); + PowerMockito.when(NodeConfigManager.getInstance()).thenReturn(config); + } + + private void setUpConfigToReturnNullOnIsDeletePermitted() throws IllegalAccessException { + NodeConfigManager config = mock(NodeConfigManager.class); + PowerMockito.mockStatic(NodeConfigManager.class); + when(config.isShutdown()).thenReturn(false); + when(config.isConfigured()).thenReturn(true); + when(config.isDeletePermitted("1")).thenThrow(new NullPointerException()); + FieldUtils.writeDeclaredStaticField(NodeServlet.class, "config", config, true); + FieldUtils.writeDeclaredStaticField(NodeRunner.class, "nodeConfigManager", config, true); + PowerMockito.when(NodeConfigManager.getInstance()).thenReturn(config); + } private void setUpNodeMainDelivery() throws IllegalAccessException{ Delivery delivery = mock(Delivery.class); doNothing().when(delivery).resetQueue(anyObject()); - FieldUtils.writeDeclaredStaticField(NodeMain.class, "delivery", delivery, true); + FieldUtils.writeDeclaredStaticField(NodeServer.class, "delivery", delivery, true); } private void setNodeConfigManagerIsConfiguredToReturnFalse() throws IllegalAccessException{ @@ -226,10 +363,11 @@ public class NodeServletTest { private void setNodeConfigManagerIsPublishPermittedToReturnAReason() throws IllegalAccessException{ NodeConfigManager config = mock(NodeConfigManager.class); when(config.isShutdown()).thenReturn(false); + when(config.getMyName()).thenReturn("dmaap-dr-node"); when(config.isConfigured()).thenReturn(true); when(config.getSpoolDir()).thenReturn("spool/dir"); when(config.getLogDir()).thenReturn("log/dir"); - when(config.isPublishPermitted(anyString(), anyString(), anyString())).thenReturn("Not Permitted"); + when(config.isPublishPermitted(anyString(), anyString(), anyString())).thenReturn("Publisher not permitted for this feed"); when(config.isAnotherNode(anyString(), anyString())).thenReturn(false); FieldUtils.writeDeclaredStaticField(NodeServlet.class, "config", config, true); } @@ -265,15 +403,42 @@ public class NodeServletTest { } List headers = new ArrayList<>(); headers.add("Content-Type"); - headers.add("X-ATT-DR-ON-BEHALF-OF"); - headers.add("X-ATT-DR-META"); + headers.add("X-DMAAP-DR-ON-BEHALF-OF"); + headers.add("X-DMAAP-DR-META"); Enumeration headerNames = Collections.enumeration(headers); when(request.getHeaderNames()).thenReturn(headerNames); Enumeration contentTypeHeader = Collections.enumeration(Arrays.asList("text/plain")); Enumeration behalfHeader = Collections.enumeration(Arrays.asList("User1")); Enumeration metaDataHeader = Collections.enumeration(Arrays.asList(metaDataString)); when(request.getHeaders("Content-Type")).thenReturn(contentTypeHeader); - when(request.getHeaders("X-ATT-DR-ON-BEHALF-OF")).thenReturn(behalfHeader); - when(request.getHeaders("X-ATT-DR-META")).thenReturn(metaDataHeader); + when(request.getHeaders("X-DMAAP-DR-ON-BEHALF-OF")).thenReturn(behalfHeader); + when(request.getHeaders("X-DMAAP-DR-META")).thenReturn(metaDataHeader); + } + + private void createFilesAndDirectories() throws IOException { + File nodeDir = new File("spool/n/172.0.0.1"); + File spoolDir = new File("spool/s/0/1"); + File dataFile = new File("spool/s/0/1/dmaap-dr-node.1234567"); + File metaDataFile = new File("spool/s/0/1/dmaap-dr-node.1234567.M"); + nodeDir.mkdirs(); + spoolDir.mkdirs(); + dataFile.createNewFile(); + metaDataFile.createNewFile(); + } + + private static void deleteCreatedDirectories() { + File spoolDir = new File("spool"); + delete(spoolDir); + } + + private static void delete(File file) { + if (file.isDirectory()) { + for (File f: file.listFiles()) { + delete(f); + } + } + if (!file.delete()) { + System.out.println("Failed to delete: " + file); + } } }