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     }
 121
 122     @Test
 123     public void setInvocationIdNoHeaderTest() {
 124         HashMap<String, String> headers = new HashMap<>();
 125         setInvocationId(new SimpleHashMap(headers));
 126         assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_INVOCATION_ID));
 127     }
 128
 129     @Test
 130     public void setResponseStatusCodeTest() {
 131         setResponseStatusCode(200);
 132         assertEquals("COMPLETE", MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
 133     }
 134
 135     @Test
 136     public void setResponseStatusCodeErrorTest() {
 137         setResponseStatusCode(400);
 138         assertEquals("ERROR", MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
 139         assertEquals("400", MDC.get(ONAPLogConstants.MDCs.ERROR_CODE));
 140         assertEquals("Bad Request", MDC.get(ONAPLogConstants.MDCs.ERROR_DESC));
 141     }
 142
 143     @Test
 144     public void clearClientMDCsTest() {
 145         MDC.put(ONAPLogConstants.MDCs.CLIENT_INVOCATION_ID, "7b77143c-9b50-410c-ac2f-05758a68e3e9");
 146         MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION, "Bad Gateway");
 147         MDC.put(ONAPLogConstants.MDCs.ERROR_DESC, "Bad Gateway");
 148         MDC.put(ONAPLogConstants.MDCs.ERROR_CODE, "502");
 149         MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, "502");
 150         MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, "502");
 151         MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, "SO");
 152         MDC.put(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME, "SDNC");
 153         MDC.put(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP, "2019-06-18T02:09:06.024Z");
 154
 155         clearClientMDCs();
 156         assertNull(MDC.get(ONAPLogConstants.MDCs.CLIENT_INVOCATION_ID));
 157         assertNull(MDC.get(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION));
 158         assertNull(MDC.get(ONAPLogConstants.MDCs.ERROR_CODE));
 159         assertNull(MDC.get(ONAPLogConstants.MDCs.ERROR_DESC));
 160         assertNull(MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
 161         assertNull(MDC.get(ONAPLogConstants.MDCs.RESPONSE_CODE));
 162         assertNull(MDC.get(ONAPLogConstants.MDCs.TARGET_ENTITY));
 163         assertNull(MDC.get(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME));
 164         assertNull(MDC.get(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP));
 165     }
 166
 167     @Test
 168     public void setTargetEntityTest() {
 169         setTargetEntity(ONAPComponents.SO);
 170         assertEquals("SO", MDC.get(ONAPLogConstants.MDCs.TARGET_ENTITY));
 171     }
 172
 173     @Test
 174     public void setResponseDescriptionTest() {
 175         setResponseDescription(502);
 176         assertEquals("Bad Gateway", MDC.get(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION));
 177     }
 178
 179     @Test
 180     public void setMDCPartnerNameBearerToken() {
 181         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 182         String value = "Bearer some-compex-token";
 183         headerMap.putSingle(HttpHeaders.AUTHORIZATION, value);
 184         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 185
 186         setMDCPartnerName(headers);
 187
 188         assertEquals(Constants.DefaultValues.UNKNOWN, MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 189     }
 190
 191     @Test
 192     public void setMDCPartnerNameFromBasicAuth() {
 193         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 194         String value = "Basic dXNlcjpwYXNz"; // decodes to user:pass
 195         headerMap.putSingle(HttpHeaders.AUTHORIZATION, value);
 196         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 197
 198         setMDCPartnerName(headers);
 199
 200         assertEquals("user", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 201     }
 202
 203     @Test
 204     public void setMDCPartnerNameTest() {
 205         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 206         headerMap.putSingle(ONAPLogConstants.Headers.PARTNER_NAME, "SO");
 207         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 208
 209         setMDCPartnerName(headers);
 210
 211         assertEquals("SO", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 212     }
 213
 214     @Test
 215     public void setMDCPartnerNameUserAgentHeaderTest() {
 216         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 217         headerMap.putSingle(HttpHeaders.USER_AGENT, "Apache-HttpClient/4.5.8 (Java/1.8.0_191)");
 218         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 219
 220         setMDCPartnerName(headers);
 221
 222         assertEquals("Apache-HttpClient/4.5.8 (Java/1.8.0_191)", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 223     }
 224
 225     @Test
 226     public void setMDCPartnerNameClientIdHeaderTest() {
 227         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 228         headerMap.putSingle(Constants.HttpHeaders.CLIENT_ID, "SO");
 229         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 230
 231         setMDCPartnerName(headers);
 232
 233         assertEquals("SO", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 234     }
 235
 236     @Test
 237     public void setMDCPartnerNameNoHeaderTest() {
 238         MultivaluedMap<String, String> headerMap = new MultivaluedHashMap<>();
 239         SimpleMap headers = new SimpleJaxrsHeadersMap(headerMap);
 240
 241         setMDCPartnerName(headers);
 242
 243         assertEquals("UNKNOWN", MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
 244     }
 245
 246     @Test
 247     public void setServerFQDNTest() {
 248         setServerFQDN();
 249         assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_IP_ADDRESS));
 250         assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_FQDN));
 251     }
 252
 253     @Test
 254     public void setClientIPAddressTest() {
 255         when(httpServletRequest.getHeader("X-Forwarded-For")).thenReturn("127.0.0.2");
 256         setClientIPAddress(httpServletRequest);
 257
 258         assertEquals("127.0.0.2", MDC.get(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS));
 259     }
 260
 261     @Test
 262     public void setClientIPAddressNoHeaderTest() {
 263         when(httpServletRequest.getRemoteAddr()).thenReturn("127.0.0.1");
 264         setClientIPAddress(httpServletRequest);
 265
 266         assertEquals("127.0.0.1", MDC.get(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS));
 267     }
 268
 269     @Test
 270     public void setClientIPAddressNullTest() {
 271         setClientIPAddress(null);
 272
 273         assertEquals("", MDC.get(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS));
 274     }
 275
 276     @Test
 277     public void setEntryTimeStampTest() {
 278         setEntryTimeStamp();
 279
 280         assertNotNull(MDC.get(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP));
 281     }
 282
 283     @Test
 284     public void setLogTimestampTest() {
 285         setLogTimestamp();
 286
 287         assertNotNull(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP));
 288     }
 289
 290     @Test
 291     public void setInstanceIDTest() {
 292         setInstanceID();
 293
 294         assertNotNull(MDC.get(ONAPLogConstants.MDCs.INSTANCE_UUID));
 295     }
 296
 297     @Test
 298     public void getPropertyTest() {
 299         System.setProperty("partnerName", "partnerName");
 300
 301         String partnerName = getProperty("partnerName");
 302         assertEquals("partnerName", partnerName);
 303     }
 304
 305     @Test
 306     public void getPropertyNullTest() {
 307         String partnerName = getProperty("partner");
 308         assertEquals("UNKNOWN", partnerName);
 309     }
 310
 311 }