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