Skip to content

Commit 4be4962

Browse files
committed
Validate that a JUnit 5 launch has no dependencies to JUnit 6 bundles
Fixes: #2045
1 parent 4fe820b commit 4be4962

File tree

6 files changed

+120
-2
lines changed

6 files changed

+120
-2
lines changed

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/BundleValidationOperation.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,15 @@
3131
import org.eclipse.osgi.util.NLS;
3232
import org.eclipse.pde.core.plugin.IPluginModelBase;
3333
import org.eclipse.pde.internal.build.BundleHelper;
34+
import org.osgi.framework.hooks.resolver.ResolverHook;
3435

3536
public class BundleValidationOperation implements IWorkspaceRunnable {
3637

3738
private static StateObjectFactory FACTORY;
3839

3940
private final Set<IPluginModelBase> fModels;
4041
private final Dictionary<String, String>[] fProperties;
42+
private ResolverHook fResolverHook;
4143
private State fState;
4244

4345
@SuppressWarnings("unchecked")
@@ -50,13 +52,20 @@ public BundleValidationOperation(Set<IPluginModelBase> models, Dictionary<String
5052
fProperties = properties;
5153
}
5254

55+
public void setResolverHook(ResolverHook resolverHook) {
56+
fResolverHook = resolverHook;
57+
}
58+
5359
@Override
5460
public void run(IProgressMonitor monitor) throws CoreException {
5561
if (FACTORY == null) {
5662
FACTORY = BundleHelper.getPlatformAdmin().getFactory();
5763
}
5864
SubMonitor subMonitor = SubMonitor.convert(monitor, fModels.size() + 1);
5965
fState = FACTORY.createState(true);
66+
if (fResolverHook != null) {
67+
fState.setResolverHookFactory(c -> fResolverHook);
68+
}
6069
long id = 1;
6170
for (IPluginModelBase fModel : fModels) {
6271
BundleDescription bundle = fModel.getBundleDescription();

ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/PDEMessages.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ public class PDEMessages extends NLS {
3636
public static String WorkbenchLauncherConfigurationDelegate_noStartup;
3737
public static String JUnitLaunchConfiguration_error_notaplugin;
3838
public static String JUnitLaunchConfiguration_error_missingPlugin;
39+
public static String JUnitLaunchConfiguration_error_invalidJunitVersion;
3940

4041
public static String OSGiLaunchConfiguration_cannotFindLaunchConfiguration;
4142
public static String OSGiLaunchConfiguration_selected;

ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchValidationOperation.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,15 @@
3838
import org.eclipse.pde.core.plugin.PluginRegistry;
3939
import org.eclipse.pde.internal.core.BundleValidationOperation;
4040
import org.eclipse.pde.internal.core.TargetPlatformHelper;
41+
import org.osgi.framework.hooks.resolver.ResolverHook;
4142

4243
public class LaunchValidationOperation implements IWorkspaceRunnable {
4344

4445
private BundleValidationOperation fOperation;
4546
public final ILaunchConfiguration fLaunchConfiguration;
4647
public final String fLaunchMode;
4748
protected final Set<IPluginModelBase> fModels;
49+
private ResolverHook fResolverHook;
4850

4951
public LaunchValidationOperation(ILaunchConfiguration configuration, Set<IPluginModelBase> models) {
5052
this(configuration, models, null);
@@ -56,9 +58,16 @@ public LaunchValidationOperation(ILaunchConfiguration configuration, Set<IPlugin
5658
fLaunchMode = launchMode;
5759
}
5860

61+
public void setResolverHook(ResolverHook resolverHook) {
62+
fResolverHook = resolverHook;
63+
}
64+
5965
@Override
6066
public void run(IProgressMonitor monitor) throws CoreException {
6167
fOperation = new BundleValidationOperation(fModels, getPlatformProperties());
68+
if (fResolverHook != null) {
69+
fOperation.setResolverHook(fResolverHook);
70+
}
6271
fOperation.run(monitor);
6372
}
6473

ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/pderesources.properties

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ WorkbenchLauncherConfigurationDelegate_jrePathNotFound = The installation path t
2525
WorkbenchLauncherConfigurationDelegate_noStartup = Launching failed. Bootstrap code cannot be found.
2626
JUnitLaunchConfiguration_error_notaplugin = Could not launch the JUnit plug-in tests because project ''{0}'' is not a plug-in project.
2727
JUnitLaunchConfiguration_error_missingPlugin = Required plug-in ''{0}'' could not be found.
28+
JUnitLaunchConfiguration_error_invalidJunitVersion = JUnit {0} launch may not function with dependency to {1} with version {2}.
2829

2930
OSGiLaunchConfiguration_cannotFindLaunchConfiguration=Cannot find the {0} OSGi framework.
3031
OSGiLaunchConfiguration_selected=selected
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
package org.eclipse.pde.launching;
2+
3+
import java.util.Arrays;
4+
import java.util.Collection;
5+
import java.util.HashMap;
6+
import java.util.Iterator;
7+
import java.util.Map;
8+
import java.util.Set;
9+
10+
import org.eclipse.core.runtime.IStatus;
11+
import org.eclipse.core.runtime.Status;
12+
import org.eclipse.debug.core.ILaunchConfiguration;
13+
import org.eclipse.osgi.service.resolver.BundleDescription;
14+
import org.eclipse.osgi.util.NLS;
15+
import org.eclipse.pde.core.plugin.IPluginModelBase;
16+
import org.eclipse.pde.internal.launching.PDEMessages;
17+
import org.eclipse.pde.internal.launching.launcher.EclipsePluginValidationOperation;
18+
import org.osgi.framework.Constants;
19+
import org.osgi.framework.Version;
20+
import org.osgi.framework.hooks.resolver.ResolverHook;
21+
import org.osgi.framework.wiring.BundleCapability;
22+
import org.osgi.framework.wiring.BundleRequirement;
23+
import org.osgi.framework.wiring.BundleRevision;
24+
25+
final class JUnitEclipsePluginValidationOperation extends EclipsePluginValidationOperation implements ResolverHook {
26+
27+
private static final String JUNIT_BUNDLE_PREFIX = "junit"; //$NON-NLS-1$
28+
private final Map<BundleDescription, IStatus[]> errors;
29+
private final int junitVersion;
30+
31+
@SuppressWarnings("restriction")
32+
public JUnitEclipsePluginValidationOperation(ILaunchConfiguration configuration, Set<IPluginModelBase> models) {
33+
super(configuration, models);
34+
errors = new HashMap<>(2);
35+
org.eclipse.jdt.internal.junit.launcher.ITestKind testKind = org.eclipse.jdt.internal.junit.launcher.JUnitLaunchConfigurationConstants.getTestRunnerKind(configuration);
36+
if (org.eclipse.jdt.internal.junit.launcher.TestKindRegistry.JUNIT5_TEST_KIND_ID.equals(testKind.getId())) {
37+
junitVersion = 5;
38+
} else {
39+
junitVersion = -1;
40+
}
41+
if (junitVersion == 5) {
42+
setResolverHook(this);
43+
}
44+
}
45+
46+
@Override
47+
public void filterMatches(BundleRequirement requirement, Collection<BundleCapability> candidates) {
48+
if (!Constants.RESOLUTION_OPTIONAL.equals(requirement.getDirectives().get(Constants.RESOLUTION_DIRECTIVE))) {
49+
String requirementName = requirement.getRevision().getSymbolicName();
50+
if (!requirementName.startsWith(JUNIT_BUNDLE_PREFIX)) {
51+
Iterator<BundleCapability> iterator = candidates.iterator();
52+
while (iterator.hasNext()) {
53+
BundleCapability candidate = iterator.next();
54+
BundleRevision candidateRevision = candidate.getRevision();
55+
String name = candidateRevision.getSymbolicName();
56+
Version version = candidateRevision.getVersion();
57+
if (version.getMajor() > junitVersion && name.startsWith(JUNIT_BUNDLE_PREFIX)) {
58+
BundleDescription bundle = getState().getBundle(requirementName, requirement.getRevision().getVersion());
59+
if (bundle != null) {
60+
String error = NLS.bind(PDEMessages.JUnitLaunchConfiguration_error_invalidJunitVersion, new Object[] {Integer.valueOf(junitVersion), name, version});
61+
IStatus[] bundleErrors = errors.computeIfAbsent(bundle, b -> new Status[0]);
62+
if (!Arrays.stream(bundleErrors).map(IStatus::getMessage).anyMatch(m -> error.equals(m))) {
63+
IStatus[] newBundleErrors = Arrays.copyOf(bundleErrors, bundleErrors.length + 1);
64+
newBundleErrors[bundleErrors.length] = Status.error(error);
65+
errors.put(bundle, newBundleErrors);
66+
}
67+
68+
}
69+
}
70+
}
71+
}
72+
}
73+
}
74+
75+
@Override
76+
public void filterResolvable(Collection<BundleRevision> candidates) {
77+
}
78+
79+
@Override
80+
public void filterSingletonCollisions(BundleCapability singleton, Collection<BundleCapability> collisionCandidates) {
81+
}
82+
83+
@Override
84+
public void end() {
85+
}
86+
87+
@Override
88+
public boolean hasErrors() {
89+
return super.hasErrors() || !errors.isEmpty();
90+
}
91+
92+
@Override
93+
public Map<Object, Object[]> getInput() {
94+
Map<Object, Object[]> map = super.getInput();
95+
map.putAll(errors);
96+
return map;
97+
}
98+
99+
}

ui/org.eclipse.pde.launching/src/org/eclipse/pde/launching/JUnitLaunchConfigurationDelegate.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@
7474
import org.eclipse.pde.internal.launching.PDELaunchingPlugin;
7575
import org.eclipse.pde.internal.launching.PDEMessages;
7676
import org.eclipse.pde.internal.launching.launcher.BundleLauncherHelper;
77-
import org.eclipse.pde.internal.launching.launcher.EclipsePluginValidationOperation;
7877
import org.eclipse.pde.internal.launching.launcher.LaunchArgumentsHelper;
7978
import org.eclipse.pde.internal.launching.launcher.LaunchConfigurationHelper;
8079
import org.eclipse.pde.internal.launching.launcher.LaunchPluginValidator;
@@ -610,7 +609,7 @@ protected void validateProjectDependencies(ILaunchConfiguration configuration, I
610609
* a progress monitor
611610
*/
612611
protected void validatePluginDependencies(ILaunchConfiguration configuration, IProgressMonitor monitor) throws CoreException {
613-
EclipsePluginValidationOperation op = new EclipsePluginValidationOperation(configuration, fModels.keySet(), launchMode);
612+
JUnitEclipsePluginValidationOperation op = new JUnitEclipsePluginValidationOperation(configuration, fModels.keySet());
614613
LaunchPluginValidator.runValidationOperation(op, monitor);
615614
}
616615
}

0 commit comments

Comments
 (0)