lttng-ust-java-tests-log4j2/src/test/java/org/lttng/ust/agent/utils/Log4j2TestContext.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.utils;
  20
  21 import java.net.URI;
  22 import java.net.URL;
  23
  24 import org.apache.logging.log4j.LogManager;
  25 import org.apache.logging.log4j.core.LoggerContext;
  26
  27 /**
  28  * Log4j 2.x test context utilities.
  29  */
  30 public class Log4j2TestContext {
  31
  32     private final URI configFileUri;
  33
  34     private LoggerContext loggerContext;
  35
  36     /**
  37      * @param configFile path to the log4j configuration file.
  38      */
  39     public Log4j2TestContext(String configFile) {
  40
  41         URL resource = getClass().getClassLoader().getResource(configFile);
  42
  43         if (resource == null) {
  44             throw new IllegalArgumentException("Config file not found: " + configFile);
  45         }
  46
  47         try {
  48             this.configFileUri = resource.toURI();
  49         } catch (Exception e) {
  50             throw new IllegalArgumentException("Config file invalid URI: " + resource);
  51         }
  52     }
  53
  54     /**
  55      * @return the log4j2 logger context.
  56      */
  57     public synchronized LoggerContext getLoggerContext() {
  58         return loggerContext;
  59     }
  60
  61     /**
  62      * Initialize the log4j2 context before running a test.
  63      */
  64     public synchronized void beforeTest() {
  65         loggerContext = (LoggerContext) LogManager.getContext(
  66                 ClassLoader.getSystemClassLoader(), false, configFileUri);
  67     }
  68
  69     /**
  70      * Dispose of the log4j2 context after running a test.
  71      */
  72     public synchronized void afterTest() {
  73         loggerContext.stop();
  74     }
  75 }