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.Assert.assertEquals;
  22 import static org.junit.Assert.assertNotNull;
  23 import static org.junit.Assert.assertTrue;
  24 import static org.junit.Assert.fail;
  25
  26 import java.lang.reflect.Field;
  27 import java.util.List;
  28
  29 import org.apache.log4j.Level;
  30 import org.apache.log4j.Logger;
  31 import org.junit.After;
  32 import org.junit.AfterClass;
  33 import org.junit.Before;
  34 import org.junit.BeforeClass;
  35 import org.junit.Test;
  36 import org.junit.runner.RunWith;
  37 import org.lttng.tools.ILttngSession;
  38 import org.lttng.tools.ILttngSession.Domain;
  39 import org.lttng.ust.agent.ILttngHandler;
  40 import org.lttng.ust.agent.LTTngAgent;
  41 import org.lttng.ust.agent.utils.Log4jTestUtils;
  42 import org.lttng.ust.agent.utils.TestPrintRunner;
  43
  44 /**
  45  * Enabled events test for the LTTng-UST Log4j log handler, using the legacy
  46  * API.
  47  */
  48 @RunWith(TestPrintRunner.class)
  49 @SuppressWarnings("deprecation")
  50 public class Log4jLegacyApiIT {
  51
  52     private static final Domain DOMAIN = Domain.LOG4J;
  53
  54     private static final String EVENT_NAME_A = "EventA";
  55     private static final String EVENT_NAME_B = "EventB";
  56
  57     private ILttngSession session;
  58     private LTTngAgent agent;
  59
  60     private Logger loggerA;
  61     private Logger loggerB;
  62
  63     /**
  64      * Class setup
  65      */
  66     @BeforeClass
  67     public static void log4jClassSetup() {
  68         Log4jTestUtils.testClassSetup();
  69     }
  70
  71     /**
  72      * Class cleanup
  73      */
  74     @AfterClass
  75     public static void log4jClassCleanup() {
  76         Log4jTestUtils.testClassCleanup();
  77     }
  78
  79     /**
  80      * Test setup
  81      */
  82     @Before
  83     public void setup() {
  84         loggerA = Logger.getLogger(EVENT_NAME_A);
  85         agent = LTTngAgent.getLTTngAgent();
  86         loggerB = Logger.getLogger(EVENT_NAME_B);
  87
  88         loggerA.setLevel(Level.ALL);
  89         loggerB.setLevel(Level.ALL);
  90
  91         session = ILttngSession.createSession(null, DOMAIN);
  92     }
  93
  94     /**
  95      * Test cleanup
  96      */
  97     @After
  98     public void tearDown() {
  99         session.close();
 100
 101         agent.dispose();
 102
 103         loggerA = null;
 104         loggerB = null;
 105     }
 106
 107     /**
 108      * Test tracing with no events enabled in the tracing session.
 109      */
 110     @Test
 111     public void testNoEvents() {
 112         assertTrue(session.start());
 113
 114         Log4jTestUtils.send10Events(loggerA);
 115         Log4jTestUtils.send10Events(loggerB);
 116
 117         assertTrue(session.stop());
 118
 119         List<String> output = session.view();
 120         assertNotNull(output);
 121         assertTrue(output.isEmpty());
 122
 123         ILttngHandler handler = getAgentHandler();
 124         assertEquals(0, handler.getEventCount());
 125     }
 126
 127     /**
 128      * Test tracing with all events enabled (-l -a) in the tracing session.
 129      */
 130     @Test
 131     public void testAllEvents() {
 132         assertTrue(session.enableAllEvents());
 133         assertTrue(session.start());
 134
 135         Log4jTestUtils.send10Events(loggerA);
 136         Log4jTestUtils.send10Events(loggerB);
 137
 138         assertTrue(session.stop());
 139
 140         List<String> output = session.view();
 141         assertNotNull(output);
 142         assertEquals(20, output.size());
 143
 144         ILttngHandler handler = getAgentHandler();
 145         assertEquals(20, handler.getEventCount());
 146     }
 147
 148     /**
 149      * Test tracing with a subset of events enabled in the tracing session.
 150      */
 151     @Test
 152     public void testSomeEvents() {
 153         assertTrue(session.enableEvents(EVENT_NAME_A));
 154         assertTrue(session.start());
 155
 156         Log4jTestUtils.send10Events(loggerA);
 157         Log4jTestUtils.send10Events(loggerB);
 158
 159         assertTrue(session.stop());
 160
 161         List<String> output = session.view();
 162         assertNotNull(output);
 163         assertEquals(10, output.size());
 164
 165         ILttngHandler handler = getAgentHandler();
 166         assertEquals(10, handler.getEventCount());
 167     }
 168
 169     /**
 170      * Get the singleton Log4j Handler currently managed by the LTTngAgent. It
 171      * is not public, so we need reflection to access it.
 172      *
 173      * @return The agent's Log4j handler
 174      */
 175     private static ILttngHandler getAgentHandler() {
 176         try {
 177             Field log4jAppenderField = LTTngAgent.class.getDeclaredField("log4jAppender");
 178             log4jAppenderField.setAccessible(true);
 179             return (ILttngHandler) log4jAppenderField.get(LTTngAgent.getLTTngAgent());
 180         } catch (ReflectiveOperationException | SecurityException e) {
 181             fail(e.getMessage());
 182             return null;
 183         }
 184     }
 185
 186 }
 187