--- /dev/null
+/*******************************************************************************
+ * ============LICENSE_START==================================================
+ * * org.onap.dmaap
+ * * ===========================================================================
+ * * Copyright © 2017 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====================================================
+ * *
+ * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ * *
+ ******************************************************************************/
+package org.onap.dmaap.datarouter.provisioning;
+
+import org.apache.commons.lang3.reflect.FieldUtils;
+import org.jetbrains.annotations.NotNull;
+import org.json.JSONArray;
+import org.json.JSONObject;
+import org.junit.Before;
+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.Feed;
+import org.onap.dmaap.datarouter.provisioning.beans.Insertable;
+import org.onap.dmaap.datarouter.provisioning.beans.Subscription;
+import org.powermock.api.mockito.PowerMockito;
+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.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import static org.hamcrest.Matchers.notNullValue;
+import static org.mockito.Mockito.*;
+import static org.onap.dmaap.datarouter.provisioning.BaseServlet.BEHALF_HEADER;
+
+
+@RunWith(PowerMockRunner.class)
+@SuppressStaticInitializationFor({"org.onap.dmaap.datarouter.provisioning.beans.Feed", "org.onap.dmaap.datarouter.provisioning.beans.Subscription"})
+public class SubscribeServletTest extends DrServletTestBase{
+ private static SubscribeServlet subscribeServlet;
+
+ @Mock
+ private HttpServletRequest request;
+ @Mock
+ private HttpServletResponse response;
+
+ @Before
+ public void setUp() throws Exception {
+ super.setUp();
+ subscribeServlet = new SubscribeServlet();
+ setAuthoriserToReturnRequestIsAuthorized();
+ setPokerToNotCreateTimersWhenDeleteFeedIsCalled();
+ setupValidAuthorisedRequest();
+ setUpValidSecurityOnHttpRequest();
+ setUpValidContentHeadersAndJSONOnHttpRequest();
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_DELETE_SC_METHOD_NOT_ALLOWED_Response_Is_Generated() throws Exception {
+ subscribeServlet.doDelete(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_METHOD_NOT_ALLOWED), argThat(notNullValue(String.class)));
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_GET_And_Is_Not_Secure_When_HTTPS_Is_Required_Then_Forbidden_Response_Is_Generated() throws Exception {
+ when(request.isSecure()).thenReturn(false);
+ subscribeServlet.doGet(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_GET_And_BEHALF_HEADER_Is_Not_Set_In_Request_Then_Bad_Request_Response_Is_Generated() throws Exception {
+ setBehalfHeader(null);
+ subscribeServlet.doGet(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
+ }
+
+
+ @Test
+ public void Given_Request_Is_HTTP_GET_And_Path_Header_Is_Not_Set_In_Request_With_Valid_Path_Then_Bad_Request_Response_Is_Generated() throws Exception {
+ when(request.getPathInfo()).thenReturn(null);
+ subscribeServlet.doGet(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_GET_And_Feed_Id_Is_Invalid_Then_Not_Found_Response_Is_Generated() throws Exception {
+ setFeedToReturnInvalidFeedIdSupplied();
+ subscribeServlet.doGet(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class)));
+ }
+
+
+ @Test
+ public void Given_Request_Is_HTTP_GET_And_Request_Is_Not_Authorized_Then_Forbidden_Response_Is_Generated() throws Exception {
+ setAuthoriserToReturnRequestNotAuthorized();
+ subscribeServlet.doGet(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
+ }
+
+
+ @Test
+ public void Given_Request_Is_HTTP_GET_And_Request_Succeeds() throws Exception {
+ ServletOutputStream outStream = mock(ServletOutputStream.class);
+ when(response.getOutputStream()).thenReturn(outStream);
+ PowerMockito.mockStatic(Subscription.class);
+ List<String> list = new ArrayList<String>();
+ list.add("{}");
+ PowerMockito.when(Subscription.getSubscriptionUrlList(anyInt())).thenReturn(list);
+ subscribeServlet.doGet(request, response);
+ verify(response).setStatus(eq(HttpServletResponse.SC_OK));
+ }
+
+
+ @Test
+ public void Given_Request_Is_HTTP_PUT_SC_METHOD_NOT_ALLOWED_Response_Is_Generated() throws Exception {
+ subscribeServlet.doPut(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_METHOD_NOT_ALLOWED), argThat(notNullValue(String.class)));
+ }
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_Is_Not_Secure_When_HTTPS_Is_Required_Then_Forbidden_Response_Is_Generated() throws Exception {
+ when(request.isSecure()).thenReturn(false);
+ subscribeServlet.doPost(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_BEHALF_HEADER_Is_Not_Set_In_Request_Then_Bad_Request_Response_Is_Generated() throws Exception {
+ setBehalfHeader(null);
+ subscribeServlet.doPost(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
+ }
+
+
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_Path_Header_Is_Not_Set_In_Request_With_Valid_Path_Then_Bad_Request_Response_Is_Generated() throws Exception {
+ when(request.getPathInfo()).thenReturn(null);
+ subscribeServlet.doPost(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
+ }
+
+
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_Feed_Id_Is_Invalid_Then_Not_Found_Response_Is_Generated() throws Exception {
+ setFeedToReturnInvalidFeedIdSupplied();
+ subscribeServlet.doPost(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class)));
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_Request_Is_Not_Authorized_Then_Forbidden_Response_Is_Generated() throws Exception {
+ setAuthoriserToReturnRequestNotAuthorized();
+ subscribeServlet.doPost(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_Content_Header_Is_Not_Supported_Type_Then_Unsupported_Media_Type_Response_Is_Generated() throws Exception {
+ when(request.getHeader("Content-Type")).thenReturn("application/vnd.att-dr.feed; version=1.1");
+ when(request.getContentType()).thenReturn("stub_contentType");
+ subscribeServlet.doPost(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE), argThat(notNullValue(String.class)));
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_Request_Contains_Badly_Formed_JSON_Then_Bad_Request_Response_Is_Generated() throws Exception {
+ subscribeServlet.doPost(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_Active_Feeds_Equals_Max_Feeds_Then_Bad_Request_Response_Is_Generated() throws Exception {
+ FieldUtils.writeDeclaredStaticField(BaseServlet.class, "maxSubs", 0, true);
+ SubscribeServlet subscribeServlet = new SubscribeServlet() {
+ protected JSONObject getJSONfromInput(HttpServletRequest req) {
+ return new JSONObject();
+ }
+ };
+ subscribeServlet.doPost(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_CONFLICT), argThat(notNullValue(String.class)));
+ }
+
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_POST_Fails_Bad_Request_Response_Is_Generated() throws Exception {
+ PowerMockito.mockStatic(Subscription.class);
+ PowerMockito.when(Subscription.getSubscriptionMatching(mock(Subscription.class))).thenReturn(null);
+ JSONObject JSObject = buildRequestJsonObject();
+ SubscribeServlet subscribeServlet = new SubscribeServlet() {
+ protected JSONObject getJSONfromInput(HttpServletRequest req) {
+ JSONObject jo = new JSONObject();
+ jo.put("name", "stub_name");
+ jo.put("version", "2.0");
+ jo.put("metadataOnly", true);
+ jo.put("suspend", true);
+ jo.put("delivery", JSObject);
+ return jo;
+ }
+
+ @Override
+ protected boolean doInsert(Insertable bean) {
+ return false;
+ }
+ };
+ FieldUtils.writeDeclaredStaticField(BaseServlet.class, "maxSubs", 10, true);
+ subscribeServlet.doPost(request, response);
+ verify(response).sendError(eq(HttpServletResponse.SC_INTERNAL_SERVER_ERROR), argThat(notNullValue(String.class)));
+ }
+
+
+ @Test
+ public void Given_Request_Is_HTTP_POST_And_Change_On_Feeds_Succeeds_A_STATUS_OK_Response_Is_Generated() throws Exception {
+ ServletOutputStream outStream = mock(ServletOutputStream.class);
+ when(response.getOutputStream()).thenReturn(outStream);
+ PowerMockito.mockStatic(Subscription.class);
+ PowerMockito.when(Subscription.getSubscriptionMatching(mock(Subscription.class))).thenReturn(null);
+ JSONObject JSObject = buildRequestJsonObject();
+ SubscribeServlet subscribeServlet = new SubscribeServlet() {
+ protected JSONObject getJSONfromInput(HttpServletRequest req) {
+ JSONObject jo = new JSONObject();
+ jo.put("name", "stub_name");
+ jo.put("version", "2.0");
+ jo.put("metadataOnly", true);
+ jo.put("suspend", true);
+ jo.put("delivery", JSObject);
+ return jo;
+ }
+
+ @Override
+ protected boolean doInsert(Insertable bean) {
+ return true;
+ }
+ };
+ FieldUtils.writeDeclaredStaticField(BaseServlet.class, "maxSubs", 10, true);
+ subscribeServlet.doPost(request, response);
+ verify(response).setStatus(eq(HttpServletResponse.SC_CREATED));
+ }
+
+
+ @NotNull
+ private JSONObject buildRequestJsonObject() {
+ JSONObject JSObject = new JSONObject();
+ JSONArray endpointIDs = new JSONArray();
+ JSONObject JOEndpointIDs = new JSONObject();
+ JOEndpointIDs.put("id", "stub_endpoint_id");
+ JOEndpointIDs.put("password", "stub_endpoint_password");
+ endpointIDs.put(JOEndpointIDs);
+
+ JSONArray endpointAddresses = new JSONArray();
+ endpointAddresses.put("127.0.0.1");
+
+ JSObject.put("classification", "stub_classification");
+ JSObject.put("endpoint_ids", endpointIDs);
+ JSObject.put("endpoint_addrs", endpointAddresses);
+ JSObject.put("url", "https://stub_address");
+ JSObject.put("use100", "true");
+ JSObject.put("password", "stub_password");
+ JSObject.put("user", "stub_user");
+ return JSObject;
+ }
+
+
+
+ private void initialiseBaseServletToBypassRetreiviingInitialisationParametersFromDatabase() throws IllegalAccessException {
+ FieldUtils.writeDeclaredStaticField(BaseServlet.class, "startmsgFlag", false, true);
+ SynchronizerTask synchronizerTask = mock(SynchronizerTask.class);
+ when(synchronizerTask.getState()).thenReturn(SynchronizerTask.UNKNOWN);
+ FieldUtils.writeDeclaredStaticField(SynchronizerTask.class, "synctask", synchronizerTask, true);
+ FieldUtils.writeDeclaredStaticField(BaseServlet.class, "max_subs", 10, true);
+ }
+
+ private void setUpValidSecurityOnHttpRequest() throws Exception {
+ when(request.isSecure()).thenReturn(true);
+ Set<String> authAddressesAndNetworks = new HashSet<String>();
+ authAddressesAndNetworks.add(("127.0.0.1"));
+ FieldUtils.writeDeclaredStaticField(BaseServlet.class, "authorizedAddressesAndNetworks", authAddressesAndNetworks, true);
+ FieldUtils.writeDeclaredStaticField(BaseServlet.class, "requireCert", false, true);
+ }
+
+ private void setBehalfHeader(String headerValue) {
+ when(request.getHeader(BEHALF_HEADER)).thenReturn(headerValue);
+ }
+
+ private void setValidPathInfoInHttpHeader() {
+ when(request.getPathInfo()).thenReturn("/123");
+ }
+
+ private void setFeedToReturnInvalidFeedIdSupplied() {
+ PowerMockito.mockStatic(Feed.class);
+ PowerMockito.when(Feed.getFeedById(anyInt())).thenReturn(null);
+ }
+
+ private void setFeedToReturnValidFeedForSuppliedId() {
+ PowerMockito.mockStatic(Feed.class);
+ Feed feed = mock(Feed.class);
+ PowerMockito.when(Feed.getFeedById(anyInt())).thenReturn(feed);
+ when(feed.isDeleted()).thenReturn(false);
+ when(feed.asJSONObject(true)).thenReturn(mock(JSONObject.class));
+ when(feed.getPublisher()).thenReturn("Stub_Value");
+ when(feed.getName()).thenReturn("stub_name");
+ when(feed.getVersion()).thenReturn("1.0");
+ when(feed.asLimitedJSONObject()).thenReturn(mock(JSONObject.class));
+ }
+
+ private void setAuthoriserToReturnRequestNotAuthorized() 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(false);
+ }
+
+ 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);
+ }
+
+ private void setPokerToNotCreateTimersWhenDeleteFeedIsCalled() throws Exception {
+ Poker poker = mock(Poker.class);
+ FieldUtils.writeDeclaredStaticField(Poker.class, "poker", poker, true);
+ }
+
+ private void setupValidAuthorisedRequest() throws Exception {
+ setUpValidSecurityOnHttpRequest();
+ setBehalfHeader("Stub_Value");
+ setValidPathInfoInHttpHeader();
+ setFeedToReturnValidFeedForSuppliedId();
+ }
+
+ private void setUpValidContentHeadersAndJSONOnHttpRequest() {
+ when(request.getHeader("Content-Type")).thenReturn("application/vnd.att-dr.subscription; version=1.0");
+ when(request.getHeader("X-ATT-DR-ON-BEHALF-OF-GROUP")).thenReturn("stub_subjectGroup");
+
+ }
+
+}
\ No newline at end of file
Code Review / dmaap / datarouter.git / blobdiff