git.lttng.org Git - lttng-ust-java-tests.git/blob

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