From 47a19cc825190fa57cca9fe83c6024dcb767886c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christoph=20L=C3=A4ubrich?= <laeubi@laeubi-soft.de>
Date: Sun, 15 Dec 2024 06:33:58 +0100
Subject: [PATCH] Do not automatically detect JVMs on CI systems

Automatic detection on CI systems can cause a lot of trouble (e.g.
memory consumption, time to read the jvms, old jvms lingering around)
and is generally not useful as a CI has usually a dedicated and fixed
setup to run with.

This adds a check for the common 'CI' environment variable that is
usually defined by all usual CI/CD pipelines to indicate a job is
running on a CI server to skip the detection regardless of preferences
configuration. If one absolutely want the feature even for CI, the
system-property 'DetectVMInstallationsJob.disabled' can be set to false
to restore previous behavior.
---
 .../launching/DetectVMInstallationsJob.java   | 26 +++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/org.eclipse.jdt.launching/launching/org/eclipse/jdt/internal/launching/DetectVMInstallationsJob.java b/org.eclipse.jdt.launching/launching/org/eclipse/jdt/internal/launching/DetectVMInstallationsJob.java
index 7a0b9c15e3..0373047b08 100644
--- a/org.eclipse.jdt.launching/launching/org/eclipse/jdt/internal/launching/DetectVMInstallationsJob.java
+++ b/org.eclipse.jdt.launching/launching/org/eclipse/jdt/internal/launching/DetectVMInstallationsJob.java
@@ -46,6 +46,20 @@
  */
 public class DetectVMInstallationsJob extends Job {
 
+	/**
+	 * CI is a common variable defined in CI/CDI servers like Jenkins, Gitlab, Github, ... to indicate it is a CI environment
+	 */
+	private static final String ENV_CI = "CI"; //$NON-NLS-1$
+	/**
+	 * Property that can be defined to control general behavior
+	 * <ul>
+	 * <li><code>DetectVMInstallationsJob.disabled = true</code> - automatic discovery is always disabled</li>
+	 * <li><code>DetectVMInstallationsJob.disabled = false</code> - check runs everywhere depending on preferences</li>
+	 * <li><code>DetectVMInstallationsJob.disabled</code> not specified - automatic discovery is disabled if environment variable <code>CI</code> has
+	 * value <code>true</code> otherwise runs depending on preferences</li>
+	 * </pre>
+	 */
+	private static final String PROPERTY_DETECT_VM_INSTALLATIONS_JOB_DISABLED = "DetectVMInstallationsJob.disabled"; //$NON-NLS-1$
 	private static final Object FAMILY = DetectVMInstallationsJob.class;
 
 	public DetectVMInstallationsJob() {
@@ -222,11 +236,19 @@ public boolean belongsTo(Object family) {
 	}
 
 	public static void initialize() {
-		boolean forcedDisableVMDetection = Boolean.getBoolean("DetectVMInstallationsJob.disabled"); //$NON-NLS-1$
+		if (Boolean.getBoolean(PROPERTY_DETECT_VM_INSTALLATIONS_JOB_DISABLED)) {
+			// early exit no need to read preferences or check env variable!
+			return;
+		}
+		if (System.getProperty(PROPERTY_DETECT_VM_INSTALLATIONS_JOB_DISABLED) == null && Boolean.parseBoolean(System.getenv(ENV_CI))) {
+			// exit because no explicit value for the property was given and we are running in a CI environment
+			return;
+		}
+		// finally look what is defined in the preferences
 		IEclipsePreferences instanceNode = InstanceScope.INSTANCE.getNode(LaunchingPlugin.getDefault().getBundle().getSymbolicName());
 		IEclipsePreferences defaultNode = DefaultScope.INSTANCE.getNode(LaunchingPlugin.getDefault().getBundle().getSymbolicName());
 		boolean defaultValue = defaultNode.getBoolean(LaunchingPlugin.PREF_DETECT_VMS_AT_STARTUP, true);
-		if (!forcedDisableVMDetection && instanceNode.getBoolean(LaunchingPlugin.PREF_DETECT_VMS_AT_STARTUP, defaultValue)) {
+		if (instanceNode.getBoolean(LaunchingPlugin.PREF_DETECT_VMS_AT_STARTUP, defaultValue)) {
 			new DetectVMInstallationsJob().schedule();
 		}
 	}