Log VM install changes during JDT debug tests, set default VM for execution environments

See: #782

Author: trancexpress

org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/AbstractDebugTest.java

@@ -128,15 +128,20 @@
 import org.eclipse.jdt.debug.tests.core.LiteralTests17;
 import org.eclipse.jdt.debug.tests.refactoring.MemberParser;
 import org.eclipse.jdt.debug.ui.IJavaDebugUIConstants;
+import org.eclipse.jdt.internal.compiler.impl.CompilerOptions;
+import org.eclipse.jdt.internal.debug.core.JDIDebugPlugin;
 import org.eclipse.jdt.internal.debug.core.model.JDIDebugTarget;
 import org.eclipse.jdt.internal.debug.eval.ast.engine.ASTEvaluationEngine;
 import org.eclipse.jdt.internal.debug.ui.BreakpointUtils;
 import org.eclipse.jdt.internal.debug.ui.IJDIPreferencesConstants;
 import org.eclipse.jdt.internal.debug.ui.JDIDebugUIPlugin;
 import org.eclipse.jdt.launching.IJavaLaunchConfigurationConstants;
 import org.eclipse.jdt.launching.IVMInstall;
+import org.eclipse.jdt.launching.IVMInstallChangedListener;
 import org.eclipse.jdt.launching.JavaRuntime;
+import org.eclipse.jdt.launching.PropertyChangeEvent;
 import org.eclipse.jdt.launching.environments.IExecutionEnvironment;
+import org.eclipse.jdt.launching.environments.IExecutionEnvironmentsManager;
 import org.eclipse.jface.dialogs.ErrorDialog;
 import org.eclipse.jface.dialogs.MessageDialogWithToggle;
 import org.eclipse.jface.preference.IPreferenceStore;
@@ -170,6 +175,10 @@
 @SuppressWarnings("deprecation")
 public abstract class AbstractDebugTest extends TestCase implements  IEvaluationListener {
 
+	private static final String JAVASE_PREFIX = "JavaSE-";
+
+	private static boolean setupFirstTest = false;
+
 	public static final String MULTI_OUTPUT_PROJECT_NAME = "MultiOutput";
 	public static final String BOUND_EE_PROJECT_NAME = "BoundEE";
 	public static final String ONE_FOUR_PROJECT_NAME = "DebugTests";
@@ -264,6 +273,12 @@ public AbstractDebugTest(String name) {
 
 	@Override
 	protected void setUp() throws Exception {
+		if (!setupFirstTest) {
+			setupFirstTest = true;
+			TestUtil.logInfo("SETTING UP TESTS");
+			JavaRuntime.addVMInstallChangedListener(new LogVMInstallChanges());
+			setExecutionEnvironmentDefaults();
+		}
 		TestUtil.logInfo("SETUP " + getClass().getSimpleName() + "." + getName());
 		super.setUp();
 		setPreferences();
@@ -3090,4 +3105,78 @@ private static String toString(Collection<IMarker> markers) {
 	public interface StackFrameSupplier {
 		IJavaStackFrame get() throws Exception;
 	}
+
+	/**
+	 * Sets 'JavaSE-N' execution environment default VMs to the default VM install.
+	 */
+	protected static void setExecutionEnvironmentDefaults() {
+		IVMInstall vm = JavaRuntime.getDefaultVMInstall();
+		TestUtil.logInfo("Default VM is \"" + vm.getName() + "\"");
+		IExecutionEnvironmentsManager manager = JavaRuntime.getExecutionEnvironmentsManager();
+		IExecutionEnvironment[] environments = manager.getExecutionEnvironments();
+		List<String> versions = new ArrayList<>();
+		for (IExecutionEnvironment environment : environments) {
+			String id = environment.getId();
+			if (id.startsWith(JAVASE_PREFIX)) {
+				String version = id.substring(JAVASE_PREFIX.length());
+				long jdkLevel = CompilerOptions.versionToJdkLevel(version, false);
+				if (jdkLevel != 0 && JavaRuntime.compareJavaVersions(vm, version) >= 0) {
+					environment.setDefaultVM(vm);
+					versions.add(environment.getId());
+				}
+			}
+		}
+		if (!versions.isEmpty()) {
+			TestUtil.logInfo("Set VM \"" + vm.getName() + "\" for execution environments: " + versions);
+		}
+	}
+
+	/**
+	 * Removes the default VM install of 'JavaSE-N' execution environments.
+	 */
+	protected static void clearExecutionEnvironmentDefaults() {
+		IExecutionEnvironmentsManager manager = JavaRuntime.getExecutionEnvironmentsManager();
+		IExecutionEnvironment[] environments = manager.getExecutionEnvironments();
+		List<String> versions = new ArrayList<>();
+		for (IExecutionEnvironment environment : environments) {
+			String id = environment.getId();
+			if (id.startsWith(JAVASE_PREFIX)) {
+				environment.setDefaultVM(null);
+				String version = id.substring(JAVASE_PREFIX.length());
+				versions.add(version);
+			}
+		}
+		TestUtil.logInfo("Cleared default VM for execution environments: " + versions);
+	}
+
+	private static void logVMChange(String message, IVMInstall vm) {
+		IStatus status = new Status(IStatus.INFO, JDIDebugPlugin.getUniqueIdentifier(),
+				message + " " + vm.getName() + ", location: " + vm.getInstallLocation(),
+				new RuntimeException("strack trace info"));
+		JDIDebugPlugin.log(status);
+	}
+
+	private static class LogVMInstallChanges implements IVMInstallChangedListener {
+
+		@Override
+		public void vmRemoved(IVMInstall vm) {
+			logVMChange("VM removed", vm);
+		}
+
+		@Override
+		public void vmChanged(PropertyChangeEvent event) {
+		}
+
+		@Override
+		public void vmAdded(IVMInstall vm) {
+			logVMChange("VM added", vm);
+
+		}
+
+		@Override
+		public void defaultVMInstallChanged(IVMInstall previous, IVMInstall current) {
+			logVMChange("Default VM changed", current);
+		}
+
+	}
 }

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

@@ -225,8 +225,8 @@ public void testLimitModules1() throws Exception {
 	}
 
 	private void checkVMInstall(IJavaProject javaProject) throws CoreException {
+		IVMInstall defaultVm = JavaRuntime.getDefaultVMInstall();
 		IVMInstall vm = JavaRuntime.getVMInstall(javaProject);
-		assertTrue("Expected at least Java 21 for project JVM but got: " + vm.getName() + ", with location: "
-				+ vm.getInstallLocation(), JavaRuntime.compareJavaVersions(vm, JavaCore.VERSION_21) >= 0);
+		assertEquals("Expected default VM but got: " + vm.getInstallLocation(), defaultVm.getName(), vm.getName());
 	}
 }

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

@@ -62,6 +62,7 @@ public MultiReleaseLaunchTests(String name) {
 	@Override
 	protected void setUp() throws Exception {
 		super.setUp();
+		clearExecutionEnvironmentDefaults();
 		final Set<File> existingLocations = new HashSet<>();
 		List<RequiredJavaVersion> requiredJavaVersions = new ArrayList<>(List.of(JAVA_11, JAVA_17, JAVA_21));
 		removeExistingJavaVersions(requiredJavaVersions, existingLocations);
@@ -104,6 +105,7 @@ private void matchInstallationsFrom(final File rootDir, List<RequiredJavaVersion
 	protected void tearDown() throws Exception {
 		super.tearDown();
 		disposeVms.forEach(Runnable::run);
+		setExecutionEnvironmentDefaults();
 	}
 
 	@Override