Move the search from the dialog to the DetectVMInstallationsJob

and use that search method in the test to discover and dispose required
jvms

Author: laeubi

org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/core/MultiReleaseLaunchTests.java

@@ -13,51 +13,87 @@
  *******************************************************************************/
 package org.eclipse.jdt.debug.tests.core;
 
+import java.io.File;
 import java.io.StringReader;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Properties;
+import java.util.Set;
+import java.util.UUID;
 
+import org.eclipse.core.runtime.NullProgressMonitor;
 import org.eclipse.debug.core.DebugPlugin;
 import org.eclipse.debug.core.ILaunchConfiguration;
 import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
 import org.eclipse.debug.ui.DebugUITools;
 import org.eclipse.jdt.core.IJavaProject;
 import org.eclipse.jdt.debug.core.IJavaDebugTarget;
 import org.eclipse.jdt.debug.tests.ui.AbstractDebugUiTests;
+import org.eclipse.jdt.internal.launching.DetectVMInstallationsJob;
 import org.eclipse.jdt.launching.IVMInstall;
 import org.eclipse.jdt.launching.IVMInstall2;
 import org.eclipse.jdt.launching.IVMInstallType;
 import org.eclipse.jdt.launching.JavaRuntime;
+import org.eclipse.jdt.launching.VMStandin;
 import org.eclipse.jface.text.IDocument;
 import org.eclipse.ui.console.IConsole;
 import org.eclipse.ui.console.TextConsole;
 
 /**
  * <b>IMPORTANT</b> This test requires some different JVM installs to be present (see {@link #JAVA_11}, {@link #JAVA_17}, {@link #JAVA_21})) if such
- * JVMs can not be found, the test will fail!
+ * JVMs can not be found, the test will fail! One can specify a basedir to search for such jvms with the {@link #JVM_SEARCH_BASE} system property.
  */
 public class MultiReleaseLaunchTests extends AbstractDebugUiTests {
 
+	private static final String JVM_SEARCH_BASE = "MultiReleaseLaunchTests.rootDir";
 	private static final RequiredJavaVersion JAVA_11 = new RequiredJavaVersion(11, 16);
 	private static final RequiredJavaVersion JAVA_17 = new RequiredJavaVersion(17, 20);
 	private static final RequiredJavaVersion JAVA_21 = new RequiredJavaVersion(21, Integer.MAX_VALUE);
 
+	private List<Runnable> disposeVms = new ArrayList<>();
+
 	public MultiReleaseLaunchTests(String name) {
 		super(name);
 	}
 
 	@Override
 	protected void setUp() throws Exception {
 		super.setUp();
+		final Set<File> existingLocations = new HashSet<>();
 		List<RequiredJavaVersion> requiredJavaVersions = new ArrayList<>(List.of(JAVA_11, JAVA_17, JAVA_21));
-		removeExistingJavaVersions(requiredJavaVersions);
+		removeExistingJavaVersions(requiredJavaVersions, existingLocations);
+		if (!requiredJavaVersions.isEmpty()) {
+			final File rootDir = new File(System.getProperty(JVM_SEARCH_BASE, "/opt/tools/java/openjdk/"));
+			final List<File> locations = new ArrayList<>();
+			final List<IVMInstallType> types = new ArrayList<>();
+			DetectVMInstallationsJob.search(rootDir, locations, types, existingLocations, new NullProgressMonitor());
+			for (int i = 0; i < locations.size(); i++) {
+				File location = locations.get(i);
+				IVMInstallType type = types.get(i);
+				String id = "MultiReleaseLaunchTests-" + UUID.randomUUID() + "-" + i;
+				VMStandin workingCopy = new VMStandin(type, id);
+				workingCopy.setInstallLocation(location);
+				IVMInstall install = workingCopy.convertToRealVM();
+				if (removeIfMatch(requiredJavaVersions, install)) {
+					disposeVms.add(() -> type.disposeVMInstall(id));
+				} else {
+					type.disposeVMInstall(id);
+				}
+			}
+		}
 		assertTrue("The following java versions are required by this test but can not be found: "
 				+ requiredJavaVersions, requiredJavaVersions.isEmpty());
 	}
 
+	@Override
+	protected void tearDown() throws Exception {
+		super.tearDown();
+		disposeVms.forEach(Runnable::run);
+	}
+
 	@Override
 	protected IJavaProject getProjectContext() {
 		return getMultireleaseProject();
@@ -110,23 +146,29 @@ private static int getJavaVersion(IVMInstall install) {
 		return -1;
 	}
 
-	private static void removeExistingJavaVersions(Collection<RequiredJavaVersion> requiredJavaVersions) {
+	private static void removeExistingJavaVersions(Collection<RequiredJavaVersion> requiredJavaVersions, Set<File> existingLocations) {
 		IVMInstallType[] installTypes = JavaRuntime.getVMInstallTypes();
 		for (IVMInstallType installType : installTypes) {
 			IVMInstall[] vmInstalls = installType.getVMInstalls();
 			for (IVMInstall install : vmInstalls) {
 				if (requiredJavaVersions.isEmpty()) {
 					return;
 				}
-				int javaVersion = getJavaVersion(install);
-				for (Iterator<RequiredJavaVersion> iterator = requiredJavaVersions.iterator(); iterator.hasNext();) {
-					if (iterator.next().matches(javaVersion)) {
-						iterator.remove();
-						break;
-					}
-				}
+				existingLocations.add(install.getInstallLocation());
+				removeIfMatch(requiredJavaVersions, install);
+			}
+		}
+	}
+
+	protected static boolean removeIfMatch(Collection<RequiredJavaVersion> requiredJavaVersions, IVMInstall install) {
+		int javaVersion = getJavaVersion(install);
+		for (Iterator<RequiredJavaVersion> iterator = requiredJavaVersions.iterator(); iterator.hasNext();) {
+			if (iterator.next().matches(javaVersion)) {
+				iterator.remove();
+				return true;
 			}
 		}
+		return false;
 	}
 
 	private static record RequiredJavaVersion(int from, int to) {

org.eclipse.jdt.debug.ui/ui/org/eclipse/jdt/internal/debug/ui/jres/InstalledJREsBlock.java

@@ -23,7 +23,6 @@
 
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IProgressMonitor;
-import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.ListenerList;
 import org.eclipse.core.runtime.Platform;
 import org.eclipse.core.runtime.SubMonitor;
@@ -910,7 +909,7 @@ protected void search() {
 			@Override
 			public void run(IProgressMonitor monitor) {
 				monitor.beginTask(JREMessages.InstalledJREsBlock_11, IProgressMonitor.UNKNOWN);
-				search(rootDir, locations, types, exstingLocations, monitor);
+				DetectVMInstallationsJob.search(rootDir, locations, types, exstingLocations, monitor);
 				monitor.done();
 			}
 		};
@@ -1031,75 +1030,6 @@ private String createUniqueId(IVMInstallType vmType) {
 		return id;
 	}
 
-	/**
-	 * Searches the specified directory recursively for installed VMs, adding each
-	 * detected VM to the <code>found</code> list. Any directories specified in
-	 * the <code>ignore</code> are not traversed.
-	 */
-	protected void search(File directory, List<File> found, List<IVMInstallType> types, Set<File> ignore, IProgressMonitor monitor) {
-		if (monitor.isCanceled()) {
-			return;
-		}
-
-		String[] fileNames = directory.list();
-		if (fileNames == null) {
-			return; // not a directory
-		}
-		List<String> names = new ArrayList<>();
-		names.add(null); // self
-		names.addAll(List.of(fileNames));
-		List<File> subDirs = new ArrayList<>();
-		for (String name : names) {
-			if (monitor.isCanceled()) {
-				return;
-			}
-			File file = name == null ? directory : new File(directory, name);
-			monitor.subTask(NLS.bind(JREMessages.InstalledJREsBlock_14, Integer.toString(found.size()),
-					file.toPath().normalize().toAbsolutePath().toString().replace("&", "&&") )); // @see bug 29855 //$NON-NLS-1$ //$NON-NLS-2$
-			IVMInstallType[] vmTypes = JavaRuntime.getVMInstallTypes();
-			if (file.isDirectory()) {
-				if (ignore.add(file)) {
-					boolean validLocation = false;
-
-					// Take the first VM install type that claims the location as a
-					// valid VM install.  VM install types should be smart enough to not
-					// claim another type's VM, but just in case...
-					for (int j = 0; j < vmTypes.length; j++) {
-						if (monitor.isCanceled()) {
-							return;
-						}
-						IVMInstallType type = vmTypes[j];
-						IStatus status = type.validateInstallLocation(file);
-						if (status.isOK()) {
-							String filePath = file.getPath();
-							int index = filePath.lastIndexOf(File.separatorChar);
-							File newFile = file;
-							// remove bin folder from install location as java executables are found only under bin for Java 9 and above
-							if (index > 0 && filePath.substring(index + 1).equals("bin")) { //$NON-NLS-1$
-								newFile = new File(filePath.substring(0, index));
-							}
-							found.add(newFile);
-							types.add(type);
-							validLocation = true;
-							break;
-						}
-					}
-					if (!validLocation) {
-						subDirs.add(file);
-					}
-				}
-			}
-		}
-		while (!subDirs.isEmpty()) {
-			File subDir = subDirs.remove(0);
-			search(subDir, found, types, ignore, monitor);
-			if (monitor.isCanceled()) {
-				return;
-			}
-		}
-
-	}
-
 	/**
 	 * Sets the checked JRE, possible <code>null</code>
 	 *

org.eclipse.jdt.debug.ui/ui/org/eclipse/jdt/internal/debug/ui/jres/JREMessages.java

@@ -45,7 +45,6 @@ public class JREMessages extends NLS {
 	public static String InstalledJREsBlock_11;
 	public static String InstalledJREsBlock_12;
 	public static String InstalledJREsBlock_13;
-	public static String InstalledJREsBlock_14;
 	public static String InstalledJREsBlock_15;
 	public static String InstalledJREsBlock_16;
 

org.eclipse.jdt.debug.ui/ui/org/eclipse/jdt/internal/debug/ui/jres/JREMessages.properties

@@ -36,7 +36,6 @@ InstalledJREsBlock_10=Directory Selection
 InstalledJREsBlock_11=Searching...
 InstalledJREsBlock_12=Information
 InstalledJREsBlock_13=No JREs found in {0}
-InstalledJREsBlock_14=Found {0} - Searching {1}
 InstalledJREsBlock_15=Installed &JREs:
 InstalledJREsBlock_16=Dupli&cate...
 InstalledJREsBlock_19={0} (contributed)

org.eclipse.jdt.launching/launching/org/eclipse/jdt/internal/launching/DetectVMInstallationsJob.java

@@ -38,6 +38,7 @@
 import org.eclipse.jdt.launching.IVMInstallType;
 import org.eclipse.jdt.launching.JavaRuntime;
 import org.eclipse.jdt.launching.VMStandin;
+import org.eclipse.osgi.util.NLS;
 
 /**
  * Lookup for VMs installed in standard or usual locations; and add the existing ones that
@@ -240,6 +241,75 @@ public boolean belongsTo(Object family) {
 		return family.equals(FAMILY);
 	}
 
+	/**
+	 * Searches the specified directory recursively for installed VMs, adding each
+	 * detected VM to the <code>found</code> list. Any directories specified in
+	 * the <code>ignore</code> are not traversed.
+	 */
+	public static void search(File directory, List<File> found, List<IVMInstallType> types, Set<File> ignore, IProgressMonitor monitor) {
+		if (monitor.isCanceled()) {
+			return;
+		}
+
+		String[] fileNames = directory.list();
+		if (fileNames == null) {
+			return; // not a directory
+		}
+		List<String> names = new ArrayList<>();
+		names.add(null); // self
+		names.addAll(List.of(fileNames));
+		List<File> subDirs = new ArrayList<>();
+		for (String name : names) {
+			if (monitor.isCanceled()) {
+				return;
+			}
+			File file = name == null ? directory : new File(directory, name);
+			monitor.subTask(NLS.bind(LaunchingMessages.SearchingJVMs, Integer.toString(found.size()),
+					file.toPath().normalize().toAbsolutePath().toString().replace("&", "&&") )); // @see bug 29855 //$NON-NLS-1$ //$NON-NLS-2$
+			IVMInstallType[] vmTypes = JavaRuntime.getVMInstallTypes();
+			if (file.isDirectory()) {
+				if (ignore.add(file)) {
+					boolean validLocation = false;
+
+					// Take the first VM install type that claims the location as a
+					// valid VM install.  VM install types should be smart enough to not
+					// claim another type's VM, but just in case...
+					for (int j = 0; j < vmTypes.length; j++) {
+						if (monitor.isCanceled()) {
+							return;
+						}
+						IVMInstallType type = vmTypes[j];
+						IStatus status = type.validateInstallLocation(file);
+						if (status.isOK()) {
+							String filePath = file.getPath();
+							int index = filePath.lastIndexOf(File.separatorChar);
+							File newFile = file;
+							// remove bin folder from install location as java executables are found only under bin for Java 9 and above
+							if (index > 0 && filePath.substring(index + 1).equals("bin")) { //$NON-NLS-1$
+								newFile = new File(filePath.substring(0, index));
+							}
+							found.add(newFile);
+							types.add(type);
+							validLocation = true;
+							break;
+						}
+					}
+					if (!validLocation) {
+						subDirs.add(file);
+					}
+				}
+			}
+		}
+		while (!subDirs.isEmpty()) {
+			File subDir = subDirs.remove(0);
+			search(subDir, found, types, ignore, monitor);
+			if (monitor.isCanceled()) {
+				return;
+			}
+		}
+
+	}
+
 	public static void initialize() {
 		if (Boolean.getBoolean(PROPERTY_DETECT_VM_INSTALLATIONS_JOB_DISABLED)) {
 			// early exit no need to read preferences or check env variable!

org.eclipse.jdt.launching/launching/org/eclipse/jdt/internal/launching/LaunchingMessages.java

@@ -18,6 +18,8 @@
 public class LaunchingMessages extends NLS {
 	private static final String BUNDLE_NAME = "org.eclipse.jdt.internal.launching.LaunchingMessages";//$NON-NLS-1$
 
+	public static String SearchingJVMs;
+
 	public static String AbstractJavaLaunchConfigurationDelegate_Java_project_not_specified_9;
 	public static String AbstractJavaLaunchConfigurationDelegate_JRE_home_directory_for__0__does_not_exist___1__6;
 	public static String AbstractJavaLaunchConfigurationDelegate_JRE_home_directory_not_specified_for__0__5;

org.eclipse.jdt.launching/launching/org/eclipse/jdt/internal/launching/LaunchingMessages.properties

@@ -206,4 +206,5 @@ VMLogging_1=Restoring vm library location:
 VMLogging_2=Creating Library with Java Install path:
 VMLogging_3=Default Install retrieved:
 lookupInstalledJVMs=Detect installed JVMs
-configuringJVM=Configuring installed JVM {0}
+configuringJVM=Configuring installed JVM {0}
+SearchingJVMs=Found {0} - Searching {1}