lttng-ust-java-tests-log4j2/src/main/java/org/lttng/ust/agent/integration/events/Log4j2EnabledEventsITBase.java

   1 /*
   2  * Copyright (C) 2022, EfficiOS Inc.
   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.integration.events;
  20
  21 import java.io.IOException;
  22
  23 import org.apache.logging.log4j.core.Logger;
  24 import org.junit.jupiter.api.AfterAll;
  25 import org.junit.jupiter.api.AfterEach;
  26 import org.junit.jupiter.api.BeforeAll;
  27 import org.junit.jupiter.api.BeforeEach;
  28 import org.junit.jupiter.api.Test;
  29 import org.junit.jupiter.api.TestInstance;
  30 import org.junit.jupiter.api.TestInstance.Lifecycle;
  31 import org.lttng.ust.agent.ILttngHandler;
  32 import org.lttng.ust.agent.utils.Log4j2TestContext;
  33 import org.lttng.ust.agent.utils.Log4j2TestUtils;
  34
  35 /**
  36  * Enabled events test for the LTTng-UST Log4j 2.x log handler.
  37  */
  38 @TestInstance(Lifecycle.PER_CLASS)
  39 public abstract class Log4j2EnabledEventsITBase extends EnabledEventsITBase {
  40
  41     private static final String APPENDER_NAME_A = "LttngA";
  42     private static final String APPENDER_NAME_B = "LttngB";
  43     private static final String APPENDER_NAME_C = "LttngC";
  44
  45     private Log4j2TestContext testContext;
  46
  47     private Logger loggerA;
  48     private Logger loggerB;
  49     private Logger loggerC;
  50     private Logger loggerD;
  51
  52     /**
  53      * Class setup
  54      */
  55     @BeforeAll
  56     public void log4j2ClassSetup() {
  57         Log4j2TestUtils.testClassSetup(getDomain());
  58     }
  59
  60     /**
  61      * Class cleanup
  62      */
  63     @AfterAll
  64     public static void log4j2ClassCleanup() {
  65         Log4j2TestUtils.testClassCleanup();
  66     }
  67
  68     /**
  69      * Test setup
  70      *
  71      * @throws SecurityException
  72      * @throws IOException
  73      */
  74     @SuppressWarnings("resource")
  75     @BeforeEach
  76     public void log4j2Setup() throws SecurityException, IOException {
  77
  78         testContext = new Log4j2TestContext("log4j2." + this.getClass().getSimpleName() + ".xml");
  79
  80         testContext.beforeTest();
  81
  82         loggerA = testContext.getLoggerContext().getLogger(EVENT_NAME_A);
  83         loggerB = testContext.getLoggerContext().getLogger(EVENT_NAME_B);
  84         loggerC = testContext.getLoggerContext().getLogger(EVENT_NAME_C);
  85         loggerD = testContext.getLoggerContext().getLogger(EVENT_NAME_D);
  86
  87         handlerA = (ILttngHandler) loggerA.getAppenders().get(APPENDER_NAME_A);
  88         handlerB = (ILttngHandler) loggerB.getAppenders().get(APPENDER_NAME_B);
  89         handlerC = (ILttngHandler) loggerC.getAppenders().get(APPENDER_NAME_C);
  90     }
  91
  92     /**
  93      * Test teardown
  94      */
  95     @AfterEach
  96     public void log4j2Teardown() {
  97         loggerA = null;
  98         loggerB = null;
  99         loggerC = null;
 100         loggerD = null;
 101
 102         testContext.afterTest();
 103     }
 104
 105     @Override
 106     protected boolean closeHandlers()
 107     {
 108         return false;
 109     }
 110
 111     @Override
 112     protected void sendEventsToLoggers() {
 113         Log4j2TestUtils.send10Events(loggerA);
 114         Log4j2TestUtils.send10Events(loggerB);
 115         Log4j2TestUtils.send10Events(loggerC);
 116         Log4j2TestUtils.send10Events(loggerD);
 117     }
 118
 119     @Override
 120     protected void sendLocalizedEvent(String rawString, Object[] params) {
 121         throw new UnsupportedOperationException();
 122     }
 123
 124     @Override
 125     @Test
 126     public void testLocalizedMessage() {
 127         /* Does not apply to log4j 1.2.x */
 128     }
 129 }