datarouter-prov/src/test/java/org/onap/dmaap/datarouter/provisioning/FeedServletTest.java

   1 /*******************************************************************************
   2  * ============LICENSE_START==================================================
   3  * * org.onap.dmaap
   4  * * ===========================================================================
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * * ===========================================================================
   7  * * Licensed under the Apache License, Version 2.0 (the "License");
   8  * * you may not use this file except in compliance with the License.
   9  * * You may obtain a copy of the License at
  10  * *
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0
  12  * *
  13  *  * Unless required by applicable law or agreed to in writing, software
  14  * * distributed under the License is distributed on an "AS IS" BASIS,
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * * See the License for the specific language governing permissions and
  17  * * limitations under the License.
  18  * * ============LICENSE_END====================================================
  19  * *
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  * *
  22  ******************************************************************************/
  23 package org.onap.dmaap.datarouter.provisioning;
  24
  25 import org.apache.commons.lang3.reflect.FieldUtils;
  26 import org.json.JSONObject;
  27 import org.junit.Before;
  28 import org.junit.Test;
  29 import org.junit.runner.RunWith;
  30 import org.mockito.Mock;
  31 import org.onap.dmaap.datarouter.authz.AuthorizationResponse;
  32 import org.onap.dmaap.datarouter.authz.Authorizer;
  33 import org.onap.dmaap.datarouter.provisioning.beans.Feed;
  34 import org.onap.dmaap.datarouter.provisioning.beans.Updateable;
  35 import org.powermock.api.mockito.PowerMockito;
  36 import org.powermock.core.classloader.annotations.SuppressStaticInitializationFor;
  37 import org.powermock.modules.junit4.PowerMockRunner;
  38
  39 import javax.servlet.ServletInputStream;
  40 import javax.servlet.ServletOutputStream;
  41 import javax.servlet.http.HttpServletRequest;
  42 import javax.servlet.http.HttpServletResponse;
  43 import java.util.HashSet;
  44 import java.util.Set;
  45
  46 import static org.hamcrest.Matchers.notNullValue;
  47 import static org.mockito.Mockito.*;
  48 import static org.onap.dmaap.datarouter.provisioning.BaseServlet.BEHALF_HEADER;
  49
  50
  51 @RunWith(PowerMockRunner.class)
  52 @SuppressStaticInitializationFor("org.onap.dmaap.datarouter.provisioning.beans.Feed")
  53 public class FeedServletTest {
  54     private static FeedServlet feedServlet;
  55
  56     @Mock
  57     private HttpServletRequest request;
  58     @Mock
  59     private HttpServletResponse response;
  60
  61     @Before
  62     public void setUp() throws Exception {
  63         initialiseBaseServletToBypassRetreiviingInitialisationParametersFromDatabase();
  64         feedServlet = new FeedServlet();
  65         setAuthoriserToReturnRequestIsAuthorized();
  66         setPokerToNotCreateTimersWhenDeleteFeedIsCalled();
  67         setUpValidAuthorisedRequest();
  68         setUpValidSecurityOnHttpRequest();
  69     }
  70
  71     @Test
  72     public void Given_Request_Is_HTTP_DELETE_And_Is_Not_Secure_When_HTTPS_Is_Required_Then_Forbidden_Response_Is_Generated() throws Exception {
  73         when(request.isSecure()).thenReturn(false);
  74         feedServlet.doDelete(request, response);
  75         verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
  76     }
  77
  78
  79     @Test
  80     public void Given_Request_Is_HTTP_DELETE_And_BEHALF_HEADER_Is_Not_Set_In_Request_Then_Bad_Request_Response_Is_Generated() throws Exception {
  81         setBehalfHeader(null);
  82         feedServlet.doDelete(request, response);
  83         verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
  84     }
  85
  86
  87     @Test
  88     public void Given_Request_Is_HTTP_DELETE_And_Path_Header_Is_Not_Set_In_Request_With_Valid_Path_Then_Bad_Request_Response_Is_Generated() throws Exception {
  89         when(request.getPathInfo()).thenReturn(null);
  90         feedServlet.doDelete(request, response);
  91         verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
  92     }
  93
  94
  95     @Test
  96     public void Given_Request_Is_HTTP_DELETE_And_Feed_Id_Is_Invalid_Then_Not_Found_Response_Is_Generated() throws Exception {
  97         setFeedToReturnInvalidFeedIdSupplied();
  98         feedServlet.doDelete(request, response);
  99         verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class)));
 100     }
 101
 102
 103     @Test
 104     public void Given_Request_Is_HTTP_DELETE_And_Request_Is_Not_Authorized_Then_Forbidden_Response_Is_Generated() throws Exception {
 105         setAuthoriserToReturnRequestNotAuthorized();
 106         feedServlet.doDelete(request, response);
 107         verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
 108     }
 109
 110
 111     @Test
 112     public void Given_Request_Is_HTTP_DELETE_And_Delete_On_Database_Fails_An_Internal_Server_Error_Is_Reported() throws Exception {
 113         FeedServlet feedServlet = new FeedServlet() {
 114             protected boolean doUpdate(Updateable bean) {
 115                 return false;
 116             }
 117         };
 118         feedServlet.doDelete(request, response);
 119         verify(response).sendError(eq(HttpServletResponse.SC_INTERNAL_SERVER_ERROR), argThat(notNullValue(String.class)));
 120     }
 121
 122
 123     @Test
 124     public void Given_Request_Is_HTTP_DELETE_And_Delete_On_Database_Succeeds_A_NO_CONTENT_Response_Is_Generated() throws Exception {
 125         FeedServlet feedServlet = new FeedServlet() {
 126             protected boolean doUpdate(Updateable bean) {
 127                 return true;
 128             }
 129         };
 130         feedServlet.doDelete(request, response);
 131         verify(response).setStatus(eq(HttpServletResponse.SC_NO_CONTENT));
 132     }
 133
 134     @Test
 135     public void Given_Request_Is_HTTP_GET_And_Is_Not_Secure_When_HTTPS_Is_Required_Then_Forbidden_Response_Is_Generated() throws Exception {
 136         when(request.isSecure()).thenReturn(false);
 137         feedServlet.doGet(request, response);
 138         verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
 139     }
 140
 141     @Test
 142     public void Given_Request_Is_HTTP_GET_And_BEHALF_HEADER_Is_Not_Set_In_Request_Then_Bad_Request_Response_Is_Generated() throws Exception {
 143         setBehalfHeader(null);
 144         feedServlet.doGet(request, response);
 145         verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
 146     }
 147
 148
 149     @Test
 150     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 {
 151         when(request.getPathInfo()).thenReturn(null);
 152         feedServlet.doGet(request, response);
 153         verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
 154     }
 155
 156
 157     @Test
 158     public void Given_Request_Is_HTTP_GET_And_Feed_Id_Is_Invalid_Then_Not_Found_Response_Is_Generated() throws Exception {
 159         setFeedToReturnInvalidFeedIdSupplied();
 160         feedServlet.doGet(request, response);
 161         verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class)));
 162     }
 163
 164
 165     @Test
 166     public void Given_Request_Is_HTTP_GET_And_Request_Is_Not_Authorized_Then_Forbidden_Response_Is_Generated() throws Exception {
 167         setAuthoriserToReturnRequestNotAuthorized();
 168         feedServlet.doGet(request, response);
 169         verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
 170     }
 171
 172
 173     @Test
 174     public void Given_Request_Is_HTTP_GET_And_Request_Succeeds() throws Exception {
 175         ServletOutputStream outStream = mock(ServletOutputStream.class);
 176         when(response.getOutputStream()).thenReturn(outStream);
 177         feedServlet.doGet(request, response);
 178         verify(response).setStatus(eq(HttpServletResponse.SC_OK));
 179     }
 180
 181
 182     @Test
 183     public void Given_Request_Is_HTTP_PUT_And_Is_Not_Secure_When_HTTPS_Is_Required_Then_Forbidden_Response_Is_Generated() throws Exception {
 184         when(request.isSecure()).thenReturn(false);
 185         feedServlet.doPut(request, response);
 186         verify(response).sendError(eq(HttpServletResponse.SC_FORBIDDEN), argThat(notNullValue(String.class)));
 187     }
 188
 189     @Test
 190     public void Given_Request_Is_HTTP_PUT_And_BEHALF_HEADER_Is_Not_Set_In_Request_Then_Bad_Request_Response_Is_Generated() throws Exception {
 191         setBehalfHeader(null);
 192         feedServlet.doPut(request, response);
 193         verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
 194     }
 195
 196
 197     @Test
 198     public void Given_Request_Is_HTTP_PUT_And_Path_Header_Is_Not_Set_In_Request_With_Valid_Path_Then_Bad_Request_Response_Is_Generated() throws Exception {
 199         when(request.getPathInfo()).thenReturn(null);
 200         feedServlet.doPut(request, response);
 201         verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
 202     }
 203
 204
 205     @Test
 206     public void Given_Request_Is_HTTP_PUT_And_Feed_Id_Is_Invalid_Then_Not_Found_Response_Is_Generated() throws Exception {
 207         setFeedToReturnInvalidFeedIdSupplied();
 208         feedServlet.doPut(request, response);
 209         verify(response).sendError(eq(HttpServletResponse.SC_NOT_FOUND), argThat(notNullValue(String.class)));
 210     }
 211
 212     @Test
 213     public void Given_Request_Is_HTTP_PUT_And_Content_Header_Is_Not_Supported_Type_Then_Unsupported_Media_Type_Response_Is_Generated() throws Exception {
 214         when(request.getContentType()).thenReturn("stub_contentType");
 215         feedServlet.doPut(request, response);
 216         verify(response).sendError(eq(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE), argThat(notNullValue(String.class)));
 217     }
 218
 219     @Test
 220     public void Given_Request_Is_HTTP_PUT_And_Request_Contains_Badly_Formed_JSON_Then_Bad_Request_Response_Is_Generated() throws Exception {
 221         when(request.getHeader("Content-Type")).thenReturn("application/vnd.att-dr.feed; version=1.0");
 222         ServletInputStream inStream = mock(ServletInputStream.class);
 223         when(request.getInputStream()).thenReturn(inStream);
 224         feedServlet.doPut(request, response);
 225         verify(response).sendError(eq(HttpServletResponse.SC_BAD_REQUEST), argThat(notNullValue(String.class)));
 226     }
 227
 228
 229     private void initialiseBaseServletToBypassRetreiviingInitialisationParametersFromDatabase() throws IllegalAccessException {
 230         FieldUtils.writeDeclaredStaticField(BaseServlet.class, "startmsg_flag", false, true);
 231         SynchronizerTask synchronizerTask = mock(SynchronizerTask.class);
 232         when(synchronizerTask.getState()).thenReturn(SynchronizerTask.UNKNOWN);
 233         FieldUtils.writeDeclaredStaticField(SynchronizerTask.class, "synctask", synchronizerTask, true);
 234     }
 235
 236     private void setUpValidSecurityOnHttpRequest() throws Exception {
 237         when(request.isSecure()).thenReturn(true);
 238         Set<String> authAddressesAndNetworks = new HashSet<String>();
 239         authAddressesAndNetworks.add(("127.0.0.1"));
 240         FieldUtils.writeDeclaredStaticField(BaseServlet.class, "authorizedAddressesAndNetworks", authAddressesAndNetworks, true);
 241         FieldUtils.writeDeclaredStaticField(BaseServlet.class, "require_cert", false, true);
 242     }
 243
 244     private void setBehalfHeader(String headerValue) {
 245         when(request.getHeader(BEHALF_HEADER)).thenReturn(headerValue);
 246     }
 247
 248     private void setValidPathInfoInHttpHeader() {
 249         when(request.getPathInfo()).thenReturn("/123");
 250     }
 251
 252     private void setFeedToReturnInvalidFeedIdSupplied() {
 253         PowerMockito.mockStatic(Feed.class);
 254         PowerMockito.when(Feed.getFeedById(anyInt())).thenReturn(null);
 255     }
 256
 257     private void setFeedToReturnValidFeedForSuppliedId() {
 258         PowerMockito.mockStatic(Feed.class);
 259         Feed feed = mock(Feed.class);
 260         PowerMockito.when(Feed.getFeedById(anyInt())).thenReturn(feed);
 261         when(feed.isDeleted()).thenReturn(false);
 262         when(feed.asJSONObject(true)).thenReturn(mock(JSONObject.class));
 263     }
 264
 265     private void setAuthoriserToReturnRequestNotAuthorized() throws IllegalAccessException {
 266         AuthorizationResponse authResponse = mock(AuthorizationResponse.class);
 267         Authorizer authorizer = mock(Authorizer.class);
 268         FieldUtils.writeDeclaredStaticField(BaseServlet.class, "authz", authorizer, true);
 269         when(authorizer.decide(request)).thenReturn(authResponse);
 270         when(authResponse.isAuthorized()).thenReturn(false);
 271     }
 272
 273     private void setAuthoriserToReturnRequestIsAuthorized() throws IllegalAccessException {
 274         AuthorizationResponse authResponse = mock(AuthorizationResponse.class);
 275         Authorizer authorizer = mock(Authorizer.class);
 276         FieldUtils.writeDeclaredStaticField(BaseServlet.class, "authz", authorizer, true);
 277         when(authorizer.decide(request)).thenReturn(authResponse);
 278         when(authResponse.isAuthorized()).thenReturn(true);
 279     }
 280
 281     private void setPokerToNotCreateTimersWhenDeleteFeedIsCalled() throws Exception {
 282         Poker poker = mock(Poker.class);
 283         FieldUtils.writeDeclaredStaticField(Poker.class, "p", poker, true);
 284     }
 285
 286     private void setUpValidAuthorisedRequest() throws Exception {
 287         setUpValidSecurityOnHttpRequest();
 288         setBehalfHeader("Stub_Value");
 289         setValidPathInfoInHttpHeader();
 290         setFeedToReturnValidFeedForSuppliedId();
 291     }
 292 }