Provided dependencies from imported BOM are not correctly calculated …

…on hover #347 A fix for the case with the version defined with property variable in parent pom.xml and JUnit test case
eclipse-lemminx · Feb 2, 2023 · b1aa67c · b1aa67c
1 parent dd3fe65
commit b1aa67c
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 34 deletions.
diff --git a/...n/java/org/eclipse/lemminx/extensions/maven/participants/hover/MavenHoverParticipant.java b/...n/java/org/eclipse/lemminx/extensions/maven/participants/hover/MavenHoverParticipant.java
@@ -201,8 +201,9 @@ private String getManagedVersionText(IHoverRequest request) {
 			for (DOMElement e : elements) {
 				Optional<String> version = DOMUtils.findChildElementText(e, VERSION_ELT);
 				if (version.isPresent()) {
+					Dependency d = ParticipantUtils.getArtifactToSearch(parentMavenProject, e);
 					String sourceModelId = parentMavenProject.getGroupId() + ':' + parentMavenProject.getArtifactId() + ':' + parentMavenProject.getVersion();
-					return createVersionMessage(request.canSupportMarkupKind(MarkupKind.MARKDOWN), version.get(), sourceModelId, parentPomFile.toURI().toString());
+					return createVersionMessage(request.canSupportMarkupKind(MarkupKind.MARKDOWN), d.getVersion(), sourceModelId, parentPomFile.toURI().toString());
 				}
 			}
 

diff --git a/...java/org/eclipse/lemminx/extensions/maven/participants/hover/ManagedVersionHoverTest.java b/...java/org/eclipse/lemminx/extensions/maven/participants/hover/ManagedVersionHoverTest.java
@@ -123,8 +123,8 @@ void testManagedVersionHoverInDependencyGrandchild() throws IOException, URISynt
     @Timeout(90000)
     void testManagedVersionHoverForBomProvidedDependency() throws IOException, URISyntaxException {
         System.out.println(">>> testManagedVersionHoverForBomProvidedDependency");
-        DOMDocument document = createDOMDocument("/pom-bom-defined-dependency-version.xml", languageService);
-        Position position = new Position(25, 20);
+        DOMDocument document = createDOMDocument("/eclipse-bom-tester/pom.xml", languageService);
+        Position position = new Position(26, 30);
 
         // Find Definition links
 		List<? extends LocationLink> definitions = languageService.findDefinition(document, position, ()->{});
@@ -140,14 +140,40 @@ void testManagedVersionHoverForBomProvidedDependency() throws IOException, URISy
         assertTrue(value.contains("8.0.0"));
         assertTrue(value.contains("The artifact is managed in"));
         assertTrue(value.contains("jakarta.platform:jakarta.jakartaee-api:8.0.0"));
+        assertTrue(value.contains("jakarta.jakartaee-api-8.0.0.pom"));
 
         // Compare the links from definition and hover
 		assertTrue(definitions.stream().map(LocationLink::getTargetUri)
 				.anyMatch(uri -> value.replace('\\', '/').contains(uri.substring("file:/".length()))));
         System.out.println("<<< testManagedVersionHoverForBomProvidedDependency");
     }
 
-	// Enable MARKDOWN format
+    @Test
+    @Timeout(90000)
+    void testManagedVersionHoverForBomProvidedDependencyWithProperty() throws IOException, URISyntaxException {
+        System.out.println(">>> testManagedVersionHoverForBomProvidedDependencyWithProperty");
+        DOMDocument document = createDOMDocument("/eclipse-bom-tester/pom.xml", languageService);
+        Position position = new Position(32, 30);
+
+        // Find Definition links
+		List<? extends LocationLink> definitions = languageService.findDefinition(document, position, ()->{});
+		definitions.stream().map(LocationLink::getTargetUri).forEach(u -> System.out.println("Definition Link: " + u));
+		assertTrue(definitions.stream().map(LocationLink::getTargetUri).anyMatch(uri -> uri.endsWith("commons-lang3-3.12.0.pom")));
+
+        // Find Hover with managed version
+        Hover hover = languageService.doHover(document, position, createSharedSettings());
+        final String value = hover.getContents().getRight().getValue();
+        System.out.println("Hover Text: [" + value + "]");
+        assertNotNull(value);
+        assertTrue(value.contains("The managed version is"));
+        assertTrue(value.contains("3.12.0"));
+        assertTrue(value.contains("The artifact is managed in"));
+        assertTrue(value.contains("org.eclipse.test:bom-import-parent:1.0.0"));
+        assertTrue(value.contains("eclipse-bom-tester/parent/pom.xml"));
+        System.out.println("<<< testManagedVersionHoverForBomProvidedDependencyWithProperty");
+    }
+
+    // Enable MARKDOWN format
 	private static SharedSettings createSharedSettings() {
 		HoverCapabilities hoverCapabilities = new HoverCapabilities();
 		hoverCapabilities.setContentFormat(Arrays.asList(MarkupKind.MARKDOWN));

diff --git a/lemminx-maven/src/test/resources/eclipse-bom-tester/parent/pom.xml b/lemminx-maven/src/test/resources/eclipse-bom-tester/parent/pom.xml
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>org.eclipse.test</groupId>
+    <artifactId>bom-import-parent</artifactId>
+    <version>1.0.0</version>
+
+    <inceptionYear>2023</inceptionYear>
+
+    <packaging>pom</packaging>
+
+    <properties>
+        <payara-version>5.2022.3</payara-version>
+        <commons-lang3-version>3.12.0</commons-lang3-version>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+
+            <dependency>
+                <groupId>fish.payara.api</groupId>
+                <artifactId>payara-bom</artifactId>
+                <version>${payara-version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+
+            <dependency>
+                <groupId>org.apache.commons</groupId>
+                <artifactId>commons-lang3</artifactId>
+                <version>${commons-lang3-version}</version>
+            </dependency>
+
+        </dependencies>
+    </dependencyManagement>
+
+</project>
diff --git a/lemminx-maven/src/test/resources/eclipse-bom-tester/pom.xml b/lemminx-maven/src/test/resources/eclipse-bom-tester/pom.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>org.eclipse.test</groupId>
+        <artifactId>bom-import-parent</artifactId>
+        <version>1.0.0</version>
+        <relativePath>parent/pom.xml</relativePath>
+    </parent>
+
+    <artifactId>bom-import-child</artifactId>
+
+    <inceptionYear>2023</inceptionYear>
+
+    <packaging>pom</packaging>
+
+
+    <dependencies>
+
+        <dependency>
+            <groupId>jakarta.platform</groupId>
+            <artifactId>jakarta.jakartaee-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+        </dependency>
+
+    </dependencies>
+
+</project>
diff --git a/lemminx-maven/src/test/resources/pom-bom-defined-dependency-version.xml b/lemminx-maven/src/test/resources/pom-bom-defined-dependency-version.xml