Skip to content

Commit

Permalink
Cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@donat
donat committed Jun 10, 2024
1 parent 4505012 commit eddc018
Show file tree
Hide file tree
Showing 7 changed files with 109 additions and 147 deletions.
5 changes: 2 additions & 3 deletions ...t/src/main/groovy/org/eclipse/buildship/core/internal/marker/GradleErrorMarkerTest.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,7 @@ class GradleErrorMarkerTest extends ProjectSynchronizationSpecification {
def problems = gradleInternal.services.get(Problems)
problems.forNamespace("buildscript").reporting {
it.label("Problem label")
.category('deprecation', 'plugin')
it.id("Problem label", 'deprecation')
.severity(Severity.WARNING)
.solution("Please use 'standard-plugin-2' instead of this plugin")
}
Expand All @@ -152,7 +151,7 @@ class GradleErrorMarkerTest extends ProjectSynchronizationSpecification {
then:
numOfGradleErrorMarkers == 1
gradleErrorMarkers[0].getAttribute(IMarker.MESSAGE) == 'Problem label'
gradleErrorMarkers[0].getAttribute(GradleErrorMarker.ATTRIBUTE_PROBLEM_CATEGORY) == 'buildscript:deprecation:plugin'
gradleErrorMarkers[0].getAttribute(GradleErrorMarker.ATTRIBUTE_ID) == 'deprecation'

}
}
4 changes: 2 additions & 2 deletions ....buildship.core/src/main/java/org/eclipse/buildship/core/internal/DefaultGradleBuild.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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());
Expand Down
141 changes: 48 additions & 93 deletions ...ship.core/src/main/java/org/eclipse/buildship/core/internal/marker/GradleErrorMarker.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
package org.eclipse.buildship.core.internal.marker;

import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Collectors;
import java.util.function.Consumer;

import com.google.common.base.Throwables;

Expand All @@ -20,7 +19,6 @@
import org.eclipse.core.runtime.CoreException;

import org.eclipse.buildship.core.internal.CorePlugin;
import org.eclipse.buildship.core.internal.util.progress.ProblemEventAdapter;
import org.eclipse.buildship.core.internal.workspace.InternalGradleBuild;

/**
Expand All @@ -31,16 +29,14 @@
public class GradleErrorMarker {

public static final String ID = CorePlugin.PLUGIN_ID + ".errormarker";
public static final String ATTRIBUTE_STACKTRACE = "stacktrace";
public static final String ATTRIBUTE_ROOT_DIR = "rootdir";
public static final String ATTRIBUTE_ID = "problem.id";
public static final String ATTRIBUTE_LABEL = "problem.label";
public static final String ATTRIBUTE_DETAILS = "problem.details";
public static final String ATTRIBUTE_STACKTRACE = "stacktrace";
public static final String ATTRIBUTE_ROOT_DIR = "rootdir";
public static final String ATTRIBUTE_PROBLEM_CATEGORY = "problem.category";
public static final String ATTRIBUTE_PROBLEM_SOLUTIONS = "problem.solutions";
public static final String ATTRIBUTE_SOLUTIONS = "problem.solutions";
public static final String ATTRIBUTE_DOCUMENTATION_LINK = "problem.documentationlink";


private GradleErrorMarker() {
}

Expand All @@ -49,112 +45,71 @@ public static boolean belongsToBuild(IMarker marker, InternalGradleBuild build)
return build.getBuildConfig().getRootProjectDirectory().getAbsolutePath().equals(rootDir);
}

public static void createError(IResource resource, InternalGradleBuild gradleBuild, String message, Throwable exception) {
createMarker(IMarker.SEVERITY_ERROR, resource, gradleBuild, message, exception, 0);
}

public static void createError(IResource resource, InternalGradleBuild gradleBuild, String message, Throwable exception, int lineNumber) {
createMarker(IMarker.SEVERITY_ERROR, resource, gradleBuild, message, exception, lineNumber);
}

public static void createWarning(IResource resource, InternalGradleBuild gradleBuild, String message, Throwable exception, int lineNumber) {
createMarker(IMarker.SEVERITY_WARNING, resource, gradleBuild, message, exception,lineNumber);
public static void createWarning(IResource resource, InternalGradleBuild gradleBuild, String message, Throwable exception) {
createMarker(IMarker.SEVERITY_WARNING, resource, gradleBuild, message, exception, 0);
}

private static void createMarker(int severity, IResource resource, InternalGradleBuild gradleBuild, String message, Throwable exception, int lineNumber) {
createMarker(severity, resource, gradleBuild, message, exception, lineNumber, null, null, null);
}

public static void createMarker(int severity, IResource resource, InternalGradleBuild gradleBuild, String message, Throwable exception, int lineNumber, String category,
List<String> solutions, String documentationLink) {
if (exception != null) {
String stackTrace = Throwables.getStackTraceAsString(exception);
createMarker(severity, resource, gradleBuild, message, stackTrace, lineNumber, category, solutions, documentationLink, null);
}

}

public static void createMarker(int severity,
IResource resource,
InternalGradleBuild gradleBuild,
String message,
String exception,
int lineNumber,
String category,
List<String> solutions,
String documentationLink,
ProblemEventAdapter adapter) {
try {
IMarker marker = resource.createMarker(GradleErrorMarker.ID);

String stacktrace = exception == null ? null : trimMarkerProperty(Throwables.getStackTraceAsString(exception));
createMarker(resource, severity, gradleBuild, message, stacktrace, marker -> {
if (lineNumber >= 0) {
marker.setAttribute(IMarker.LINE_NUMBER, lineNumber);
try {
marker.setAttribute(IMarker.LINE_NUMBER, lineNumber);
} catch (CoreException e) {
throw new RuntimeException(e);
}
}
}, t -> {});
}

marker.setAttribute(IMarker.MESSAGE, trimMarkerProperty(message));
marker.setAttribute(IMarker.PRIORITY, IMarker.PRIORITY_HIGH);
marker.setAttribute(IMarker.SEVERITY, severity);
marker.setAttribute(ATTRIBUTE_ROOT_DIR, gradleBuild.getBuildConfig().getRootProjectDirectory().getAbsolutePath());
if (exception != null) {
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_STACKTRACE, trimMarkerProperty(exception));
}
if (category != null) {
marker.setAttribute(ATTRIBUTE_PROBLEM_CATEGORY, category);
}
if (solutions != null) {
String solutionsString = solutions.stream().collect(Collectors.joining(System.getProperty("line.separator")));
marker.setAttribute(ATTRIBUTE_PROBLEM_SOLUTIONS, solutionsString);
private static void createMarker(IResource resource, int severity, InternalGradleBuild gradleBuild, String message, String exception, Consumer<IMarker> positionConfiguration,
Consumer<IMarker> after) {
createMarker(resource, new Consumer<IMarker>() {

@Override
public void accept(IMarker marker) {
try {
marker.setAttribute(IMarker.PRIORITY, IMarker.PRIORITY_HIGH);
marker.setAttribute(IMarker.SEVERITY, severity);
marker.setAttribute(ATTRIBUTE_ROOT_DIR, gradleBuild.getBuildConfig().getRootProjectDirectory().getAbsolutePath());
marker.setAttribute(IMarker.MESSAGE, trimMarkerProperty(message));
if (exception != null) {
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_STACKTRACE, exception);
}
} catch (CoreException e) {
CorePlugin.logger().warn("Cannot create Gradle error marker", e);
throw new RuntimeException(e);
}
}
if (documentationLink != null) {
marker.setAttribute(ATTRIBUTE_DOCUMENTATION_LINK, documentationLink);
}
if (adapter != null) {
adapter.apply(marker);
}
} catch (CoreException e) {
CorePlugin.logger().warn("Cannot create Gradle error marker", e);
}
}.andThen(positionConfiguration).andThen(after));
}

public static void createMarker(int severity,
IResource resource,
InternalGradleBuild gradleBuild,
String message,
String exception,
int startOffset,
int endOffset,
String category,
List<String> solutions,
String documentationLink,
ProblemEventAdapter adapter) {
private static void createMarker(IResource resource, Consumer<IMarker> markerConfiguration) {
try {
IMarker marker = resource.createMarker(GradleErrorMarker.ID);
marker.setAttribute(IMarker.CHAR_START, startOffset);
marker.setAttribute(IMarker.CHAR_END, startOffset + endOffset);
marker.setAttribute(IMarker.MESSAGE, trimMarkerProperty(message));
marker.setAttribute(IMarker.PRIORITY, IMarker.PRIORITY_HIGH);
marker.setAttribute(IMarker.SEVERITY, severity);
marker.setAttribute(ATTRIBUTE_ROOT_DIR, gradleBuild.getBuildConfig().getRootProjectDirectory().getAbsolutePath());
if (exception != null) {
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_STACKTRACE, trimMarkerProperty(exception));
}
if (category != null) {
marker.setAttribute(ATTRIBUTE_PROBLEM_CATEGORY, category);
}
if (solutions != null) {
String solutionsString = solutions.stream().collect(Collectors.joining(System.getProperty("line.separator")));
marker.setAttribute(ATTRIBUTE_PROBLEM_SOLUTIONS, solutionsString);
}
if (documentationLink != null) {
marker.setAttribute(ATTRIBUTE_DOCUMENTATION_LINK, documentationLink);
}
if (adapter != null) {
adapter.apply(marker);
}
} catch (CoreException e) {
markerConfiguration.accept(marker);
} catch (Exception e) {
CorePlugin.logger().warn("Cannot create Gradle error marker", e);
}
}

public static void createProblemMarker(int severity, IResource resource, InternalGradleBuild gradleBuild, String message, String exception, Consumer<IMarker> problemPosition, Consumer<IMarker> problemDetails) {
createMarker(resource, severity, gradleBuild, message, exception, problemPosition, problemDetails);
}

/*
* The Eclipse platform will throw an exception if a marker property is longer than 65535 bytes
* https://github.com/eclipse-platform/eclipse.platform/blob/97d555a8b563dcb3a32bd43ad58ba452fa027a73/resources/bundles/org.eclipse.core.resources/src/org/eclipse/core/internal/resources/MarkerInfo.java#L56-L60
* https://github.com/eclipse-platform/eclipse.platform/blob/
* 97d555a8b563dcb3a32bd43ad58ba452fa027a73/resources/bundles/org.eclipse.core.resources/src/org
* /eclipse/core/internal/resources/MarkerInfo.java#L56-L60
*/
private static String trimMarkerProperty(String property) {
// avoid calling String.toBytes() for shorter Strings
Expand Down
31 changes: 25 additions & 6 deletions .../src/main/java/org/eclipse/buildship/core/internal/util/progress/ProblemEventAdapter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,46 @@
******************************************************************************/
package org.eclipse.buildship.core.internal.util.progress;

import java.util.List;
import java.util.function.Consumer;
import java.util.stream.Collectors;

import org.gradle.tooling.events.problems.ProblemGroup;
import org.gradle.tooling.events.problems.SingleProblemEvent;
import org.gradle.tooling.events.problems.Solution;

import org.eclipse.core.resources.IMarker;
import org.eclipse.core.runtime.CoreException;

import org.eclipse.buildship.core.internal.marker.GradleErrorMarker;

public class ProblemEventAdapter {
public class ProblemEventAdapter implements Consumer<IMarker> {

private final SingleProblemEvent problem;

public ProblemEventAdapter(SingleProblemEvent problem) {
this.problem = problem;
}

public void apply(IMarker marker) throws CoreException {
String idInfo = this.problem.getDefinition().getId().getDisplayName() + " (id: " + fqid() + ")";
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_ID, idInfo);
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_LABEL, this.problem.getContextualLabel().getContextualLabel());
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_DETAILS, this.problem.getDetails().getDetails());
@Override
public void accept(IMarker marker) {
try {
String idInfo = this.problem.getDefinition().getId().getDisplayName() + " (id: " + fqid() + ")";
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_ID, idInfo);
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_LABEL, this.problem.getContextualLabel().getContextualLabel());
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_DETAILS, this.problem.getDetails().getDetails());
List<Solution> solutions = this.problem.getSolutions();
if (solutions != null) {
String solutionsString = solutions.stream().map(Solution::getSolution).collect(Collectors.joining(System.getProperty("line.separator")));
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_SOLUTIONS, solutionsString);
}
String documentationLink = this.problem.getDefinition().getDocumentationLink().getUrl();
if (documentationLink != null) {
marker.setAttribute(GradleErrorMarker.ATTRIBUTE_DOCUMENTATION_LINK, documentationLink);
}
} catch (CoreException e) {
throw new RuntimeException(e);
}
}

private String fqid() {
Expand Down
Loading

0 comments on commit eddc018

Please sign in to comment.