Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ensure project and pom.xml diagnostics are properly reset #818

Merged
merged 1 commit into from
Oct 2, 2018
Merged

Ensure project and pom.xml diagnostics are properly reset #818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 19 additions & 15 deletions ...dt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/WorkspaceDiagnosticsHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.stream.Collectors;
import java.util.stream.Stream;

Expand Down Expand Up @@ -51,9 +50,6 @@
import org.eclipse.m2e.core.internal.IMavenConstants;
import org.eclipse.m2e.core.internal.Messages;

import com.google.common.collect.HashMultimap;
import com.google.common.collect.Multimap;

/**
* Listens to the resource change events and converts {@link IMarker}s to {@link Diagnostic}s.
*
Expand Down Expand Up @@ -115,29 +111,37 @@ public boolean visit(IResourceDelta delta) throws CoreException {
if (JavaLanguageServerPlugin.getProjectsManager().getDefaultProject().equals(resource.getProject())) {
return false;
}
IProject project = (IProject) resource;
// report problems for other projects
IMarker[] markers = resource.findMarkers(null, true, IResource.DEPTH_ONE);
IMarker[] markers = project.findMarkers(null, true, IResource.DEPTH_ONE);
Range range = new Range(new Position(0, 0), new Position(0, 0));

Multimap<String, IMarker> allMarkers = HashMultimap.create(1, markers.length);
List<IMarker> projectMarkers = new ArrayList<>(markers.length);

String uri = JDTUtils.getFileURI(project);
IFile pom = project.getFile("pom.xml");
List<IMarker> pomMarkers = new ArrayList<>();
if (pom.exists()) {
pomMarkers.addAll(Arrays.asList(pom.findMarkers(null, true, 1)));
}

String uri = JDTUtils.getFileURI(resource);
for (IMarker marker : markers) {
if (!marker.exists() || CheckMissingNaturesListener.MARKER_TYPE.equals(marker.getType())) {
continue;
}
if (IMavenConstants.MARKER_CONFIGURATION_ID.equals(marker.getType())) {
String message = marker.getAttribute(IMarker.MESSAGE, "");
if (Messages.ProjectConfigurationUpdateRequired.equals(message)) {
allMarkers.put(uri + "/pom.xml", marker);
}
pomMarkers.add(marker);
} else {
allMarkers.put(uri, marker);
projectMarkers.add(marker);
}
}
for (Entry<String, Collection<IMarker>> e : allMarkers.asMap().entrySet()) {
List<Diagnostic> diagnostics = toDiagnosticArray(range, e.getValue());
connection.publishDiagnostics(new PublishDiagnosticsParams(ResourceUtils.toClientUri(e.getKey()), diagnostics));

List<Diagnostic> diagnostics = toDiagnosticArray(range, projectMarkers);
String clientUri = ResourceUtils.toClientUri(uri);
connection.publishDiagnostics(new PublishDiagnosticsParams(clientUri, diagnostics));
if (pom.exists()) {
diagnostics = toDiagnosticArray(range, pomMarkers);
connection.publishDiagnostics(new PublishDiagnosticsParams(ResourceUtils.toClientUri(clientUri + "/pom.xml"), diagnostics));
}
return true;
}
Expand Down
17 changes: 10 additions & 7 deletions org.eclipse.jdt.ls.tests/projects/maven/multimodule/module1/childmodule/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>foo.bar</groupId>
<artifactId>childmodule</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>

<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>foo.bar</groupId>
<artifactId>module1</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>childmodule</artifactId>
</project>
27 changes: 16 additions & 11 deletions org.eclipse.jdt.ls.tests/projects/maven/multimodule/module1/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>foo.bar</groupId>
<artifactId>module1</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>pom</packaging>

<modules>
<module>childmodule</module>
</modules>

<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>foo.bar</groupId>
<artifactId>multimodule</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>module1</artifactId>
<packaging>pom</packaging>

<modules>
<module>childmodule</module>
</modules>

</project>
17 changes: 10 additions & 7 deletions org.eclipse.jdt.ls.tests/projects/maven/multimodule/module2/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>foo.bar</groupId>
<artifactId>module2</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>

<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>foo.bar</groupId>
<artifactId>multimodule</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>module2</artifactId>
</project>
18 changes: 11 additions & 7 deletions org.eclipse.jdt.ls.tests/projects/maven/multimodule/module3/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>foo.bar</groupId>
<artifactId>module3</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>

<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>foo.bar</groupId>
<artifactId>multimodule</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>module3</artifactId>
<packaging>jar</packaging>
</project>
55 changes: 28 additions & 27 deletions org.eclipse.jdt.ls.tests/projects/maven/multimodule/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>foo.bar</groupId>
<artifactId>multimodule</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>module1</module>
</modules>

<profiles>
<profile>
<id>test</id>
<modules>
<module>module3</module>
</modules>
</profile>
<profile>
<id>default</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<modules>
<module>module2</module>
</modules>
</profile>
</profiles>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>foo.bar</groupId>
<artifactId>multimodule</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>module1</module>
</modules>
<profiles>
<profile>
<id>test</id>
<modules>
<module>module3</module>
</modules>
</profile>
<profile>
<id>default</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<modules>
<module>module2</module>
</modules>
</profile>
</profiles>
</project>
79 changes: 78 additions & 1 deletion ....tests/src/org/eclipse/jdt/ls/core/internal/handlers/WorkspaceDiagnosticsHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.atLeastOnce;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.reset;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
Expand Down Expand Up @@ -251,7 +253,8 @@ public void testMissingNatures() throws Exception {
Collections.reverse(allCalls);
projectsManager.setConnection(client);
Optional<PublishDiagnosticsParams> projectDiags = allCalls.stream().filter(p -> p.getUri().endsWith("eclipse/wtpproject")).findFirst();
assertFalse(projectDiags.isPresent());
assertTrue(projectDiags.isPresent());
assertEquals("Unexpected diagnostics:\n" + projectDiags.get().getDiagnostics(), 0, projectDiags.get().getDiagnostics().size());
}

@Test
Expand Down Expand Up @@ -288,6 +291,80 @@ public void testProjectConfigurationIsNotUpToDate() throws Exception {
assertEquals(diag.getSeverity(), DiagnosticSeverity.Warning);
}

@Test
public void testResetPomDiagnostics() throws Exception {
//import project
importProjects("maven/multimodule");
IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject("multimodule");
IFile pom = project.getFile("/pom.xml");
assertTrue(pom.exists());
//@formatter:off
String compilerPlugin = "\n<build>\n" +
" <pluginManagement>\n" +
" <plugins>\n" +
" <plugin>\n" +
" <artifactId>maven-compiler-plugin</artifactId>\n" +
" <version>3.8.0</version>\n" +
" <configuration>\n" +
" <release>9</release>\n" +
" </configuration>\n" +
" </plugin>\n" +
" </plugins>\n" +
" </pluginManagement>\n" +
"</build>\n";
//@formatter:on

ResourceUtils.setContent(pom, ResourceUtils.getContent(pom).replaceAll("<profiles>", compilerPlugin + "\n<profiles>"));

ResourcesPlugin.getWorkspace().build(IncrementalProjectBuilder.INCREMENTAL_BUILD, monitor);

ArgumentCaptor<PublishDiagnosticsParams> captor = ArgumentCaptor.forClass(PublishDiagnosticsParams.class);
verify(connection, atLeastOnce()).publishDiagnostics(captor.capture());
List<PublishDiagnosticsParams> allCalls = captor.getAllValues();

List<PublishDiagnosticsParams> pomDiags = allCalls.stream().filter(p -> p.getUri().endsWith("pom.xml") && !p.getDiagnostics().isEmpty()).collect(Collectors.toList());
assertEquals("No pom.xml errors were found", 3, pomDiags.size());
assertTrue(pomDiags.get(0).getUri(), pomDiags.get(0).getUri().endsWith("childmodule/pom.xml"));
assertEquals(1, pomDiags.get(0).getDiagnostics().size());
assertEquals(pomDiags.get(0).getDiagnostics().get(0).getMessage(), WorkspaceDiagnosticsHandler.PROJECT_CONFIGURATION_IS_NOT_UP_TO_DATE_WITH_POM_XML);
assertTrue(pomDiags.get(1).getUri().endsWith("module2/pom.xml"));
assertEquals(1, pomDiags.get(1).getDiagnostics().size());
assertEquals(pomDiags.get(1).getDiagnostics().get(0).getMessage(), WorkspaceDiagnosticsHandler.PROJECT_CONFIGURATION_IS_NOT_UP_TO_DATE_WITH_POM_XML);
assertTrue(pomDiags.get(2).getUri().endsWith("module3/pom.xml"));
assertEquals(1, pomDiags.get(2).getDiagnostics().size());
assertEquals(pomDiags.get(2).getDiagnostics().get(0).getMessage(), WorkspaceDiagnosticsHandler.PROJECT_CONFIGURATION_IS_NOT_UP_TO_DATE_WITH_POM_XML);

reset(connection);
captor = ArgumentCaptor.forClass(PublishDiagnosticsParams.class);
projectsManager.updateProject(project, true);
waitForBackgroundJobs();

verify(connection, atLeastOnce()).publishDiagnostics(captor.capture());
allCalls = captor.getAllValues();

pomDiags = allCalls.stream().filter(p -> p.getUri().endsWith("pom.xml")).collect(Collectors.toList());
boolean reset1 = false;
boolean reset2 = false;
boolean reset3 = true;
for (PublishDiagnosticsParams diag : pomDiags) {
String uri = diag.getUri();
if (uri.endsWith("childmodule/pom.xml")) {
assertEquals("Unexpected diagnostics:\n" + diag.getDiagnostics(), 0, diag.getDiagnostics().size());
reset1 = true;
} else if (uri.endsWith("module2/pom.xml")) {
assertEquals("Unexpected diagnostics:\n" + diag.getDiagnostics(), 0, diag.getDiagnostics().size());
reset2 = true;
} else if (uri.endsWith("module3/pom.xml")) {//not a active module so was not updated. But this is actually a dubious behavior. Need to change that
assertEquals("Unexpected diagnostics:\n" + diag.getDiagnostics(), 1, diag.getDiagnostics().size());
reset3 = false;
}
}
assertTrue("childmodule/pom.xml diagnostics were not reset", reset1);
assertTrue("module2/pom.xml diagnostics were not reset", reset2);
assertFalse("module3/pom.xml diagnostics were reset", reset3);

}

private IMarker createMarker(int severity, String msg, int line, int start, int end) {
IMarker m = mock(IMarker.class);
when(m.exists()).thenReturn(true);
Expand Down