Commit | Line | Data |
---|---|---|
2b408e85 AM |
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 | ||
4821eac9 | 19 | package org.lttng.ust.agent.integration.events; |
c5524c71 AM |
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; | |
c5524c71 | 25 | |
c5524c71 | 26 | import java.lang.reflect.Field; |
bda25414 AM |
27 | import java.util.Arrays; |
28 | import java.util.Collections; | |
c5524c71 AM |
29 | import java.util.List; |
30 | ||
31 | import org.apache.log4j.Level; | |
b342ee75 | 32 | import org.apache.log4j.LogManager; |
c5524c71 AM |
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; | |
64c5b50c | 39 | import org.junit.runner.RunWith; |
45d1768c AM |
40 | import org.lttng.tools.ILttngSession; |
41 | import org.lttng.tools.ILttngSession.Domain; | |
c5524c71 AM |
42 | import org.lttng.ust.agent.ILttngHandler; |
43 | import org.lttng.ust.agent.LTTngAgent; | |
4821eac9 | 44 | import org.lttng.ust.agent.utils.Log4jTestUtils; |
64c5b50c | 45 | import org.lttng.ust.agent.utils.TestPrintRunner; |
c5524c71 | 46 | |
8a0613fa AM |
47 | /** |
48 | * Enabled events test for the LTTng-UST Log4j log handler, using the legacy | |
49 | * API. | |
50 | */ | |
64c5b50c | 51 | @RunWith(TestPrintRunner.class) |
c5524c71 | 52 | @SuppressWarnings("deprecation") |
7b82be36 | 53 | public class Log4jLegacyApiIT { |
c5524c71 AM |
54 | |
55 | private static final Domain DOMAIN = Domain.LOG4J; | |
56 | ||
57 | private static final String EVENT_NAME_A = "EventA"; | |
58 | private static final String EVENT_NAME_B = "EventB"; | |
59 | ||
45d1768c | 60 | private ILttngSession session; |
3e1f7ff4 | 61 | private LTTngAgent agent; |
8576633f | 62 | |
c5524c71 AM |
63 | private Logger loggerA; |
64 | private Logger loggerB; | |
65 | ||
8a0613fa AM |
66 | /** |
67 | * Class setup | |
68 | */ | |
c5524c71 | 69 | @BeforeClass |
eca27046 AM |
70 | public static void log4jClassSetup() { |
71 | Log4jTestUtils.testClassSetup(); | |
c5524c71 AM |
72 | } |
73 | ||
8a0613fa AM |
74 | /** |
75 | * Class cleanup | |
76 | */ | |
c5524c71 | 77 | @AfterClass |
eca27046 AM |
78 | public static void log4jClassCleanup() { |
79 | Log4jTestUtils.testClassCleanup(); | |
c5524c71 AM |
80 | } |
81 | ||
8a0613fa AM |
82 | /** |
83 | * Test setup | |
84 | */ | |
c5524c71 AM |
85 | @Before |
86 | public void setup() { | |
87 | loggerA = Logger.getLogger(EVENT_NAME_A); | |
3e1f7ff4 | 88 | agent = LTTngAgent.getLTTngAgent(); |
c5524c71 AM |
89 | loggerB = Logger.getLogger(EVENT_NAME_B); |
90 | ||
91 | loggerA.setLevel(Level.ALL); | |
92 | loggerB.setLevel(Level.ALL); | |
8576633f | 93 | |
ff620bef | 94 | session = ILttngSession.createSession(null, DOMAIN); |
c5524c71 AM |
95 | } |
96 | ||
8a0613fa AM |
97 | /** |
98 | * Test cleanup | |
99 | */ | |
c5524c71 AM |
100 | @After |
101 | public void tearDown() { | |
8576633f | 102 | session.close(); |
c5524c71 | 103 | |
3e1f7ff4 | 104 | agent.dispose(); |
c5524c71 AM |
105 | |
106 | loggerA = null; | |
107 | loggerB = null; | |
108 | } | |
109 | ||
8a0613fa AM |
110 | /** |
111 | * Test tracing with no events enabled in the tracing session. | |
112 | */ | |
c5524c71 AM |
113 | @Test |
114 | public void testNoEvents() { | |
8576633f | 115 | assertTrue(session.start()); |
c5524c71 | 116 | |
8576633f AM |
117 | Log4jTestUtils.send10Events(loggerA); |
118 | Log4jTestUtils.send10Events(loggerB); | |
c5524c71 | 119 | |
8576633f | 120 | assertTrue(session.stop()); |
c5524c71 | 121 | |
8576633f | 122 | List<String> output = session.view(); |
c5524c71 AM |
123 | assertNotNull(output); |
124 | assertTrue(output.isEmpty()); | |
125 | ||
c5524c71 AM |
126 | ILttngHandler handler = getAgentHandler(); |
127 | assertEquals(0, handler.getEventCount()); | |
128 | } | |
129 | ||
8a0613fa AM |
130 | /** |
131 | * Test tracing with all events enabled (-l -a) in the tracing session. | |
132 | */ | |
c5524c71 AM |
133 | @Test |
134 | public void testAllEvents() { | |
8576633f AM |
135 | assertTrue(session.enableAllEvents()); |
136 | assertTrue(session.start()); | |
c5524c71 | 137 | |
8576633f AM |
138 | Log4jTestUtils.send10Events(loggerA); |
139 | Log4jTestUtils.send10Events(loggerB); | |
c5524c71 | 140 | |
8576633f | 141 | assertTrue(session.stop()); |
c5524c71 | 142 | |
8576633f | 143 | List<String> output = session.view(); |
c5524c71 AM |
144 | assertNotNull(output); |
145 | assertEquals(20, output.size()); | |
146 | ||
c5524c71 AM |
147 | ILttngHandler handler = getAgentHandler(); |
148 | assertEquals(20, handler.getEventCount()); | |
149 | } | |
150 | ||
8a0613fa AM |
151 | /** |
152 | * Test tracing with a subset of events enabled in the tracing session. | |
153 | */ | |
c5524c71 AM |
154 | @Test |
155 | public void testSomeEvents() { | |
8576633f AM |
156 | assertTrue(session.enableEvents(EVENT_NAME_A)); |
157 | assertTrue(session.start()); | |
c5524c71 | 158 | |
8576633f AM |
159 | Log4jTestUtils.send10Events(loggerA); |
160 | Log4jTestUtils.send10Events(loggerB); | |
c5524c71 | 161 | |
8576633f | 162 | assertTrue(session.stop()); |
c5524c71 | 163 | |
8576633f | 164 | List<String> output = session.view(); |
c5524c71 AM |
165 | assertNotNull(output); |
166 | assertEquals(10, output.size()); | |
167 | ||
c5524c71 AM |
168 | ILttngHandler handler = getAgentHandler(); |
169 | assertEquals(10, handler.getEventCount()); | |
170 | } | |
171 | ||
bda25414 AM |
172 | /** |
173 | * Test that the "lttng list" commands lists the expected events. | |
174 | */ | |
175 | @Test | |
176 | public void testListEvents() { | |
177 | List<String> enabledEvents = session.listEvents(); | |
178 | List<String> expectedEvents = Arrays.asList(EVENT_NAME_A, EVENT_NAME_B); | |
179 | ||
b342ee75 AM |
180 | /* |
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. | |
185 | * | |
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. | |
188 | */ | |
189 | expectedEvents.forEach(event -> assertTrue(enabledEvents.contains(event))); | |
bda25414 AM |
190 | } |
191 | ||
c5524c71 AM |
192 | /** |
193 | * Get the singleton Log4j Handler currently managed by the LTTngAgent. It | |
194 | * is not public, so we need reflection to access it. | |
195 | * | |
196 | * @return The agent's Log4j handler | |
197 | */ | |
8576633f | 198 | private static ILttngHandler getAgentHandler() { |
c5524c71 AM |
199 | try { |
200 | Field log4jAppenderField = LTTngAgent.class.getDeclaredField("log4jAppender"); | |
201 | log4jAppenderField.setAccessible(true); | |
202 | return (ILttngHandler) log4jAppenderField.get(LTTngAgent.getLTTngAgent()); | |
203 | } catch (ReflectiveOperationException | SecurityException e) { | |
1f3dd43c | 204 | fail(e.getMessage()); |
c5524c71 AM |
205 | return null; |
206 | } | |
207 | } | |
208 | ||
209 | } | |
210 |