| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You 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. |
| */ |
| package org.apache.logging.log4j.nosql.appender; |
| |
| import java.io.IOException; |
| import java.sql.SQLException; |
| import java.util.Collection; |
| import java.util.Date; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| |
| import org.apache.logging.log4j.Level; |
| import org.apache.logging.log4j.MarkerManager; |
| import org.apache.logging.log4j.ThreadContext; |
| import org.apache.logging.log4j.core.LogEvent; |
| import org.apache.logging.log4j.core.appender.AppenderLoggingException; |
| import org.apache.logging.log4j.core.impl.Log4jLogEvent; |
| import org.apache.logging.log4j.junit.ThreadContextStackRule; |
| import org.apache.logging.log4j.message.Message; |
| import org.junit.Before; |
| import org.junit.Rule; |
| import org.junit.Test; |
| import org.junit.rules.ExpectedException; |
| import org.junit.runner.RunWith; |
| import org.mockito.ArgumentCaptor; |
| import org.mockito.Captor; |
| import org.mockito.Mock; |
| import org.mockito.invocation.InvocationOnMock; |
| import org.mockito.runners.MockitoJUnitRunner; |
| import org.mockito.stubbing.Answer; |
| |
| import static org.junit.Assert.*; |
| import static org.mockito.ArgumentMatchers.anyInt; |
| import static org.mockito.BDDMockito.given; |
| import static org.mockito.BDDMockito.then; |
| import static org.mockito.Mockito.mock; |
| |
| @RunWith(MockitoJUnitRunner.class) |
| public class NoSqlDatabaseManagerTest { |
| @Mock |
| private NoSqlConnection<Map<String, Object>, DefaultNoSqlObject> connection; |
| @Mock |
| private NoSqlProvider<NoSqlConnection<Map<String, Object>, DefaultNoSqlObject>> provider; |
| @Mock |
| private Message message; |
| @Captor |
| private ArgumentCaptor<NoSqlObject<Map<String, Object>>> captor; |
| |
| @Rule |
| public final ThreadContextStackRule threadContextRule = new ThreadContextStackRule(); |
| @Rule |
| public final ExpectedException expectedException = ExpectedException.none(); |
| |
| @Before |
| public void setUp() { |
| given(provider.getConnection()).willReturn(connection); |
| given(connection.createObject()).willAnswer(new Answer<DefaultNoSqlObject>() { |
| @Override |
| public DefaultNoSqlObject answer(final InvocationOnMock invocation) throws Throwable { |
| return new DefaultNoSqlObject(); |
| } |
| }); |
| given(connection.createList(anyInt())).willAnswer(new Answer<DefaultNoSqlObject[]>() { |
| @Override |
| public DefaultNoSqlObject[] answer(final InvocationOnMock invocation) throws Throwable { |
| return new DefaultNoSqlObject[invocation.<Integer>getArgument(0)]; |
| } |
| }); |
| } |
| |
| @Test |
| public void testConnection() { |
| try (final NoSqlDatabaseManager<?> manager = NoSqlDatabaseManager.getNoSqlDatabaseManager("name", 0, |
| provider)) { |
| |
| assertNotNull("The manager should not be null.", manager); |
| |
| manager.connectAndStart(); |
| then(provider).should().getConnection(); |
| manager.commitAndClose(); |
| } |
| } |
| |
| @Test |
| public void testWriteInternalNotConnected01() { |
| try (final NoSqlDatabaseManager<?> manager = NoSqlDatabaseManager.getNoSqlDatabaseManager("name", 0, |
| provider)) { |
| expectedException.expect(AppenderLoggingException.class); |
| manager.writeInternal(mock(LogEvent.class)); |
| } |
| } |
| |
| @Test |
| public void testWriteInternalNotConnected02() { |
| given(connection.isClosed()).willReturn(true); |
| |
| try (final NoSqlDatabaseManager<?> manager = NoSqlDatabaseManager.getNoSqlDatabaseManager("name", 0, |
| provider)) { |
| |
| manager.startup(); |
| manager.connectAndStart(); |
| then(provider).should().getConnection(); |
| |
| expectedException.expect(AppenderLoggingException.class); |
| manager.writeInternal(mock(LogEvent.class)); |
| } |
| } |
| |
| @Test |
| public void testWriteInternal01() { |
| given(connection.isClosed()).willReturn(false); |
| given(message.getFormattedMessage()).willReturn("My formatted message 01."); |
| |
| try (final NoSqlDatabaseManager<?> manager = NoSqlDatabaseManager.getNoSqlDatabaseManager("name", 0, |
| provider)) { |
| |
| manager.startup(); |
| manager.connectAndStart(); |
| then(provider).should().getConnection(); |
| |
| final LogEvent event = Log4jLogEvent.newBuilder() |
| .setLevel(Level.WARN) |
| .setLoggerName("com.foo.NoSQLDbTest.testWriteInternal01") |
| .setMessage(message) |
| .setSource(new StackTraceElement("com.foo.Bar", "testMethod01", "Bar.java", 15)) |
| .setThreadId(1L) |
| .setThreadName("MyThread-A") |
| .setThreadPriority(1) |
| .setTimeMillis(1234567890123L) |
| .build(); |
| |
| manager.writeInternal(event); |
| then(connection).should().insertObject(captor.capture()); |
| |
| final NoSqlObject<Map<String, Object>> inserted = captor.getValue(); |
| assertNotNull("The inserted value should not be null.", inserted); |
| final Map<String, Object> object = inserted.unwrap(); |
| assertNotNull("The unwrapped object should not be null.", object); |
| |
| assertEquals("The level is not correct.", Level.WARN, object.get("level")); |
| assertEquals("The logger is not correct.", "com.foo.NoSQLDbTest.testWriteInternal01", |
| object.get("loggerName")); |
| assertEquals("The message is not correct.", "My formatted message 01.", object.get("message")); |
| assertEquals("The thread is not correct.", "MyThread-A", object.get("threadName")); |
| assertEquals("The millis is not correct.", 1234567890123L, object.get("millis")); |
| assertEquals("The date is not correct.", 1234567890123L, ((Date) object.get("date")).getTime()); |
| |
| assertTrue("The source should be a map.", object.get("source") instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> source = (Map<String, Object>) object.get("source"); |
| assertEquals("The class is not correct.", "com.foo.Bar", source.get("className")); |
| assertEquals("The method is not correct.", "testMethod01", source.get("methodName")); |
| assertEquals("The file name is not correct.", "Bar.java", source.get("fileName")); |
| assertEquals("The line number is not correct.", 15, source.get("lineNumber")); |
| |
| assertNull("The marker should be null.", object.get("marker")); |
| |
| assertNull("The thrown should be null.", object.get("thrown")); |
| |
| assertTrue("The context map should be empty.", ((Map) object.get("contextMap")).isEmpty()); |
| |
| assertTrue("The context stack should be null.", ((Collection) object.get("contextStack")).isEmpty()); |
| |
| } |
| } |
| |
| @Test |
| public void testWriteInternal02() { |
| given(connection.isClosed()).willReturn(false); |
| given(message.getFormattedMessage()).willReturn("Another cool message 02."); |
| |
| try (final NoSqlDatabaseManager<?> manager = NoSqlDatabaseManager.getNoSqlDatabaseManager("name", 0, |
| provider)) { |
| manager.startup(); |
| |
| manager.connectAndStart(); |
| then(provider).should().getConnection(); |
| |
| final RuntimeException exception = new RuntimeException("This is something cool!"); |
| final Map<String, String> context = new HashMap<>(); |
| context.put("hello", "world"); |
| context.put("user", "pass"); |
| |
| ThreadContext.push("message1"); |
| ThreadContext.push("stack2"); |
| final ThreadContext.ContextStack stack = ThreadContext.getImmutableStack(); |
| ThreadContext.clearStack(); |
| |
| final LogEvent event = Log4jLogEvent.newBuilder() |
| .setLevel(Level.DEBUG) |
| .setLoggerName("com.foo.NoSQLDbTest.testWriteInternal02") |
| .setMessage(message) |
| .setSource(new StackTraceElement("com.bar.Foo", "anotherMethod03", "Foo.java", 9)) |
| .setMarker(MarkerManager.getMarker("LoneMarker")) |
| .setThreadId(1L) |
| .setThreadName("AnotherThread-B") |
| .setThreadPriority(1) |
| .setTimeMillis(987654321564L) |
| .setThrown(exception) |
| .setContextMap(context) |
| .setContextStack(stack) |
| .build(); |
| |
| manager.writeInternal(event); |
| then(connection).should().insertObject(captor.capture()); |
| |
| final NoSqlObject<Map<String, Object>> inserted = captor.getValue(); |
| assertNotNull("The inserted value should not be null.", inserted); |
| final Map<String, Object> object = inserted.unwrap(); |
| assertNotNull("The unwrapped object should not be null.", object); |
| |
| assertEquals("The level is not correct.", Level.DEBUG, object.get("level")); |
| assertEquals("The logger is not correct.", "com.foo.NoSQLDbTest.testWriteInternal02", |
| object.get("loggerName")); |
| assertEquals("The message is not correct.", "Another cool message 02.", object.get("message")); |
| assertEquals("The thread is not correct.", "AnotherThread-B", object.get("threadName")); |
| assertEquals("The millis is not correct.", 987654321564L, object.get("millis")); |
| assertEquals("The date is not correct.", 987654321564L, ((Date) object.get("date")).getTime()); |
| |
| assertTrue("The source should be a map.", object.get("source") instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> source = (Map<String, Object>) object.get("source"); |
| assertEquals("The class is not correct.", "com.bar.Foo", source.get("className")); |
| assertEquals("The method is not correct.", "anotherMethod03", source.get("methodName")); |
| assertEquals("The file name is not correct.", "Foo.java", source.get("fileName")); |
| assertEquals("The line number is not correct.", 9, source.get("lineNumber")); |
| |
| assertTrue("The marker should be a map.", object.get("marker") instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> marker = (Map<String, Object>) object.get("marker"); |
| assertEquals("The marker name is not correct.", "LoneMarker", marker.get("name")); |
| assertNull("The marker parent should be null.", marker.get("parent")); |
| |
| assertTrue("The thrown should be a map.", object.get("thrown") instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> thrown = (Map<String, Object>) object.get("thrown"); |
| assertEquals("The thrown type is not correct.", "java.lang.RuntimeException", thrown.get("type")); |
| assertEquals("The thrown message is not correct.", "This is something cool!", thrown.get("message")); |
| assertTrue("The thrown stack trace should be a list.", thrown.get("stackTrace") instanceof List); |
| @SuppressWarnings("unchecked") |
| final List<Map<String, Object>> stackTrace = (List<Map<String, Object>>) thrown.get("stackTrace"); |
| assertEquals("The thrown stack trace length is not correct.", exception.getStackTrace().length, |
| stackTrace.size()); |
| for (int i = 0; i < exception.getStackTrace().length; i++) { |
| final StackTraceElement e1 = exception.getStackTrace()[i]; |
| final Map<String, Object> e2 = stackTrace.get(i); |
| |
| assertEquals("Element class name [" + i + "] is not correct.", e1.getClassName(), e2.get("className")); |
| assertEquals("Element method name [" + i + "] is not correct.", e1.getMethodName(), |
| e2.get("methodName")); |
| assertEquals("Element file name [" + i + "] is not correct.", e1.getFileName(), e2.get("fileName")); |
| assertEquals("Element line number [" + i + "] is not correct.", e1.getLineNumber(), |
| e2.get("lineNumber")); |
| } |
| assertNull("The thrown should have no cause.", thrown.get("cause")); |
| |
| assertTrue("The context map should be a map.", object.get("contextMap") instanceof Map); |
| assertEquals("The context map is not correct.", context, object.get("contextMap")); |
| |
| assertTrue("The context stack should be list.", object.get("contextStack") instanceof List); |
| assertEquals("The context stack is not correct.", stack.asList(), object.get("contextStack")); |
| } |
| } |
| |
| @Test |
| public void testWriteInternal03() { |
| given(connection.isClosed()).willReturn(false); |
| given(message.getFormattedMessage()).willReturn("Another cool message 02."); |
| |
| try (final NoSqlDatabaseManager<?> manager = NoSqlDatabaseManager.getNoSqlDatabaseManager("name", 0, |
| provider)) { |
| manager.startup(); |
| |
| manager.connectAndStart(); |
| then(provider).should().getConnection(); |
| |
| final IOException exception1 = new IOException("This is the cause."); |
| final SQLException exception2 = new SQLException("This is the result.", exception1); |
| final Map<String, String> context = new HashMap<>(); |
| context.put("hello", "world"); |
| context.put("user", "pass"); |
| |
| ThreadContext.push("message1"); |
| ThreadContext.push("stack2"); |
| final ThreadContext.ContextStack stack = ThreadContext.getImmutableStack(); |
| ThreadContext.clearStack(); |
| |
| final LogEvent event = Log4jLogEvent.newBuilder() |
| .setLevel(Level.DEBUG) |
| .setLoggerName("com.foo.NoSQLDbTest.testWriteInternal02") |
| .setMessage(message) |
| .setSource(new StackTraceElement("com.bar.Foo", "anotherMethod03", "Foo.java", 9)) |
| .setMarker(MarkerManager.getMarker("AnotherMarker").addParents( |
| MarkerManager.getMarker("Parent1").addParents(MarkerManager.getMarker("GrandParent1")), |
| MarkerManager.getMarker("Parent2"))) |
| .setThreadId(1L) |
| .setThreadName("AnotherThread-B") |
| .setThreadPriority(1) |
| .setTimeMillis(987654321564L) |
| .setThrown(exception2) |
| .setContextMap(context) |
| .setContextStack(stack) |
| .build(); |
| |
| manager.writeInternal(event); |
| then(connection).should().insertObject(captor.capture()); |
| |
| final NoSqlObject<Map<String, Object>> inserted = captor.getValue(); |
| assertNotNull("The inserted value should not be null.", inserted); |
| final Map<String, Object> object = inserted.unwrap(); |
| assertNotNull("The unwrapped object should not be null.", object); |
| |
| assertEquals("The level is not correct.", Level.DEBUG, object.get("level")); |
| assertEquals("The logger is not correct.", "com.foo.NoSQLDbTest.testWriteInternal02", |
| object.get("loggerName")); |
| assertEquals("The message is not correct.", "Another cool message 02.", object.get("message")); |
| assertEquals("The thread is not correct.", "AnotherThread-B", object.get("threadName")); |
| assertEquals("The millis is not correct.", 987654321564L, object.get("millis")); |
| assertEquals("The date is not correct.", 987654321564L, ((Date) object.get("date")).getTime()); |
| |
| assertTrue("The source should be a map.", object.get("source") instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> source = (Map<String, Object>) object.get("source"); |
| assertEquals("The class is not correct.", "com.bar.Foo", source.get("className")); |
| assertEquals("The method is not correct.", "anotherMethod03", source.get("methodName")); |
| assertEquals("The file name is not correct.", "Foo.java", source.get("fileName")); |
| assertEquals("The line number is not correct.", 9, source.get("lineNumber")); |
| |
| assertTrue("The marker should be a map.", object.get("marker") instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> marker = (Map<String, Object>) object.get("marker"); |
| assertEquals("The marker name is not correct.", "AnotherMarker", marker.get("name")); |
| |
| assertTrue("The marker parents should be a list.", marker.get("parents") instanceof List); |
| @SuppressWarnings("unchecked") |
| final List<Object> markerParents = (List<Object>) marker.get("parents"); |
| assertEquals("The marker parents should contain two parents", 2, markerParents.size()); |
| |
| assertTrue("The marker parents[0] should be a map.", markerParents.get(0) instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> parent1 = (Map<String, Object>) markerParents.get(0); |
| assertEquals("The first marker parent name is not correct.", "Parent1", parent1.get("name")); |
| |
| assertTrue("The marker parents[1] should be a map.", markerParents.get(1) instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> parent2 = (Map<String, Object>) markerParents.get(1); |
| assertEquals("The second marker parent name is not correct.", "Parent2", parent2.get("name")); |
| assertNull("The second marker should have no parent.", parent2.get("parent")); |
| |
| assertTrue("The parent1 parents should be a list.", parent1.get("parents") instanceof List); |
| @SuppressWarnings("unchecked") |
| final List<Object> parent1Parents = (List<Object>) parent1.get("parents"); |
| assertEquals("The parent1 parents should have only one parent", 1, parent1Parents.size()); |
| |
| assertTrue("The parent1Parents[0] should be a map.", parent1Parents.get(0) instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> parent1parent = (Map<String, Object>) parent1Parents.get(0); |
| assertEquals("The first parent1 parent name is not correct.", "GrandParent1", parent1parent.get("name")); |
| assertNull("The parent1parent marker should have no parent.", parent1parent.get("parent")); |
| |
| assertTrue("The thrown should be a map.", object.get("thrown") instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> thrown = (Map<String, Object>) object.get("thrown"); |
| assertEquals("The thrown type is not correct.", "java.sql.SQLException", thrown.get("type")); |
| assertEquals("The thrown message is not correct.", "This is the result.", thrown.get("message")); |
| assertTrue("The thrown stack trace should be a list.", thrown.get("stackTrace") instanceof List); |
| @SuppressWarnings("unchecked") |
| final List<Map<String, Object>> stackTrace = (List<Map<String, Object>>) thrown.get("stackTrace"); |
| assertEquals("The thrown stack trace length is not correct.", exception2.getStackTrace().length, |
| stackTrace.size()); |
| for (int i = 0; i < exception2.getStackTrace().length; i++) { |
| final StackTraceElement e1 = exception2.getStackTrace()[i]; |
| final Map<String, Object> e2 = stackTrace.get(i); |
| |
| assertEquals("Element class name [" + i + "] is not correct.", e1.getClassName(), e2.get("className")); |
| assertEquals("Element method name [" + i + "] is not correct.", e1.getMethodName(), |
| e2.get("methodName")); |
| assertEquals("Element file name [" + i + "] is not correct.", e1.getFileName(), e2.get("fileName")); |
| assertEquals("Element line number [" + i + "] is not correct.", e1.getLineNumber(), |
| e2.get("lineNumber")); |
| } |
| assertTrue("The thrown cause should be a map.", thrown.get("cause") instanceof Map); |
| @SuppressWarnings("unchecked") |
| final Map<String, Object> cause = (Map<String, Object>) thrown.get("cause"); |
| assertEquals("The cause type is not correct.", "java.io.IOException", cause.get("type")); |
| assertEquals("The cause message is not correct.", "This is the cause.", cause.get("message")); |
| assertTrue("The cause stack trace should be a list.", cause.get("stackTrace") instanceof List); |
| @SuppressWarnings("unchecked") |
| final List<Map<String, Object>> causeStackTrace = (List<Map<String, Object>>) cause.get("stackTrace"); |
| assertEquals("The cause stack trace length is not correct.", exception1.getStackTrace().length, |
| causeStackTrace.size()); |
| for (int i = 0; i < exception1.getStackTrace().length; i++) { |
| final StackTraceElement e1 = exception1.getStackTrace()[i]; |
| final Map<String, Object> e2 = causeStackTrace.get(i); |
| |
| assertEquals("Element class name [" + i + "] is not correct.", e1.getClassName(), e2.get("className")); |
| assertEquals("Element method name [" + i + "] is not correct.", e1.getMethodName(), |
| e2.get("methodName")); |
| assertEquals("Element file name [" + i + "] is not correct.", e1.getFileName(), e2.get("fileName")); |
| assertEquals("Element line number [" + i + "] is not correct.", e1.getLineNumber(), |
| e2.get("lineNumber")); |
| } |
| assertNull("The cause should have no cause.", cause.get("cause")); |
| |
| assertTrue("The context map should be a map.", object.get("contextMap") instanceof Map); |
| assertEquals("The context map is not correct.", context, object.get("contextMap")); |
| |
| assertTrue("The context stack should be list.", object.get("contextStack") instanceof List); |
| assertEquals("The context stack is not correct.", stack.asList(), object.get("contextStack")); |
| } |
| } |
| } |