Support JUnit 5 and JUnit 6 for org.eclipse.pde.core.requiredPlugins

When a plug-in requires the JUnit bundle junit-jupiter-api,
if the target platform contains both JUnit 5 and JUnit 6,
RequiredPluginsClasspathContainer will put JUnit 6 on the JDT classpath.

This is problematic, since a plug-in cannot then specify JUnit 5,
even when constraining the version of junit-jupiter-api.

This change checks what version of junit-jupiter-api is required,
then adds only that version of JUnit bundles to the container.

Fixes: #2007

Author: trancexpress

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

@@ -14,19 +14,17 @@
  *******************************************************************************/
 package org.eclipse.pde.internal.core;
 
-import static org.eclipse.pde.internal.core.DependencyManager.Options.INCLUDE_OPTIONAL_DEPENDENCIES;
-
 import java.io.File;
 import java.util.ArrayDeque;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
-import java.util.Objects;
 import java.util.Optional;
 import java.util.Queue;
 import java.util.Set;
@@ -65,6 +63,7 @@
 import org.eclipse.pde.internal.core.bnd.BndProjectManager;
 import org.eclipse.pde.internal.core.ibundle.IBundlePluginModelBase;
 import org.eclipse.pde.internal.core.natures.BndProject;
+import org.osgi.framework.Version;
 import org.osgi.resource.Resource;
 
 import aQute.bnd.build.Container;
@@ -75,18 +74,13 @@
 class RequiredPluginsClasspathContainer {
 
 	@SuppressWarnings("nls")
-	private static final Set<String> JUNIT5_RUNTIME_PLUGINS = Set.of("org.junit", //
-			"junit-jupiter-engine", // BSN of the bundle from Maven-Central
-			"org.junit.jupiter.engine"); // BSN of the bundle from Eclipse-Orbit
-	@SuppressWarnings("nls")
 	private static final Set<String> JUNIT5_API_PLUGINS = Set.of( //
 			"junit-jupiter-api", // BSN of the bundle from Maven-Central
 			"org.junit.jupiter.api"); // BSN of the bundle from Eclipse-Orbit
 
 	private final IPluginModelBase fModel;
 	private final IBuild fBuild;
 
-	private List<BundleDescription> junit5RuntimeClosure;
 	private IClasspathEntry[] fEntries;
 	private boolean addImportedPackages;
 
@@ -575,20 +569,22 @@ protected void addExtraClasspathEntries(List<IClasspathEntry> entries, String[]
 	 */
 	private void addJunit5RuntimeDependencies(Set<BundleDescription> added, List<IClasspathEntry> entries)
 			throws CoreException {
-		if (!containsJunit5Dependency(added)) {
+		Optional<BundleDescription> highesJunitBundle = getHighestJunitBundle(added);
+		if (highesJunitBundle.isEmpty()) {
 			return;
 		}
-
-		if (junit5RuntimeClosure == null) {
-			junit5RuntimeClosure = collectJunit5RuntimeRequirements();
+		Set<BundleDescription> junitRequirements = DependencyManager
+				.findRequirementsClosure(Collections.singleton(highesJunitBundle.get()));
+		if (junitRequirements.isEmpty()) {
+			return;
 		}
 
 		String id = fModel.getPluginBase().getId();
-		if (id != null && junit5RuntimeClosure.stream().map(BundleDescription::getSymbolicName).anyMatch(id::equals)) {
+		if (id != null && junitRequirements.stream().map(BundleDescription::getSymbolicName).anyMatch(id::equals)) {
 			return; // never extend the classpath of a junit bundle
 		}
 
-		for (BundleDescription desc : junit5RuntimeClosure) {
+		for (BundleDescription desc : junitRequirements) {
 			if (added.contains(desc)) {
 				continue; // bundle has explicit dependency
 			}
@@ -599,21 +595,6 @@ private void addJunit5RuntimeDependencies(Set<BundleDescription> added, List<ICl
 		}
 	}
 
-	private boolean containsJunit5Dependency(Collection<BundleDescription> dependencies) {
-		return dependencies.stream().map(BundleDescription::getSymbolicName).anyMatch(JUNIT5_API_PLUGINS::contains);
-	}
-
-	private static List<BundleDescription> collectJunit5RuntimeRequirements() {
-		List<BundleDescription> roots = JUNIT5_RUNTIME_PLUGINS.stream().map(PluginRegistry::findModel)
-				.filter(Objects::nonNull).filter(IPluginModelBase::isEnabled)
-				.map(IPluginModelBase::getBundleDescription).toList();
-		Set<BundleDescription> closure = DependencyManager.findRequirementsClosure(roots,
-				INCLUDE_OPTIONAL_DEPENDENCIES);
-		String systemBundleBSN = TargetPlatformHelper.getPDEState().getSystemBundle();
-		return closure.stream().filter(b -> !b.getSymbolicName().equals(systemBundleBSN))
-				.sorted(Comparator.comparing(BundleDescription::getSymbolicName)).toList();
-	}
-
 	private void addSecondaryDependencies(BundleDescription desc, Set<BundleDescription> added,
 			List<IClasspathEntry> entries) {
 		try {
@@ -716,4 +697,18 @@ private void addExtraLibrary(IPath path, IPluginModelBase model, List<IClasspath
 		}
 	}
 
+	private static Optional<BundleDescription> getHighestJunitBundle(Collection<BundleDescription> bundleDescriptions) {
+		return bundleDescriptions.stream().filter(RequiredPluginsClasspathContainer::isJunit5ApiBundle)
+				.max(RequiredPluginsClasspathContainer::bundleVersionsCompare);
+	}
+
+	private static int bundleVersionsCompare(BundleDescription bd1, BundleDescription bd2) {
+		Version v1 = bd1.getVersion();
+		Version v2 = bd2.getVersion();
+		return v1.compareTo(v2);
+	}
+
+	private static boolean isJunit5ApiBundle(BundleDescription bundleDescription) {
+		return JUNIT5_API_PLUGINS.contains(bundleDescription.getSymbolicName());
+	}
 }