2 * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
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.
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.
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.
19 package org
.lttng
.ust
.agent
.integration
.events
;
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
;
26 import java
.lang
.reflect
.Field
;
27 import java
.util
.Arrays
;
28 import java
.util
.List
;
30 import org
.apache
.log4j
.Level
;
31 import org
.apache
.log4j
.Logger
;
32 import org
.junit
.jupiter
.api
.AfterAll
;
33 import org
.junit
.jupiter
.api
.AfterEach
;
34 import org
.junit
.jupiter
.api
.BeforeAll
;
35 import org
.junit
.jupiter
.api
.BeforeEach
;
36 import org
.junit
.jupiter
.api
.Tag
;
37 import org
.junit
.jupiter
.api
.Test
;
38 import org
.junit
.jupiter
.api
.extension
.ExtendWith
;
39 import org
.lttng
.tools
.ILttngSession
;
40 import org
.lttng
.tools
.ILttngSession
.Domain
;
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
.TestPrintExtension
;
47 * Enabled events test for the LTTng-UST Log4j log handler, using the legacy
50 @ExtendWith(TestPrintExtension
.class)
51 @SuppressWarnings("deprecation")
54 public class Log4jLegacyApiIT
{
56 private static final Domain DOMAIN
= Domain
.LOG4J
;
58 private static final String EVENT_NAME_A
= "EventA";
59 private static final String EVENT_NAME_B
= "EventB";
61 private ILttngSession session
;
62 private LTTngAgent agent
;
64 private Logger loggerA
;
65 private Logger loggerB
;
71 public static void log4jClassSetup() {
72 Log4jTestUtils
.testClassSetup();
79 public static void log4jClassCleanup() {
80 Log4jTestUtils
.testClassCleanup();
88 loggerA
= Logger
.getLogger(EVENT_NAME_A
);
89 agent
= LTTngAgent
.getLTTngAgent();
90 loggerB
= Logger
.getLogger(EVENT_NAME_B
);
92 loggerA
.setLevel(Level
.ALL
);
93 loggerB
.setLevel(Level
.ALL
);
95 session
= ILttngSession
.createSession(null, DOMAIN
);
102 public void tearDown() {
112 * Test tracing with no events enabled in the tracing session.
115 public void testNoEvents() {
116 assertTrue(session
.start());
118 Log4jTestUtils
.send10Events(loggerA
);
119 Log4jTestUtils
.send10Events(loggerB
);
121 assertTrue(session
.stop());
123 List
<String
> output
= session
.view();
124 assertNotNull(output
);
125 assertTrue(output
.isEmpty());
127 ILttngHandler handler
= getAgentHandler();
128 assertEquals(0, handler
.getEventCount());
132 * Test tracing with all events enabled (-l -a) in the tracing session.
135 public void testAllEvents() {
136 assertTrue(session
.enableAllEvents());
137 assertTrue(session
.start());
139 Log4jTestUtils
.send10Events(loggerA
);
140 Log4jTestUtils
.send10Events(loggerB
);
142 assertTrue(session
.stop());
144 List
<String
> output
= session
.view();
145 assertNotNull(output
);
146 assertEquals(20, output
.size());
148 ILttngHandler handler
= getAgentHandler();
149 assertEquals(20, handler
.getEventCount());
153 * Test tracing with a subset of events enabled in the tracing session.
156 public void testSomeEvents() {
157 assertTrue(session
.enableEvents(EVENT_NAME_A
));
158 assertTrue(session
.start());
160 Log4jTestUtils
.send10Events(loggerA
);
161 Log4jTestUtils
.send10Events(loggerB
);
163 assertTrue(session
.stop());
165 List
<String
> output
= session
.view();
166 assertNotNull(output
);
167 assertEquals(10, output
.size());
169 ILttngHandler handler
= getAgentHandler();
170 assertEquals(10, handler
.getEventCount());
174 * Test that the "lttng list" commands lists the expected events.
177 public void testListEvents() {
178 List
<String
> enabledEvents
= session
.listEvents();
179 List
<String
> expectedEvents
= Arrays
.asList(EVENT_NAME_A
, EVENT_NAME_B
);
182 * It doesn't seem possible to forcibly remove Loggers with log4j 1.2.
183 * This, coupled with the way the legacy agent works, makes it so
184 * loggers defined in other tests will always "leak" into this one when
185 * running the whole test suite.
187 * For this test, simply check that the expected names are present, and
188 * let pass the case where other loggers may the present too.
190 expectedEvents
.forEach(event
-> assertTrue(enabledEvents
.contains(event
)));
194 * Get the singleton Log4j Handler currently managed by the LTTngAgent. It
195 * is not public, so we need reflection to access it.
197 * @return The agent's Log4j handler
199 private static ILttngHandler
getAgentHandler() {
201 Field log4jAppenderField
= LTTngAgent
.class.getDeclaredField("log4jAppender");
202 log4jAppenderField
.setAccessible(true);
203 return (ILttngHandler
) log4jAppenderField
.get(LTTngAgent
.getLTTngAgent());
204 } catch (ReflectiveOperationException
| SecurityException e
) {
205 fail(e
.getMessage());