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