src/test/java/org/lttng/ust/agent/integration/log4j/Log4jLegacyApiTest.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.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.lttng.ust.agent.ILttngHandler;
  38 import org.lttng.ust.agent.LTTngAgent;
  39 import org.lttng.ust.agent.utils.LttngSession;
  40 import org.lttng.ust.agent.utils.LttngSession.Domain;
  41 import org.lttng.ust.agent.utils.MiscTestUtils;
  42
  43 /**
  44  * Enabled events test for the LTTng-UST Log4j log handler, using the legacy
  45  * API.
  46  */
  47 @SuppressWarnings("deprecation")
  48 public class Log4jLegacyApiTest {
  49
  50     private static final Domain DOMAIN = Domain.LOG4J;
  51
  52     private static final String EVENT_NAME_A = "EventA";
  53     private static final String EVENT_NAME_B = "EventB";
  54
  55     private LttngSession session;
  56
  57     private Logger loggerA;
  58     private Logger loggerB;
  59
  60     /**
  61      * Class setup
  62      */
  63     @BeforeClass
  64     public static void classSetup() {
  65         /* Skip tests if we can't find the JNI library or lttng-tools */
  66         assumeTrue(MiscTestUtils.checkForLog4jLibrary());
  67         assumeTrue(MiscTestUtils.checkForLttngTools(Domain.LOG4J));
  68
  69         LttngSession.destroyAllSessions();
  70     }
  71
  72     /**
  73      * Class cleanup
  74      */
  75     @AfterClass
  76     public static void classCleanup() {
  77         LttngSession.deleteAllTracee();
  78     }
  79
  80     /**
  81      * Test setup
  82      */
  83     @Before
  84     public void setup() {
  85         loggerA = Logger.getLogger(EVENT_NAME_A);
  86         LTTngAgent.getLTTngAgent();
  87         loggerB = Logger.getLogger(EVENT_NAME_B);
  88
  89         loggerA.setLevel(Level.ALL);
  90         loggerB.setLevel(Level.ALL);
  91
  92         session = new LttngSession(null, DOMAIN);
  93     }
  94
  95     /**
  96      * Test cleanup
  97      */
  98     @After
  99     public void tearDown() {
 100         session.close();
 101
 102         LTTngAgent.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      * Get the singleton Log4j Handler currently managed by the LTTngAgent. It
 172      * is not public, so we need reflection to access it.
 173      *
 174      * @return The agent's Log4j handler
 175      */
 176     private static ILttngHandler getAgentHandler() {
 177         try {
 178             Field log4jAppenderField = LTTngAgent.class.getDeclaredField("log4jAppender");
 179             log4jAppenderField.setAccessible(true);
 180             return (ILttngHandler) log4jAppenderField.get(LTTngAgent.getLTTngAgent());
 181         } catch (ReflectiveOperationException | SecurityException e) {
 182             fail();
 183             return null;
 184         }
 185     }
 186
 187 }
 188