2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 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.logging.filter.base;
23 import static org.junit.Assert.assertEquals;
24 import static org.junit.Assert.assertNotNull;
25 import static org.junit.Assert.assertNull;
26 import static org.mockito.Mockito.when;
28 import java.time.ZoneOffset;
29 import java.time.ZonedDateTime;
30 import java.util.HashMap;
31 import javax.servlet.http.HttpServletRequest;
32 import javax.ws.rs.core.HttpHeaders;
33 import javax.ws.rs.core.MultivaluedHashMap;
34 import javax.ws.rs.core.MultivaluedMap;
35 import org.junit.After;
36 import org.junit.Test;
37 import org.junit.runner.RunWith;
38 import org.mockito.Mock;
39 import org.mockito.junit.MockitoJUnitRunner;
40 import org.onap.logging.ref.slf4j.ONAPLogConstants;
43 @RunWith(MockitoJUnitRunner.class)
44 public class MDCSetupTest extends MDCSetup {
47 private HttpServletRequest httpServletRequest;
49 private String requestId = "4d31fe02-4918-4975-942f-fe51a44e6a9b";
50 private String invocationId = "4d31fe02-4918-4975-942f-fe51a44e6a9a";
53 public void tearDown() {
55 System.clearProperty("partnerName");
59 public void setElapsedTimeTest() {
60 String expected = "318";
61 MDC.put(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP, "2019-06-18T02:09:06.024Z");
62 MDC.put(ONAPLogConstants.MDCs.LOG_TIMESTAMP, "2019-06-18T02:09:06.342Z");
65 assertEquals(expected, MDC.get(ONAPLogConstants.MDCs.ELAPSED_TIME));
69 public void setElapsedTimeInvokeTimestampTest() {
70 String expected = "318";
71 MDC.put(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP, "2019-06-18T02:09:06.024Z");
72 MDC.put(ONAPLogConstants.MDCs.LOG_TIMESTAMP, "2019-06-18T02:09:06.342Z");
74 setElapsedTimeInvokeTimestamp();
75 assertEquals(expected, MDC.get(ONAPLogConstants.MDCs.ELAPSED_TIME));
79 public void setRequestIdTest() {
80 HashMap<String, String> headers = new HashMap<>();
81 headers.put(ONAPLogConstants.Headers.REQUEST_ID, requestId);
82 String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
83 assertEquals(requestId, fetchedRequestId);
87 public void setRequestIdRequestIdHeaderTest() {
88 HashMap<String, String> headers = new HashMap<>();
89 headers.put(Constants.HttpHeaders.HEADER_REQUEST_ID, requestId);
90 String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
91 assertEquals(requestId, fetchedRequestId);
95 public void setRequestIdTransactionIdHeaderTest() {
96 HashMap<String, String> headers = new HashMap<>();
97 headers.put(Constants.HttpHeaders.TRANSACTION_ID, requestId);
98 String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
99 assertEquals(requestId, fetchedRequestId);
103 public void setRequestIdEcompRequestIdHeaderTest() {
104 HashMap<String, String> headers = new HashMap<>();
105 headers.put(Constants.HttpHeaders.ECOMP_REQUEST_ID, requestId);
106 String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
107 assertEquals(requestId, fetchedRequestId);
111 public void setRequestIdNoHeaderTest() {
112 HashMap<String, String> headers = new HashMap<>();
113 String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
114 assertNotNull(fetchedRequestId);
118 public void setInvocationIdTest() {
119 HashMap<String, String> headers = new HashMap<>();
120 headers.put(ONAPLogConstants.Headers.INVOCATION_ID, invocationId);
121 setInvocationId(new SimpleHashMap(headers));
122 assertEquals(invocationId, MDC.get(ONAPLogConstants.MDCs.SERVER_INVOCATION_ID));
123 assertEquals(invocationId, MDC.get(ONAPLogConstants.MDCs.INVOCATION_ID));
127 public void setInvocationIdNoHeaderTest() {
128 HashMap<String, String> headers = new HashMap<>();
129 setInvocationId(new SimpleHashMap(headers));
130 assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_INVOCATION_ID));
131 assertNotNull(MDC.get(ONAPLogConstants.MDCs.INVOCATION_ID));
135 public void setResponseStatusCodeTest() {
136 setResponseStatusCode(200);
137 assertEquals("COMPLETE", MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
141 public void setResponseStatusCodeErrorTest() {
142 setResponseStatusCode(400);
143 assertEquals("ERROR", MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
144 assertEquals("400", MDC.get(ONAPLogConstants.MDCs.ERROR_CODE));
145 assertEquals("Bad Request", MDC.get(ONAPLogConstants.MDCs.ERROR_DESC));
149 public void clearClientMDCsTest() {
150 MDC.put(ONAPLogConstants.MDCs.CLIENT_INVOCATION_ID, "7b77143c-9b50-410c-ac2f-05758a68e3e9");
151 MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION, "Bad Gateway");
152 MDC.put(ONAPLogConstants.MDCs.ERROR_DESC, "Bad Gateway");
153 MDC.put(ONAPLogConstants.MDCs.ERROR_CODE, "502");
154 MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, "502");
155 MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, "502");
156 MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, "SO");
157 MDC.put(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME, "SDNC");
158 MDC.put(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP, "2019-06-18T02:09:06.024Z");
161 assertNull(MDC.get(ONAPLogConstants.MDCs.CLIENT_INVOCATION_ID));
162 assertNull(MDC.get(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION));
163 assertNull(MDC.get(ONAPLogConstants.MDCs.ERROR_CODE));
164 assertNull(MDC.get(ONAPLogConstants.MDCs.ERROR_DESC));
165 assertNull(MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
166 assertNull(MDC.get(ONAPLogConstants.MDCs.RESPONSE_CODE));
167 assertNull(MDC.get(ONAPLogConstants.MDCs.TARGET_ENTITY));
168 assertNull(MDC.get(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME));
169 assertNull(MDC.get(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP));
173 public void setTargetEntityTest() {
174 setTargetEntity(ONAPComponents.SO);
175 assertEquals("SO", MDC.get(ONAPLogConstants.MDCs.TARGET_ENTITY));
179 public void setResponseDescriptionTest() {
180 setResponseDescription(502);
181 assertEquals("Bad Gateway", MDC.get(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION));
185 public void setMDCPartnerNameBearerToken() {
186 MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
187 String value = "Bearer some-compex-token";
188 headerMap.putSingle(HttpHeaders.AUTHORIZATION, value);
189 SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
191 setMDCPartnerName(headers);
193 assertEquals(Constants.DefaultValues.UNKNOWN, MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
197 public void setMDCPartnerNameFromBasicAuth() {
198 MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
199 String value = "Basic dXNlcjpwYXNz"; // decodes to user:pass
200 headerMap.putSingle(HttpHeaders.AUTHORIZATION, value);
201 SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
203 setMDCPartnerName(headers);
205 assertEquals("user", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
209 public void setMDCPartnerNameTest() {
210 MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
211 headerMap.putSingle(ONAPLogConstants.Headers.PARTNER_NAME, "SO");
212 SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
214 setMDCPartnerName(headers);
216 assertEquals("SO", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
220 public void setMDCPartnerNameUserAgentHeaderTest() {
221 MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
222 headerMap.putSingle(HttpHeaders.USER_AGENT, "Apache-HttpClient/4.5.8 (Java/1.8.0_191)");
223 SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
225 setMDCPartnerName(headers);
227 assertEquals("Apache-HttpClient/4.5.8 (Java/1.8.0_191)", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
231 public void setMDCPartnerNameNoHeaderTest() {
232 MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
233 SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
235 setMDCPartnerName(headers);
237 assertEquals("UNKNOWN", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
241 public void setServerFQDNTest() {
243 assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_IP_ADDRESS));
244 assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_FQDN));
248 public void setClientIPAddressTest() {
249 when(httpServletRequest.getHeader("X-Forwarded-For")).thenReturn("127.0.0.2");
250 setClientIPAddress(httpServletRequest);
252 assertEquals("127.0.0.2", MDC.get(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS));
256 public void setClientIPAddressNoHeaderTest() {
257 when(httpServletRequest.getRemoteAddr()).thenReturn("127.0.0.1");
258 setClientIPAddress(httpServletRequest);
260 assertEquals("127.0.0.1", MDC.get(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS));
264 public void setClientIPAddressNullTest() {
265 setClientIPAddress(null);
267 assertEquals("", MDC.get(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS));
271 public void setEntryTimeStampTest() {
274 assertNotNull(MDC.get(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP));
278 public void setLogTimestampTest() {
281 assertNotNull(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP));
285 public void setInstanceIDTest() {
288 assertNotNull(MDC.get(ONAPLogConstants.MDCs.INSTANCE_UUID));
292 public void getPropertyTest() {
293 System.setProperty("partnerName", "partnerName");
295 String partnerName = getProperty("partnerName");
296 assertEquals("partnerName", partnerName);
300 public void getPropertyNullTest() {
301 String partnerName = getProperty("partner");
302 assertEquals("UNKNOWN", partnerName);
306 public void overrideServerIp() {
307 String ip = "127.0.0.1";
308 System.setProperty(serverIpAddressOverride, ip);
309 MDCSetup m = new MDCSetup();
310 assertEquals(ip, m.serverIpAddress);
314 public void overrideServerFqdn() {
315 String nodeName = "node300";
316 System.setProperty(serverFqdnOverride, nodeName);
317 MDCSetup m = new MDCSetup();
318 assertEquals(nodeName, m.serverFqdn);
322 public void testPrecision() {
323 System.setProperty(MDCSetup.INSTANT_PRECISION_OVERRIDE, "3");
324 ZonedDateTime zdt = ZonedDateTime.now(ZoneOffset.UTC);
325 zdt = zdt.withNano(333666999);
326 MDCSetup m = new MDCSetup();
327 String currentTimestamp = m.getCurrentTimeStamp();
328 assertEquals(24, currentTimestamp.length());