reference/logging-filter/logging-filter-base/src/test/java/org/onap/logging/filter/base/MDCSetupTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - Logging
   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
  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.logging.filter.base;
  22
  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;
  27 import java.util.HashMap;
  28 import javax.servlet.http.HttpServletRequest;
  29 import javax.ws.rs.core.HttpHeaders;
  30 import javax.ws.rs.core.MultivaluedHashMap;
  31 import javax.ws.rs.core.MultivaluedMap;
  32 import org.junit.After;
  33 import org.junit.Test;
  34 import org.junit.runner.RunWith;
  35 import org.mockito.Mock;
  36 import org.mockito.junit.MockitoJUnitRunner;
  37 import org.onap.logging.ref.slf4j.ONAPLogConstants;
  38 import org.slf4j.MDC;
  39
  40 @RunWith(MockitoJUnitRunner.class)
  41 public class MDCSetupTest extends MDCSetup {
  42
  43     @Mock
  44     private HttpServletRequest httpServletRequest;
  45
  46     private String requestId = "4d31fe02-4918-4975-942f-fe51a44e6a9b";
  47     private String invocationId = "4d31fe02-4918-4975-942f-fe51a44e6a9a";
  48
  49     @After
  50     public void tearDown() {
  51         MDC.clear();
  52         System.clearProperty("partnerName");
  53     }
  54
  55     @Test
  56     public void setElapsedTimeTest() {
  57         String expected = "318";
  58         MDC.put(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP, "2019-06-18T02:09:06.024Z");
  59         MDC.put(ONAPLogConstants.MDCs.LOG_TIMESTAMP, "2019-06-18T02:09:06.342Z");
  60
  61         setElapsedTime();
  62         assertEquals(expected, MDC.get(ONAPLogConstants.MDCs.ELAPSED_TIME));
  63     }
  64
  65     @Test
  66     public void setElapsedTimeInvokeTimestampTest() {
  67         String expected = "318";
  68         MDC.put(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP, "2019-06-18T02:09:06.024Z");
  69         MDC.put(ONAPLogConstants.MDCs.LOG_TIMESTAMP, "2019-06-18T02:09:06.342Z");
  70
  71         setElapsedTimeInvokeTimestamp();
  72         assertEquals(expected, MDC.get(ONAPLogConstants.MDCs.ELAPSED_TIME));
  73     }
  74
  75     @Test
  76     public void setRequestIdTest() {
  77         HashMap<String, String> headers = new HashMap<>();
  78         headers.put(ONAPLogConstants.Headers.REQUEST_ID, requestId);
  79         String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
  80         assertEquals(requestId, fetchedRequestId);
  81     }
  82
  83     @Test
  84     public void setRequestIdRequestIdHeaderTest() {
  85         HashMap<String, String> headers = new HashMap<>();
  86         headers.put(Constants.HttpHeaders.HEADER_REQUEST_ID, requestId);
  87         String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
  88         assertEquals(requestId, fetchedRequestId);
  89     }
  90
  91     @Test
  92     public void setRequestIdTransactionIdHeaderTest() {
  93         HashMap<String, String> headers = new HashMap<>();
  94         headers.put(Constants.HttpHeaders.TRANSACTION_ID, requestId);
  95         String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
  96         assertEquals(requestId, fetchedRequestId);
  97     }
  98
  99     @Test
 100     public void setRequestIdEcompRequestIdHeaderTest() {
 101         HashMap<String, String> headers = new HashMap<>();
 102         headers.put(Constants.HttpHeaders.ECOMP_REQUEST_ID, requestId);
 103         String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
 104         assertEquals(requestId, fetchedRequestId);
 105     }
 106
 107     @Test
 108     public void setRequestIdNoHeaderTest() {
 109         HashMap<String, String> headers = new HashMap<>();
 110         String fetchedRequestId = getRequestId(new SimpleHashMap(headers));
 111         assertNotNull(fetchedRequestId);
 112     }
 113
 114     @Test
 115     public void setInvocationIdTest() {
 116         HashMap<String, String> headers = new HashMap<>();
 117         headers.put(ONAPLogConstants.Headers.INVOCATION_ID, invocationId);
 118         setInvocationId(new SimpleHashMap(headers));
 119         assertEquals(invocationId, MDC.get(ONAPLogConstants.MDCs.SERVER_INVOCATION_ID));
 120         assertEquals(invocationId, MDC.get(ONAPLogConstants.MDCs.INVOCATION_ID));
 121     }
 122
 123     @Test
 124     public void setInvocationIdNoHeaderTest() {
 125         HashMap<String, String> headers = new HashMap<>();
 126         setInvocationId(new SimpleHashMap(headers));
 127         assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_INVOCATION_ID));
 128         assertNotNull(MDC.get(ONAPLogConstants.MDCs.INVOCATION_ID));
 129     }
 130
 131     @Test
 132     public void setResponseStatusCodeTest() {
 133         setResponseStatusCode(200);
 134         assertEquals("COMPLETE", MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
 135     }
 136
 137     @Test
 138     public void setResponseStatusCodeErrorTest() {
 139         setResponseStatusCode(400);
 140         assertEquals("ERROR", MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
 141         assertEquals("400", MDC.get(ONAPLogConstants.MDCs.ERROR_CODE));
 142         assertEquals("Bad Request", MDC.get(ONAPLogConstants.MDCs.ERROR_DESC));
 143     }
 144
 145     @Test
 146     public void clearClientMDCsTest() {
 147         MDC.put(ONAPLogConstants.MDCs.CLIENT_INVOCATION_ID, "7b77143c-9b50-410c-ac2f-05758a68e3e9");
 148         MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION, "Bad Gateway");
 149         MDC.put(ONAPLogConstants.MDCs.ERROR_DESC, "Bad Gateway");
 150         MDC.put(ONAPLogConstants.MDCs.ERROR_CODE, "502");
 151         MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, "502");
 152         MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, "502");
 153         MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, "SO");
 154         MDC.put(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME, "SDNC");
 155         MDC.put(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP, "2019-06-18T02:09:06.024Z");
 156
 157         clearClientMDCs();
 158         assertNull(MDC.get(ONAPLogConstants.MDCs.CLIENT_INVOCATION_ID));
 159         assertNull(MDC.get(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION));
 160         assertNull(MDC.get(ONAPLogConstants.MDCs.ERROR_CODE));
 161         assertNull(MDC.get(ONAPLogConstants.MDCs.ERROR_DESC));
 162         assertNull(MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
 163         assertNull(MDC.get(ONAPLogConstants.MDCs.RESPONSE_CODE));
 164         assertNull(MDC.get(ONAPLogConstants.MDCs.TARGET_ENTITY));
 165         assertNull(MDC.get(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME));
 166         assertNull(MDC.get(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP));
 167     }
 168
 169     @Test
 170     public void setTargetEntityTest() {
 171         setTargetEntity(ONAPComponents.SO);
 172         assertEquals("SO", MDC.get(ONAPLogConstants.MDCs.TARGET_ENTITY));
 173     }
 174
 175     @Test
 176     public void setResponseDescriptionTest() {
 177         setResponseDescription(502);
 178         assertEquals("Bad Gateway", MDC.get(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION));
 179     }
 180
 181     @Test
 182     public void setMDCPartnerNameBearerToken() {
 183         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 184         String value = "Bearer some-compex-token";
 185         headerMap.putSingle(HttpHeaders.AUTHORIZATION, value);
 186         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 187
 188         setMDCPartnerName(headers);
 189
 190         assertEquals(Constants.DefaultValues.UNKNOWN, MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 191     }
 192
 193     @Test
 194     public void setMDCPartnerNameFromBasicAuth() {
 195         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 196         String value = "Basic dXNlcjpwYXNz"; // decodes to user:pass
 197         headerMap.putSingle(HttpHeaders.AUTHORIZATION, value);
 198         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 199
 200         setMDCPartnerName(headers);
 201
 202         assertEquals("user", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 203     }
 204
 205     @Test
 206     public void setMDCPartnerNameTest() {
 207         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 208         headerMap.putSingle(ONAPLogConstants.Headers.PARTNER_NAME, "SO");
 209         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 210
 211         setMDCPartnerName(headers);
 212
 213         assertEquals("SO", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 214     }
 215
 216     @Test
 217     public void setMDCPartnerNameUserAgentHeaderTest() {
 218         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 219         headerMap.putSingle(HttpHeaders.USER_AGENT, "Apache-HttpClient/4.5.8 (Java/1.8.0_191)");
 220         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 221
 222         setMDCPartnerName(headers);
 223
 224         assertEquals("Apache-HttpClient/4.5.8 (Java/1.8.0_191)", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 225     }
 226
 227     @Test
 228     public void setMDCPartnerNameNoHeaderTest() {
 229         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 230         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 231
 232         setMDCPartnerName(headers);
 233
 234         assertEquals("UNKNOWN", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 235     }
 236
 237     @Test
 238     public void setServerFQDNTest() {
 239         setServerFQDN();
 240         assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_IP_ADDRESS));
 241         assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_FQDN));
 242     }
 243
 244     @Test
 245     public void setClientIPAddressTest() {
 246         when(httpServletRequest.getHeader("X-Forwarded-For")).thenReturn("127.0.0.2");
 247         setClientIPAddress(httpServletRequest);
 248
 249         assertEquals("127.0.0.2", MDC.get(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS));
 250     }
 251
 252     @Test
 253     public void setClientIPAddressNoHeaderTest() {
 254         when(httpServletRequest.getRemoteAddr()).thenReturn("127.0.0.1");
 255         setClientIPAddress(httpServletRequest);
 256
 257         assertEquals("127.0.0.1", MDC.get(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS));
 258     }
 259
 260     @Test
 261     public void setClientIPAddressNullTest() {
 262         setClientIPAddress(null);
 263
 264         assertEquals("", MDC.get(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS));
 265     }
 266
 267     @Test
 268     public void setEntryTimeStampTest() {
 269         setEntryTimeStamp();
 270
 271         assertNotNull(MDC.get(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP));
 272     }
 273
 274     @Test
 275     public void setLogTimestampTest() {
 276         setLogTimestamp();
 277
 278         assertNotNull(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP));
 279     }
 280
 281     @Test
 282     public void setInstanceIDTest() {
 283         setInstanceID();
 284
 285         assertNotNull(MDC.get(ONAPLogConstants.MDCs.INSTANCE_UUID));
 286     }
 287
 288     @Test
 289     public void getPropertyTest() {
 290         System.setProperty("partnerName", "partnerName");
 291
 292         String partnerName = getProperty("partnerName");
 293         assertEquals("partnerName", partnerName);
 294     }
 295
 296     @Test
 297     public void getPropertyNullTest() {
 298         String partnerName = getProperty("partner");
 299         assertEquals("UNKNOWN", partnerName);
 300     }
 301
 302     @Test
 303     public void overrideServerIp() {
 304         String ip = "127.0.0.1";
 305         System.setProperty(serverIpAddressOverride, ip);
 306         MDCSetup m = new MDCSetup();
 307         assertEquals(ip, m.serverIpAddress);
 308     }
 309
 310     @Test
 311     public void overrideServerFqdn() {
 312         String nodeName = "node300";
 313         System.setProperty(serverFqdnOverride, nodeName);
 314         MDCSetup m = new MDCSetup();
 315         assertEquals(nodeName, m.serverFqdn);
 316     }
 317
 318 }