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
.Assert
.assertEquals
;
22 import static org
.junit
.Assert
.assertNotNull
;
23 import static org
.junit
.Assert
.assertTrue
;
24 import static org
.junit
.Assert
.fail
;
26 import java
.lang
.reflect
.Field
;
27 import java
.util
.Arrays
;
28 import java
.util
.Collections
;
29 import java
.util
.List
;
31 import org
.apache
.log4j
.Level
;
32 import org
.apache
.log4j
.LogManager
;
33 import org
.apache
.log4j
.Logger
;
34 import org
.junit
.After
;
35 import org
.junit
.AfterClass
;
36 import org
.junit
.Before
;
37 import org
.junit
.BeforeClass
;
38 import org
.junit
.Test
;
39 import org
.junit
.runner
.RunWith
;
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
.Log4jTestUtils
;
45 import org
.lttng
.ust
.agent
.utils
.TestPrintRunner
;
48 * Enabled events test for the LTTng-UST Log4j log handler, using the legacy
51 @RunWith(TestPrintRunner
.class)
52 @SuppressWarnings("deprecation")
53 public class Log4jLegacyApiIT
{
55 private static final Domain DOMAIN
= Domain
.LOG4J
;
57 private static final String EVENT_NAME_A
= "EventA";
58 private static final String EVENT_NAME_B
= "EventB";
60 private ILttngSession session
;
61 private LTTngAgent agent
;
63 private Logger loggerA
;
64 private Logger loggerB
;
70 public static void log4jClassSetup() {
71 Log4jTestUtils
.testClassSetup();
78 public static void log4jClassCleanup() {
79 Log4jTestUtils
.testClassCleanup();
87 loggerA
= Logger
.getLogger(EVENT_NAME_A
);
88 agent
= LTTngAgent
.getLTTngAgent();
89 loggerB
= Logger
.getLogger(EVENT_NAME_B
);
91 loggerA
.setLevel(Level
.ALL
);
92 loggerB
.setLevel(Level
.ALL
);
94 session
= ILttngSession
.createSession(null, DOMAIN
);
101 public void tearDown() {
111 * Test tracing with no events enabled in the tracing session.
114 public void testNoEvents() {
115 assertTrue(session
.start());
117 Log4jTestUtils
.send10Events(loggerA
);
118 Log4jTestUtils
.send10Events(loggerB
);
120 assertTrue(session
.stop());
122 List
<String
> output
= session
.view();
123 assertNotNull(output
);
124 assertTrue(output
.isEmpty());
126 ILttngHandler handler
= getAgentHandler();
127 assertEquals(0, handler
.getEventCount());
131 * Test tracing with all events enabled (-l -a) in the tracing session.
134 public void testAllEvents() {
135 assertTrue(session
.enableAllEvents());
136 assertTrue(session
.start());
138 Log4jTestUtils
.send10Events(loggerA
);
139 Log4jTestUtils
.send10Events(loggerB
);
141 assertTrue(session
.stop());
143 List
<String
> output
= session
.view();
144 assertNotNull(output
);
145 assertEquals(20, output
.size());
147 ILttngHandler handler
= getAgentHandler();
148 assertEquals(20, handler
.getEventCount());
152 * Test tracing with a subset of events enabled in the tracing session.
155 public void testSomeEvents() {
156 assertTrue(session
.enableEvents(EVENT_NAME_A
));
157 assertTrue(session
.start());
159 Log4jTestUtils
.send10Events(loggerA
);
160 Log4jTestUtils
.send10Events(loggerB
);
162 assertTrue(session
.stop());
164 List
<String
> output
= session
.view();
165 assertNotNull(output
);
166 assertEquals(10, output
.size());
168 ILttngHandler handler
= getAgentHandler();
169 assertEquals(10, handler
.getEventCount());
173 * Test that the "lttng list" commands lists the expected events.
176 public void testListEvents() {
177 List
<String
> enabledEvents
= session
.listEvents();
178 List
<String
> expectedEvents
= Arrays
.asList(EVENT_NAME_A
, EVENT_NAME_B
);
181 * It doesn't seem possible to forcibly remove Loggers with log4j 1.2.
182 * This, coupled with the way the legacy agent works, makes it so
183 * loggers defined in other tests will always "leak" into this one when
184 * running the whole test suite.
186 * For this test, simply check that the expected names are present, and
187 * let pass the case where other loggers may the present too.
189 expectedEvents
.forEach(event
-> assertTrue(enabledEvents
.contains(event
)));
193 * Get the singleton Log4j Handler currently managed by the LTTngAgent. It
194 * is not public, so we need reflection to access it.
196 * @return The agent's Log4j handler
198 private static ILttngHandler
getAgentHandler() {
200 Field log4jAppenderField
= LTTngAgent
.class.getDeclaredField("log4jAppender");
201 log4jAppenderField
.setAccessible(true);
202 return (ILttngHandler
) log4jAppenderField
.get(LTTngAgent
.getLTTngAgent());
203 } catch (ReflectiveOperationException
| SecurityException e
) {
204 fail(e
.getMessage());