Render Gradle problem reports as Eclipse error markers (#1306)

Render Gradle problem reports as Eclipse error markers #1306 * Render problem reports as error markers * Use java 17 for more recent Eclipse versions * Force recreating target platform if Tooling API jar version changes * Don't limit hamcrest version * Update Tooling API to 8.9 release version
eclipse-buildship · Jul 22, 2024 · ec8eee3 · ec8eee3
1 parent 9ba95e9
commit ec8eee3
Show file tree

Hide file tree

Showing 30 changed files with 620 additions and 288 deletions.
diff --git a/build.gradle b/build.gradle
@@ -133,12 +133,18 @@ subprojects {
                     languageVersion = JavaLanguageVersion.of(8)
                 }
             }
-        } else {
+        } else if (config.targetPlatform.eclipseVersion in ['417', '418', '419', '420', '421', '422', '423', '424']) {
             java {
                 toolchain {
                     languageVersion = JavaLanguageVersion.of(11)
                 }
             }
+        } else {
+            java {
+                toolchain {
+                    languageVersion = JavaLanguageVersion.of(17)
+                }
+            }
         }
 
         tasks.matching { it instanceof JavaCompile || it instanceof GroovyCompile }.all {

diff --git a/buildSrc/src/main/groovy/eclipsebuild/BuildDefinitionPlugin.groovy b/buildSrc/src/main/groovy/eclipsebuild/BuildDefinitionPlugin.groovy
@@ -264,7 +264,15 @@ class BuildDefinitionPlugin implements Plugin<Project> {
 
             onlyIf {
                 HashFunction sha512HashFunction = Hashing.sha512()
-                String hash = sha512HashFunction.hashString(config.targetPlatform.targetDefinition.text, StandardCharsets.UTF_8)
+                String manifests = project.rootProject.allprojects
+                        .findAll { p -> p.plugins.hasPlugin(ExistingJarBundlePlugin) }
+                        .toSorted { p1, p2 -> p1.name <=> p2.name }
+                        .collect { p -> p.file("META-INF/MANIFEST.MF").exists() ? p.file("META-INF/MANIFEST.MF").text : null }
+                        .findAll { it != null }
+                        .join("\n")
+                String targetDef = config.targetPlatform.targetDefinition.text
+                String hashInput = manifests + "\n" + targetDef
+                String hash = sha512HashFunction.hashString(hashInput, StandardCharsets.UTF_8)
                 File digestFile = new File(config.nonMavenizedTargetPlatformDir, 'digest')
                 boolean digestMatch = digestFile.exists() ? digestFile.text == hash : false
                 !digestMatch

diff --git a/gradle.properties b/gradle.properties
@@ -1,5 +1,5 @@
 # production library version numbers
-toolingApiVersion=8.6
+toolingApiVersion=8.9
 
 # testing library version numbers
 guavaVersion=33.0.0

diff --git a/org.eclipse.buildship.compat/META-INF/MANIFEST.MF b/org.eclipse.buildship.compat/META-INF/MANIFEST.MF
@@ -6,5 +6,5 @@ Bundle-Version: 3.1.10.qualifier
 Bundle-Vendor: Eclipse Buildship
 Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Bundle-ActivationPolicy: lazy
-Require-Bundle: org.gradle.toolingapi;bundle-version="[8.6.0,8.7.0)";visibility:=reexport
+Require-Bundle: org.gradle.toolingapi;bundle-version="[8.9.0,8.10.0)";visibility:=reexport
 Export-Package: org.eclipse.buildship.core.internal.workspace
diff --git a/...in/groovy/org/eclipse/buildship/core/internal/configuration/BuildConfigurationTest.groovy b/...in/groovy/org/eclipse/buildship/core/internal/configuration/BuildConfigurationTest.groovy
@@ -56,7 +56,7 @@ class BuildConfigurationTest extends ProjectSynchronizationSpecification {
         WorkspaceConfiguration orignalConfiguration = configurationManager.loadWorkspaceConfiguration()
 
         when:
-        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(distribution, workspaceGradleUserHome, workspaceJavaHome, offlineMode, buildScansEnabled, autoSync, workspaceArguments, workspaceJvmArguments, showConsole, showExecutions, false))
+        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(distribution, workspaceGradleUserHome, workspaceJavaHome, offlineMode, buildScansEnabled, autoSync, workspaceArguments, workspaceJvmArguments, showConsole, showExecutions, false, false))
         BuildConfiguration configuration = createInheritingBuildConfiguration(projectDir)
 
         then:
@@ -203,7 +203,7 @@ connection.gradle.distribution=MODIFIED_DISTRO"""
 
         when:
         configurationManager.saveBuildConfiguration(buildConfig)
-        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(distribution, workspaceGradleUserHome, workspaceJavaHome, offlineMode, buildScansEnabled, autoSync, workspaceArguments, workspaceJvmArguments, showConsole, showExecutions, false))
+        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(distribution, workspaceGradleUserHome, workspaceJavaHome, offlineMode, buildScansEnabled, autoSync, workspaceArguments, workspaceJvmArguments, showConsole, showExecutions, false, false))
         buildConfig = configurationManager.loadBuildConfiguration(projectDir)
 
         then:
@@ -242,7 +242,7 @@ connection.gradle.distribution=MODIFIED_DISTRO"""
 
         when:
         configurationManager.saveBuildConfiguration(buildConfig)
-        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(GradleDistribution.fromBuild(), null, null, !buildScansEnabled, !offlineMode, !autoSync, [], [], false, false, false))
+        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(GradleDistribution.fromBuild(), null, null, !buildScansEnabled, !offlineMode, !autoSync, [], [], false, false, false, false))
         buildConfig = configurationManager.loadBuildConfiguration(projectDir)
 
         then:

diff --git a/.../groovy/org/eclipse/buildship/core/internal/configuration/ProjectConfigurationTest.groovy b/.../groovy/org/eclipse/buildship/core/internal/configuration/ProjectConfigurationTest.groovy
@@ -190,7 +190,7 @@ class ProjectConfigurationTest extends ProjectSynchronizationSpecification {
 
         when:
         configurationManager.saveProjectConfiguration(projectConfig)
-        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(distribution, gradleUserHome, javaHome, offlineMode, buildScansEnabled, autoSync, arguments, jvmArguments, showConsole, showExecutions, false))
+        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(distribution, gradleUserHome, javaHome, offlineMode, buildScansEnabled, autoSync, arguments, jvmArguments, showConsole, showExecutions, false, false))
         projectConfig = configurationManager.loadProjectConfiguration(project)
 
         then:
@@ -224,7 +224,7 @@ class ProjectConfigurationTest extends ProjectSynchronizationSpecification {
 
         when:
         configurationManager.saveProjectConfiguration(projectConfig)
-        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(GradleDistribution.fromBuild(), null, null, !buildScansEnabled, !offlineMode, !autoSync, [], [], false, false, false))
+        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(GradleDistribution.fromBuild(), null, null, !buildScansEnabled, !offlineMode, !autoSync, [], [], false, false, false, false))
         projectConfig = configurationManager.loadProjectConfiguration(project)
 
         then:

diff --git a/...roovy/org/eclipse/buildship/core/internal/configuration/WorkspaceConfigurationTest.groovy b/...roovy/org/eclipse/buildship/core/internal/configuration/WorkspaceConfigurationTest.groovy
@@ -33,14 +33,14 @@ class WorkspaceConfigurationTest extends WorkspaceSpecification {
     }
 
     @Rollup
-    def "Can save workpsace configuration"(GradleDistribution distribution, String gradleUserHome, String javaHome, boolean offlineMode, boolean buildScansEnabled, boolean autoSync, List args, List jvmArgs, boolean showConsole, boolean showExecutions, moduleSupportEnabled) {
+    def "Can save workspace configuration"(GradleDistribution distribution, String gradleUserHome, String javaHome, boolean offlineMode, boolean buildScansEnabled, boolean autoSync, List args, List jvmArgs, boolean showConsole, boolean showExecutions, moduleSupportEnabled) {
         setup:
         WorkspaceConfiguration orignalConfiguration = configurationManager.loadWorkspaceConfiguration()
 
         when:
         File gradleUserHomeDir = dir(gradleUserHome)
         File javaHomeDir = dir(javaHome)
-        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(distribution, gradleUserHomeDir, javaHomeDir, offlineMode, buildScansEnabled, autoSync, args, jvmArgs, showConsole, showExecutions, moduleSupportEnabled))
+        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(distribution, gradleUserHomeDir, javaHomeDir, offlineMode, buildScansEnabled, autoSync, args, jvmArgs, showConsole, showExecutions, moduleSupportEnabled, false))
         WorkspaceConfiguration updatedConfiguration = configurationManager.loadWorkspaceConfiguration()
 
         then:

diff --git a/...t/src/main/groovy/org/eclipse/buildship/core/internal/marker/GradleErrorMarkerTest.groovy b/...t/src/main/groovy/org/eclipse/buildship/core/internal/marker/GradleErrorMarkerTest.groovy
@@ -15,6 +15,8 @@ import org.eclipse.core.resources.IMarker
 import org.eclipse.core.runtime.IStatus
 
 import org.eclipse.buildship.core.GradleDistribution
+import org.eclipse.buildship.core.internal.CorePlugin
+import org.eclipse.buildship.core.internal.configuration.WorkspaceConfiguration
 import org.eclipse.buildship.core.internal.test.fixtures.ProjectSynchronizationSpecification
 
 class GradleErrorMarkerTest extends ProjectSynchronizationSpecification {
@@ -128,6 +130,8 @@ class GradleErrorMarkerTest extends ProjectSynchronizationSpecification {
 
     def "Convers problem reports to error markers"() {
         setup:
+        WorkspaceConfiguration w = CorePlugin.configurationManager().loadWorkspaceConfiguration()
+        configurationManager.saveWorkspaceConfiguration(new WorkspaceConfiguration(w.gradleDistribution, w.gradleUserHome, w.javaHome, w.offline, w.buildScansEnabled, w.autoSync, w.arguments, w.jvmArguments, w.showConsoleView, w.showExecutionsView, w.experimentalModuleSupportEnabled , true))
         File projectDir = dir('error-marker-test') {
             file 'build.gradle', '''
                 import org.gradle.api.internal.GradleInternal
@@ -138,21 +142,24 @@ class GradleErrorMarkerTest extends ProjectSynchronizationSpecification {
                 def problems = gradleInternal.services.get(Problems)
 
                 problems.forNamespace("buildscript").reporting {
-                    it.label("Problem label")
-                        .category('deprecation', 'plugin')
+                    it.id("id", 'My problem')
+                        .details("Problem details")
                         .severity(Severity.WARNING)
                         .solution("Please use 'standard-plugin-2' instead of this plugin")
-            }
+                }
             '''
         }
 
         when:
-        tryImportAndWait(projectDir)
+        importAndWait(projectDir)
 
         then:
-        numOfGradleErrorMarkers == 1
-        gradleErrorMarkers[0].getAttribute(IMarker.MESSAGE) == 'Problem label'
-        gradleErrorMarkers[0].getAttribute(GradleErrorMarker.ATTRIBUTE_PROBLEM_CATEGORY) == 'buildscript:deprecation:plugin'
+        problemsApiErrorMarkers.size() == 1
+        problemsApiErrorMarkers[0].getAttribute(IMarker.MESSAGE) == 'Problem details'
+        problemsApiErrorMarkers[0].getAttribute(GradleErrorMarker.ATTRIBUTE_FQID) == 'generic:id'
+
+        cleanup:
+        CorePlugin.configurationManager().saveWorkspaceConfiguration(w)
 
     }
 }
diff --git a/...in/groovy/org/eclipse/buildship/core/internal/test/fixtures/WorkspaceSpecification.groovy b/...in/groovy/org/eclipse/buildship/core/internal/test/fixtures/WorkspaceSpecification.groovy
@@ -32,6 +32,7 @@ import org.eclipse.debug.core.ILaunchManager
 import org.eclipse.jdt.core.IJavaProject
 import org.eclipse.jdt.core.JavaCore
 
+import org.eclipse.buildship.core.GradleDistribution
 import org.eclipse.buildship.core.internal.CorePlugin
 import org.eclipse.buildship.core.internal.configuration.BuildConfiguration
 import org.eclipse.buildship.core.internal.configuration.ConfigurationManager
@@ -40,7 +41,6 @@ import org.eclipse.buildship.core.internal.marker.GradleErrorMarker
 import org.eclipse.buildship.core.internal.preferences.DefaultPersistentModel
 import org.eclipse.buildship.core.internal.preferences.PersistentModel
 import org.eclipse.buildship.core.internal.util.gradle.GradleVersion
-import org.eclipse.buildship.core.GradleDistribution
 import org.eclipse.buildship.core.internal.workspace.EclipseVmUtil
 import org.eclipse.buildship.core.internal.workspace.PersistentModelBuilder
 import org.eclipse.buildship.core.internal.workspace.WorkspaceOperations
@@ -247,7 +247,11 @@ abstract class WorkspaceSpecification extends Specification {
     }
 
     protected List<IMarker> getGradleErrorMarkers(IResource rootResource = workspace.root) {
-        rootResource.findMarkers(GradleErrorMarker.ID, false, IResource.DEPTH_INFINITE) as List
+        (rootResource.findMarkers(GradleErrorMarker.ID, false, IResource.DEPTH_INFINITE) as List).findAll { IMarker m -> m.getAttribute(GradleErrorMarker.ATTRIBUTE_FQID, null) == null }
+    }
+
+    protected List<IMarker> getProblemsApiErrorMarkers(IResource rootResource = workspace.root) {
+        (rootResource.findMarkers(GradleErrorMarker.ID, false, IResource.DEPTH_INFINITE) as List).findAll { IMarker m -> m.getAttribute(GradleErrorMarker.ATTRIBUTE_FQID, null) != null }
     }
 
     protected List<IStatus> getPlatformLogErrors() {

diff --git a/...lipse/buildship/core/internal/workspace/SynchronizingBuildScriptUpdateListenerTest.groovy b/...lipse/buildship/core/internal/workspace/SynchronizingBuildScriptUpdateListenerTest.groovy
@@ -212,6 +212,7 @@ class SynchronizingBuildScriptUpdateListenerTest extends ProjectSynchronizationS
             workspaceConfig.jvmArguments,
             workspaceConfig.showConsoleView,
             workspaceConfig.showExecutionsView,
+            false,
             false)
         configurationManager.saveWorkspaceConfiguration(workspaceConfig)
     }

diff --git a/org.eclipse.buildship.core/META-INF/MANIFEST.MF b/org.eclipse.buildship.core/META-INF/MANIFEST.MF
@@ -16,7 +16,7 @@ Require-Bundle: org.eclipse.core.expressions,
  org.eclipse.jdt.junit.core,
  org.eclipse.jdt.launching,
  org.eclipse.debug.core,
- org.gradle.toolingapi;bundle-version="[8.6.0,8.7.0)";visibility:=reexport,
+ org.gradle.toolingapi;bundle-version="[8.9.0,8.10.0)";visibility:=reexport,
  com.google.guava;bundle-version="33.0.0",
  com.google.gson;bundle-version="[2.7.0,3.0.0)",
  org.eclipse.buildship.compat;visibility:=reexport

diff --git a/....buildship.core/src/main/java/org/eclipse/buildship/core/internal/DefaultGradleBuild.java b/....buildship.core/src/main/java/org/eclipse/buildship/core/internal/DefaultGradleBuild.java
@@ -197,9 +197,9 @@ SynchronizationResult run(CancellationTokenSource tokenSource, IProgressMonitor
                 CorePlugin.operationManager().run(this, tokenSource, monitor);
                 for (SynchronizationProblem f : this.failures) {
                     if (f.getSeverity() == IStatus.ERROR) {
-                        GradleErrorMarker.createError(f.getResource(), this.gradleBuild, f.getMessage(), f.getException(), 0);
+                        GradleErrorMarker.createError(f.getResource(), this.gradleBuild, f.getMessage(), f.getException());
                     } else if (f.getSeverity() == IStatus.WARNING) {
-                        GradleErrorMarker.createWarning(f.getResource(), this.gradleBuild, f.getMessage(), f.getException(), 0);
+                        GradleErrorMarker.createWarning(f.getResource(), this.gradleBuild, f.getMessage(), f.getException());
                     }
                 }
                 result = DefaultSynchronizationResult.from(getFailures());

diff --git a/.../org/eclipse/buildship/core/internal/configuration/WorkspaceConfigurationPersistence.java b/.../org/eclipse/buildship/core/internal/configuration/WorkspaceConfigurationPersistence.java
@@ -73,7 +73,7 @@ public WorkspaceConfiguration readWorkspaceConfig() {
         boolean showConsoleView = preferences.getBoolean(SHOW_CONSOLE_VIEW, true);
         boolean showExecutionsView = preferences.getBoolean(SHOW_EXECUTIONS_VIEW, true);
         boolean moduleSupport = preferences.getBoolean(EXPERIMENTAL_ENABLE_MODULE_SUPPORT, false);
-        boolean problemsApiSupport = preferences.getBoolean(PROBLEMS_API_SUPPORT, true);
+        boolean problemsApiSupport = preferences.getBoolean(PROBLEMS_API_SUPPORT, false);
         return new WorkspaceConfiguration(distribution, gradleUserHome, javaHome, offlineMode, buildScansEnabled, autoSyncEnabled, arguments, jvmArguments, showConsoleView, showExecutionsView, moduleSupport, problemsApiSupport);
     }