/*
* 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.pattern;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.MarkerManager;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.impl.Log4jLogEvent;
import org.apache.logging.log4j.core.util.Constants;
import org.apache.logging.log4j.message.SimpleMessage;
import org.junit.Before;
import org.junit.Test;
import static org.junit.Assert.*;
/**
*
*/
public class PatternParserTest {
static String OUTPUT_FILE = "output/PatternParser";
static String WITNESS_FILE = "witness/PatternParser";
LoggerContext ctx = (LoggerContext) LogManager.getContext();
Logger root = ctx.getLogger("");
private static String msgPattern = "%m%n";
private final String mdcMsgPattern1 = "%m : %X%n";
private final String mdcMsgPattern2 = "%m : %X{key1}%n";
private final String mdcMsgPattern3 = "%m : %X{key2}%n";
private final String mdcMsgPattern4 = "%m : %X{key3}%n";
private final String mdcMsgPattern5 = "%m : %X{key1},%X{key2},%X{key3}%n";
private static String customPattern = "[%d{yyyyMMdd HH:mm:ss,SSS}] %-5p [%-25.25c{1}:%-4L] - %m%n";
private static String nestedPatternHighlight =
"%highlight{%d{dd MMM yyyy HH:mm:ss,SSS}{GMT+0} [%t] %-5level: %msg%n%throwable}";
private static final String KEY = "Converter";
private PatternParser parser;
@Before
public void setup() {
parser = new PatternParser(KEY);
}
private void validateConverter(final List<PatternFormatter> formatter, final int index, final String name) {
final PatternConverter pc = formatter.get(index).getConverter();
assertEquals("Incorrect converter " + pc.getName() + " at index " + index + " expected " + name,
pc.getName(), name);
}
/**
* Test the default pattern
*/
@Test
public void defaultPattern() {
final List<PatternFormatter> formatters = parser.parse(msgPattern);
assertNotNull(formatters);
assertTrue(formatters.size() == 2);
validateConverter(formatters, 0, "Message");
validateConverter(formatters, 1, "Line Sep");
}
/**
* Test the custom pattern
*/
@Test
public void testCustomPattern() {
final List<PatternFormatter> formatters = parser.parse(customPattern);
assertNotNull(formatters);
final Map<String, String> mdc = new HashMap<String, String>();
mdc.put("loginId", "Fred");
final Throwable t = new Throwable();
final StackTraceElement[] elements = t.getStackTrace();
final LogEvent event = new Log4jLogEvent("org.apache.logging.log4j.PatternParserTest", MarkerManager.getMarker("TEST"),
Logger.class.getName(), Level.INFO, new SimpleMessage("Hello, world"), null,
mdc, null, "Thread1", elements[0], System.currentTimeMillis());
final StringBuilder buf = new StringBuilder();
for (final PatternFormatter formatter : formatters) {
formatter.format(event, buf);
}
final String str = buf.toString();
final String expected = "INFO [PatternParserTest :93 ] - Hello, world" + Constants.LINE_SEPARATOR;
assertTrue("Expected to end with: " + expected + ". Actual: " + str, str.endsWith(expected));
}
@Test
public void testNestedPatternHighlight() {
testNestedPatternHighlight(Level.TRACE, "\u001B[30m");
testNestedPatternHighlight(Level.DEBUG, "\u001B[36m");
testNestedPatternHighlight(Level.INFO, "\u001B[32m");
testNestedPatternHighlight(Level.WARN, "\u001B[33m");
testNestedPatternHighlight(Level.ERROR, "\u001B[1;31m");
testNestedPatternHighlight(Level.FATAL, "\u001B[1;31m");
}
private void testNestedPatternHighlight(final Level level, final String expectedStart) {
final List<PatternFormatter> formatters = parser.parse(nestedPatternHighlight);
assertNotNull(formatters);
final Throwable t = new Throwable();
final StackTraceElement[] stackTraceElement = t.getStackTrace();
final LogEvent event = new Log4jLogEvent("org.apache.logging.log4j.PatternParserTest",
MarkerManager.getMarker("TEST"), Logger.class.getName(), level, new SimpleMessage("Hello, world"),
null, null, null, "Thread1", /*stackTraceElement[0]*/null, System.currentTimeMillis());
final StringBuilder buf = new StringBuilder();
for (final PatternFormatter formatter : formatters) {
formatter.format(event, buf);
}
final String str = buf.toString();
final String expectedEnd = String.format("] %-5s: Hello, world%s\u001B[m", level, Constants.LINE_SEPARATOR);
assertTrue("Expected to start with: " + expectedStart + ". Actual: " + str, str.startsWith(expectedStart));
assertTrue("Expected to end with: \"" + expectedEnd + "\". Actual: \"" + str, str.endsWith(expectedEnd));
}
}