lttng-ust-java-tests-log4j/src/test/java/org/lttng/ust/agent/utils/Log4jTestUtils.java

   1 /*
   2  * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 package org.lttng.ust.agent.utils;
  20
  21 import static org.junit.jupiter.api.Assertions.assertTrue;
  22 import static org.junit.jupiter.api.Assertions.fail;
  23
  24 import java.io.IOException;
  25
  26 import org.apache.log4j.Level;
  27 import org.apache.log4j.Logger;
  28 import org.lttng.tools.LttngToolsHelper;
  29 import org.lttng.tools.ILttngSession.Domain;
  30 import org.lttng.ust.agent.log4j.LttngLogAppender;
  31
  32 /**
  33  * Utility methods for log4j tests
  34  */
  35 public final class Log4jTestUtils {
  36
  37     private Log4jTestUtils() {
  38     }
  39
  40     /**
  41      * Setup method common to most log4j tests. To be called in a @BeforeClass.
  42      */
  43     public static void testClassSetup() {
  44         /* Make sure we can find the JNI library and lttng-tools */
  45         checkForLog4jLibrary();
  46         assertTrue(LttngUtils.checkForLttngTools(Domain.LOG4J), "lttng-tools is not working properly.");
  47
  48         LttngToolsHelper.destroyAllSessions();
  49     }
  50
  51     /**
  52      * Teardown method common to most log4j tests. To be called in a @AfterClass.
  53      */
  54     public static void testClassCleanup() {
  55         LttngToolsHelper.deleteAllTraces();
  56     }
  57
  58     /**
  59      * Check the the Log4j native library is available, effectively allowing
  60      * LTTng Log4j appenders to be used.
  61      */
  62     private static void checkForLog4jLibrary() {
  63         try {
  64             LttngLogAppender testAppender = new LttngLogAppender();
  65             testAppender.close();
  66         } catch (SecurityException | IOException e) {
  67             fail(e.getMessage());
  68         }
  69     }
  70
  71     /**
  72      * Send 10 dummy events through the provided logger
  73      *
  74      * @param logger
  75      *            The logger to use to send events
  76      */
  77     public static void send10Events(Logger logger) {
  78         // Levels/priorities are DEBUG, ERROR, FATAL, INFO, TRACE, WARN
  79         logger.debug("Debug message. Lost among so many.");
  80         logger.debug("Debug message with a throwable", new IOException());
  81         logger.error("Error messsage. This might be bad.");
  82         logger.error("Error message with a throwable", new IOException());
  83         logger.fatal("A fatal message. You are already dead.");
  84         logger.info("A info message. Lol, who cares.");
  85         logger.trace("A trace message. No, no *that* trace");
  86         logger.warn("A warn message. Yellow underline.");
  87         logger.log(Level.DEBUG, "A debug message using .log()");
  88         logger.log(Level.ERROR, "A error message using .log()");
  89     }
  90 }