lttng-ust-java-tests-log4j/src/test/java/org/lttng/ust/agent/integration/events/Log4jLegacyApiIT.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.integration.events;
  20
  21 import static org.junit.jupiter.api.Assertions.assertEquals;
  22 import static org.junit.jupiter.api.Assertions.assertNotNull;
  23 import static org.junit.jupiter.api.Assertions.assertTrue;
  24 import static org.junit.jupiter.api.Assertions.fail;
  25
  26 import java.lang.reflect.Field;
  27 import java.util.Arrays;
  28 import java.util.List;
  29
  30 import org.apache.log4j.Level;
  31 import org.apache.log4j.Logger;
  32 import org.junit.jupiter.api.AfterAll;
  33 import org.junit.jupiter.api.AfterEach;
  34 import org.junit.jupiter.api.BeforeAll;
  35 import org.junit.jupiter.api.BeforeEach;
  36 import org.junit.jupiter.api.Test;
  37 import org.junit.jupiter.api.extension.ExtendWith;
  38 import org.lttng.tools.ILttngSession;
  39 import org.lttng.tools.ILttngSession.Domain;
  40 import org.lttng.ust.agent.ILttngHandler;
  41 import org.lttng.ust.agent.LTTngAgent;
  42 import org.lttng.ust.agent.utils.Log4jTestUtils;
  43 import org.lttng.ust.agent.utils.TestPrintExtension;
  44
  45 /**
  46  * Enabled events test for the LTTng-UST Log4j log handler, using the legacy
  47  * API.
  48  */
  49 @ExtendWith(TestPrintExtension.class)
  50 @SuppressWarnings("deprecation")
  51 public class Log4jLegacyApiIT {
  52
  53     private static final Domain DOMAIN = Domain.LOG4J;
  54
  55     private static final String EVENT_NAME_A = "EventA";
  56     private static final String EVENT_NAME_B = "EventB";
  57
  58     private ILttngSession session;
  59     private LTTngAgent agent;
  60
  61     private Logger loggerA;
  62     private Logger loggerB;
  63
  64     /**
  65      * Class setup
  66      */
  67     @BeforeAll
  68     public static void log4jClassSetup() {
  69         Log4jTestUtils.testClassSetup();
  70     }
  71
  72     /**
  73      * Class cleanup
  74      */
  75     @AfterAll
  76     public static void log4jClassCleanup() {
  77         Log4jTestUtils.testClassCleanup();
  78     }
  79
  80     /**
  81      * Test setup
  82      */
  83     @BeforeEach
  84     public void setup() {
  85         loggerA = Logger.getLogger(EVENT_NAME_A);
  86         agent = LTTngAgent.getLTTngAgent();
  87         loggerB = Logger.getLogger(EVENT_NAME_B);
  88
  89         loggerA.setLevel(Level.ALL);
  90         loggerB.setLevel(Level.ALL);
  91
  92         session = ILttngSession.createSession(null, DOMAIN);
  93     }
  94
  95     /**
  96      * Test cleanup
  97      */
  98     @AfterEach
  99     public void tearDown() {
 100         session.close();
 101
 102         agent.dispose();
 103
 104         loggerA = null;
 105         loggerB = null;
 106     }
 107
 108     /**
 109      * Test tracing with no events enabled in the tracing session.
 110      */
 111     @Test
 112     public void testNoEvents() {
 113         assertTrue(session.start());
 114
 115         Log4jTestUtils.send10Events(loggerA);
 116         Log4jTestUtils.send10Events(loggerB);
 117
 118         assertTrue(session.stop());
 119
 120         List<String> output = session.view();
 121         assertNotNull(output);
 122         assertTrue(output.isEmpty());
 123
 124         ILttngHandler handler = getAgentHandler();
 125         assertEquals(0, handler.getEventCount());
 126     }
 127
 128     /**
 129      * Test tracing with all events enabled (-l -a) in the tracing session.
 130      */
 131     @Test
 132     public void testAllEvents() {
 133         assertTrue(session.enableAllEvents());
 134         assertTrue(session.start());
 135
 136         Log4jTestUtils.send10Events(loggerA);
 137         Log4jTestUtils.send10Events(loggerB);
 138
 139         assertTrue(session.stop());
 140
 141         List<String> output = session.view();
 142         assertNotNull(output);
 143         assertEquals(20, output.size());
 144
 145         ILttngHandler handler = getAgentHandler();
 146         assertEquals(20, handler.getEventCount());
 147     }
 148
 149     /**
 150      * Test tracing with a subset of events enabled in the tracing session.
 151      */
 152     @Test
 153     public void testSomeEvents() {
 154         assertTrue(session.enableEvents(EVENT_NAME_A));
 155         assertTrue(session.start());
 156
 157         Log4jTestUtils.send10Events(loggerA);
 158         Log4jTestUtils.send10Events(loggerB);
 159
 160         assertTrue(session.stop());
 161
 162         List<String> output = session.view();
 163         assertNotNull(output);
 164         assertEquals(10, output.size());
 165
 166         ILttngHandler handler = getAgentHandler();
 167         assertEquals(10, handler.getEventCount());
 168     }
 169
 170     /**
 171      * Test that the "lttng list" commands lists the expected events.
 172      */
 173     @Test
 174     public void testListEvents() {
 175         List<String> enabledEvents = session.listEvents();
 176         List<String> expectedEvents = Arrays.asList(EVENT_NAME_A, EVENT_NAME_B);
 177
 178         /*
 179          * It doesn't seem possible to forcibly remove Loggers with log4j 1.2.
 180          * This, coupled with the way the legacy agent works, makes it so
 181          * loggers defined in other tests will always "leak" into this one when
 182          * running the whole test suite.
 183          *
 184          * For this test, simply check that the expected names are present, and
 185          * let pass the case where other loggers may the present too.
 186          */
 187         expectedEvents.forEach(event -> assertTrue(enabledEvents.contains(event)));
 188     }
 189
 190     /**
 191      * Get the singleton Log4j Handler currently managed by the LTTngAgent. It
 192      * is not public, so we need reflection to access it.
 193      *
 194      * @return The agent's Log4j handler
 195      */
 196     private static ILttngHandler getAgentHandler() {
 197         try {
 198             Field log4jAppenderField = LTTngAgent.class.getDeclaredField("log4jAppender");
 199             log4jAppenderField.setAccessible(true);
 200             return (ILttngHandler) log4jAppenderField.get(LTTngAgent.getLTTngAgent());
 201         } catch (ReflectiveOperationException | SecurityException e) {
 202             fail(e.getMessage());
 203             return null;
 204         }
 205     }
 206
 207 }
 208