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,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 +271,12 @@ public AbstractDebugTest(String name) {
 
 	@Override
 	protected void setUp() throws Exception {
+		if (!setupFirstTest) {
+			TestUtil.logInfo("SETTING UP TESTS");
+			setExecutionEnvironments();
+			JavaRuntime.addVMInstallChangedListener(new LogVMInstallChanges());
+			setupFirstTest = true;
+		}
 		TestUtil.logInfo("SETUP " + getClass().getSimpleName() + "." + getName());
 		super.setUp();
 		setPreferences();
@@ -3090,4 +3103,58 @@ private static String toString(Collection<IMarker> markers) {
 	public interface StackFrameSupplier {
 		IJavaStackFrame get() throws Exception;
 	}
+
+	private static void setExecutionEnvironments() {
+		IVMInstall vm = JavaRuntime.getDefaultVMInstall();
+		TestUtil.logInfo("Default VM is \"" + vm.getName() + "\"");
+		String javaSEPrefix = "JavaSE-";
+		IExecutionEnvironmentsManager manager = JavaRuntime.getExecutionEnvironmentsManager();
+		IExecutionEnvironment[] environments = manager.getExecutionEnvironments();
+		List<String> versions = new ArrayList<>();
+		for (IExecutionEnvironment environment : environments) {
+			String id = environment.getId();
+			if (id.startsWith(javaSEPrefix)) {
+				String version = id.substring(javaSEPrefix.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);
+		}
+	}
+
+	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

@@ -17,15 +17,13 @@
 import java.util.Arrays;
 import java.util.List;
 
-import org.eclipse.core.runtime.CoreException;
 import org.eclipse.debug.core.ILaunchConfiguration;
 import org.eclipse.jdt.core.IClasspathAttribute;
 import org.eclipse.jdt.core.IClasspathEntry;
 import org.eclipse.jdt.core.IJavaProject;
 import org.eclipse.jdt.core.JavaCore;
 import org.eclipse.jdt.core.JavaModelException;
 import org.eclipse.jdt.debug.tests.AbstractDebugTest;
-import org.eclipse.jdt.launching.IVMInstall;
 import org.eclipse.jdt.launching.JavaRuntime;
 
 public class ModuleOptionsTests extends AbstractDebugTest {
@@ -115,7 +113,6 @@ private int indexOfJREContainer(IClasspathEntry[] rawClasspath) {
 
 	public void testAddModules1() throws Exception {
 		IJavaProject javaProject = getProjectContext();
-		checkVMInstall(javaProject);
 		List<String> defaultModules = getDefaultModules(javaProject);
 		defaultModules.add("jdk.crypto.cryptoki"); // requires jdk.crypto.ec up to Java 21
 		try {
@@ -139,7 +136,6 @@ public void testAddModules1() throws Exception {
 
 	public void testLimitModules_release9() throws Exception {
 		IJavaProject javaProject = getProjectContext();
-		checkVMInstall(javaProject);
 		try {
 			javaProject.setOption(JavaCore.COMPILER_RELEASE, JavaCore.ENABLED);
 			List<String> defaultModules = getDefaultModules(javaProject);
@@ -184,7 +180,6 @@ public void testLimitModules_release9() throws Exception {
 	public void testLimitModules1() throws Exception {
 		IJavaProject javaProject = getProjectContext();
 		javaProject.setOption(JavaCore.COMPILER_RELEASE, JavaCore.DISABLED);
-		checkVMInstall(javaProject);
 		List<String> defaultModules = getDefaultModules(javaProject);
 		String expectedModules;
 		String moduleList = String.join(",", defaultModules);
@@ -223,10 +218,4 @@ public void testLimitModules1() throws Exception {
 			removeClasspathAttributesFromSystemLibrary(javaProject);
 		}
 	}
-
-	private void checkVMInstall(IJavaProject javaProject) throws CoreException {
-		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);
-	}
 }