******************************************************************************/
package org.onap.dmaap.datarouter.provisioning;
-import static org.hamcrest.Matchers.notNullValue;
-import static org.mockito.Matchers.anyString;
-import static org.mockito.Matchers.argThat;
-import static org.mockito.Matchers.eq;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.onap.dmaap.datarouter.provisioning.BaseServlet.BEHALF_HEADER;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.read.ListAppender;
+import jakarta.servlet.ServletInputStream;
+import jakarta.servlet.ServletOutputStream;
import java.io.File;
import java.net.InetAddress;
-import java.util.HashMap;
-import java.util.Map;
-import javax.servlet.ServletInputStream;
-import javax.servlet.ServletOutputStream;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
+import javax.persistence.EntityManager;
+import javax.persistence.EntityManagerFactory;
+import javax.persistence.Persistence;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
import org.apache.commons.lang3.reflect.FieldUtils;
+import org.junit.AfterClass;
+import org.junit.Assert;
import org.junit.Before;
+import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
-import org.onap.dmaap.datarouter.authz.AuthorizationResponse;
-import org.onap.dmaap.datarouter.authz.Authorizer;
import org.onap.dmaap.datarouter.provisioning.beans.Deleteable;
-import org.onap.dmaap.datarouter.provisioning.beans.Feed;
import org.onap.dmaap.datarouter.provisioning.beans.Insertable;
import org.onap.dmaap.datarouter.provisioning.beans.LogRecord;
-import org.onap.dmaap.datarouter.provisioning.beans.NodeClass;
import org.onap.dmaap.datarouter.provisioning.beans.Parameters;
-import org.onap.dmaap.datarouter.provisioning.beans.Subscription;
import org.onap.dmaap.datarouter.provisioning.beans.Updateable;
-import org.onap.dmaap.datarouter.provisioning.utils.LogfileLoader;
-import org.onap.dmaap.datarouter.provisioning.utils.RLEBitSet;
+import org.onap.dmaap.datarouter.provisioning.utils.Poker;
import org.powermock.api.mockito.PowerMockito;
+import org.powermock.core.classloader.annotations.PowerMockIgnore;
import org.powermock.core.classloader.annotations.PrepareForTest;
-import org.powermock.core.classloader.annotations.SuppressStaticInitializationFor;
import org.powermock.modules.junit4.PowerMockRunner;
@RunWith(PowerMockRunner.class)
@PrepareForTest(LogRecord.class)
-@SuppressStaticInitializationFor({"org.onap.dmaap.datarouter.provisioning.beans.Feed",
- "org.onap.dmaap.datarouter.provisioning.beans.Parameters",
- "org.onap.dmaap.datarouter.provisioning.beans.NodeClass",
- "org.onap.dmaap.datarouter.provisioning.beans.Subscription",
- "org.onap.dmaap.datarouter.provisioning.utils.LogfileLoader"})
+@PowerMockIgnore({"com.sun.org.apache.xerces.*", "javax.xml.*", "org.xml.*", "org.w3c.*"})
public class InternalServletTest extends DrServletTestBase {
-
+ private static EntityManagerFactory emf;
+ private static EntityManager em;
private InternalServlet internalServlet;
@Mock
@Mock
private HttpServletResponse response;
+ ListAppender<ILoggingEvent> listAppender;
+
+ @BeforeClass
+ public static void init() {
+ emf = Persistence.createEntityManagerFactory("dr-unit-tests");
+ em = emf.createEntityManager();
+ System.setProperty(
+ "org.onap.dmaap.datarouter.provserver.properties",
+ "src/test/resources/h2Database.properties");
+ }
+
+ @AfterClass
+ public static void tearDownClass() {
+ em.clear();
+ em.close();
+ emf.close();
+ }
+
@Before
public void setUp() throws Exception {
- super.setUp();
- internalServlet = new InternalServlet();
- setAuthoriserToReturnRequestIsAuthorized();
- setUpValidAuthorisedRequest();
+ listAppender = setTestLogger(InternalServlet.class);
+ internalServlet = new InternalServlet();
+ setUpValidAuthorisedRequest();
}
@Test
public void Given_Request_Is_HTTP_GET_And_Address_Not_Authorized_When_HTTPS_Is_Required_Then_Forbidden_Response_Is_Generated()
throws Exception {
when(request.getRemoteAddr()).thenReturn("127.100.0.3");
- FieldUtils.writeDeclaredStaticField(BaseServlet.class, "isAddressAuthEnabled", "true", true);
-
internalServlet.doGet(request, response);
verify(response)
- .sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
+ .sendError(eq(HttpServletResponse.SC_FORBIDDEN), anyString());
+ verifyEnteringExitCalled(listAppender);
}
@Test
}
@Test
- public void Given_Request_Is_HTTP_GET_With_Halt_In_Endpoint_Request_Succeeds() throws Exception {
+ public void Given_Request_Is_HTTP_GET_With_Halt_In_Endpoint_Then_Request_Succeeds() throws Exception {
when(request.getPathInfo()).thenReturn("/halt");
when(request.isSecure()).thenReturn(false);
when(request.getRemoteAddr()).thenReturn("127.0.0.1");
}
@Test
- public void Given_Request_Is_HTTP_GET_With_FetchProv_In_Endpoint_Request_Succeeds()
+ public void Given_Request_Is_HTTP_GET_With_FetchProv_In_Endpoint_Then_Request_Succeeds()
throws Exception {
when(request.getPathInfo()).thenReturn("/fetchProv");
when(request.isSecure()).thenReturn(false);
internalServlet.doGet(request, response);
verify(response).setStatus(eq(HttpServletResponse.SC_OK));
+ verifyEnteringExitCalled(listAppender);
}
@Test
- public void Given_Request_Is_HTTP_GET_With_Prov_In_Endpoint_Request_Succeeds() throws Exception {
+ public void Given_Request_Is_HTTP_GET_With_Prov_In_Endpoint_Then_Request_Succeeds() throws Exception {
when(request.getPathInfo()).thenReturn("/prov");
when(request.getQueryString()).thenReturn(null);
setPokerToNotCreateTimers();
}
@Test
- public void Given_Request_Is_HTTP_GET_With_Logs_In_Endpoint_Request_Succeeds() throws Exception {
+ public void Given_Request_Is_HTTP_GET_With_Logs_In_Endpoint_Then_Request_Succeeds() throws Exception {
when(request.getPathInfo()).thenReturn("/logs/");
ServletOutputStream outStream = mock(ServletOutputStream.class);
when(response.getOutputStream()).thenReturn(outStream);
}
@Test
- public void Given_Request_Is_HTTP_GET_Starts_With_Logs_In_Endpoint_Request_Succeeds()
+ public void Given_Request_Is_HTTP_GET_Starts_With_Logs_In_Endpoint_Then_Request_Succeeds()
throws Exception {
when(request.getPathInfo()).thenReturn("/logs/TestFile");
internalServlet.doGet(request, response);
verify(response)
- .sendError(eq(HttpServletResponse.SC_NO_CONTENT), argThat(notNullValue(String.class)));
+ .sendError(eq(HttpServletResponse.SC_NO_CONTENT), anyString());
}
@Test
public void Given_Request_Is_HTTP_GET_Starts_With_Logs_In_Endpoint_And_File_Exists_Then_Request_Returns_Ok()
throws Exception {
when(request.getPathInfo()).thenReturn("/logs/testFile.txt");
+ File testDir = new File("unit-test-logs");
File testFile = new File("unit-test-logs/testFile.txt");
+ testDir.mkdirs();
testFile.createNewFile();
testFile.deleteOnExit();
ServletOutputStream outStream = mock(ServletOutputStream.class);
}
@Test
- public void Given_Request_Is_HTTP_GET_With_Api_In_Endpoint_Request_Succeeds() throws Exception {
- when(request.getPathInfo()).thenReturn("/api/Key");
- setParametersToNotContactDb(false);
+ public void Given_Request_Is_HTTP_GET_With_Api_In_Endpoint_Then_Request_Succeeds() throws Exception {
+ when(request.getPathInfo()).thenReturn("/api/DELIVERY_MAX_RETRY_INTERVAL");
ServletOutputStream outStream = mock(ServletOutputStream.class);
when(response.getOutputStream()).thenReturn(outStream);
internalServlet.doGet(request, response);
}
@Test
- public void Given_Request_Is_HTTP_GET_With_Drlogs_In_Endpoint_Request_Succeeds()
+ public void Given_Request_Is_HTTP_GET_With_Drlogs_In_Endpoint_Then_Request_Succeeds()
throws Exception {
when(request.getPathInfo()).thenReturn("/drlogs/");
- mockLogfileLoader();
ServletOutputStream outStream = mock(ServletOutputStream.class);
when(response.getOutputStream()).thenReturn(outStream);
internalServlet.doGet(request, response);
}
@Test
- public void Given_Request_Is_HTTP_GET_Incorrect_Endpoint_Then_No_Content_Response_Is_Generated()
+ public void Given_Request_Is_HTTP_GET_With_Incorrect_Endpoint_Then_No_Content_Response_Is_Generated()
throws Exception {
when(request.getPathInfo()).thenReturn("/incorrect/");
internalServlet.doGet(request, response);
verify(response)
- .sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class)));
+ .sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString());
}
@Test
FieldUtils.writeDeclaredStaticField(BaseServlet.class, "isAddressAuthEnabled", "true", true);
internalServlet.doPut(request, response);
verify(response)
- .sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
+ .sendError(eq(HttpServletResponse.SC_FORBIDDEN), anyString());
+ verifyEnteringExitCalled(listAppender);
}
@Test
public void Given_Request_Is_HTTP_PUT_With_Api_In_Endpoint_Request_Succeeds() throws Exception {
- when(request.getPathInfo()).thenReturn("/api/Key");
- setParametersToNotContactDb(false);
+ when(request.getPathInfo()).thenReturn("/api/NODES");
String[] values = {"V", "a", "l", "u", "e", "s"};
when(request.getParameterValues(anyString())).thenReturn(values);
internalServlet = internalServerSuccess();
setPokerToNotCreateTimers();
- mockProvisioningParametersChanged();
internalServlet.doPut(request, response);
verify(response).setStatus(eq(HttpServletResponse.SC_OK));
+ verifyEnteringExitCalled(listAppender);
}
@Test
public void Given_Request_Is_HTTP_PUT_With_Api_In_Endpoint_And_Update_Fails_Then_Internal_Server_Error_Is_Generated()
throws Exception {
- when(request.getPathInfo()).thenReturn("/api/Key");
- setParametersToNotContactDb(false);
+ when(request.getPathInfo()).thenReturn("/api/NODES");
String[] values = {"V", "a", "l", "u", "e", "s"};
when(request.getParameterValues(anyString())).thenReturn(values);
internalServlet = internalServerFailure();
internalServlet.doPut(request, response);
verify(response).sendError(eq(HttpServletResponse.SC_INTERNAL_SERVER_ERROR),
- argThat(notNullValue(String.class)));
+ anyString());
}
@Test
when(request.getPathInfo()).thenReturn("/incorrect");
internalServlet.doPut(request, response);
verify(response)
- .sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class)));
+ .sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString());
}
@Test
FieldUtils.writeDeclaredStaticField(BaseServlet.class, "isAddressAuthEnabled", "true", true);
internalServlet.doDelete(request, response);
verify(response)
- .sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
+ .sendError(eq(HttpServletResponse.SC_FORBIDDEN), anyString());
+ verifyEnteringExitCalled(listAppender);
}
@Test
public void Given_Request_Is_HTTP_DELETE_With_Api_In_Endpoint_Request_Succeeds()
throws Exception {
- when(request.getPathInfo()).thenReturn("/api/Key");
- setParametersToNotContactDb(false);
+ when(request.getPathInfo()).thenReturn("/api/NODES");
String[] values = {"V", "a", "l", "u", "e", "s"};
when(request.getParameterValues(anyString())).thenReturn(values);
internalServlet = internalServerSuccess();
setPokerToNotCreateTimers();
- mockProvisioningParametersChanged();
internalServlet.doDelete(request, response);
verify(response).setStatus(eq(HttpServletResponse.SC_OK));
+ verifyEnteringExitCalled(listAppender);
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_DELETE_With_LogRollInterval_Api_In_Endpoint_Request_Succeeds() {
+ when(request.getPathInfo()).thenReturn("/api/LOGROLL_INTERVAL");
+ internalServlet.doDelete(request, response);
+ verify(response).setStatus(eq(HttpServletResponse.SC_OK));
+ Parameters p1 = Parameters.getParameter("NODES");
+ Assert.assertEquals("{\"keyname\":\"NODES\",\"value\":\"dmaap-dr-node\"}", p1.asJSONObject().toString());
+ Assert.assertEquals("PARAM: keyname=NODES, value=dmaap-dr-node", p1.toString());
}
@Test
public void Given_Request_Is_HTTP_DELETE_With_Api_In_Endpoint_And_Delete_Fails_Then_Internal_Server_Error_Is_Generated()
throws Exception {
- when(request.getPathInfo()).thenReturn("/api/Key");
- setParametersToNotContactDb(false);
+ when(request.getPathInfo()).thenReturn("/api/NODES");
String[] values = {"V", "a", "l", "u", "e", "s"};
when(request.getParameterValues(anyString())).thenReturn(values);
internalServlet = internalServerFailure();
internalServlet.doDelete(request, response);
verify(response).sendError(eq(HttpServletResponse.SC_INTERNAL_SERVER_ERROR),
- argThat(notNullValue(String.class)));
+ anyString());
}
@Test
when(request.getPathInfo()).thenReturn("/incorrect");
internalServlet.doDelete(request, response);
verify(response)
- .sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class)));
+ .sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString());
}
@Test
throws Exception {
when(request.getRemoteAddr()).thenReturn("127.100.0.3");
internalServlet.doPost(request, response);
- FieldUtils.writeDeclaredStaticField(BaseServlet.class, "isAddressAuthEnabled", "true", true);
verify(response)
- .sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
+ .sendError(eq(HttpServletResponse.SC_FORBIDDEN), anyString());
+ verifyEnteringExitCalled(listAppender);
}
@Test
public void Given_Request_Is_HTTP_POST_With_Api_In_Endpoint_Request_Succeeds() throws Exception {
- when(request.getPathInfo()).thenReturn("/api/Key");
- setParametersToNotContactDb(true);
+ when(request.getPathInfo()).thenReturn("/api/key");
String[] values = {"V", "a", "l", "u", "e", "s"};
when(request.getParameterValues(anyString())).thenReturn(values);
internalServlet = internalServerSuccess();
setPokerToNotCreateTimers();
- mockProvisioningParametersChanged();
internalServlet.doPost(request, response);
verify(response).setStatus(eq(HttpServletResponse.SC_OK));
+ verifyEnteringExitCalled(listAppender);
}
@Test
public void Given_Request_Is_HTTP_POST_With_Api_In_Endpoint_And_Insert_Fails_Then_Internal_Server_Error_Is_Generated()
throws Exception {
when(request.getPathInfo()).thenReturn("/api/Key");
- setParametersToNotContactDb(true);
String[] values = {"V", "a", "l", "u", "e", "s"};
when(request.getParameterValues(anyString())).thenReturn(values);
internalServlet = internalServerFailure();
internalServlet.doPost(request, response);
verify(response).sendError(eq(HttpServletResponse.SC_INTERNAL_SERVER_ERROR),
- argThat(notNullValue(String.class)));
+ anyString());
}
@Test
- public void Given_Request_Is_HTTP_POST_To_Logs_And_Content_Header_Is_Not_Supported_Type_Then_Unsupported_Media_Type_Response_Is_Generated()
- throws Exception {
+ public void Given_Request_Is_HTTP_POST_To_Logs_And_Content_Header_Is_Not_Supported_Type_Then_Unsupported_Media_Type_Response_Is_Generated() {
when(request.getHeader("Content-Type")).thenReturn("stub_contentType");
when(request.getPathInfo()).thenReturn("/logs/");
internalServlet.doPost(request, response);
}
@Test
- public void Given_Request_Is_HTTP_POST_To_Logs_And_Content_Encoding_Is_Not_Supported_Type_Then_Unsupported_Media_Type_Response_Is_Generated()
- throws Exception {
+ public void Given_Request_Is_HTTP_POST_To_Logs_And_Content_Encoding_Is_Not_Supported_Type_Then_Unsupported_Media_Type_Response_Is_Generated() {
when(request.getHeader("Content-Encoding")).thenReturn("not-supported");
when(request.getPathInfo()).thenReturn("/logs/");
internalServlet.doPost(request, response);
File testDir = new File("unit-test-logs/spool");
testDir.mkdirs();
testDir.deleteOnExit();
- mockLogfileLoader();
internalServlet.doPost(request, response);
verify(response).setStatus(eq(HttpServletResponse.SC_CREATED));
}
@Test
- public void Given_Request_Is_HTTP_POST_To_Drlogs_And_Then_Unsupported_Media_Type_Response_Is_Generated()
- throws Exception {
+ public void Given_Request_Is_HTTP_POST_To_Drlogs_And_Then_Unsupported_Media_Type_Response_Is_Generated() {
when(request.getHeader("Content-Type")).thenReturn("stub_contentType");
when(request.getPathInfo()).thenReturn("/drlogs/");
internalServlet.doPost(request, response);
verify(response).setStatus(eq(HttpServletResponse.SC_OK));
}
+ @Test
+ public void Given_Request_Is_HTTP_POST_To_Api_And_Request_Succeeds() {
+ when(request.getPathInfo()).thenReturn("/api/NEW_PARAM?val=blah");
+ internalServlet.doPost(request, response);
+ verify(response).setStatus(eq(HttpServletResponse.SC_OK));
+ }
+
@Test
public void Given_Request_Is_HTTP_POST_With_Incorrect_Endpoint_Then_Not_Found_Error_Is_Generated()
throws Exception {
when(request.getPathInfo()).thenReturn("/incorrect/");
internalServlet.doPost(request, response);
verify(response)
- .sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class)));
- }
-
- private void setAuthoriserToReturnRequestIsAuthorized() throws IllegalAccessException {
- AuthorizationResponse authResponse = mock(AuthorizationResponse.class);
- Authorizer authorizer = mock(Authorizer.class);
- FieldUtils.writeDeclaredStaticField(BaseServlet.class, "authz", authorizer, true);
- when(authorizer.decide(request)).thenReturn(authResponse);
- when(authResponse.isAuthorized()).thenReturn(true);
+ .sendError(eq(HttpServletResponse.SC_NOT_FOUND), anyString());
}
private void setUpValidAuthorisedRequest() throws Exception {
FieldUtils.writeDeclaredStaticField(Poker.class, "poker", poker, true);
}
- private void setParametersToNotContactDb(boolean isPost) {
- PowerMockito.mockStatic(Parameters.class);
- Parameters parameters = mock(Parameters.class);
- if (isPost) {
- PowerMockito.when(Parameters.getParameter(anyString())).thenReturn(null);
- } else {
- PowerMockito.when(Parameters.getParameter(anyString())).thenReturn(parameters);
- }
- }
-
private InternalServlet internalServerSuccess() {
InternalServlet internalServlet = new InternalServlet() {
};
return internalServlet;
}
-
- private void mockProvisioningParametersChanged() throws IllegalAccessException {
- PowerMockito.mockStatic(Feed.class);
- PowerMockito.mockStatic(Subscription.class);
- PowerMockito.when(Feed.countActiveFeeds()).thenReturn(0);
- PowerMockito.when(Subscription.countActiveSubscriptions()).thenReturn(0);
- Map<String, Integer> map = new HashMap<>();
- FieldUtils.writeDeclaredStaticField(NodeClass.class, "map", map, true);
- }
-
- private void mockLogfileLoader() {
- PowerMockito.mockStatic(LogfileLoader.class);
- LogfileLoader logfileLoader = mock(LogfileLoader.class);
- when(logfileLoader.getBitSet()).thenReturn(new RLEBitSet());
- PowerMockito.when(LogfileLoader.getLoader()).thenReturn(logfileLoader);
- }
}