Log VM install changes during JDT debug tests, set default VM for execution environment in test

See: #782

Author: trancexpress

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

@@ -128,14 +128,17 @@
 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.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.jface.dialogs.ErrorDialog;
 import org.eclipse.jface.dialogs.MessageDialogWithToggle;
@@ -170,6 +173,8 @@
 @SuppressWarnings("deprecation")
 public abstract class AbstractDebugTest extends TestCase implements  IEvaluationListener {
 
+	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 +269,11 @@ public AbstractDebugTest(String name) {
 
 	@Override
 	protected void setUp() throws Exception {
+		if (!setupFirstTest) {
+			setupFirstTest = true;
+			TestUtil.logInfo("SETTING UP TESTS");
+			JavaRuntime.addVMInstallChangedListener(new LogVMInstallChanges());
+		}
 		TestUtil.logInfo("SETUP " + getClass().getSimpleName() + "." + getName());
 		super.setUp();
 		setPreferences();
@@ -3090,4 +3100,35 @@ private static String toString(Collection<IMarker> markers) {
 	public interface StackFrameSupplier {
 		IJavaStackFrame get() throws Exception;
 	}
+
+	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

@@ -25,11 +25,16 @@
 import org.eclipse.jdt.core.JavaCore;
 import org.eclipse.jdt.core.JavaModelException;
 import org.eclipse.jdt.debug.tests.AbstractDebugTest;
+import org.eclipse.jdt.debug.tests.TestUtil;
 import org.eclipse.jdt.launching.IVMInstall;
 import org.eclipse.jdt.launching.JavaRuntime;
+import org.eclipse.jdt.launching.environments.IExecutionEnvironment;
+import org.eclipse.jdt.launching.environments.IExecutionEnvironmentsManager;
 
 public class ModuleOptionsTests extends AbstractDebugTest {
 
+	private static final String JAVASE_9 = "JavaSE-9";
+
 	private static final String ASSUMED_DEFAULT_MODULES_9 = "java.se," //
 			// + "javafx.base,javafx.controls,javafx.fxml,javafx.graphics,javafx.media,javafx.swing,javafx.web," REMOVED in 10
 			+ "jdk.accessibility,jdk.attach,jdk.compiler,jdk.dynalink,jdk.httpserver,"//
@@ -64,11 +69,27 @@ public class ModuleOptionsTests extends AbstractDebugTest {
 			+ "jdk.unsupported.desktop," //
 			+ "jdk.xml.dom";
 
+	private IVMInstall defaultVM9;
 
 	public ModuleOptionsTests(String name) {
 		super(name);
 	}
 
+	@Override
+	protected void setUp() throws Exception {
+		super.setUp();
+		prepareExecutionEnvironment9();
+	}
+
+	@Override
+	protected void tearDown() throws Exception {
+		try {
+			restoreExecutionEnvironment9();
+		} finally {
+			super.tearDown();
+		}
+	}
+
 	@Override
 	protected IJavaProject getProjectContext() {
 		return get9Project();
@@ -225,8 +246,38 @@ 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());
+	}
+
+	/**
+	 * JDT tests run in different environments where different major JVM installations might be selected as "default" JVM for a specific Execution Environment (EE).
+	 * This test cases project requires JavaSE-9 EE, which can be resolved to e.g. Java 11, 17 or 21, depending on the installed JVMs.
+	 * JVM modules vary between Java major versions, while we need a stable set of modules for the test case.
+	 * Therefore we "pin" the JVM used for the JavaSE-9 EE to the JVM on which the tests are executed - to avoid tests failing in different test environments.
+	 */
+	private void prepareExecutionEnvironment9() {
+		IVMInstall vm = JavaRuntime.getDefaultVMInstall();
+		IExecutionEnvironment environment9 = getExecutionEnvironment9();
+		defaultVM9 = environment9.getDefaultVM();
+		environment9.setDefaultVM(vm);
+		TestUtil.logInfo("Set VM \"" + vm.getName() + "\" for execution environments: " + environment9.getId());
+	}
+
+	private void restoreExecutionEnvironment9() {
+		IExecutionEnvironment environment9 = getExecutionEnvironment9();
+		environment9.setDefaultVM(defaultVM9);
+		TestUtil.logInfo("Restored default VM for execution environment: " + environment9.getId());
+	}
+
+	private static IExecutionEnvironment getExecutionEnvironment9() {
+		IExecutionEnvironmentsManager manager = JavaRuntime.getExecutionEnvironmentsManager();
+		IExecutionEnvironment[] environments = manager.getExecutionEnvironments();
+		return Arrays.stream(environments).filter(ModuleOptionsTests::isEnvironment9).findFirst().orElseThrow();
+	}
+
+	private static boolean isEnvironment9(IExecutionEnvironment environment) {
+		return JAVASE_9.equals(environment.getId());
 	}
 }