* ============LICENSE_START=======================================================
* policy-utils
* ================================================================================
- * Copyright (C) 2018-2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2018-2020 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2024 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
package org.onap.policy.drools.utils.logging;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotEquals;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
import java.time.Duration;
import java.time.Instant;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
import org.slf4j.MDC;
-public class MdcTransactionTest {
+class MdcTransactionTest {
@Test
- public void resetSubTransaction() {
+ void testResetSubTransaction() {
MdcTransaction trans =
MdcTransaction.newTransaction(null, null).resetSubTransaction();
assertNullSubTransactionFields(trans);
- assertNotNull(MDC.get(MdcTransaction.REQUEST_ID));
- assertNotNull(MDC.get(MdcTransaction.PARTNER_NAME));
- assertNotNull(MDC.get(MdcTransaction.VIRTUAL_SERVER_NAME));
- assertNotNull(MDC.get(MdcTransaction.SERVER));
- assertNotNull(MDC.get(MdcTransaction.SERVER_IP_ADDRESS));
- assertNotNull(MDC.get(MdcTransaction.SERVER_FQDN));
- assertNotNull(MDC.get(MdcTransaction.SERVICE_NAME));
-
- assertNull(MDC.get(MdcTransaction.INVOCATION_ID));
- assertNull(MDC.get(MdcTransaction.BEGIN_TIMESTAMP));
- assertNull(MDC.get(MdcTransaction.END_TIMESTAMP));
- assertNull(MDC.get(MdcTransaction.ELAPSED_TIME));
- assertNull(MDC.get(MdcTransaction.SERVICE_INSTANCE_ID));
- assertNull(MDC.get(MdcTransaction.INSTANCE_UUID));
- assertNull(MDC.get(MdcTransaction.PROCESS_KEY));
- assertNull(MDC.get(MdcTransaction.STATUS_CODE));
- assertNull(MDC.get(MdcTransaction.RESPONSE_CODE));
- assertNull(MDC.get(MdcTransaction.RESPONSE_DESCRIPTION));
- assertNull(MDC.get(MdcTransaction.SEVERITY));
- assertNull(MDC.get(MdcTransaction.ALERT_SEVERITY));
- assertNull(MDC.get(MdcTransaction.TARGET_ENTITY));
- assertNull(MDC.get(MdcTransaction.TARGET_SERVICE_NAME));
- assertNull(MDC.get(MdcTransaction.TARGET_VIRTUAL_ENTITY));
- assertNull(MDC.get(MdcTransaction.CLIENT_IP_ADDRESS));
- assertNull(MDC.get(MdcTransaction.REMOTE_HOST));
-
- assertEquals(trans.getRequestId(), MDC.get(MdcTransaction.REQUEST_ID));
- assertEquals(trans.getPartner(), MDC.get(MdcTransaction.PARTNER_NAME));
- assertEquals(trans.getVirtualServerName(), MDC.get(MdcTransaction.VIRTUAL_SERVER_NAME));
- assertEquals(trans.getServer(), MDC.get(MdcTransaction.SERVER));
- assertEquals(trans.getServerIpAddress(), MDC.get(MdcTransaction.SERVER_IP_ADDRESS));
- assertEquals(trans.getServerFqdn(), MDC.get(MdcTransaction.SERVER_FQDN));
- assertEquals(trans.getServiceName(), MDC.get(MdcTransaction.SERVICE_NAME));
+ assertNotNullKeys(
+ MdcTransactionConstants.REQUEST_ID,
+ MdcTransactionConstants.PARTNER_NAME,
+ MdcTransactionConstants.VIRTUAL_SERVER_NAME,
+ MdcTransactionConstants.SERVER,
+ MdcTransactionConstants.SERVER_IP_ADDRESS,
+ MdcTransactionConstants.SERVER_FQDN,
+ MdcTransactionConstants.SERVICE_NAME
+ );
+
+
+ assertNullKeys(
+ MdcTransactionConstants.INVOCATION_ID,
+ MdcTransactionConstants.BEGIN_TIMESTAMP,
+ MdcTransactionConstants.END_TIMESTAMP,
+ MdcTransactionConstants.ELAPSED_TIME,
+ MdcTransactionConstants.SERVICE_INSTANCE_ID,
+ MdcTransactionConstants.INSTANCE_UUID,
+ MdcTransactionConstants.PROCESS_KEY,
+ MdcTransactionConstants.STATUS_CODE,
+ MdcTransactionConstants.RESPONSE_CODE,
+ MdcTransactionConstants.RESPONSE_DESCRIPTION,
+ MdcTransactionConstants.SEVERITY,
+ MdcTransactionConstants.TARGET_ENTITY,
+ MdcTransactionConstants.TARGET_SERVICE_NAME,
+ MdcTransactionConstants.TARGET_VIRTUAL_ENTITY,
+ MdcTransactionConstants.CLIENT_IP_ADDRESS,
+ MdcTransactionConstants.REMOTE_HOST
+ );
+
+ assertTransactionFields(trans);
+ }
+
+ private void assertNotNullKeys(String... notNullKeys) {
+ for (String key: notNullKeys) {
+ assertNotNull(key, MDC.get(key));
+ }
+ }
+
+ private void assertNullKeys(String... nullKeys) {
+ for (String key: nullKeys) {
+ assertNull(MDC.get(key));
+ }
}
private void assertNullSubTransactionFields(MdcTransaction trans) {
assertNull(trans.getProcessKey());
assertNull(trans.getClientIpAddress());
assertNull(trans.getRemoteHost());
- assertNull(trans.getAlertSeverity());
+ assertNull(trans.getSeverity());
assertNull(trans.getTargetVirtualEntity());
}
protected void assertTransactionFields(MdcTransaction trans) {
- assertEquals(trans.getRequestId(), MDC.get(MdcTransaction.REQUEST_ID));
- assertEquals(trans.getPartner(), MDC.get(MdcTransaction.PARTNER_NAME));
- assertEquals(trans.getVirtualServerName(), MDC.get(MdcTransaction.VIRTUAL_SERVER_NAME));
- assertEquals(trans.getServer(), MDC.get(MdcTransaction.SERVER));
- assertEquals(trans.getServerIpAddress(), MDC.get(MdcTransaction.SERVER_IP_ADDRESS));
- assertEquals(trans.getServerFqdn(), MDC.get(MdcTransaction.SERVER_FQDN));
- assertEquals(trans.getServiceName(), MDC.get(MdcTransaction.SERVICE_NAME));
+ assertEquals(trans.getRequestId(), MDC.get(MdcTransactionConstants.REQUEST_ID));
+ assertEquals(trans.getPartner(), MDC.get(MdcTransactionConstants.PARTNER_NAME));
+ assertEquals(trans.getVirtualServerName(), MDC.get(MdcTransactionConstants.VIRTUAL_SERVER_NAME));
+ assertEquals(trans.getServer(), MDC.get(MdcTransactionConstants.SERVER));
+ assertEquals(trans.getServerIpAddress(), MDC.get(MdcTransactionConstants.SERVER_IP_ADDRESS));
+ assertEquals(trans.getServerFqdn(), MDC.get(MdcTransactionConstants.SERVER_FQDN));
+ assertEquals(trans.getServiceName(), MDC.get(MdcTransactionConstants.SERVICE_NAME));
}
@Test
- public void flush() {
+ void testFlush() {
MdcTransaction trans =
- MdcTransaction.newTransaction()
+ MdcTransaction.newTransaction()
.setRequestId(null)
.setInvocationId(null)
.setPartner(null)
.setResponseCode("response-code")
.setResponseDescription("response-description")
.setSeverity("severity")
- .setAlertSeverity("alert-severity")
.setTargetEntity("target-entity")
.setTargetServiceName("target-service-name")
.setTargetVirtualEntity("target-virtual-entity")
assertTransactionFields(trans);
- assertNotNull(MDC.get(MdcTransaction.INVOCATION_ID));
- assertNotNull(MDC.get(MdcTransaction.BEGIN_TIMESTAMP));
- assertNotNull(MDC.get(MdcTransaction.END_TIMESTAMP));
- assertNotNull(MDC.get(MdcTransaction.ELAPSED_TIME));
- assertNotNull(MDC.get(MdcTransaction.SERVICE_INSTANCE_ID));
- assertNotNull(MDC.get(MdcTransaction.INSTANCE_UUID));
- assertNotNull(MDC.get(MdcTransaction.PROCESS_KEY));
- assertNotNull(MDC.get(MdcTransaction.STATUS_CODE));
- assertNotNull(MDC.get(MdcTransaction.RESPONSE_CODE));
- assertNotNull(MDC.get(MdcTransaction.RESPONSE_DESCRIPTION));
- assertNotNull(MDC.get(MdcTransaction.SEVERITY));
- assertNotNull(MDC.get(MdcTransaction.ALERT_SEVERITY));
- assertNotNull(MDC.get(MdcTransaction.TARGET_ENTITY));
- assertNotNull(MDC.get(MdcTransaction.TARGET_SERVICE_NAME));
- assertNotNull(MDC.get(MdcTransaction.TARGET_VIRTUAL_ENTITY));
- assertNotNull(MDC.get(MdcTransaction.CLIENT_IP_ADDRESS));
- assertNotNull(MDC.get(MdcTransaction.REMOTE_HOST));
-
- assertEquals(trans.getInvocationId(), MDC.get(MdcTransaction.INVOCATION_ID));
- assertEquals(trans.timestamp(trans.getStartTime()), MDC.get(MdcTransaction.BEGIN_TIMESTAMP));
- assertEquals(trans.timestamp(trans.getEndTime()), MDC.get(MdcTransaction.END_TIMESTAMP));
- assertNotEquals(trans.getElapsedTime(), MDC.get(MdcTransaction.ELAPSED_TIME));
+ assertNotNullKeys(
+ MdcTransactionConstants.INVOCATION_ID,
+ MdcTransactionConstants.BEGIN_TIMESTAMP,
+ MdcTransactionConstants.END_TIMESTAMP,
+ MdcTransactionConstants.ELAPSED_TIME,
+ MdcTransactionConstants.SERVICE_INSTANCE_ID,
+ MdcTransactionConstants.INSTANCE_UUID,
+ MdcTransactionConstants.PROCESS_KEY,
+ MdcTransactionConstants.STATUS_CODE,
+ MdcTransactionConstants.RESPONSE_CODE,
+ MdcTransactionConstants.RESPONSE_DESCRIPTION,
+ MdcTransactionConstants.SEVERITY,
+ MdcTransactionConstants.TARGET_ENTITY,
+ MdcTransactionConstants.TARGET_SERVICE_NAME,
+ MdcTransactionConstants.TARGET_VIRTUAL_ENTITY,
+ MdcTransactionConstants.CLIENT_IP_ADDRESS,
+ MdcTransactionConstants.REMOTE_HOST);
+
+ assertEquals(trans.getInvocationId(), MDC.get(MdcTransactionConstants.INVOCATION_ID));
+ assertEquals(trans.timestamp(trans.getStartTime()), MDC.get(MdcTransactionConstants.BEGIN_TIMESTAMP));
+ assertEquals(trans.timestamp(trans.getEndTime()), MDC.get(MdcTransactionConstants.END_TIMESTAMP));
assertEquals(String.valueOf(Duration.between(trans.getStartTime(), trans.getEndTime()).toMillis()),
- MDC.get(MdcTransaction.ELAPSED_TIME));
- assertEquals(trans.getServiceInstanceId(), MDC.get(MdcTransaction.SERVICE_INSTANCE_ID));
- assertEquals(trans.getInstanceUuid(), MDC.get(MdcTransaction.INSTANCE_UUID));
- assertEquals(trans.getProcessKey(),MDC.get(MdcTransaction.PROCESS_KEY));
- assertEquals(trans.getStatusCode(), MDC.get(MdcTransaction.STATUS_CODE));
- assertEquals(trans.getResponseCode(), MDC.get(MdcTransaction.RESPONSE_CODE));
- assertEquals(trans.getResponseDescription(), MDC.get(MdcTransaction.RESPONSE_DESCRIPTION));
- assertEquals(trans.getSeverity(), MDC.get(MdcTransaction.SEVERITY));
- assertEquals(trans.getAlertSeverity(), MDC.get(MdcTransaction.ALERT_SEVERITY));
- assertEquals(trans.getTargetEntity(), MDC.get(MdcTransaction.TARGET_ENTITY));
- assertEquals(trans.getTargetServiceName(), MDC.get(MdcTransaction.TARGET_SERVICE_NAME));
- assertEquals(trans.getTargetVirtualEntity(), MDC.get(MdcTransaction.TARGET_VIRTUAL_ENTITY));
- assertEquals(trans.getClientIpAddress(), MDC.get(MdcTransaction.CLIENT_IP_ADDRESS));
- assertEquals(trans.getRemoteHost(), MDC.get(MdcTransaction.REMOTE_HOST));
-
- assertEquals("service-instance-id", trans.getServiceInstanceId());
- assertEquals("process-key", trans.getProcessKey());
- assertEquals("status-code", trans.getStatusCode());
- assertEquals("response-code", trans.getResponseCode());
- assertEquals("response-description", trans.getResponseDescription());
- assertEquals("severity", trans.getSeverity());
- assertEquals("alert-severity", trans.getAlertSeverity());
- assertEquals("target-entity", trans.getTargetEntity());
- assertEquals("target-service-name", trans.getTargetServiceName());
- assertEquals("target-virtual-entity", trans.getTargetVirtualEntity());
- assertEquals("client-ip-address", trans.getClientIpAddress());
- assertEquals("remote-host", trans.getRemoteHost());
+ MDC.get(MdcTransactionConstants.ELAPSED_TIME));
+ assertEquals(trans.getInstanceUuid(), MDC.get(MdcTransactionConstants.INSTANCE_UUID));
+
+ assertKeyEquals("service-instance-id", trans.getServiceInstanceId(),
+ MdcTransactionConstants.SERVICE_INSTANCE_ID);
+ assertKeyEquals("process-key", trans.getProcessKey(), MdcTransactionConstants.PROCESS_KEY);
+ assertKeyEquals("status-code", trans.getStatusCode(), MdcTransactionConstants.STATUS_CODE);
+ assertKeyEquals("response-code", trans.getResponseCode(), MdcTransactionConstants.RESPONSE_CODE);
+ assertKeyEquals("response-description", trans.getResponseDescription(),
+ MdcTransactionConstants.RESPONSE_DESCRIPTION);
+ assertKeyEquals("severity", trans.getSeverity(), MdcTransactionConstants.SEVERITY);
+ assertKeyEquals("target-entity", trans.getTargetEntity(), MdcTransactionConstants.TARGET_ENTITY);
+ assertKeyEquals("target-service-name", trans.getTargetServiceName(),
+ MdcTransactionConstants.TARGET_SERVICE_NAME);
+ assertKeyEquals("target-virtual-entity", trans.getTargetVirtualEntity(),
+ MdcTransactionConstants.TARGET_VIRTUAL_ENTITY);
+ assertKeyEquals("client-ip-address", trans.getClientIpAddress(), MdcTransactionConstants.CLIENT_IP_ADDRESS);
+ assertKeyEquals("remote-host", trans.getRemoteHost(), MdcTransactionConstants.REMOTE_HOST);
+ }
+
+ private void assertKeyEquals(String expected, String transValue, String mdcKey) {
+ assertEquals(expected, transValue, "trans." + expected);
+ assertEquals(expected, MDC.get(mdcKey), "mdc." + expected);
}
@Test
- public void metric() {
+ void testMetric() {
MdcTransaction trans =
MdcTransaction.newTransaction(null, null).metric();
}
@Test
- public void transaction() {
+ void testTransaction() {
MdcTransaction trans =
MdcTransaction.newTransaction(null, null).transaction();
}
@Test
- public void subTransaction() {
+ void testSubTransaction() {
MdcTransaction trans =
MdcTransaction.newTransaction(null, "partner");
.setResponseCode("response-code")
.setResponseDescription("response-description")
.setSeverity("severity")
- .setAlertSeverity("alert-severity")
.setTargetEntity("target-entity")
.setTargetServiceName("target-service-name")
.setTargetVirtualEntity("target-virtual-entity")