/* * 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 static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import org.apache.logging.log4j.Level; import org.apache.logging.log4j.core.LogEvent; import org.apache.logging.log4j.core.config.Configuration; import org.apache.logging.log4j.core.config.DefaultConfiguration; import org.apache.logging.log4j.core.config.builder.impl.DefaultConfigurationBuilder; import org.apache.logging.log4j.core.impl.Log4jLogEvent; import org.apache.logging.log4j.core.util.Constants; import org.apache.logging.log4j.message.Message; import org.apache.logging.log4j.message.ParameterizedMessage; import org.apache.logging.log4j.message.SimpleMessage; import org.apache.logging.log4j.message.StringMapMessage; import org.apache.logging.log4j.message.StructuredDataMessage; import org.junit.Test; /** * */ public class MessagePatternConverterTest { @Test public void testPattern() throws Exception { final MessagePatternConverter converter = MessagePatternConverter.newInstance(null, null); Message msg = new SimpleMessage("Hello!"); LogEvent event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); StringBuilder sb = new StringBuilder(); converter.format(event, sb); assertEquals("Unexpected result", "Hello!", sb.toString()); event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(null).build(); sb = new StringBuilder(); converter.format(event, sb); assertEquals("Incorrect length: " + sb, 0, sb.length()); msg = new SimpleMessage(null); event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); sb = new StringBuilder(); converter.format(event, sb); assertEquals("Incorrect length: " + sb, 4, sb.length()); } @Test public void testPatternAndParameterizedMessageDateLookup() throws Exception { final MessagePatternConverter converter = MessagePatternConverter.newInstance(null, null); final Message msg = new ParameterizedMessage("${date:now:buhu}"); final LogEvent event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); final StringBuilder sb = new StringBuilder(); converter.format(event, sb); assertEquals("Unexpected result", "${date:now:buhu}", sb.toString()); } @Test public void testLookupEnabledByDefault() { assertFalse("Expected lookups to be enabled", Constants.FORMAT_MESSAGES_PATTERN_DISABLE_LOOKUPS); } @Test public void testLookup() { final Configuration config = new DefaultConfigurationBuilder() .addProperty("foo", "bar") .build(true); final MessagePatternConverter converter = MessagePatternConverter.newInstance(config, null); final Message msg = new ParameterizedMessage("${foo}"); final LogEvent event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); final StringBuilder sb = new StringBuilder(); converter.format(event, sb); assertEquals("Unexpected result", "bar", sb.toString()); } @Test public void testDisabledLookup() { final Configuration config = new DefaultConfigurationBuilder() .addProperty("foo", "bar") .build(true); final MessagePatternConverter converter = MessagePatternConverter.newInstance( config, new String[] {"nolookups"}); final Message msg = new ParameterizedMessage("${foo}"); final LogEvent event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); final StringBuilder sb = new StringBuilder(); converter.format(event, sb); assertEquals("Expected the raw pattern string without lookup", "${foo}", sb.toString()); } @Test public void testPatternWithConfiguration() throws Exception { final Configuration config = new DefaultConfiguration(); final MessagePatternConverter converter = MessagePatternConverter.newInstance(config, null); Message msg = new SimpleMessage("Hello!"); LogEvent event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); StringBuilder sb = new StringBuilder(); converter.format(event, sb); assertEquals("Unexpected result", "Hello!", sb.toString()); event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(null).build(); sb = new StringBuilder(); converter.format(event, sb); assertEquals("Incorrect length: " + sb, 0, sb.length()); msg = new SimpleMessage(null); event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); sb = new StringBuilder(); converter.format(event, sb); assertEquals("Incorrect length: " + sb, 4, sb.length()); } @Test public void testMapMessageFormatJson() throws Exception { final MessagePatternConverter converter = MessagePatternConverter.newInstance(null, new String[]{"json"}); Message msg = new StringMapMessage() .with("key", "val"); LogEvent event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); StringBuilder sb = new StringBuilder(); converter.format(event, sb); assertEquals("Unexpected result", "{\"key\":\"val\"}", sb.toString()); } @Test public void testMapMessageFormatXml() throws Exception { final MessagePatternConverter converter = MessagePatternConverter.newInstance(null, new String[]{"xml"}); Message msg = new StringMapMessage() .with("key", "val"); LogEvent event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); StringBuilder sb = new StringBuilder(); converter.format(event, sb); assertEquals("Unexpected result", "<Map>\n <Entry key=\"key\">val</Entry>\n</Map>", sb.toString()); } @Test public void testMapMessageFormatDefault() throws Exception { final MessagePatternConverter converter = MessagePatternConverter.newInstance(null, null); Message msg = new StringMapMessage() .with("key", "val"); LogEvent event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); StringBuilder sb = new StringBuilder(); converter.format(event, sb); assertEquals("Unexpected result", "key=\"val\"", sb.toString()); } @Test public void testStructuredDataFormatFull() throws Exception { final MessagePatternConverter converter = MessagePatternConverter.newInstance(null, new String[]{"FULL"}); Message msg = new StructuredDataMessage("id", "message", "type") .with("key", "val"); LogEvent event = Log4jLogEvent.newBuilder() // .setLoggerName("MyLogger") // .setLevel(Level.DEBUG) // .setMessage(msg).build(); StringBuilder sb = new StringBuilder(); converter.format(event, sb); assertEquals("Unexpected result", "type [id key=\"val\"] message", sb.toString()); } }