Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 7ea5d66de29d2e3b5994d5c42d40968c0e5879cf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
/*******************************************************************************
 * Copyright (c) 2010, 2011 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.osgi.tests.bundles;

import java.util.*;
import junit.framework.*;
import org.eclipse.core.internal.runtime.RuntimeLog;
import org.eclipse.core.runtime.*;
import org.eclipse.equinox.log.*;
import org.eclipse.equinox.log.Logger;
import org.eclipse.osgi.framework.log.FrameworkLog;
import org.eclipse.osgi.framework.log.FrameworkLogEntry;
import org.osgi.framework.*;
import org.osgi.service.event.*;
import org.osgi.service.log.*;

public class LoggingTests extends AbstractBundleTests {
	static final String EQUINOX_LOGGER = "org.eclipse.equinox.logger";

	public static Test suite() {
		return new TestSuite(LoggingTests.class);
	}

	class LogServiceReference {
		private final ServiceReference logRef;
		final ExtendedLogService logService;
		private final ServiceReference readerRef;
		final ExtendedLogReaderService readerService;
		private final ServiceReference fwkLogRef;
		final FrameworkLog fwkLog;

		public LogServiceReference(ServiceReference logRef, ExtendedLogService logService, ServiceReference readerRef, ExtendedLogReaderService readerService, ServiceReference fwkLogRef, FrameworkLog fwkLog) {

			this.logRef = logRef;
			this.logService = logService;
			this.readerRef = readerRef;
			this.readerService = readerService;
			this.fwkLogRef = fwkLogRef;
			this.fwkLog = fwkLog;
		}

		public void unget(BundleContext bc) {
			bc.ungetService(logRef);
			bc.ungetService(readerRef);
			bc.ungetService(fwkLogRef);
		}
	}

	class ILogEntry {
		final IStatus status;
		final String plugin;

		ILogEntry(IStatus status, String plugin) {
			this.status = status;
			this.plugin = plugin;
		}
	}

	class TestListener {
		final List context;
		boolean found = false;

		TestListener(List context) {
			this.context = context;
		}

		synchronized boolean waitforContext() {
			if (context.size() > 0)
				try {
					wait(5000);
				} catch (InterruptedException e) {
					Thread.currentThread().interrupt();
				}
			return context.size() == 0;

		}

		synchronized void checkContext(IStatus check) {
			if (check == null)
				return;
			if (context.size() > 0) {
				IStatus expected = (IStatus) context.get(0);
				try {
					assertEquals(expected.getSeverity(), check.getSeverity());
					assertEquals(expected.getCode(), check.getCode());
					assertEquals(expected.getMessage(), check.getMessage());
					assertEquals(expected.getPlugin(), check.getPlugin());
				} catch (AssertionFailedError e) {
					return;
				}
				context.remove(0);
				if (context.size() == 0)
					notifyAll();
			}
		}

		synchronized void addContext(List moreContext) {
			context.addAll(moreContext);
		}
	}

	class TestILogListener extends TestListener implements ILogListener {
		TestILogListener(List context) {
			super(context);
		}

		List entries = new ArrayList();

		public void logging(IStatus status, String plugin) {
			entries.add(new ILogEntry(status, plugin));
			checkContext(status);
		}

		List getEntries() {
			return entries;
		}
	}

	class TestLogListener extends TestListener implements LogListener, LogFilter {
		TestLogListener(List context) {
			super(context);
		}

		List entries = new ArrayList();

		public void logged(LogEntry entry) {
			entries.add(entry);
			Object check = ((ExtendedLogEntry) entry).getContext();
			if (check instanceof FrameworkLogEntry)
				check = ((FrameworkLogEntry) check).getContext();
			if (check instanceof IStatus)
				checkContext((IStatus) check);
		}

		List getEntries() {
			return entries;
		}

		public boolean isLoggable(Bundle bundle, String loggerName, int logLevel) {
			return EQUINOX_LOGGER.equals(loggerName);
		}
	}

	private LogServiceReference getLogService(BundleContext bc) {
		ServiceReference logRef = bc.getServiceReference(ExtendedLogService.class.getName());
		assertNotNull("log service ref is null", logRef);
		ServiceReference readerRef = bc.getServiceReference(ExtendedLogReaderService.class.getName());
		assertNotNull("log reader ref is null", readerRef);
		ServiceReference fwkLogRef = bc.getServiceReference(FrameworkLog.class.getName());
		assertNotNull("framework log ref is null", fwkLogRef);

		ExtendedLogService logService = (ExtendedLogService) bc.getService(logRef);
		assertNotNull("log service is null", logService);
		ExtendedLogReaderService readerService = (ExtendedLogReaderService) bc.getService(readerRef);
		assertNotNull("reader service is null", readerService);
		FrameworkLog fwkLog = (FrameworkLog) bc.getService(fwkLogRef);
		assertNotNull("framework log is null", fwkLog);
		return new LogServiceReference(logRef, logService, readerRef, readerService, fwkLogRef, fwkLog);
	}

	public void testLogService() throws BundleException {
		// Tests listeners at all levels when logged with the LogService
		Bundle testBundle = installer.installBundle("test.logging.a"); //$NON-NLS-1$
		testBundle.start();
		BundleContext bc = testBundle.getBundleContext();
		LogServiceReference logRef = getLogService(bc);
		IStatus a = new Status(IStatus.ERROR, testBundle.getSymbolicName(), getName());
		List context = new ArrayList();
		context.add(a);
		TestILogListener iLogListener1 = new TestILogListener(new ArrayList(context));
		TestILogListener iLogListener2 = new TestILogListener(new ArrayList(context));
		TestLogListener logListener = new TestLogListener(new ArrayList(context));

		ILog testLog = Platform.getLog(testBundle);
		testLog.addLogListener(iLogListener1);
		Platform.addLogListener(iLogListener2);
		logRef.readerService.addLogListener(logListener, logListener);
		try {
			ExtendedLogService logService = logRef.logService;
			Logger logger = logService.getLogger(testBundle, EQUINOX_LOGGER);
			logger.log(a, LogService.LOG_ERROR, a.getMessage());
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			assertTrue("Missing context", logListener.waitforContext());

			iLogListener1.addContext(new ArrayList(context));
			iLogListener2.addContext(new ArrayList(context));
			logListener.addContext(new ArrayList(context));

			logger.log(new FrameworkLogEntry(a, testBundle.getSymbolicName(), a.getSeverity(), a.getCode(), a.getMessage(), 0, null, null), LogService.LOG_ERROR, a.getMessage());
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			assertTrue("Missing context", logListener.waitforContext());

			iLogListener1.addContext(new ArrayList(context));
			iLogListener2.addContext(new ArrayList(context));
			logListener.addContext(new ArrayList(context));

			logListener.entries.clear();
			logger.log(LogService.LOG_ERROR, a.getMessage());
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			// there is no status here
			assertFalse("Missing context", logListener.waitforContext());
			// but we should have received one log entry
			assertEquals("Wrong number of entries", 1, logListener.entries.size());
		} finally {
			testLog.removeLogListener(iLogListener1);
			Platform.removeLogListener(iLogListener2);
			logRef.readerService.removeLogListener(logListener);
			logRef.unget(bc);
		}
	}

	public void testPluginILog() throws BundleException {
		// Tests listeners at all levels when logged with a plugin ILog
		Bundle testBundle = installer.installBundle("test.logging.a"); //$NON-NLS-1$
		testBundle.start();
		BundleContext bc = testBundle.getBundleContext();
		LogServiceReference logRef = getLogService(bc);
		IStatus a = new Status(IStatus.ERROR, testBundle.getSymbolicName(), getName());
		List context = new ArrayList();
		context.add(a);
		TestILogListener iLogListener1 = new TestILogListener(new ArrayList(context));
		TestILogListener iLogListener2 = new TestILogListener(new ArrayList(context));
		TestLogListener logListener = new TestLogListener(new ArrayList(context));

		ILog testLog = Platform.getLog(testBundle);
		testLog.addLogListener(iLogListener1);
		Platform.addLogListener(iLogListener2);
		logRef.readerService.addLogListener(logListener, logListener);
		try {
			testLog.log(a);
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			assertTrue("Missing context", logListener.waitforContext());

			iLogListener1.addContext(new ArrayList(context));
			iLogListener2.addContext(new ArrayList(context));
			logListener.addContext(new ArrayList(context));

			testLog.log(a);
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			assertTrue("Missing context", logListener.waitforContext());
		} finally {
			testLog.removeLogListener(iLogListener1);
			Platform.removeLogListener(iLogListener2);
			logRef.readerService.removeLogListener(logListener);
			logRef.unget(bc);
		}
	}

	public void testRuntimeLog() throws BundleException {
		// Tests listeners at all levels when logged with the RuntimeLog
		Bundle testBundle = installer.installBundle("test.logging.a"); //$NON-NLS-1$
		testBundle.start();
		BundleContext bc = testBundle.getBundleContext();
		LogServiceReference logRef = getLogService(bc);
		IStatus a = new Status(IStatus.ERROR, testBundle.getSymbolicName(), getName());
		List context = new ArrayList();
		context.add(a);
		TestILogListener iLogListener1 = new TestILogListener(new ArrayList(context));
		TestILogListener iLogListener2 = new TestILogListener(new ArrayList(context));
		TestLogListener logListener = new TestLogListener(new ArrayList(context));

		ILog testLog = Platform.getLog(testBundle);
		testLog.addLogListener(iLogListener1);
		Platform.addLogListener(iLogListener2);
		logRef.readerService.addLogListener(logListener, logListener);
		try {
			RuntimeLog.log(a);
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			assertTrue("Missing context", logListener.waitforContext());

			iLogListener1.addContext(new ArrayList(context));
			iLogListener2.addContext(new ArrayList(context));
			logListener.addContext(new ArrayList(context));

			RuntimeLog.log(a);
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			assertTrue("Missing context", logListener.waitforContext());
		} finally {
			testLog.removeLogListener(iLogListener1);
			Platform.removeLogListener(iLogListener2);
			logRef.readerService.removeLogListener(logListener);
			logRef.unget(bc);
		}
	}

	public void testFrameworkLog() throws BundleException {
		// Tests listeners at all levels when logged with the FrameworkLog
		Bundle testBundle = installer.installBundle("test.logging.a"); //$NON-NLS-1$
		testBundle.start();
		BundleContext bc = testBundle.getBundleContext();
		LogServiceReference logRef = getLogService(bc);
		IStatus a = new Status(IStatus.ERROR, testBundle.getSymbolicName(), getName());
		List context = new ArrayList();
		context.add(a);
		TestILogListener iLogListener1 = new TestILogListener(new ArrayList(context));
		TestILogListener iLogListener2 = new TestILogListener(new ArrayList(context));
		TestLogListener logListener = new TestLogListener(new ArrayList(context));

		ILog testLog = Platform.getLog(testBundle);
		testLog.addLogListener(iLogListener1);
		Platform.addLogListener(iLogListener2);
		logRef.readerService.addLogListener(logListener, logListener);
		try {
			FrameworkLogEntry fwkLogEntry = new FrameworkLogEntry(a, testBundle.getSymbolicName(), a.getSeverity(), a.getCode(), a.getMessage(), 0, null, null);
			logRef.fwkLog.log(fwkLogEntry);
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			assertTrue("Missing context", logListener.waitforContext());

			iLogListener1.addContext(new ArrayList(context));
			iLogListener2.addContext(new ArrayList(context));
			logListener.addContext(new ArrayList(context));

			logRef.fwkLog.log(fwkLogEntry);
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			assertTrue("Missing context", logListener.waitforContext());

			iLogListener1.addContext(new ArrayList(context));
			iLogListener2.addContext(new ArrayList(context));
			logListener.addContext(new ArrayList(context));

			logListener.entries.clear();
			logRef.fwkLog.log(new FrameworkLogEntry(testBundle.getSymbolicName(), a.getSeverity(), a.getCode(), a.getMessage(), 0, null, null));
			assertTrue("Missing context", iLogListener1.waitforContext());
			assertTrue("Missing context", iLogListener2.waitforContext());
			// there is no status here
			assertFalse("Missing context", logListener.waitforContext());
			// but we should have received one log entry
			assertEquals("Wrong number of entries", 1, logListener.entries.size());
		} finally {
			testLog.removeLogListener(iLogListener1);
			Platform.removeLogListener(iLogListener2);
			logRef.readerService.removeLogListener(logListener);
			logRef.unget(bc);
		}
	}

	public void testEventAdminAdapter1() {
		ServiceReference eventRef = getContext().getServiceReference(EventAdmin.class.getName());
		assertNotNull("No eventAdmin.", eventRef);
		LogServiceReference logRef = getLogService(getContext());

		final List events = new ArrayList();
		EventHandler testHandler = new EventHandler() {

			public void handleEvent(Event event) {
				synchronized (events) {
					events.add(event);
					events.notifyAll();
				}
			}
		};

		Dictionary props = new Hashtable();
		props.put(EventConstants.EVENT_TOPIC, "org/osgi/service/log/LogEntry/*");
		ServiceRegistration handlerReg = getContext().registerService(EventHandler.class.getName(), testHandler, props);
		try {
			logRef.logService.log(LogService.LOG_ERROR, getName());
			Event testEvent = null;
			synchronized (events) {
				if (events.size() == 0)
					try {
						events.wait(5000);
					} catch (InterruptedException e) {
						Thread.currentThread().interrupt();
					}
				if (events.size() > 0)
					testEvent = (Event) events.get(0);
			}
			assertNotNull("No event fired", testEvent);
			assertEquals("Wrong message", getName(), testEvent.getProperty("message"));
		} finally {
			handlerReg.unregister();
			logRef.unget(getContext());
		}
	}

	public void testEventAdminAdapter2() {
		ServiceReference eventRef = getContext().getServiceReference(EventAdmin.class.getName());
		assertNotNull("No eventAdmin.", eventRef);
		LogServiceReference logRef = getLogService(getContext());

		final List events = new ArrayList();
		EventHandler testHandler = new EventHandler() {

			public void handleEvent(Event event) {
				synchronized (events) {
					events.add(event);
					events.notifyAll();
				}
				throw new NullPointerException();
			}
		};

		Dictionary props = new Hashtable();
		props.put(EventConstants.EVENT_TOPIC, "org/osgi/service/log/LogEntry/*");
		ServiceRegistration handlerReg = getContext().registerService(EventHandler.class.getName(), testHandler, props);
		try {
			logRef.logService.log(LogService.LOG_ERROR, getName());
			int size = 0;
			synchronized (events) {
				for (int i = 0; i < 3 && events.size() < 3; i++)
					try {
						events.wait(5000);
					} catch (InterruptedException e) {
						Thread.currentThread().interrupt();
					}
				size = events.size();
			}
			assertEquals("Should only get one event from bad handler", 2, size);
		} finally {
			handlerReg.unregister();
			logRef.unget(getContext());
		}
	}

	public void testBug347183() throws BundleException {
		// test recursive logging
		final Bundle testBundle = installer.installBundle("test.logging.a"); //$NON-NLS-1$
		testBundle.start();
		LogServiceReference logRef = getLogService(getContext());
		ILogListener recurseLog = new ILogListener() {

			public void logging(IStatus status, String plugin) {
				Platform.getLog(testBundle).log(status);
			}
		};
		Platform.addLogListener(recurseLog);
		try {
			logRef.fwkLog.log(new FrameworkLogEntry(getContext().getBundle().getSymbolicName(), FrameworkLogEntry.ERROR, 0, "Test message", 0, null, null));

			// prime the log so we don't have to create it in the logging call
			Platform.getLog(testBundle);

			logRef.fwkLog.log(new FrameworkLogEntry(getContext().getBundle().getSymbolicName(), FrameworkLogEntry.ERROR, 0, "Test message", 0, null, null));
		} finally {
			Platform.removeLogListener(recurseLog);
		}
	}
}

Back to the top