Track instrumentation metadata.yaml files as inputs of :instrumentation-docs:test (open-telemetry#18225)

Author: trask

instrumentation-docs/build.gradle.kts

@@ -18,6 +18,21 @@ dependencies {
 }
 
 tasks {
+  test {
+    // DeclarativeConfigValidationTest walks ../instrumentation for metadata.yaml files,
+    // so changes to those files must invalidate this task's build cache entry.
+    // Eagerly resolve to a concrete file list (rather than passing a FileTree rooted at
+    // the instrumentation directory) to avoid Gradle's implicit-dependency validation
+    // flagging overlap with sibling subprojects' build/ output directories.
+    val metadataYamlFiles = fileTree(rootDir.resolve("instrumentation")) {
+      include("**/metadata.yaml")
+      exclude("**/build/**")
+    }.files
+    inputs.files(metadataYamlFiles)
+      .withPropertyName("instrumentationMetadataYamlFiles")
+      .withPathSensitivity(PathSensitivity.RELATIVE)
+  }
+
   val runAnalysis by registering(JavaExec::class) {
     dependsOn(classes)
 

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/utils/FileManager.java

@@ -38,9 +38,10 @@ private static InstrumentationPath parseInstrumentationPath(String filePath) {
       return null;
     }
 
+    String normalized = normalizeSeparators(filePath);
     String instrumentationSegment = "/instrumentation/";
-    int startIndex = filePath.indexOf(instrumentationSegment) + instrumentationSegment.length();
-    String[] parts = filePath.substring(startIndex).split("/");
+    int startIndex = normalized.indexOf(instrumentationSegment) + instrumentationSegment.length();
+    String[] parts = normalized.substring(startIndex).split("/");
 
     if (parts.length < 2) {
       return null;
@@ -58,23 +59,28 @@ public static boolean isValidInstrumentationPath(String filePath) {
     if (filePath == null || filePath.isEmpty()) {
       return false;
     }
+    String normalized = normalizeSeparators(filePath);
     String instrumentationSegment = "instrumentation/";
 
-    if (!filePath.contains(instrumentationSegment)) {
+    if (!normalized.contains(instrumentationSegment)) {
       return false;
     }
 
-    int javaagentCount = filePath.split("/javaagent", -1).length - 1;
+    int javaagentCount = normalized.split("/javaagent", -1).length - 1;
     if (javaagentCount > 1) {
       return false;
     }
 
-    if (filePath.matches(
+    if (normalized.matches(
         ".*(/test/|/testing|/build/|-common/|-common-|common-|/compile-stub/|-testing|bootstrap/src).*")) {
       return false;
     }
 
-    return filePath.endsWith("javaagent") || filePath.endsWith("library");
+    return normalized.endsWith("javaagent") || normalized.endsWith("library");
+  }
+
+  private static String normalizeSeparators(String filePath) {
+    return filePath.replace('\\', '/');
   }
 
   public List<String> findBuildGradleFiles(String instrumentationDirectory) {
@@ -85,7 +91,7 @@ public List<String> findBuildGradleFiles(String instrumentationDirectory) {
           .filter(
               path ->
                   path.getFileName().toString().equals("build.gradle.kts")
-                      && !path.toString().contains("/testing/")
+                      && !normalizeSeparators(path.toString()).contains("/testing/")
                       && !isInNestedInstrumentationModule(path, rootPath))
           .map(Path::toString)
           .collect(toList());
@@ -105,13 +111,11 @@ public List<String> findBuildGradleFiles(String instrumentationDirectory) {
    */
   private static boolean isInNestedInstrumentationModule(Path filePath, Path rootPath) {
     Path relativePath = rootPath.relativize(filePath);
-    String relativeStr = relativePath.toString();
-
-    String[] segments = relativeStr.split("/");
 
     // Find the first javaagent or library segment
-    for (int i = 0; i < segments.length; i++) {
-      if (segments[i].equals("javaagent") || segments[i].equals("library")) {
+    for (int i = 0; i < relativePath.getNameCount(); i++) {
+      String segment = relativePath.getName(i).toString();
+      if (segment.equals("javaagent") || segment.equals("library")) {
         // If javaagent/library is not the first segment, it's a nested module
         return i > 0;
       }

instrumentation/r2dbc-1.0/metadata.yaml

@@ -29,7 +29,6 @@ configurations:
     type: boolean
     default: false
   - name: otel.instrumentation.common.peer-service-mapping
-    declarative_name: java.common.service_peer_mapping
     description: Used to specify a mapping from host names or IP addresses to peer services.
     type: map
     default: ""