lttng-ust-java-tests-jul/src/test/java/org/lttng/ust/agent/integration/events/JulLegacyApiIT.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.Collections;
  29 import java.util.List;
  30 import java.util.logging.Level;
  31 import java.util.logging.LogManager;
  32 import java.util.logging.Logger;
  33
  34 import org.junit.jupiter.api.AfterAll;
  35 import org.junit.jupiter.api.AfterEach;
  36 import org.junit.jupiter.api.BeforeAll;
  37 import org.junit.jupiter.api.BeforeEach;
  38 import org.junit.jupiter.api.Test;
  39 import org.junit.jupiter.api.extension.ExtendWith;
  40 import org.lttng.tools.ILttngSession;
  41 import org.lttng.tools.ILttngSession.Domain;
  42 import org.lttng.ust.agent.ILttngHandler;
  43 import org.lttng.ust.agent.LTTngAgent;
  44 import org.lttng.ust.agent.utils.JulTestUtils;
  45 import org.lttng.ust.agent.utils.TestPrintExtension;
  46
  47 /**
  48  * Enabled events test for the LTTng-UST JUL log handler, using the legacy API.
  49  */
  50 @ExtendWith(TestPrintExtension.class)
  51 @SuppressWarnings("deprecation")
  52 public class JulLegacyApiIT {
  53
  54     private static final Domain DOMAIN = Domain.JUL;
  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     private LTTngAgent agent;
  61
  62     private Logger loggerA;
  63     private Logger loggerB;
  64
  65     /**
  66      * Class setup
  67      */
  68     @BeforeAll
  69     public static void julClassSetup() {
  70         JulTestUtils.testClassSetup();
  71     }
  72
  73     /**
  74      * Class cleanup
  75      */
  76     @AfterAll
  77     public static void julClassCleanup() {
  78         JulTestUtils.testClassCleanup();
  79     }
  80
  81     /**
  82      * Test setup
  83      */
  84     @BeforeEach
  85     public void setup() {
  86         /* Clear the JUL logger configuration */
  87         LogManager.getLogManager().reset();
  88         System.gc();
  89
  90         loggerA = Logger.getLogger(EVENT_NAME_A);
  91         agent = 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     @AfterEach
 104     public void tearDown() {
 105         session.close();
 106
 107         agent.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         JulTestUtils.send10EventsTo(loggerA);
 121         JulTestUtils.send10EventsTo(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 (-j -a) in the tracing session.
 135      */
 136     @Test
 137     public void testAllEvents() {
 138         assertTrue(session.enableAllEvents());
 139         assertTrue(session.start());
 140
 141         JulTestUtils.send10EventsTo(loggerA);
 142         JulTestUtils.send10EventsTo(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         JulTestUtils.send10EventsTo(loggerA);
 163         JulTestUtils.send10EventsTo(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      * Test that the "lttng list" commands lists the expected events.
 177      */
 178     @Test
 179     public void testListEvents() {
 180         List<String> enabledEvents = session.listEvents();
 181         List<String> expectedEvents = Arrays.asList(EVENT_NAME_A, EVENT_NAME_B);
 182
 183         Collections.sort(enabledEvents);
 184         Collections.sort(expectedEvents);
 185
 186         assertEquals(expectedEvents, enabledEvents);
 187     }
 188
 189     /**
 190      * Get the singleton JUL Handler currently managed by the LTTngAgent. It is
 191      * not public, so we need reflection to access it.
 192      *
 193      * @return The agent's JUL handler
 194      */
 195     private static ILttngHandler getAgentHandler() {
 196         try {
 197             Field julHandlerField = LTTngAgent.class.getDeclaredField("julHandler");
 198             julHandlerField.setAccessible(true);
 199             return (ILttngHandler) julHandlerField.get(LTTngAgent.getLTTngAgent());
 200         } catch (ReflectiveOperationException | SecurityException e) {
 201             fail(e.getMessage());
 202             return null;
 203         }
 204     }
 205
 206 }
 207