1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*-
* ============LICENSE_START===============================================
* ONAP SDC
* ========================================================================
* Modifications Copyright (c) 2019 Samsung
* ========================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=================================================
*/
package org.onap.sdc.common.onaplog;
import static com.google.code.beanmatchers.BeanMatchers.hasValidBeanConstructor;
import static com.google.code.beanmatchers.BeanMatchers.hasValidBeanEquals;
import static com.google.code.beanmatchers.BeanMatchers.hasValidBeanHashCodeFor;
import static com.google.code.beanmatchers.BeanMatchers.hasValidGettersAndSetters;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.when;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;
import org.onap.sdc.common.onaplog.enums.LogLevel;
import org.onap.sdc.common.onaplog.enums.OnapLoggerErrorCode;
import org.onap.sdc.common.onaplog.enums.Severity;
import org.slf4j.MDC;
import uk.org.lidalia.slf4jtest.LoggingEvent;
@RunWith(MockitoJUnitRunner.class)
public class OnapLoggerAuditTest {
private static OnapMDCWrapper onapMDCWrapper = OnapMDCWrapper.getInstance();
private static final String DUMMY_SERVER_FQDN = "onap.test.com";
private static final String DUMMY_AUTO_SERVER_IP_ADDRESS = "127.0.0.2";
private static final String INSTANCE_UUID = "testUUID";
private static final String TEST_CLASS_NAME = OnapLoggerAudit.class.getName();
private static final String PROCESS_KEY = "testKey";
private static final String CUSTOM_FIELD1 = "testField1";
private static final String CUSTOM_FIELD2 = "testField2";
private static final String CUSTOM_FIELD3 = "testField3";
private static final String CUSTOM_FIELD4 = "testField4";
private static final String REMOTE_HOST = "testHost";
private static final String SERVICE_NAME = "testName";
private static final String PARENT_NAME = "testParentName";
private static final String RESPONCE_DESC = "exampleDesc";
private static final String SERVICE_INSTANCE_ID = "1234";
private static final String LOG_MESSAGE = "Test Message";
private static final String KEY_REQUEST_ID = "4321";
private static final int ALERT_SEVERITY = 2;
private static final int RESPONSE_CODE = 2;
@Mock
private OnapLoggerErrorCode loggerErrorCode;
@Mock
private Severity severity;
@Test
public void shouldHaveValidGettersAndSetters() {
assertThat(OnapLoggerAudit.class, hasValidGettersAndSetters());
}
@Test
public void checkEquals() {
assertThat(OnapLoggerAudit.class, hasValidBeanEquals());
}
@Test
public void testHasValidConstructor() {
assertThat(OnapLoggerAudit.class, hasValidBeanConstructor());
}
@Test
public void checkHashCodeFor() {
assertThat(OnapLoggerAudit.class, hasValidBeanHashCodeFor());
}
@Test
public void testLoggerAuditFullFlow() {
// given
OnapLoggerAudit audit = OnapLoggerFactory.getLogger(OnapLoggerAudit.class);
assertNotNull(audit);
LoggerAdapter adapter = new LoggerAdapter(OnapLoggerAudit.class);
when(loggerErrorCode.getErrorCode()).thenReturn(RESPONSE_CODE);
when(severity.getSeverityType()).thenReturn(ALERT_SEVERITY);
setupMDC(audit);
validateMDC();
// when
audit.startTimer();
audit.stopTimer();
audit.log(LogLevel.ERROR, TEST_CLASS_NAME, LOG_MESSAGE);
audit.log(LogLevel.WARN, TEST_CLASS_NAME, LOG_MESSAGE);
audit.log(LogLevel.INFO, TEST_CLASS_NAME, LOG_MESSAGE);
audit.log(LogLevel.DEBUG, TEST_CLASS_NAME, LOG_MESSAGE);
// then
ImmutableList<LoggingEvent> logs = adapter.getLoggingEvents();
validateAuditLog(LogLevel.ERROR, logs.get(0));
validateAuditLog(LogLevel.WARN, logs.get(1));
validateAuditLog(LogLevel.INFO, logs.get(2));
validateAuditLog(LogLevel.DEBUG, logs.get(3));
MDC.clear();
}
@Test
public void testCleanLogger() {
// given
OnapLoggerAudit audit = OnapLoggerFactory.getLogger(OnapLoggerAudit.class);
assertNotNull(audit);
audit.onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_KEY_REQUEST_ID);
audit.onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_REMOTE_HOST);
audit.onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_INSTANCE_UUID);
audit.setKeyRequestId(KEY_REQUEST_ID);
audit.setRemoteHost(REMOTE_HOST);
audit.setInstanceUUID(INSTANCE_UUID);
// when
audit.clear();
// then
assertNull(MDC.get(OnapLogConfiguration.MDC_KEY_REQUEST_ID));
assertNull(MDC.get(OnapLogConfiguration.MDC_REMOTE_HOST));
assertNull(MDC.get(OnapLogConfiguration.MDC_INSTANCE_UUID));
}
private void setupMDC(OnapLoggerAudit audit) {
audit.setAutoServerFQDN(DUMMY_SERVER_FQDN)
.setAutoServerIPAddress(DUMMY_AUTO_SERVER_IP_ADDRESS)
.setInstanceUUID(INSTANCE_UUID)
.setOptClassName(TEST_CLASS_NAME)
.setOptProcessKey(PROCESS_KEY)
.setOptAlertSeverity(severity)
.setOptCustomField1(CUSTOM_FIELD1)
.setOptCustomField2(CUSTOM_FIELD2)
.setOptCustomField3(CUSTOM_FIELD3)
.setOptCustomField4(CUSTOM_FIELD4)
.setRemoteHost(REMOTE_HOST)
.setServiceName(SERVICE_NAME)
.setPartnerName(PARENT_NAME)
.setResponseCode(loggerErrorCode)
.setResponseDesc(RESPONCE_DESC)
.setOptServiceInstanceId(SERVICE_INSTANCE_ID)
.setKeyRequestId(KEY_REQUEST_ID);
}
private void validateMDC() {
assertEquals(DUMMY_SERVER_FQDN, MDC.get(OnapLogConfiguration.MDC_SERVER_FQDN));
assertEquals(DUMMY_AUTO_SERVER_IP_ADDRESS, MDC.get(OnapLogConfiguration.MDC_SERVER_IP_ADDRESS));
assertEquals(INSTANCE_UUID, MDC.get(OnapLogConfiguration.MDC_INSTANCE_UUID));
assertEquals(TEST_CLASS_NAME, MDC.get(OnapLogConfiguration.MDC_CLASS_NAME));
assertEquals(PROCESS_KEY, MDC.get(OnapLogConfiguration.MDC_PROCESS_KEY));
assertEquals(String.valueOf(ALERT_SEVERITY), MDC.get(OnapLogConfiguration.MDC_ALERT_SEVERITY));
assertEquals(CUSTOM_FIELD1, MDC.get(OnapLogConfiguration.MDC_OPT_FIELD1));
assertEquals(CUSTOM_FIELD2, MDC.get(OnapLogConfiguration.MDC_OPT_FIELD2));
assertEquals(CUSTOM_FIELD3, MDC.get(OnapLogConfiguration.MDC_OPT_FIELD3));
assertEquals(CUSTOM_FIELD4, MDC.get(OnapLogConfiguration.MDC_OPT_FIELD4));
assertEquals(REMOTE_HOST, MDC.get(OnapLogConfiguration.MDC_REMOTE_HOST));
assertEquals(SERVICE_NAME, MDC.get(OnapLogConfiguration.MDC_SERVICE_NAME));
assertEquals(PARENT_NAME, MDC.get(OnapLogConfiguration.MDC_PARTNER_NAME));
assertEquals(String.valueOf(RESPONSE_CODE), MDC.get(OnapLogConfiguration.MDC_RESPONSE_CODE));
assertEquals(SERVICE_INSTANCE_ID, MDC.get(OnapLogConfiguration.MDC_SERVICE_INSTANCE_ID));
assertEquals(KEY_REQUEST_ID, MDC.get(OnapLogConfiguration.MDC_KEY_REQUEST_ID));
}
private void validateAuditLog(LogLevel logLevel, LoggingEvent log) {
assertEquals(logLevel.name(), log.getLevel().name());
assertEquals(LOG_MESSAGE, log.getMessage());
assertNotNull(log.getTimestamp());
ImmutableMap<String, String> mdc = log.getMdc();
assertEquals(onapMDCWrapper.getFqdn(), mdc.get(OnapLogConfiguration.MDC_SERVER_FQDN));
assertEquals(onapMDCWrapper.getHostAddress(), mdc.get(OnapLogConfiguration.MDC_SERVER_IP_ADDRESS));
assertEquals(INSTANCE_UUID, mdc.get(OnapLogConfiguration.MDC_INSTANCE_UUID));
assertEquals(TEST_CLASS_NAME, mdc.get(OnapLogConfiguration.MDC_CLASS_NAME));
assertEquals(PROCESS_KEY, mdc.get(OnapLogConfiguration.MDC_PROCESS_KEY));
assertEquals(String.valueOf(ALERT_SEVERITY), mdc.get(OnapLogConfiguration.MDC_ALERT_SEVERITY));
assertEquals(CUSTOM_FIELD1, mdc.get(OnapLogConfiguration.MDC_OPT_FIELD1));
assertEquals(CUSTOM_FIELD2, mdc.get(OnapLogConfiguration.MDC_OPT_FIELD2));
assertEquals(CUSTOM_FIELD3, mdc.get(OnapLogConfiguration.MDC_OPT_FIELD3));
assertEquals(CUSTOM_FIELD4, mdc.get(OnapLogConfiguration.MDC_OPT_FIELD4));
assertEquals(REMOTE_HOST, mdc.get(OnapLogConfiguration.MDC_REMOTE_HOST));
assertEquals(SERVICE_NAME, mdc.get(OnapLogConfiguration.MDC_SERVICE_NAME));
assertEquals(PARENT_NAME, mdc.get(OnapLogConfiguration.MDC_PARTNER_NAME));
assertEquals(String.valueOf(RESPONSE_CODE), mdc.get(OnapLogConfiguration.MDC_RESPONSE_CODE));
assertEquals(SERVICE_INSTANCE_ID, mdc.get(OnapLogConfiguration.MDC_SERVICE_INSTANCE_ID));
assertEquals(KEY_REQUEST_ID, mdc.get(OnapLogConfiguration.MDC_KEY_REQUEST_ID));
assertNotNull(mdc.get(OnapLogConfiguration.MDC_BEGIN_TIMESTAMP));
assertNotNull(MDC.get(OnapLogConfiguration.MDC_END_TIMESTAMP));
assertNotNull(MDC.get(OnapLogConfiguration.MDC_ELAPSED_TIME));
}
}
|
