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
.List
;
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
.ust
.agent
.ILttngHandler
;
41 import org
.lttng
.ust
.agent
.LTTngAgent
;
42 import org
.lttng
.ust
.agent
.utils
.Log4jTestUtils
;
43 import org
.lttng
.ust
.agent
.utils
.TestPrintRunner
;
46 * Enabled events test for the LTTng-UST Log4j log handler, using the legacy
49 @RunWith(TestPrintRunner
.class)
50 @SuppressWarnings("deprecation")
51 public class Log4jLegacyApiIT
{
53 private static final Domain DOMAIN
= Domain
.LOG4J
;
55 private static final String EVENT_NAME_A
= "EventA";
56 private static final String EVENT_NAME_B
= "EventB";
58 private ILttngSession session
;
59 private LTTngAgent agent
;
61 private Logger loggerA
;
62 private Logger loggerB
;
68 public static void log4jClassSetup() {
69 Log4jTestUtils
.testClassSetup();
76 public static void log4jClassCleanup() {
77 Log4jTestUtils
.testClassCleanup();
85 loggerA
= Logger
.getLogger(EVENT_NAME_A
);
86 agent
= LTTngAgent
.getLTTngAgent();
87 loggerB
= Logger
.getLogger(EVENT_NAME_B
);
89 loggerA
.setLevel(Level
.ALL
);
90 loggerB
.setLevel(Level
.ALL
);
92 session
= ILttngSession
.createSession(null, DOMAIN
);
99 public void tearDown() {
109 * Test tracing with no events enabled in the tracing session.
112 public void testNoEvents() {
113 assertTrue(session
.start());
115 Log4jTestUtils
.send10Events(loggerA
);
116 Log4jTestUtils
.send10Events(loggerB
);
118 assertTrue(session
.stop());
120 List
<String
> output
= session
.view();
121 assertNotNull(output
);
122 assertTrue(output
.isEmpty());
124 ILttngHandler handler
= getAgentHandler();
125 assertEquals(0, handler
.getEventCount());
129 * Test tracing with all events enabled (-l -a) in the tracing session.
132 public void testAllEvents() {
133 assertTrue(session
.enableAllEvents());
134 assertTrue(session
.start());
136 Log4jTestUtils
.send10Events(loggerA
);
137 Log4jTestUtils
.send10Events(loggerB
);
139 assertTrue(session
.stop());
141 List
<String
> output
= session
.view();
142 assertNotNull(output
);
143 assertEquals(20, output
.size());
145 ILttngHandler handler
= getAgentHandler();
146 assertEquals(20, handler
.getEventCount());
150 * Test tracing with a subset of events enabled in the tracing session.
153 public void testSomeEvents() {
154 assertTrue(session
.enableEvents(EVENT_NAME_A
));
155 assertTrue(session
.start());
157 Log4jTestUtils
.send10Events(loggerA
);
158 Log4jTestUtils
.send10Events(loggerB
);
160 assertTrue(session
.stop());
162 List
<String
> output
= session
.view();
163 assertNotNull(output
);
164 assertEquals(10, output
.size());
166 ILttngHandler handler
= getAgentHandler();
167 assertEquals(10, handler
.getEventCount());
171 * Test that the "lttng list" commands lists the expected events.
174 public void testListEvents() {
175 List
<String
> enabledEvents
= session
.listEvents();
176 List
<String
> expectedEvents
= Arrays
.asList(EVENT_NAME_A
, EVENT_NAME_B
);
179 * It doesn't seem possible to forcibly remove Loggers with log4j 1.2.
180 * This, coupled with the way the legacy agent works, makes it so
181 * loggers defined in other tests will always "leak" into this one when
182 * running the whole test suite.
184 * For this test, simply check that the expected names are present, and
185 * let pass the case where other loggers may the present too.
187 expectedEvents
.forEach(event
-> assertTrue(enabledEvents
.contains(event
)));
191 * Get the singleton Log4j Handler currently managed by the LTTngAgent. It
192 * is not public, so we need reflection to access it.
194 * @return The agent's Log4j handler
196 private static ILttngHandler
getAgentHandler() {
198 Field log4jAppenderField
= LTTngAgent
.class.getDeclaredField("log4jAppender");
199 log4jAppenderField
.setAccessible(true);
200 return (ILttngHandler
) log4jAppenderField
.get(LTTngAgent
.getLTTngAgent());
201 } catch (ReflectiveOperationException
| SecurityException e
) {
202 fail(e
.getMessage());