Repository: logging-log4j2 Updated Branches: refs/heads/LOG4J2-1349-gcfree-threadcontext 7615afadd -> 57eb25143
LOG4J2-1349 addiditional tests Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/57eb2514 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/57eb2514 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/57eb2514 Branch: refs/heads/LOG4J2-1349-gcfree-threadcontext Commit: 57eb25143cc3ff8e4b5688da4e7b301749cc8ce0 Parents: 7615afa Author: rpopma <rpo...@apache.org> Authored: Mon Sep 5 23:13:15 2016 +0900 Committer: rpopma <rpo...@apache.org> Committed: Mon Sep 5 23:13:15 2016 +0900 ---------------------------------------------------------------------- .../logging/log4j/ThreadContextTestAccess.java | 34 ++++ ...ggerAllThreadContextImplementationsTest.java | 186 +++++++++++++++++++ ...AsyncLoggerGarbageFreeThreadContextTest.java | 83 --------- .../AsyncLoggerConfigThreadContextTest.xml | 29 +++ .../resources/AsyncLoggerThreadContextTest.xml | 9 +- 5 files changed, 255 insertions(+), 86 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/57eb2514/log4j-core/src/test/java/org/apache/logging/log4j/ThreadContextTestAccess.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/ThreadContextTestAccess.java b/log4j-core/src/test/java/org/apache/logging/log4j/ThreadContextTestAccess.java new file mode 100644 index 0000000..67c2d98 --- /dev/null +++ b/log4j-core/src/test/java/org/apache/logging/log4j/ThreadContextTestAccess.java @@ -0,0 +1,34 @@ +/* + * 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; + +/** + * <p> + * Utility class to access package protected methods in {@code ThreadContext}. + * </p> + * + * @see ThreadContext + * @since 2.7 + */ +public final class ThreadContextTestAccess { + private ThreadContextTestAccess() { // prevent instantiation + } + + public static void init() { + ThreadContext.init(); + } +} http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/57eb2514/log4j-core/src/test/java/org/apache/logging/log4j/core/async/AsyncLoggerAllThreadContextImplementationsTest.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/async/AsyncLoggerAllThreadContextImplementationsTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/async/AsyncLoggerAllThreadContextImplementationsTest.java new file mode 100644 index 0000000..58b9bec --- /dev/null +++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/async/AsyncLoggerAllThreadContextImplementationsTest.java @@ -0,0 +1,186 @@ +/* + * 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.core.async; + +import java.io.BufferedReader; +import java.io.File; +import java.io.FileReader; +import java.io.IOException; +import java.util.Arrays; +import java.util.Collection; + +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.apache.logging.log4j.ThreadContext; +import org.apache.logging.log4j.ThreadContextAccess; +import org.apache.logging.log4j.ThreadContextTestAccess; +import org.apache.logging.log4j.core.CoreLoggerContexts; +import org.apache.logging.log4j.core.config.ConfigurationFactory; +import org.apache.logging.log4j.core.util.Constants; +import org.apache.logging.log4j.spi.DefaultThreadContextMap; +import org.apache.logging.log4j.util.Unbox; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; + +import static org.junit.Assert.*; + +@RunWith(Parameterized.class) +public class AsyncLoggerAllThreadContextImplementationsTest { + + final static int LINE_COUNT = 130; + private ContextImpl contextImpl; + private Mode asyncMode; + + @BeforeClass + public static void beforeClass() { + System.setProperty("AsyncLogger.RingBufferSize", "128"); // minimum ringbuffer size + System.setProperty("AsyncLoggerConfig.RingBufferSize", "128"); // minimum ringbuffer size + } + + @AfterClass + public static void afterClass() { + System.clearProperty("AsyncLogger.RingBufferSize"); + System.clearProperty("AsyncLoggerConfig.RingBufferSize"); + System.clearProperty(Constants.LOG4J_CONTEXT_SELECTOR); + System.clearProperty(ConfigurationFactory.CONFIGURATION_FILE_PROPERTY); + System.clearProperty("log4j2.garbagefree.threadContextMap"); + System.clearProperty("log4j2.is.webapp"); + System.clearProperty("log4j2.threadContextMap"); + } + + static enum Mode { + ALL_ASYNC, MIXED, BOTH; + + void initSelector() { + if (this == ALL_ASYNC || this == BOTH) { + System.setProperty(Constants.LOG4J_CONTEXT_SELECTOR, AsyncLoggerContextSelector.class.getName()); + } else { + System.clearProperty(Constants.LOG4J_CONTEXT_SELECTOR); + } + } + + void initConfigFile() { + System.setProperty(ConfigurationFactory.CONFIGURATION_FILE_PROPERTY, this == ALL_ASYNC // + ? "AsyncLoggerThreadContextTest.xml" // + : "AsyncLoggerConfigThreadContextTest.xml"); + } + } + + static enum ContextImpl { + WEBAPP, GARBAGE_FREE, COPY_ON_WRITE; + + void init() { + System.clearProperty("log4j2.threadContextMap"); + final String PACKAGE = "org.apache.logging.log4j.spi."; + System.setProperty("log4j2.threadContextMap", PACKAGE + implClassSimpleName()); + ThreadContextTestAccess.init(); + } + + public String implClassSimpleName() { + switch (this) { + case WEBAPP: + return DefaultThreadContextMap.class.getSimpleName(); + case GARBAGE_FREE: + return "GarbageFreeSortedArrayThreadContextMap"; + case COPY_ON_WRITE: + return "CopyOnWriteSortedArrayThreadContextMap"; + } + throw new IllegalStateException("Unknown state " + this); + } + } + + @Parameterized.Parameters + public static Collection<Object[]> data() { + return Arrays.asList(new Object[][] { + { ContextImpl.WEBAPP, Mode.ALL_ASYNC}, + { ContextImpl.WEBAPP, Mode.MIXED }, + { ContextImpl.WEBAPP, Mode.BOTH }, + { ContextImpl.GARBAGE_FREE, Mode.ALL_ASYNC}, + { ContextImpl.GARBAGE_FREE, Mode.MIXED}, + { ContextImpl.GARBAGE_FREE, Mode.BOTH}, + { ContextImpl.COPY_ON_WRITE, Mode.ALL_ASYNC}, + { ContextImpl.COPY_ON_WRITE, Mode.MIXED}, + { ContextImpl.COPY_ON_WRITE, Mode.BOTH} + }); + } + + public AsyncLoggerAllThreadContextImplementationsTest(ContextImpl contextImpl, Mode asyncMode) { + this.contextImpl = contextImpl; + this.asyncMode = asyncMode; + + asyncMode.initSelector(); + asyncMode.initConfigFile(); + + contextImpl.init(); + } + + @Test + public void testAsyncLogWritesToLog() throws Exception { + final File file = new File("target", "AsyncLoggerTest.log"); + // System.out.println(f.getAbsolutePath()); + file.delete(); + + final File sync = new File("target", "SynchronousContextTest.log"); + sync.delete(); + + ThreadContext.push("stackvalue"); + ThreadContext.put("KEY", "mapvalue"); + + final Logger log = LogManager.getLogger("com.foo.Bar"); + for (int i = 0; i < LINE_COUNT; i++) { + if ((i & 1) == 1) { + ThreadContext.put("count", String.valueOf(i)); + } else { + ThreadContext.remove("count"); + } + final String contextmap = ThreadContextAccess.getThreadContextMap().getClass().getSimpleName(); + log.info("{} {} i={}", contextImpl, contextmap, Unbox.box(i)); + } + ThreadContext.pop(); + CoreLoggerContexts.stopLoggerContext(false, file); // stop async thread + + checkResult(file); + if (asyncMode == Mode.MIXED || asyncMode == Mode.BOTH) { + checkResult(sync); + } + LogManager.shutdown(); + } + + private void checkResult(final File file) throws IOException { + final String contextDesc = contextImpl + " " + contextImpl.implClassSimpleName(); + try (final BufferedReader reader = new BufferedReader(new FileReader(file))) { + String expect = null; + for (int i = 0; i < LINE_COUNT; i++) { + String line = reader.readLine(); + if ((i & 1) == 1) { + expect = "INFO c.f.Bar mapvalue [stackvalue] {KEY=mapvalue, count=" + i + "} " + + contextDesc + " i=" + i; + } else { + expect = "INFO c.f.Bar mapvalue [stackvalue] {KEY=mapvalue} " + contextDesc + " i=" + i; + } + assertEquals("line " + i, expect, line); + } + final String noMoreLines = reader.readLine(); + assertNull("done", noMoreLines); + } finally { + file.delete(); + } + } +} http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/57eb2514/log4j-core/src/test/java/org/apache/logging/log4j/core/async/AsyncLoggerGarbageFreeThreadContextTest.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/async/AsyncLoggerGarbageFreeThreadContextTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/async/AsyncLoggerGarbageFreeThreadContextTest.java deleted file mode 100644 index da232bd..0000000 --- a/log4j-core/src/test/java/org/apache/logging/log4j/core/async/AsyncLoggerGarbageFreeThreadContextTest.java +++ /dev/null @@ -1,83 +0,0 @@ -/* - * 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.core.async; - -import java.io.BufferedReader; -import java.io.File; -import java.io.FileReader; - -import org.apache.logging.log4j.LogManager; -import org.apache.logging.log4j.Logger; -import org.apache.logging.log4j.ThreadContext; -import org.apache.logging.log4j.core.CoreLoggerContexts; -import org.apache.logging.log4j.core.config.ConfigurationFactory; -import org.apache.logging.log4j.core.util.Constants; -import org.apache.logging.log4j.util.Unbox; -import org.junit.AfterClass; -import org.junit.BeforeClass; -import org.junit.Test; - -import static org.junit.Assert.*; - -public class AsyncLoggerGarbageFreeThreadContextTest { - - @BeforeClass - public static void beforeClass() { - System.setProperty("log4j2.garbagefree.threadContextMap", "true"); - System.setProperty("AsyncLogger.RingBufferSize", "128"); // minimum ringbuffer size - System.setProperty(Constants.LOG4J_CONTEXT_SELECTOR, - AsyncLoggerContextSelector.class.getName()); - System.setProperty(ConfigurationFactory.CONFIGURATION_FILE_PROPERTY, - "AsyncLoggerThreadContextTest.xml"); - } - - @AfterClass - public static void afterClass() { - System.clearProperty(Constants.LOG4J_CONTEXT_SELECTOR); - } - - @Test - public void testAsyncLogWritesToLog() throws Exception { - final File file = new File("target", "AsyncLoggerTest.log"); - // System.out.println(f.getAbsolutePath()); - file.delete(); - - ThreadContext.push("stackvalue"); - ThreadContext.put("KEY", "mapvalue"); - - final Logger log = LogManager.getLogger("com.foo.Bar"); - final String msg = "Async logger msg"; - for (int i = 0; i < 128; i++) { - log.info("init message #{}", Unbox.box(i)); - } - log.info(msg, new InternalError("this is not a real error")); - CoreLoggerContexts.stopLoggerContext(false, file); // stop async thread - - final BufferedReader reader = new BufferedReader(new FileReader(file)); - for (int i = 0; i < 128; i++) { - reader.readLine(); - } - final String line1 = reader.readLine(); - reader.close(); - file.delete(); - assertNotNull("line1", line1); - assertTrue("line1 correct", line1.contains(msg)); - - assertTrue("ThreadContext.map", line1.contains("mapvalue")); - assertTrue("ThreadContext.stack", line1.contains("stackvalue")); - } -} http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/57eb2514/log4j-core/src/test/resources/AsyncLoggerConfigThreadContextTest.xml ---------------------------------------------------------------------- diff --git a/log4j-core/src/test/resources/AsyncLoggerConfigThreadContextTest.xml b/log4j-core/src/test/resources/AsyncLoggerConfigThreadContextTest.xml new file mode 100644 index 0000000..5419e20 --- /dev/null +++ b/log4j-core/src/test/resources/AsyncLoggerConfigThreadContextTest.xml @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8"?> +<Configuration status="ERROR"> + <Properties> + <Property name="configProp">configValue</Property> + </Properties> + <Appenders> + <RandomAccessFile name="RandomAccessFile" fileName="target/AsyncLoggerTest.log" + immediateFlush="false" append="false"> + <PatternLayout> + <Pattern>%p %c{1.} %X{KEY} %x %X %m%ex%n</Pattern> + </PatternLayout> + </RandomAccessFile> + <RandomAccessFile name="SynchronousRandomAccessFile" fileName="target/SynchronousContextTest.log" + immediateFlush="true" append="false"> + <PatternLayout> + <Pattern>%p %c{1.} %X{KEY} %x %X %m%ex%n</Pattern> + </PatternLayout> + </RandomAccessFile> + </Appenders> + + <Loggers> + <AsyncLogger name="com.foo" level="info" includeLocation="false" additivity="true"> + <AppenderRef ref="RandomAccessFile"/> + </AsyncLogger> + <Root level="info" includeLocation="false"> + <AppenderRef ref="SynchronousRandomAccessFile"/> + </Root> + </Loggers> +</Configuration> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/57eb2514/log4j-core/src/test/resources/AsyncLoggerThreadContextTest.xml ---------------------------------------------------------------------- diff --git a/log4j-core/src/test/resources/AsyncLoggerThreadContextTest.xml b/log4j-core/src/test/resources/AsyncLoggerThreadContextTest.xml index 734fb9e..6e507d2 100644 --- a/log4j-core/src/test/resources/AsyncLoggerThreadContextTest.xml +++ b/log4j-core/src/test/resources/AsyncLoggerThreadContextTest.xml @@ -1,14 +1,17 @@ <?xml version="1.0" encoding="UTF-8"?> <Configuration status="ERROR"> + <Properties> + <Property name="configProp">configValue</Property> + </Properties> <Appenders> - <RandomAccessFile name="RandomAccessFile" fileName="target/AsyncLoggerTest.log" + <RandomAccessFile name="RandomAccessFile" fileName="target/AsyncLoggerTest.log" immediateFlush="false" append="false"> <PatternLayout> - <Pattern>%d %p %c{1.} [%t] %X{KEY} %x %location %m %ex%n</Pattern> + <Pattern>%p %c{1.} %X{KEY} %x %X %m%ex%n</Pattern> </PatternLayout> </RandomAccessFile> </Appenders> - + <Loggers> <Root level="info" includeLocation="false"> <AppenderRef ref="RandomAccessFile"/>
