vid-app-common/src/test/java/org/onap/vid/controller/PromiseEcompRequestIdFilterTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * VID
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2019 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
  21 package org.onap.vid.controller;
  22
  23 import com.google.common.collect.ImmutableMap;
  24 import org.mockito.ArgumentCaptor;
  25 import org.mockito.Mockito;
  26 import org.mockito.stubbing.Answer;
  27 import org.onap.portalsdk.core.web.support.UserUtils;
  28 import org.onap.vid.controller.filter.PromiseEcompRequestIdFilter;
  29 import org.springframework.mock.web.MockHttpServletResponse;
  30 import org.testng.annotations.Test;
  31
  32 import javax.servlet.FilterChain;
  33 import javax.servlet.ServletException;
  34 import javax.servlet.ServletRequest;
  35 import javax.servlet.ServletResponse;
  36 import javax.servlet.http.HttpServletRequest;
  37 import javax.servlet.http.HttpServletResponse;
  38 import java.io.IOException;
  39 import java.util.*;
  40 import java.util.function.Function;
  41
  42 import static org.apache.commons.lang3.StringUtils.equalsIgnoreCase;
  43 import static org.hamcrest.CoreMatchers.is;
  44 import static org.hamcrest.MatcherAssert.assertThat;
  45 import static org.hamcrest.Matchers.*;
  46 import static org.mockito.ArgumentMatchers.any;
  47 import static org.mockito.ArgumentMatchers.argThat;
  48 import static org.onap.portalsdk.core.util.SystemProperties.ECOMP_REQUEST_ID;
  49
  50 @Test
  51 public class PromiseEcompRequestIdFilterTest {
  52
  53     private final String anotherHeader = "ANDREI_RUBLEV";
  54     private final String anotherValue = "foo value";
  55     private final String mixedCaseHeader = "x-ecomp-REQUESTID";
  56
  57     @Test
  58     public void givenRequestIdHeader_headerValueNotChanged() throws IOException, ServletException {
  59
  60         final String someTxId = "863850e2-8545-4efd-94b8-afba5f52b3d5";
  61
  62         final ImmutableMap<String, String> incomingRequestHeaders = ImmutableMap.of(
  63                 anotherHeader, anotherValue,
  64                 ECOMP_REQUEST_ID, someTxId
  65         );
  66
  67         buildRequestThenRunThroughFilterAndAssertResultRequestHeaders(incomingRequestHeaders, specificTxId(someTxId));
  68     }
  69
  70     @Test
  71     public void givenMixedCaseRequestIdHeader_headerValueNotChanged() throws IOException, ServletException {
  72
  73         final String someTxId = "729bbd8d-b0c2-4809-a794-dcccd9cda2c0";
  74
  75         final ImmutableMap<String, String> incomingRequestHeaders = ImmutableMap.of(
  76                 mixedCaseHeader, someTxId,
  77                 anotherHeader, anotherValue
  78         );
  79
  80         buildRequestThenRunThroughFilterAndAssertResultRequestHeaders(incomingRequestHeaders, specificTxId(someTxId));
  81     }
  82
  83     @Test
  84     public void givenNoRequestIdHeader_headerValueWasGenerated() throws IOException, ServletException {
  85
  86         final ImmutableMap<String, String> incomingRequestHeaders = ImmutableMap.of(
  87                 anotherHeader, anotherValue
  88         );
  89
  90         buildRequestThenRunThroughFilterAndAssertResultRequestHeaders(incomingRequestHeaders, UserUtils::getRequestId);
  91     }
  92
  93
  94     private void buildRequestThenRunThroughFilterAndAssertResultRequestHeaders(
  95             ImmutableMap<String, String> originalRequestHeaders,
  96             Function<HttpServletRequest, String> txIdExtractor
  97     ) throws IOException, ServletException {
  98         HttpServletRequest servletRequest = createMockedHttpServletRequest(originalRequestHeaders);
  99         HttpServletResponse servletResponse = createMockedHttpServletResponse();
 100
 101         final FilterChain capturingFilterChain = Mockito.mock(FilterChain.class);
 102
 103         //////////////////
 104         //
 105         // doFilter() is the function under test
 106         //
 107         new PromiseEcompRequestIdFilter().doFilter(servletRequest, servletResponse, capturingFilterChain);
 108         //
 109         //////////////////
 110
 111         final ServletRequest capturedServletRequest = extractCapturedServletRequest(capturingFilterChain);
 112         final ServletResponse capturedServletResponse = extractCapturedServletResponse(capturingFilterChain);
 113         final String expectedTxId = txIdExtractor.apply((HttpServletRequest) capturedServletRequest);
 114
 115         assertRequestObjectHeaders(capturedServletRequest, expectedTxId);
 116         assertResponseObjectHeaders(capturedServletResponse, expectedTxId);
 117     }
 118
 119
 120     private void assertRequestObjectHeaders(ServletRequest request, String expectedTxId) {
 121         /*
 122         Assert that:
 123         - Two headers are in place
 124         - Direct value extraction is as expected
 125         - UserUtils.getRequestId() returns correct and valid value
 126          */
 127         final HttpServletRequest httpServletRequest = (HttpServletRequest) request;
 128
 129         assertThat(Collections.list(httpServletRequest.getHeaderNames()),
 130                 containsInAnyOrder(equalToIgnoringCase(ECOMP_REQUEST_ID), equalToIgnoringCase(anotherHeader)));
 131
 132         assertThat(httpServletRequest.getHeader(anotherHeader), is(anotherValue));
 133
 134         assertThat(httpServletRequest.getHeader(ECOMP_REQUEST_ID), is(expectedTxId));
 135         assertThat(httpServletRequest.getHeader(mixedCaseHeader), is(expectedTxId));
 136
 137         assertThat(UserUtils.getRequestId(httpServletRequest), is(expectedTxId));
 138         assertThat(UserUtils.getRequestId(httpServletRequest), is(not(emptyOrNullString())));
 139     }
 140
 141     private void assertResponseObjectHeaders(ServletResponse response, String txId) {
 142         final String REQUEST_ID_HEADER_NAME_IN_RESPONSE = mixedCaseHeader + "-echo";
 143         final HttpServletResponse httpServletResponse = (HttpServletResponse) response;
 144
 145         assertThat("header " + REQUEST_ID_HEADER_NAME_IN_RESPONSE.toLowerCase() + " in response must be provided",
 146                 httpServletResponse.getHeader(REQUEST_ID_HEADER_NAME_IN_RESPONSE), is(txId));
 147     }
 148
 149
 150
 151     private HttpServletRequest createMockedHttpServletRequest(Map<String, String> requestHeaders) {
 152         HttpServletRequest servletRequest = Mockito.mock(HttpServletRequest.class);
 153         requestHeaders.forEach((k, v) -> {
 154             Mockito.when(servletRequest.getHeader(argThat(s -> equalsIgnoreCase(s, k)))).thenReturn(v);
 155             Mockito.when(servletRequest.getHeaders(argThat(s -> equalsIgnoreCase(s, k)))).then(returnEnumerationAnswer(v));
 156         });
 157         Mockito.when(servletRequest.getHeaderNames()).then(returnEnumerationAnswer(requestHeaders.keySet()));
 158         return servletRequest;
 159     }
 160
 161     private HttpServletResponse createMockedHttpServletResponse() {
 162         return new MockHttpServletResponse();
 163     }
 164
 165     private static Answer<Enumeration<String>> returnEnumerationAnswer(String ... items) {
 166         return returnEnumerationAnswer(Arrays.asList(items));
 167     }
 168
 169     private static Answer<Enumeration<String>> returnEnumerationAnswer(Collection<String> items) {
 170         return invocation -> Collections.enumeration(items);
 171     }
 172
 173     private Function<HttpServletRequest, String> specificTxId(String someTxId) {
 174         return r -> someTxId;
 175     }
 176
 177     private ServletRequest extractCapturedServletRequest(FilterChain capturingFilterChain) throws IOException, ServletException {
 178         ArgumentCaptor<ServletRequest> captor = ArgumentCaptor.forClass(ServletRequest.class);
 179         Mockito.verify(capturingFilterChain).doFilter(captor.capture(), any());
 180         return captor.getValue();
 181     }
 182
 183     private ServletResponse extractCapturedServletResponse(FilterChain capturingFilterChain) throws IOException, ServletException {
 184         ArgumentCaptor<ServletResponse> captor = ArgumentCaptor.forClass(ServletResponse.class);
 185         Mockito.verify(capturingFilterChain).doFilter(any(), captor.capture());
 186         return captor.getValue();
 187     }
 188
 189 }