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
|
/*******************************************************************************
* Copyright (c) 2007, 2018 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.equinox.common.tests.registry;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import java.io.IOException;
import org.eclipse.core.runtime.RegistryFactory;
import org.eclipse.core.tests.harness.BundleTestingHelper;
import org.junit.BeforeClass;
import org.junit.Test;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleException;
import org.osgi.framework.FrameworkUtil;
/**
* Tests "new" registry event listener.
* @since 3.4
*/
public class RegistryListenerTest {
final private static int MAX_TIME_PER_BUNDLE = 10000; // maximum time to wait for bundle event in milliseconds
private static BundleContext fBundleContext;
@BeforeClass
public static void setUp() throws Exception {
fBundleContext = FrameworkUtil.getBundle(RegistryListenerTest.class).getBundleContext();
}
/**
* Producer and consumer bundles are installed and removed in a "normal" order
*/
@Test
public void testRegularOrder() throws IOException, BundleException {
Bundle bundle01 = null;
Bundle bundle02 = null;
WaitingRegistryListener listener = new WaitingRegistryListener();
listener.register("bundle01.xp1");
try {
bundle01 = BundleTestingHelper.installBundle("0.1", fBundleContext, "Plugin_Testing/registryListener/bundle01");
bundle02 = BundleTestingHelper.installBundle("0.2", fBundleContext, "Plugin_Testing/registryListener/bundle02");
Bundle[] testBundles = new Bundle[] {bundle01, bundle02};
BundleTestingHelper.refreshPackages(fBundleContext, testBundles);
String[] extPointIDs = listener.extPointsReceived(2 * MAX_TIME_PER_BUNDLE);
String[] extensionsReceived = listener.extensionsReceived(2 * MAX_TIME_PER_BUNDLE);
assertTrue(listener.isAdded());
assertNotNull(extPointIDs);
assertTrue(extPointIDs.length == 1);
assertTrue("bundle01.xp1".equals(extPointIDs[0]));
assertNotNull(extensionsReceived);
assertTrue(extensionsReceived.length == 1);
assertTrue("bundle02.ext1".equals(extensionsReceived[0]));
listener.reset();
bundle02.uninstall();
bundle02 = null; // reset as early as possible in case of exception
bundle01.uninstall();
bundle01 = null; // reset as early as possible in case of exception
BundleTestingHelper.refreshPackages(fBundleContext, testBundles);
extPointIDs = listener.extPointsReceived(2 * MAX_TIME_PER_BUNDLE);
extensionsReceived = listener.extensionsReceived(2 * MAX_TIME_PER_BUNDLE);
assertTrue(listener.isRemoved());
assertNotNull(extPointIDs);
assertTrue(extPointIDs.length == 1);
assertTrue("bundle01.xp1".equals(extPointIDs[0]));
assertNotNull(extensionsReceived);
assertTrue(extensionsReceived.length == 1);
assertTrue("bundle02.ext1".equals(extensionsReceived[0]));
} finally {
listener.unregister();
if (bundle01 != null) {
bundle01.uninstall();
}
if (bundle02 != null) {
bundle02.uninstall();
}
}
}
/**
* Producer and consumer bundles are installed and removed in an inverse order
*/
@Test
public void testInverseOrder() throws IOException, BundleException {
Bundle bundle01 = null;
Bundle bundle02 = null;
WaitingRegistryListener listener = new WaitingRegistryListener();
listener.register("bundle01.xp1");
try {
bundle02 = BundleTestingHelper.installBundle("0.2", fBundleContext, "Plugin_Testing/registryEvents/bundle02");
bundle01 = BundleTestingHelper.installBundle("0.1", fBundleContext, "Plugin_Testing/registryEvents/bundle01");
Bundle[] testBundles = new Bundle[] {bundle01, bundle02};
BundleTestingHelper.refreshPackages(fBundleContext, testBundles);
String[] extPointIDs = listener.extPointsReceived(2 * MAX_TIME_PER_BUNDLE);
String[] extensionsReceived = listener.extensionsReceived(2 * MAX_TIME_PER_BUNDLE);
assertTrue(listener.isAdded());
assertNotNull(extPointIDs);
assertTrue(extPointIDs.length == 1);
assertTrue("bundle01.xp1".equals(extPointIDs[0]));
assertNotNull(extensionsReceived);
assertTrue(extensionsReceived.length == 1);
assertTrue("bundle02.ext1".equals(extensionsReceived[0]));
listener.reset();
bundle01.uninstall();
bundle01 = null; // reset as early as possible in case of exception
bundle02.uninstall();
bundle02 = null; // reset as early as possible in case of exception
BundleTestingHelper.refreshPackages(fBundleContext, testBundles);
extPointIDs = listener.extPointsReceived(2 * MAX_TIME_PER_BUNDLE);
extensionsReceived = listener.extensionsReceived(2 * MAX_TIME_PER_BUNDLE);
assertTrue(listener.isRemoved());
assertNotNull(extPointIDs);
assertTrue(extPointIDs.length == 1);
assertTrue("bundle01.xp1".equals(extPointIDs[0]));
assertNotNull(extensionsReceived);
assertTrue(extensionsReceived.length == 1);
assertTrue("bundle02.ext1".equals(extensionsReceived[0]));
} finally {
listener.unregister();
if (bundle02 != null) {
bundle02.uninstall();
}
if (bundle01 != null) {
bundle01.uninstall();
}
}
}
/**
* Tests modifications to multiple extensions and extension points
* Three listeners are tested: global; on xp1 (two extensions); on xp2 (no extensions)
*/
@Test
public void testMultiplePoints() throws IOException, BundleException {
Bundle bundle = null;
WaitingRegistryListener listenerGlobal = new WaitingRegistryListener();
listenerGlobal.register(null);
WaitingRegistryListener listener1 = new WaitingRegistryListener();
listener1.register("bundleMultiple.xp1");
WaitingRegistryListener listener2 = new WaitingRegistryListener();
listener2.register("bundleMultiple.xp2");
try {
bundle = BundleTestingHelper.installBundle("0.1", fBundleContext, "Plugin_Testing/registryListener/bundleMultiple");
Bundle[] testBundles = new Bundle[] {bundle};
BundleTestingHelper.refreshPackages(fBundleContext, testBundles);
// test additions on global listener
String[] extPointIDs = listenerGlobal.extPointsReceived(MAX_TIME_PER_BUNDLE);
String[] extensionsReceived = listenerGlobal.extensionsReceived(MAX_TIME_PER_BUNDLE);
assertTrue(listenerGlobal.isAdded());
checkIDs(extPointIDs, new String[] {"bundleMultiple.xp1", "bundleMultiple.xp2"});
checkIDs(extensionsReceived, new String[] {"bundleMultiple.ext11", "bundleMultiple.ext12"});
// test additions on listener on extension point with extensions
String[] extPointIDs1 = listener1.extPointsReceived(20000);
String[] extensionsReceived1 = listener1.extensionsReceived(20000);
assertTrue(listener1.isAdded());
checkIDs(extPointIDs1, new String[] {"bundleMultiple.xp1"});
checkIDs(extensionsReceived1, new String[] {"bundleMultiple.ext11", "bundleMultiple.ext12"});
// test additions on listener on extension point with no extensions
String[] extPointIDs2 = listener2.extPointsReceived(MAX_TIME_PER_BUNDLE);
String[] extensionsReceived2 = listener2.extensionsReceived(50);
assertTrue(listener2.isAdded());
checkIDs(extPointIDs2, new String[] {"bundleMultiple.xp2"});
assertNull(extensionsReceived2);
// removal
listenerGlobal.reset();
listener1.reset();
listener2.reset();
bundle.uninstall();
bundle = null; // reset as early as possible in case of exception
BundleTestingHelper.refreshPackages(fBundleContext, testBundles);
// test removals on global listener
extPointIDs = listenerGlobal.extPointsReceived(MAX_TIME_PER_BUNDLE);
extensionsReceived = listenerGlobal.extensionsReceived(MAX_TIME_PER_BUNDLE);
assertTrue(listenerGlobal.isRemoved());
checkIDs(extPointIDs, new String[] {"bundleMultiple.xp1", "bundleMultiple.xp2"});
checkIDs(extensionsReceived, new String[] {"bundleMultiple.ext11", "bundleMultiple.ext12"});
// test removals on listener on extension point with extensions
extPointIDs1 = listener1.extPointsReceived(MAX_TIME_PER_BUNDLE);
extensionsReceived1 = listener1.extensionsReceived(MAX_TIME_PER_BUNDLE);
assertTrue(listener1.isRemoved());
checkIDs(extPointIDs1, new String[] {"bundleMultiple.xp1"});
checkIDs(extensionsReceived1, new String[] {"bundleMultiple.ext11", "bundleMultiple.ext12"});
// test removals on listener on extension point with no extensions
extPointIDs2 = listener2.extPointsReceived(MAX_TIME_PER_BUNDLE);
extensionsReceived2 = listener2.extensionsReceived(50);
assertTrue(listener2.isRemoved());
checkIDs(extPointIDs2, new String[] {"bundleMultiple.xp2"});
assertNull(extensionsReceived2);
} finally {
listenerGlobal.unregister();
listener1.unregister();
listener2.unregister();
if (bundle != null) {
bundle.uninstall();
}
}
}
/**
* Tests listener registered multiple times: once on xp1, once on xp2
*/
@Test
public void testMultipleRegistrations() throws IOException, BundleException {
Bundle bundle = null;
WaitingRegistryListener listener = new WaitingRegistryListener();
RegistryFactory.getRegistry().addListener(listener, "bundleMultiple.xp1");
RegistryFactory.getRegistry().addListener(listener, "bundleMultiple.xp1");
try {
bundle = BundleTestingHelper.installBundle("0.1", fBundleContext, "Plugin_Testing/registryListener/bundleMultiple");
Bundle[] testBundles = new Bundle[] {bundle};
BundleTestingHelper.refreshPackages(fBundleContext, testBundles);
// 1st registration: extension point; extension => 2 callbacks
// 2nd registration should be ignored: extension => 0 callbacks
// total: 2 callbacks
assertTrue(listener.waitFor(2, MAX_TIME_PER_BUNDLE) == 2);
// test additions on listener on extension point with extensions
String[] extPointIDs = listener.extPointsReceived(50);
String[] extensionsReceived = listener.extensionsReceived(50);
assertTrue(listener.isAdded());
checkIDs(extPointIDs, new String[] {"bundleMultiple.xp1"});
checkIDs(extensionsReceived, new String[] {"bundleMultiple.ext11", "bundleMultiple.ext12"});
// removal: unregistering listener once should remove both registrations
listener.reset();
listener.unregister();
bundle.uninstall();
bundle = null; // reset as early as possible in case of exception
BundleTestingHelper.refreshPackages(fBundleContext, testBundles);
// test removals on listener on extension point with extensions
assertTrue(listener.waitFor(3, 200) == 0);
extPointIDs = listener.extPointsReceived(50);
extensionsReceived = listener.extensionsReceived(50);
assertNull(extPointIDs);
assertNull(extensionsReceived);
} finally {
// second unregistration should have no effect
listener.unregister();
if (bundle != null) {
bundle.uninstall();
}
}
}
// For simplicity, this method does not expect duplicate IDs in either array
private void checkIDs(String[] receivedIDs, String[] expectedIDs) {
assertNotNull(receivedIDs);
assertNotNull(expectedIDs);
assertTrue(receivedIDs.length == expectedIDs.length);
for (String expected : expectedIDs) {
boolean found = false;
for (String receivedID : receivedIDs) {
if (expected.equals(receivedID)) {
found = true;
break;
}
}
assertTrue(found);
}
}
}
|
