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
|
/*******************************************************************************
* Copyright (c) 2013 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.container;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.util.*;
import org.eclipse.osgi.container.Module;
import org.eclipse.osgi.container.ModuleContainer;
import org.eclipse.osgi.report.resolution.ResolutionReport;
import org.eclipse.osgi.tests.container.dummys.*;
import org.junit.Test;
import org.osgi.framework.Constants;
import org.osgi.framework.namespace.PackageNamespace;
import org.osgi.framework.wiring.BundleRevision;
import org.osgi.framework.wiring.FrameworkWiring;
import org.osgi.resource.*;
import org.osgi.service.resolver.ResolutionException;
public class ResolutionReportTest extends AbstractTest {
// TODO Add test for dynamic resolution in conjunction with UNRESOLVED_PROVIDER entries.
@Test
public void testResolutionReportListenerService() throws Exception {
DummyResolverHook hook = new DummyResolverHook();
registerService(org.osgi.framework.hooks.resolver.ResolverHookFactory.class, new DummyResolverHookFactory(hook));
getSystemBundle().adapt(FrameworkWiring.class).resolveBundles(Collections.singleton(getSystemBundle()));
assertEquals("No resolution report listener callback", 1, hook.getResolutionReports().size());
assertNotNull("Resolution report was null", hook.getResolutionReports().get(0));
}
@Test
public void testResolutionReportListenerModule() throws Exception {
DummyResolverHook hook = new DummyResolverHook();
DummyContainerAdaptor adaptor = createDummyAdaptor(hook);
ModuleContainer container = adaptor.getContainer();
Module systemBundle = installDummyModule("system.bundle.MF", Constants.SYSTEM_BUNDLE_LOCATION, container);
container.resolve(Arrays.asList(systemBundle), true);
assertEquals("No resolution report listener callback", 1, hook.getResolutionReports().size());
assertNotNull("Resolution report was null", hook.getResolutionReports().get(0));
}
@Test
public void testResolutionReportBuilder() {
org.eclipse.osgi.container.ModuleResolutionReport.Builder builder = new org.eclipse.osgi.container.ModuleResolutionReport.Builder();
ResolutionReport report = builder.build();
assertNotNull("Resolution report was null", report);
}
@Test
public void testResolutionReportEntryFilteredByResolverHook() throws Exception {
DummyResolverHook hook = new DummyResolverHook() {
@Override
public void filterResolvable(Collection<BundleRevision> candidates) {
candidates.clear();
}
};
DummyContainerAdaptor adaptor = createDummyAdaptor(hook);
ModuleContainer container = adaptor.getContainer();
Module module = installDummyModule("resolution.report.a.MF", "resolution.report.a", container);
assertResolutionDoesNotSucceed(container, Arrays.asList(module));
ResolutionReport report = hook.getResolutionReports().get(0);
Map<Resource, List<ResolutionReport.Entry>> resourceToEntries = report.getEntries();
assertResolutionReportEntriesSize(resourceToEntries, 1);
List<ResolutionReport.Entry> entries = resourceToEntries.get(module.getCurrentRevision());
assertResolutionReportEntriesSize(entries, 1);
ResolutionReport.Entry entry = entries.get(0);
assertResolutionReportEntryTypeFilteredByResolverHook(entry.getType());
assertResolutionReportEntryDataNull(entry.getData());
}
@Test
public void testResolutionReportEntrySingletonSelectionNoneResolved() throws Exception {
DummyResolverHook hook = new DummyResolverHook();
DummyContainerAdaptor adaptor = createDummyAdaptor(hook);
ModuleContainer container = adaptor.getContainer();
Module resolutionReporta = installDummyModule("resolution.report.a.MF", "resolution.report.a", container);
Module resolutionReportaV1 = installDummyModule("resolution.report.a.v1.MF", "resolution.report.a.v1", container);
assertResolutionDoesNotSucceed(container, Arrays.asList(resolutionReporta, resolutionReportaV1));
ResolutionReport report = hook.getResolutionReports().get(0);
Map<Resource, List<ResolutionReport.Entry>> resourceToEntries = report.getEntries();
assertResolutionReportEntriesSize(resourceToEntries, 1);
List<ResolutionReport.Entry> entries = resourceToEntries.get(resolutionReporta.getCurrentRevision());
assertResolutionReportEntriesSize(entries, 1);
ResolutionReport.Entry entry = entries.get(0);
assertResolutionReportEntryTypeSingletonSelection(entry.getType());
assertResolutionReportEntryDataNotNull(entry.getData());
}
@Test
public void testResolutionReportEntrySingletonSelectionHighestVersionResolved() throws Exception {
DummyResolverHook hook = new DummyResolverHook();
DummyContainerAdaptor adaptor = createDummyAdaptor(hook);
ModuleContainer container = adaptor.getContainer();
Module resolutionReporta = installDummyModule("resolution.report.a.MF", "resolution.report.a", container);
Module resolutionReportaV1 = installDummyModule("resolution.report.a.v1.MF", "resolution.report.a.v1", container);
container.resolve(Arrays.asList(resolutionReportaV1), true);
clearResolutionReports(hook);
assertResolutionDoesNotSucceed(container, Arrays.asList(resolutionReporta));
ResolutionReport report = hook.getResolutionReports().get(0);
Map<Resource, List<ResolutionReport.Entry>> resourceToEntries = report.getEntries();
assertResolutionReportEntriesSize(resourceToEntries, 1);
List<ResolutionReport.Entry> entries = resourceToEntries.get(resolutionReporta.getCurrentRevision());
assertResolutionReportEntriesSize(entries, 1);
ResolutionReport.Entry entry = entries.get(0);
assertResolutionReportEntryTypeSingletonSelection(entry.getType());
assertResolutionReportEntryDataNotNull(entry.getData());
}
@Test
public void testResolutionReportEntrySingletonSelectionLowestVersionResolved() throws Exception {
DummyResolverHook hook = new DummyResolverHook();
DummyContainerAdaptor adaptor = createDummyAdaptor(hook);
ModuleContainer container = adaptor.getContainer();
Module resolutionReporta = installDummyModule("resolution.report.a.MF", "resolution.report.a", container);
container.resolve(Arrays.asList(resolutionReporta), true);
clearResolutionReports(hook);
Module resolutionReportaV1 = installDummyModule("resolution.report.a.v1.MF", "resolution.report.a.v1", container);
assertResolutionDoesNotSucceed(container, Arrays.asList(resolutionReportaV1));
ResolutionReport report = hook.getResolutionReports().get(0);
Map<Resource, List<ResolutionReport.Entry>> resourceToEntries = report.getEntries();
assertResolutionReportEntriesSize(resourceToEntries, 1);
List<ResolutionReport.Entry> entries = resourceToEntries.get(resolutionReportaV1.getCurrentRevision());
assertResolutionReportEntriesSize(entries, 1);
ResolutionReport.Entry entry = entries.get(0);
assertResolutionReportEntryTypeSingletonSelection(entry.getType());
assertResolutionReportEntryDataNotNull(entry.getData());
}
@Test
public void testResolutionReportEntryMissingCapability() throws Exception {
DummyResolverHook hook = new DummyResolverHook();
DummyContainerAdaptor adaptor = createDummyAdaptor(hook);
ModuleContainer container = adaptor.getContainer();
Module resolutionReportB = installDummyModule("resolution.report.b.MF", "resolution.report.b", container);
assertResolutionDoesNotSucceed(container, Arrays.asList(resolutionReportB));
ResolutionReport report = hook.getResolutionReports().get(0);
Map<Resource, List<ResolutionReport.Entry>> resourceToEntries = report.getEntries();
assertResolutionReportEntriesSize(resourceToEntries, 1);
List<ResolutionReport.Entry> entries = resourceToEntries.get(resolutionReportB.getCurrentRevision());
assertResolutionReportEntriesSize(entries, 1);
ResolutionReport.Entry entry = entries.get(0);
assertResolutionReportEntryTypeMissingCapability(entry.getType());
assertResolutionReportEntryDataMissingCapability(entry.getData(), "osgi.wiring.package", "resolution.report.a");
}
@Test
public void testResolutionReportEntryUnresolvedProvider01() throws Exception {
DummyResolverHook hook = new DummyResolverHook();
DummyContainerAdaptor adaptor = createDummyAdaptor(hook);
ModuleContainer container = adaptor.getContainer();
Module resolutionReportC = installDummyModule("resolution.report.c.MF", "resolution.report.c", container);
Module resolutionReportD = installDummyModule("resolution.report.d.MF", "resolution.report.d", container);
assertResolutionDoesNotSucceed(container, Arrays.asList(resolutionReportC, resolutionReportD));
ResolutionReport report = hook.getResolutionReports().get(0);
Map<Resource, List<ResolutionReport.Entry>> resourceToEntries = report.getEntries();
assertResolutionReportEntriesSize(resourceToEntries, 2);
List<ResolutionReport.Entry> entries = resourceToEntries.get(resolutionReportC.getCurrentRevision());
assertResolutionReportEntriesSize(entries, 1);
ResolutionReport.Entry entry = entries.get(0);
assertResolutionReportEntryTypeUnresolvedProvider(entry.getType());
assertResolutionReportEntryDataUnresolvedProvider(entry.getData(), new UnresolvedProviderEntryBuilder().requirement(resolutionReportC.getCurrentRevision().getRequirements("resolution.report.d").get(0)).capability(resolutionReportD.getCurrentRevision().getCapabilities("resolution.report.d").get(0)).build());
entries = resourceToEntries.get(resolutionReportD.getCurrentRevision());
assertResolutionReportEntriesSize(entries, 1);
entry = entries.get(0);
assertResolutionReportEntryTypeMissingCapability(entry.getType());
assertResolutionReportEntryDataMissingCapability(entry.getData(), "does.not.exist", null);
}
@Test
public void testResolutionReportEntryUnresolvedProvider02() throws Exception {
DummyResolverHook hook = new DummyResolverHook();
DummyContainerAdaptor adaptor = createDummyAdaptor(hook);
ModuleContainer container = adaptor.getContainer();
Module resolutionReportE = installDummyModule("resolution.report.e.MF", "resolution.report.e", container);
Module resolutionReportF = installDummyModule("resolution.report.f.MF", "resolution.report.f", container);
Module resolutionReportG = installDummyModule("resolution.report.g.MF", "resolution.report.g", container);
assertResolutionSucceeds(container, Arrays.asList(resolutionReportG, resolutionReportE, resolutionReportF));
ResolutionReport report = hook.getResolutionReports().get(0);
Map<Resource, List<ResolutionReport.Entry>> resourceToEntries = report.getEntries();
assertResolutionReportEntriesSize(resourceToEntries, 2);
List<ResolutionReport.Entry> entries = resourceToEntries.get(resolutionReportG.getCurrentRevision());
assertResolutionReportEntriesSize(entries, 1);
ResolutionReport.Entry entry = entries.get(0);
assertResolutionReportEntryTypeUnresolvedProvider(entry.getType());
assertResolutionReportEntryDataUnresolvedProvider(entry.getData(), new UnresolvedProviderEntryBuilder().requirement(resolutionReportG.getCurrentRevision().getRequirements(PackageNamespace.PACKAGE_NAMESPACE).get(1)).capability(resolutionReportF.getCurrentRevision().getCapabilities(PackageNamespace.PACKAGE_NAMESPACE).get(0)).build());
entries = resourceToEntries.get(resolutionReportF.getCurrentRevision());
assertResolutionReportEntriesSize(entries, 1);
entry = entries.get(0);
assertResolutionReportEntryTypeMissingCapability(entry.getType());
assertResolutionReportEntryDataMissingCapability(entry.getData(), "does.not.exist", null);
}
private void clearResolutionReports(DummyResolverHook hook) {
hook.getResolutionReports().clear();
}
// TODO Need to test both mandatory and optional triggers.
private void assertResolutionDoesNotSucceed(ModuleContainer container, Collection<Module> modules) {
try {
container.resolve(modules, true);
fail("Resolution should not have succeeded");
} catch (ResolutionException e) {
// Okay.
}
}
private void assertResolutionSucceeds(ModuleContainer container, Collection<Module> modules) {
try {
container.resolve(modules, false);
// Okay
} catch (ResolutionException e) {
fail("Unexpected resolution exception");
}
}
private void assertResolutionReportEntriesNotNull(Map<Resource, List<ResolutionReport.Entry>> entries) {
assertNotNull("Resolution report entries was null", entries);
}
private void assertResolutionReportEntriesSize(Map<Resource, List<ResolutionReport.Entry>> entries, int expected) {
assertResolutionReportEntriesNotNull(entries);
assertEquals("Wrong number of total resolution report entries", expected, entries.size());
}
private void assertResolutionReportEntriesNotNull(List<ResolutionReport.Entry> entries) {
assertNotNull("Resolution report entries for resource was null", entries);
}
private void assertResolutionReportEntriesSize(List<ResolutionReport.Entry> entries, int expected) {
assertResolutionReportEntriesNotNull(entries);
assertEquals("Wrong number of resolution report entries", expected, entries.size());
}
private void assertResolutionReportEntryDataNotNull(Object data) {
assertNotNull("No resolution report entry data", data);
}
private void assertResolutionReportEntryDataNull(Object data) {
assertEquals("Unexpected resolution report entry data", null, data);
}
private void assertResolutionReportEntryTypeFilteredByResolverHook(ResolutionReport.Entry.Type type) {
assertResolutionReportEntryType(ResolutionReport.Entry.Type.FILTERED_BY_RESOLVER_HOOK, type);
}
private void assertResolutionReportEntryTypeSingletonSelection(ResolutionReport.Entry.Type type) {
assertResolutionReportEntryType(ResolutionReport.Entry.Type.SINGLETON_SELECTION, type);
}
private void assertResolutionReportEntryTypeUnresolvedProvider(ResolutionReport.Entry.Type type) {
assertResolutionReportEntryType(ResolutionReport.Entry.Type.UNRESOLVED_PROVIDER, type);
}
private void assertResolutionReportEntryDataMissingCapability(Object data, String namespace, String namespaceValue) {
assertResolutionReportEntryDataNotNull(data);
assertTrue("Wrong resolution report entry data type", data instanceof Requirement);
Requirement requirement = (Requirement) data;
assertEquals("Wrong requirement namespace", namespace, requirement.getNamespace());
if (namespaceValue == null)
return;
assertTrue("Wrong requirement namespace value", requirement.getDirectives().get(Namespace.REQUIREMENT_FILTER_DIRECTIVE).contains(namespace + "=" + namespaceValue));
}
@SuppressWarnings("unchecked")
private void assertResolutionReportEntryDataUnresolvedProvider(Object data, Map<Requirement, List<Capability>> expected) {
assertResolutionReportEntryDataNotNull(data);
assertTrue("Wrong resolution report entry data type", data instanceof Map);
Map<Requirement, Set<Capability>> unresolvedProviders = (Map<Requirement, Set<Capability>>) data;
assertEquals("Wrong number of unresolved providers", expected.size(), unresolvedProviders.size());
for (Map.Entry<Requirement, List<Capability>> entry : expected.entrySet()) {
Set<Capability> actualCapabilities = unresolvedProviders.get(entry.getKey());
assertEquals("Wrong number of capabilities", entry.getValue().size(), actualCapabilities.size());
for (Capability c : entry.getValue()) {
assertTrue("Capability not found", actualCapabilities.contains(c));
}
}
}
private void assertResolutionReportEntryTypeMissingCapability(ResolutionReport.Entry.Type type) {
assertResolutionReportEntryType(ResolutionReport.Entry.Type.MISSING_CAPABILITY, type);
}
private void assertResolutionReportEntryType(ResolutionReport.Entry.Type expected, ResolutionReport.Entry.Type actual) {
assertEquals("Wrong resolution report entry type", expected, actual);
}
}
|
