PatternLayoutEscapedTest.java

/*
 * Copyright 2016 LinkedIn Corp.
 *
 * 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.
 */

package azkaban.utils;

import static org.junit.Assert.assertTrue;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.PatternLayout;
import org.apache.log4j.spi.LoggingEvent;
import org.junit.Before;
import org.junit.Test;

/**
 * Test output of PatternLayoutEscapedTest It should be appending stack traces, escaping new lines,
 * quotes, tabs and backslashes This is necessary when we are logging these messages out as JSON
 * objects
 */
public class PatternLayoutEscapedTest {

  private final Logger logger = Logger.getLogger(this.getClass());
  private final PatternLayout layout = new PatternLayoutEscaped();

  @Before
  public void beforeTest() {
    this.layout.setConversionPattern("%m");
  }

  @Test
  public void testWithException() {
    try {
      throw new Exception("This is an exception");
    } catch (final Exception e) {
      final LoggingEvent event = createEventWithException("There was an exception", e);
      // Stack trace might change if the codebase changes, but this prefix should always remain the same
      assertTrue(this.layout.format(event)
          .startsWith("There was an exception\\njava.lang.Exception: This is an exception"));
    }
  }

  @Test
  public void testNewLine() {
    final LoggingEvent event = createMessageEvent("This message contains \n new lines");
    assertTrue(this.layout.format(event).equals("This message contains \\n new lines"));
  }

  @Test
  public void testQuote() {
    final LoggingEvent event = createMessageEvent("This message contains \" quotes");
    assertTrue(this.layout.format(event).equals("This message contains \\\" quotes"));
  }

  @Test
  public void testTab() {
    final LoggingEvent event = createMessageEvent("This message contains a tab \t");
    assertTrue(this.layout.format(event).equals("This message contains a tab \\t"));
  }

  @Test
  public void testBackSlash() {
    final LoggingEvent event = createMessageEvent("This message contains a backslash \\");
    assertTrue(this.layout.format(event).equals("This message contains a backslash \\\\"));
  }

  private LoggingEvent createMessageEvent(final String message) {
    return createEventWithException(message, null);
  }

  private LoggingEvent createEventWithException(final String message, final Exception e) {
    return new LoggingEvent(this.getClass().getCanonicalName(),
        this.logger,
        0,
        Level.toLevel("INFO"),
        message,
        e);
  }
}