2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.vid.controller;
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;
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;
40 import java.util.function.Function;
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;
51 public class PromiseEcompRequestIdFilterTest {
53 private final String anotherHeader = "ANDREI_RUBLEV";
54 private final String anotherValue = "foo value";
55 private final String mixedCaseHeader = "x-ecomp-REQUESTID";
58 public void givenRequestIdHeader_headerValueNotChanged() throws IOException, ServletException {
60 final String someTxId = "863850e2-8545-4efd-94b8-afba5f52b3d5";
62 final ImmutableMap<String, String> incomingRequestHeaders = ImmutableMap.of(
63 anotherHeader, anotherValue,
64 ECOMP_REQUEST_ID, someTxId
67 buildRequestThenRunThroughFilterAndAssertResultRequestHeaders(incomingRequestHeaders, specificTxId(someTxId));
72 public void givenRequestIdHeaderThatIsNotAUUID_headerValueChanged() throws IOException, ServletException {
74 final String someTxId = "863850e28544efd94b8afba5f52b3d5";
76 final ImmutableMap<String, String> incomingRequestHeaders = ImmutableMap.of(
77 anotherHeader, anotherValue,
78 ECOMP_REQUEST_ID, someTxId
81 buildRequestThenRunThroughFilterAndAssertResultRequestHeaders(incomingRequestHeaders, UserUtils::getRequestId);
86 public void givenMixedCaseRequestIdHeader_headerValueNotChanged() throws IOException, ServletException {
88 final String someTxId = "729bbd8d-b0c2-4809-a794-dcccd9cda2c0";
90 final ImmutableMap<String, String> incomingRequestHeaders = ImmutableMap.of(
91 mixedCaseHeader, someTxId,
92 anotherHeader, anotherValue
95 buildRequestThenRunThroughFilterAndAssertResultRequestHeaders(incomingRequestHeaders, specificTxId(someTxId));
99 public void givenNoRequestIdHeader_headerValueWasGenerated() throws IOException, ServletException {
101 final ImmutableMap<String, String> incomingRequestHeaders = ImmutableMap.of(
102 anotherHeader, anotherValue
105 buildRequestThenRunThroughFilterAndAssertResultRequestHeaders(incomingRequestHeaders, UserUtils::getRequestId);
109 private void buildRequestThenRunThroughFilterAndAssertResultRequestHeaders(
110 ImmutableMap<String, String> originalRequestHeaders,
111 Function<HttpServletRequest, String> txIdExtractor
112 ) throws IOException, ServletException {
113 HttpServletRequest servletRequest = createMockedHttpServletRequest(originalRequestHeaders);
114 HttpServletResponse servletResponse = createMockedHttpServletResponse();
116 final FilterChain capturingFilterChain = Mockito.mock(FilterChain.class);
120 // doFilter() is the function under test
122 new PromiseEcompRequestIdFilter().doFilter(servletRequest, servletResponse, capturingFilterChain);
126 final ServletRequest capturedServletRequest = extractCapturedServletRequest(capturingFilterChain);
127 final ServletResponse capturedServletResponse = extractCapturedServletResponse(capturingFilterChain);
128 final String expectedTxId = txIdExtractor.apply((HttpServletRequest) capturedServletRequest);
130 assertRequestObjectHeaders(capturedServletRequest, expectedTxId);
131 assertResponseObjectHeaders(capturedServletResponse, expectedTxId);
135 private void assertRequestObjectHeaders(ServletRequest request, String expectedTxId) {
138 - Two headers are in place
139 - Direct value extraction is as expected
140 - UserUtils.getRequestId() returns correct and valid value
142 final HttpServletRequest httpServletRequest = (HttpServletRequest) request;
144 assertThat(Collections.list(httpServletRequest.getHeaderNames()),
145 containsInAnyOrder(equalToIgnoringCase(ECOMP_REQUEST_ID), equalToIgnoringCase(anotherHeader)));
147 assertThat(httpServletRequest.getHeader(anotherHeader), is(anotherValue));
149 assertThat(httpServletRequest.getHeader(ECOMP_REQUEST_ID), is(expectedTxId));
150 assertThat(httpServletRequest.getHeader(mixedCaseHeader), is(expectedTxId));
152 assertThat(UserUtils.getRequestId(httpServletRequest), is(expectedTxId));
153 assertThat(UserUtils.getRequestId(httpServletRequest), is(not(emptyOrNullString())));
156 private void assertResponseObjectHeaders(ServletResponse response, String txId) {
157 final String REQUEST_ID_HEADER_NAME_IN_RESPONSE = mixedCaseHeader + "-echo";
158 final HttpServletResponse httpServletResponse = (HttpServletResponse) response;
160 assertThat("header " + REQUEST_ID_HEADER_NAME_IN_RESPONSE.toLowerCase() + " in response must be provided",
161 httpServletResponse.getHeader(REQUEST_ID_HEADER_NAME_IN_RESPONSE), is(txId));
166 private HttpServletRequest createMockedHttpServletRequest(Map<String, String> requestHeaders) {
167 HttpServletRequest servletRequest = Mockito.mock(HttpServletRequest.class);
168 requestHeaders.forEach((k, v) -> {
169 Mockito.when(servletRequest.getHeader(argThat(s -> equalsIgnoreCase(s, k)))).thenReturn(v);
170 Mockito.when(servletRequest.getHeaders(argThat(s -> equalsIgnoreCase(s, k)))).then(returnEnumerationAnswer(v));
172 Mockito.when(servletRequest.getHeaderNames()).then(returnEnumerationAnswer(requestHeaders.keySet()));
173 return servletRequest;
176 private HttpServletResponse createMockedHttpServletResponse() {
177 return new MockHttpServletResponse();
180 private static Answer<Enumeration<String>> returnEnumerationAnswer(String ... items) {
181 return returnEnumerationAnswer(Arrays.asList(items));
184 private static Answer<Enumeration<String>> returnEnumerationAnswer(Collection<String> items) {
185 return invocation -> Collections.enumeration(items);
188 private Function<HttpServletRequest, String> specificTxId(String someTxId) {
189 return r -> someTxId;
192 private ServletRequest extractCapturedServletRequest(FilterChain capturingFilterChain) throws IOException, ServletException {
193 ArgumentCaptor<ServletRequest> captor = ArgumentCaptor.forClass(ServletRequest.class);
194 Mockito.verify(capturingFilterChain).doFilter(captor.capture(), any());
195 return captor.getValue();
198 private ServletResponse extractCapturedServletResponse(FilterChain capturingFilterChain) throws IOException, ServletException {
199 ArgumentCaptor<ServletResponse> captor = ArgumentCaptor.forClass(ServletResponse.class);
200 Mockito.verify(capturingFilterChain).doFilter(any(), captor.capture());
201 return captor.getValue();