GH-1650: parse yml property files as well when scanning for web config information

Author: martinlippert

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/requestmapping/WebConfigCodeLensProvider.java

@@ -11,9 +11,13 @@
 package org.springframework.ide.vscode.boot.java.requestmapping;
 
 import java.io.File;
+import java.io.FileInputStream;
 import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.Reader;
 import java.nio.charset.Charset;
 import java.nio.file.Path;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -48,9 +52,18 @@
 import org.springframework.ide.vscode.commons.languageserver.java.JavaProjectFinder;
 import org.springframework.ide.vscode.commons.util.BadLocationException;
 import org.springframework.ide.vscode.commons.util.text.TextDocument;
+import org.springframework.ide.vscode.commons.yaml.ast.NodeUtil;
 import org.springframework.ide.vscode.java.properties.antlr.parser.AntlrParser;
 import org.springframework.ide.vscode.java.properties.parser.ParseResults;
 import org.springframework.ide.vscode.java.properties.parser.Parser;
+import org.yaml.snakeyaml.LoaderOptions;
+import org.yaml.snakeyaml.Yaml;
+import org.yaml.snakeyaml.constructor.SafeConstructor;
+import org.yaml.snakeyaml.nodes.MappingNode;
+import org.yaml.snakeyaml.nodes.Node;
+import org.yaml.snakeyaml.nodes.NodeTuple;
+import org.yaml.snakeyaml.nodes.ScalarNode;
+import org.yaml.snakeyaml.nodes.SequenceNode;
 
 public class WebConfigCodeLensProvider implements CodeLensProvider {
 
@@ -215,9 +228,63 @@ private Stream<PropertyKeyValue> getPropertiesFromPropertiesFile(File file) {
 	}
 
 	private Stream<PropertyKeyValue> getPropertiesFromYamlFile(File file) {
+		if (file.isFile()) {
+			Yaml yaml = new Yaml(new SafeConstructor(new LoaderOptions()));
+
+			try (Reader reader = new InputStreamReader(new FileInputStream(file), "UTF8")) {
+
+				List<PropertyKeyValue> result = new ArrayList<>();
+				for (Node node : yaml.composeAll(reader)) {
+					flattenProperties("", node, result);
+				}
+
+				return result.stream();
+			} catch (Exception e ) {
+				//ignore failed attempt to read bad file
+			}
+		}
 		return Stream.empty();
+	}
+
+	private void flattenProperties(String prefix, Node node, List<PropertyKeyValue> props) {
+		switch (node.getNodeId()) {
 
-		// TODO !!!
+		case mapping:
+			if (!prefix.isEmpty()) {
+				prefix = prefix + ".";
+			}
+			MappingNode mapping = (MappingNode)node;
+			for (NodeTuple tup : mapping.getValue()) {
+				String key = NodeUtil.asScalar(tup.getKeyNode());
+				if (key != null) {
+					flattenProperties(prefix + key, tup.getValueNode(), props);
+				}
+			}
+			break;
+			
+		case scalar:
+			//End of the line.
+			props.add(new PropertyKeyValue(prefix, NodeUtil.asScalar(node)));
+			break;
+		
+		case sequence:
+			SequenceNode sequenceNode = (SequenceNode) node;
+			List<String> values = sequenceNode.getValue().stream()
+					.filter(valueNode -> valueNode instanceof ScalarNode)
+					.map(scalarNode -> NodeUtil.asScalar(scalarNode))
+					.toList();
+			
+			props.add(new PropertyKeyValue(prefix, String.join(", ", values)));
+			
+			break;
+			
+		default:
+			if (!prefix.isEmpty()) {
+				props.add(new PropertyKeyValue(prefix, "<object>"));
+			}
+
+			break;
+		}
 	}
 
 	record PropertyKeyValue (String key, String value) {}

headless-services/spring-boot-language-server/src/test/java/org/springframework/ide/vscode/boot/java/requestmapping/test/WebConfigCodeLensProviderTest.java

@@ -10,7 +10,6 @@
  *******************************************************************************/
 package org.springframework.ide.vscode.boot.java.requestmapping.test;
 
-import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
 import java.nio.charset.StandardCharsets;
@@ -71,18 +70,35 @@ public void setup() throws Exception {
 	}
 
 	@Test
-	void codeLensOverMethod() throws Exception {		
+	void codeLensOverMethodFromWebConfig() throws Exception {		
 		Path filePath = Paths.get(testProject.getLocationUri())
 				.resolve("src/main/java/org/test/versions/MappingClassWithMultipleVersions.java");
 		Editor editor = harness.newEditor(LanguageId.JAVA, new String(Files.readAllBytes(filePath), StandardCharsets.UTF_8), filePath.toUri().toASCIIString());
 
 		List<CodeLens> cls = editor.getCodeLenses("MappingClassWithMultipleVersions", 1);
-		assertEquals(2, cls.size());
-		
 		assertTrue(contains(cls, "Web Config - Path Prefix: /{version} - Versioning via Request Header: X-API-Version, Path Segment: 0 - Supported Versions: 1.1, 1.2"));
+	}
+	
+	@Test
+	void codeLensOverMethodFromProperties() throws Exception {		
+		Path filePath = Paths.get(testProject.getLocationUri())
+				.resolve("src/main/java/org/test/versions/MappingClassWithMultipleVersions.java");
+		Editor editor = harness.newEditor(LanguageId.JAVA, new String(Files.readAllBytes(filePath), StandardCharsets.UTF_8), filePath.toUri().toASCIIString());
+		
+		List<CodeLens> cls = editor.getCodeLenses("MappingClassWithMultipleVersions", 1);
 		assertTrue(contains(cls, "Properties Config - Versioning via Request Header: X-API-Version - Supported Versions: 1"));
 	}
 
+	@Test
+	void codeLensOverMethodFromPropertiesYaml() throws Exception {		
+		Path filePath = Paths.get(testProject.getLocationUri())
+				.resolve("src/main/java/org/test/versions/MappingClassWithMultipleVersions.java");
+		Editor editor = harness.newEditor(LanguageId.JAVA, new String(Files.readAllBytes(filePath), StandardCharsets.UTF_8), filePath.toUri().toASCIIString());
+		
+		List<CodeLens> cls = editor.getCodeLenses("MappingClassWithMultipleVersions", 1);
+		assertTrue(contains(cls, "Properties Config - Versioning via Path Segment: 3, Request Header: X-API-HEADER-VIA-YML - Supported Versions: 2, 3"));
+	}
+	
 	private boolean contains(List<CodeLens> cls, String title) {
 		return cls.stream().filter(cl -> cl.getCommand().getTitle().equals(title)).findAny().isPresent();
 	}

headless-services/spring-boot-language-server/src/test/resources/test-projects/test-web-config-support/src/main/resources/application.yml

@@ -0,0 +1,9 @@
+spring:
+  mvc:
+    apiversion:
+      use:
+        path-segment: 3
+        header: X-API-HEADER-VIA-YML
+      supported:
+      - 2
+      - 3