Support more fragment options in DependencyManager / unify LaunchHelper

Currently one can only choose to include all fragments or only non-test
fragments. But we can already distinguish several other types of
fragments, e.g. those that belong to extensible API or provide native
code specialization.

This now enhances DependencyManager to support a new type
(INCLUDE_PLATFORM_FRAGMENTS) and to make configurable the inclusion of
extensible API (INCLUDE_EXTENSIBLE_FRAGMENTS). Also the
BundleLauncherHelper was adjusted to be more uniform when handling
plugin versus feature based launches reading and preparing for further
customization through launch configs.

Author: laeubi

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

@@ -68,7 +68,19 @@ public enum Options {
 		 * Specifies to include all non-test fragments into the closure (must
 		 * not be combined with {@link #INCLUDE_ALL_FRAGMENTS}).
 		 */
-		INCLUDE_NON_TEST_FRAGMENTS;
+		INCLUDE_NON_TEST_FRAGMENTS,
+		/**
+		 * Option that can be set to include native fragments, that are ones
+		 * that define an {@link ICoreConstants#PLATFORM_FILTER} in their
+		 * manifest.
+		 */
+		INCLUDE_PLATFORM_FRAGMENTS,
+		/**
+		 * Option that can be set to include native fragments, that are ones
+		 * that define an {@link ICoreConstants#PLATFORM_FILTER} in their
+		 * manifest.
+		 */
+		INCLUDE_EXTENSIBLE_FRAGMENTS;
 	}
 
 	/**
@@ -168,6 +180,8 @@ public static Set<BundleDescription> findRequirementsClosure(Collection<BundleDe
 		boolean includeOptional = optionSet.contains(Options.INCLUDE_OPTIONAL_DEPENDENCIES);
 		boolean includeAllFragments = optionSet.contains(Options.INCLUDE_ALL_FRAGMENTS);
 		boolean includeNonTestFragments = optionSet.contains(Options.INCLUDE_NON_TEST_FRAGMENTS);
+		boolean includeNativeFragments = optionSet.contains(Options.INCLUDE_PLATFORM_FRAGMENTS);
+		boolean includeExtensibleFragments = optionSet.contains(Options.INCLUDE_EXTENSIBLE_FRAGMENTS);
 		if (includeAllFragments && includeNonTestFragments) {
 			throw new AssertionError("Cannot combine INCLUDE_ALL_FRAGMENTS and INCLUDE_NON_TEST_FRAGMENTS"); //$NON-NLS-1$
 		}
@@ -188,14 +202,22 @@ public static Set<BundleDescription> findRequirementsClosure(Collection<BundleDe
 			if (wiring == null || !wiring.isInUse()) {
 				continue;
 			}
-			if (includeAllFragments || includeNonTestFragments || isExtensibleApi(bundle)) {
+			if (includeAllFragments || includeNonTestFragments
+					|| (includeExtensibleFragments && isExtensibleApi(bundle))) {
 				// A fragment's host is already required by a wire
 				for (BundleDescription fragment : bundle.getFragments()) {
 					if (includeAllFragments || !isTestWorkspaceProject(fragment)) {
 						addNewRequiredBundle(fragment, closure, pending);
 					}
 				}
 			}
+			if (includeNativeFragments) {
+				for (BundleDescription fragment : bundle.getFragments()) {
+					if (isNativeFragment(fragment) && !isTestWorkspaceProject(fragment)) {
+						addNewRequiredBundle(fragment, closure, pending);
+					}
+				}
+			}
 
 			if (isFragment(wiring.getRevision())) {
 				// Requirements of a fragment are hosted at the host, which
@@ -231,6 +253,14 @@ public static Set<BundleDescription> findRequirementsClosure(Collection<BundleDe
 		return closure;
 	}
 
+	private static boolean isNativeFragment(BundleDescription fragment) {
+		Object userObject = fragment.getUserObject();
+		if (userObject instanceof IPluginModelBase model) {
+			return ClasspathUtilCore.getPlatformFilter(model) != null;
+		}
+		return false;
+	}
+
 	private static boolean isExtensibleApi(BundleDescription bundleDescription) {
 		if (bundleDescription.getFragments().length == 0) {
 			return false;

ui/org.eclipse.pde.launching/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %name
 Bundle-SymbolicName: org.eclipse.pde.launching;singleton:=true
-Bundle-Version: 3.13.500.qualifier
+Bundle-Version: 3.13.600.qualifier
 Bundle-RequiredExecutionEnvironment: JavaSE-17
 Bundle-Vendor: %provider-name
 Require-Bundle: org.eclipse.jdt.junit.core;bundle-version="[3.6.0,4.0.0)",

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

@@ -168,11 +168,21 @@ private static void addRequiredBundles(Map<IPluginModelBase, String> bundle2star
 		List<String> appRequirements = RequirementHelper.getApplicationLaunchRequirements(configuration);
 		RequirementHelper.addApplicationLaunchRequirements(appRequirements, configuration, bundle2startLevel);
 
-		boolean includeOptional = configuration.getAttribute(IPDELauncherConstants.INCLUDE_OPTIONAL, true);
-		computeDependencies(bundle2startLevel.keySet(), includeOptional, true) //
+		Set<DependencyManager.Options> options = configurationToOptions(configuration, true);
+		computeDependencies(bundle2startLevel.keySet(), options, true) //
 				.forEach(p -> addDefaultStartingBundle(bundle2startLevel, p));
 	}
 
+	protected static Set<DependencyManager.Options> configurationToOptions(ILaunchConfiguration configuration, boolean optionalDefault) throws CoreException {
+		boolean includeOptional = configuration.getAttribute(IPDELauncherConstants.INCLUDE_OPTIONAL, optionalDefault);
+		Set<DependencyManager.Options> options = new HashSet<>();
+		options.add(DependencyManager.Options.INCLUDE_EXTENSIBLE_FRAGMENTS);
+		if (includeOptional) {
+			options.add(DependencyManager.Options.INCLUDE_OPTIONAL_DEPENDENCIES);
+		}
+		return options;
+	}
+
 	// --- feature based launches ---
 
 	private static Map<IPluginModelBase, String> getMergedBundleMapFeatureBased(ILaunchConfiguration configuration, Map<IFeature, Boolean> features) throws CoreException {
@@ -221,12 +231,13 @@ private static Map<IPluginModelBase, String> getMergedBundleMapFeatureBased(ILau
 		launchPlugins.addAll(additionalPlugins.keySet());
 
 		if (addRequirements) {
+			Set<DependencyManager.Options> options = configurationToOptions(configuration, false);
 			// Add all missing plug-ins required by the application/product set in the config
 			List<String> appRequirements = RequirementHelper.getApplicationLaunchRequirements(configuration);
 			RequirementHelper.addApplicationLaunchRequirements(appRequirements, configuration, launchPlugins, launchPlugins::add);
 
 			// Get all required plugins
-			computeDependencies(launchPlugins, false, isWorkspace(defaultPluginResolution)).forEach(launchPlugins::add);
+			computeDependencies(launchPlugins, options, isWorkspace(defaultPluginResolution)).forEach(launchPlugins::add);
 		}
 
 		// Create the start levels for the selected plugins and add them to the map
@@ -542,7 +553,7 @@ private static void addBundleToMap(Map<IPluginModelBase, String> map, IPluginMod
 
 	// --- dependency resolution ---
 
-	private static Stream<IPluginModelBase> computeDependencies(Set<IPluginModelBase> includedPlugins, boolean includeOptional, boolean preferWorkspaceBundles) {
+	private static Stream<IPluginModelBase> computeDependencies(Set<IPluginModelBase> includedPlugins, Set<DependencyManager.Options> options, boolean preferWorkspaceBundles) {
 		if (includedPlugins.isEmpty()) {
 			return Stream.empty();
 		}
@@ -556,11 +567,7 @@ private static Stream<IPluginModelBase> computeDependencies(Set<IPluginModelBase
 			Version version = versionStr != null ? Version.parseVersion(versionStr) : null;
 			return launchState.getBundle(descriptor.getId(), version);
 		}).forEach(launchBundles::add);
-
-		DependencyManager.Options[] options = includeOptional //
-				? new DependencyManager.Options[] {DependencyManager.Options.INCLUDE_OPTIONAL_DEPENDENCIES}
-				: new DependencyManager.Options[] {};
-		Set<BundleDescription> closure = DependencyManager.findRequirementsClosure(launchBundles, options);
+		Set<BundleDescription> closure = DependencyManager.findRequirementsClosure(launchBundles, options.toArray(DependencyManager.Options[]::new));
 		return closure.stream().map(launchBundlePlugins::get).map(Objects::requireNonNull) //
 				.filter(p -> !includedPlugins.contains(p));
 	}

ui/org.eclipse.pde.ui.tests/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: PDE JUnit Tests
 Bundle-SymbolicName: org.eclipse.pde.ui.tests; singleton:=true
-Bundle-Version: 3.13.200.qualifier
+Bundle-Version: 3.13.300.qualifier
 Bundle-ClassPath: tests.jar
 Bundle-Vendor: Eclipse.org
 Require-Bundle: org.eclipse.pde.ui,

ui/org.eclipse.pde.ui.tests/pom.xml

@@ -18,7 +18,7 @@
     <relativePath>../../</relativePath>
   </parent>
   <artifactId>org.eclipse.pde.ui.tests</artifactId>
-  <version>3.13.200-SNAPSHOT</version>
+  <version>3.13.300-SNAPSHOT</version>
   <packaging>eclipse-test-plugin</packaging>
 
   <properties>

ui/org.eclipse.pde.ui.tests/src/org/eclipse/pde/ui/tests/launcher/FeatureBasedLaunchTest.java

@@ -1351,7 +1351,8 @@ public void testGetMergedBundleMap_automaticallyAddRequirements() throws Throwab
 				}));
 
 		// Gather requirements of the product used below
-		Map<BundleLocationDescriptor, String> requiredRPBundles = getEclipseAppRequirementClosureForRunningPlatform();
+		Map<BundleLocationDescriptor, String> requiredRPBundles = getEclipseAppRequirementClosureForRunningPlatform(
+				DependencyManager.Options.INCLUDE_EXTENSIBLE_FRAGMENTS);
 
 		TargetPlatformUtil.setRunningPlatformWithDummyBundlesAsTarget(null, targetBundles, targetFeatures,
 				tpJarDirectory);

ui/org.eclipse.pde.ui.tests/src/org/eclipse/pde/ui/tests/launcher/PluginBasedLaunchTest.java

@@ -821,11 +821,13 @@ public void testGetMergedBundleMap_automaticallyAddRequirements() throws Excepti
 				bundle("plugin.c", "1.0.0"));
 
 		Map<BundleLocationDescriptor, String> requiredRPBundlesWithoutOptional = FeatureBasedLaunchTest
-				.getEclipseAppRequirementClosureForRunningPlatform();
+				.getEclipseAppRequirementClosureForRunningPlatform(
+						DependencyManager.Options.INCLUDE_EXTENSIBLE_FRAGMENTS);
 
 		Map<BundleLocationDescriptor, String> requiredRPBundlesWithOptional = FeatureBasedLaunchTest
 				.getEclipseAppRequirementClosureForRunningPlatform(
-						DependencyManager.Options.INCLUDE_OPTIONAL_DEPENDENCIES);
+						DependencyManager.Options.INCLUDE_OPTIONAL_DEPENDENCIES,
+						DependencyManager.Options.INCLUDE_EXTENSIBLE_FRAGMENTS);
 
 		TargetPlatformUtil.setRunningPlatformWithDummyBundlesAsTarget(null, targetPlatformBundles, List.of(),
 				tpJarDirectory);