refactor and tests for deserializer

Author: jaydeluca

docs/instrumentation-list.yaml

@@ -991,14 +991,6 @@ libraries:
           type: STRING
         - name: user_agent.original
           type: STRING
-  - name: aws-lambda-events-3.11
-    source_path: instrumentation/aws-lambda/aws-lambda-events-3.11
-    scope:
-      name: io.opentelemetry.aws-lambda-events-3.11
-    target_versions:
-      library:
-      - com.amazonaws:aws-lambda-java-events:3.11.0
-      - com.amazonaws:aws-lambda-java-core:1.0.0
   - name: aws-sdk-1.11
     description: |
       This instrumentation covers the AWS SDK 1.11+ client library, enabling messaging and client spans and metrics for calls to AWS services including DynamoDB, EC2, Kinesis, Lambda, RDS, S3, secrets manager, SNS/SQS and step functions.

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/DocGeneratorApplication.java

@@ -49,7 +49,6 @@ public static void main(String[] args) throws IOException {
     printStats(modules);
   }
 
-  @SuppressWarnings("unused") // temporary helper method used for project tracking
   private static void printStats(List<InstrumentationModule> modules) {
     List<InstrumentationModule> metadata =
         modules.stream().filter(m -> m.getMetadata() != null).toList();

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/InstrumentationAnalyzer.java

@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.exc.MismatchedInputException;
 import com.fasterxml.jackson.databind.exc.ValueInstantiationException;
-import io.opentelemetry.instrumentation.docs.internal.InstrumentationMetaData;
+import io.opentelemetry.instrumentation.docs.internal.InstrumentationMetadata;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationModule;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationType;
 import io.opentelemetry.instrumentation.docs.parsers.GradleParser;
@@ -58,7 +58,7 @@ public List<InstrumentationModule> analyze() throws IOException {
   }
 
   private void enrichModule(InstrumentationModule module) throws IOException {
-    InstrumentationMetaData metaData = getMetadata(module);
+    InstrumentationMetadata metaData = getMetadata(module);
     if (metaData != null) {
       module.setMetadata(metaData);
     }
@@ -69,7 +69,7 @@ private void enrichModule(InstrumentationModule module) throws IOException {
   }
 
   @Nullable
-  private InstrumentationMetaData getMetadata(InstrumentationModule module)
+  private InstrumentationMetadata getMetadata(InstrumentationModule module)
       throws JsonProcessingException {
     String metadataFile = fileManager.getMetaDataFile(module.getSrcPath());
     if (metadataFile == null) {

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationMetaData.java renamed to instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationMetadata.java

@@ -17,7 +17,7 @@
  * Represents the data in a metadata.yaml file. This class is internal and is hence not for public
  * use. Its APIs are unstable and can change at any time.
  */
-public class InstrumentationMetaData {
+public class InstrumentationMetadata {
   @Nullable private String description;
 
   @JsonProperty("disabled_by_default")
@@ -28,11 +28,11 @@ public class InstrumentationMetaData {
 
   private List<ConfigurationOption> configurations = emptyList();
 
-  public InstrumentationMetaData() {
+  public InstrumentationMetadata() {
     this.classifications = singletonList(InstrumentationClassification.LIBRARY.name());
   }
 
-  public InstrumentationMetaData(
+  public InstrumentationMetadata(
       @Nullable String description,
       @Nullable List<String> classifications,
       @Nullable Boolean disabledByDefault,
@@ -54,7 +54,17 @@ public List<InstrumentationClassification> getClassifications() {
     if (classifications == null || classifications.isEmpty()) {
       return singletonList(InstrumentationClassification.LIBRARY);
     }
-    return classifications.stream().map(InstrumentationClassification::fromString).toList();
+    return classifications.stream()
+        .map(
+            classification -> {
+              InstrumentationClassification result =
+                  InstrumentationClassification.fromString(classification);
+              if (result == null) {
+                throw new IllegalArgumentException("Invalid classification: " + classification);
+              }
+              return result;
+            })
+        .toList();
   }
 
   public Boolean getDisabledByDefault() {

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationMetaDataDeserializer.java renamed to instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationMetadataDeserializer.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.docs.internal;
 
 import static java.util.Collections.emptyList;
+import static java.util.Collections.singletonList;
 import static java.util.Collections.unmodifiableList;
 
 import com.fasterxml.jackson.core.JsonParser;
@@ -15,19 +16,18 @@
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Locale;
 import java.util.Objects;
 import javax.annotation.Nullable;
 
 /**
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
  * any time.
  */
-public final class InstrumentationMetaDataDeserializer
-    extends JsonDeserializer<InstrumentationMetaData> {
+public final class InstrumentationMetadataDeserializer
+    extends JsonDeserializer<InstrumentationMetadata> {
 
   @Override
-  public InstrumentationMetaData deserialize(JsonParser p, DeserializationContext ctx)
+  public InstrumentationMetadata deserialize(JsonParser p, DeserializationContext ctx)
       throws IOException {
     JsonNode node = p.getCodec().readTree(p);
 
@@ -37,7 +37,7 @@ public InstrumentationMetaData deserialize(JsonParser p, DeserializationContext
     List<String> classifications = readClassifications(node.path("classification"));
     List<ConfigurationOption> configurations = readConfigurations(node.path("configurations"));
 
-    return new InstrumentationMetaData(
+    return new InstrumentationMetadata(
         description, classifications, disabledByDefault, configurations);
   }
 
@@ -55,46 +55,60 @@ private static Boolean boolOrNull(JsonNode parent, String field) {
 
   private static List<String> readClassifications(JsonNode node) {
     if (node.isMissingNode() || node.isNull()) {
-      return List.of(InstrumentationClassification.LIBRARY.name());
+      return singletonList(InstrumentationClassification.LIBRARY.name());
     }
-    List<String> out = new ArrayList<>();
-    if (node.isArray()) {
-      for (JsonNode c : node) {
-        if (c.isTextual()) {
-          out.add(c.asText());
-        }
+    if (!node.isArray()) {
+      throw new IllegalArgumentException("Classification must be an array");
+    }
+    List<String> result = new ArrayList<>();
+    for (JsonNode c : node) {
+      if (c.isTextual()) {
+        result.add(c.asText());
       }
-    } else if (node.isTextual()) {
-      out.add(node.asText());
     }
-    if (out.isEmpty()) {
-      out.add(InstrumentationClassification.LIBRARY.name());
+    if (result.isEmpty()) {
+      result.add(InstrumentationClassification.LIBRARY.name());
     }
-    return unmodifiableList(out);
+    return unmodifiableList(result);
   }
 
   private static List<ConfigurationOption> readConfigurations(JsonNode configs) {
-    if (!configs.isArray()) {
+    if (!configs.isArray() || configs.size() == 0) {
       return emptyList();
     }
-    List<ConfigurationOption> out = new ArrayList<>(configs.size());
-    int i = 0;
+    List<ConfigurationOption> configurationOptions = new ArrayList<>(configs.size());
     for (JsonNode cfg : configs) {
-      String name = Objects.requireNonNull(textOrNull(cfg, "name"));
-      String desc = Objects.requireNonNull(textOrNull(cfg, "description"));
-      String def = Objects.requireNonNull(textOrNull(cfg, "default"));
-      String typeStr = Objects.requireNonNull(textOrNull(cfg, "type"));
+      if (cfg.isNull() || !cfg.isObject()) {
+        throw new IllegalArgumentException("Configuration entry must be an object");
+      }
+
+      String name = textOrNull(cfg, "name");
+      if (name == null) {
+        throw new IllegalArgumentException("Configuration entry is missing required 'name' field");
+      }
+
+      String desc =
+          Objects.requireNonNull(
+              textOrNull(cfg, "description"),
+              "Configuration '" + name + "' is missing required 'description' field");
+      String def =
+          Objects.requireNonNull(
+              textOrNull(cfg, "default"),
+              "Configuration '" + name + "' is missing required 'default' field");
+      String typeStr =
+          Objects.requireNonNull(
+              textOrNull(cfg, "type"),
+              "Configuration '" + name + "' is missing required 'type' field");
 
       ConfigurationType type;
       try {
-        type = ConfigurationType.valueOf(typeStr.toUpperCase(Locale.ROOT));
+        type = ConfigurationType.from(typeStr);
       } catch (IllegalArgumentException ex) {
         throw new IllegalArgumentException(
-            "configurations[" + i + "].type invalid: '" + typeStr + "'", ex);
+            "Configuration '" + name + "' has invalid type: '" + typeStr + "'", ex);
       }
-      out.add(new ConfigurationOption(name, desc, def, type));
-      i++;
+      configurationOptions.add(new ConfigurationOption(name, desc, def, type));
     }
-    return unmodifiableList(out);
+    return unmodifiableList(configurationOptions);
   }
 }

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationModule.java

@@ -35,7 +35,7 @@ public class InstrumentationModule {
 
   @Nullable private Integer minJavaVersion;
 
-  @Nullable private InstrumentationMetaData metadata;
+  @Nullable private InstrumentationMetadata metadata;
 
   /**
    * This class is internal and is hence not for public use. Its APIs are unstable and can change at
@@ -79,9 +79,9 @@ public InstrumentationScopeInfo getScopeInfo() {
     return scopeInfo;
   }
 
-  public InstrumentationMetaData getMetadata() {
+  public InstrumentationMetadata getMetadata() {
     if (metadata == null) {
-      metadata = new InstrumentationMetaData();
+      metadata = new InstrumentationMetadata();
     }
 
     return metadata;
@@ -109,7 +109,7 @@ public void setTargetVersions(Map<InstrumentationType, Set<String>> targetVersio
     this.targetVersions = targetVersions;
   }
 
-  public void setMetadata(InstrumentationMetaData metadata) {
+  public void setMetadata(InstrumentationMetadata metadata) {
     this.metadata = metadata;
   }
 
@@ -135,7 +135,7 @@ public static class Builder {
     @Nullable private String namespace;
     @Nullable private String group;
     @Nullable private Integer minJavaVersion;
-    @Nullable private InstrumentationMetaData metadata;
+    @Nullable private InstrumentationMetadata metadata;
     @Nullable private Map<InstrumentationType, Set<String>> targetVersions;
     @Nullable private Map<String, List<EmittedMetrics.Metric>> metrics;
     @Nullable private Map<String, List<EmittedSpans.Span>> spans;
@@ -171,7 +171,7 @@ public Builder group(String group) {
     }
 
     @CanIgnoreReturnValue
-    public Builder metadata(InstrumentationMetaData metadata) {
+    public Builder metadata(InstrumentationMetadata metadata) {
       this.metadata = metadata;
       return this;
     }

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

@@ -14,8 +14,8 @@
 import io.opentelemetry.instrumentation.docs.internal.EmittedMetrics;
 import io.opentelemetry.instrumentation.docs.internal.EmittedSpans;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationClassification;
-import io.opentelemetry.instrumentation.docs.internal.InstrumentationMetaData;
-import io.opentelemetry.instrumentation.docs.internal.InstrumentationMetaDataDeserializer;
+import io.opentelemetry.instrumentation.docs.internal.InstrumentationMetadata;
+import io.opentelemetry.instrumentation.docs.internal.InstrumentationMetadataDeserializer;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationModule;
 import io.opentelemetry.instrumentation.docs.internal.TelemetryAttribute;
 import java.io.BufferedWriter;
@@ -47,7 +47,7 @@ public class YamlHelper {
     mapper = new ObjectMapper(new YAMLFactory());
     SimpleModule module = new SimpleModule();
     module.addDeserializer(
-        InstrumentationMetaData.class, new InstrumentationMetaDataDeserializer());
+        InstrumentationMetadata.class, new InstrumentationMetadataDeserializer());
     mapper.registerModule(module);
   }
 
@@ -311,9 +311,9 @@ private static Map<String, Object> getSpanMap(EmittedSpans.Span span) {
     return innerMetricMap;
   }
 
-  public static InstrumentationMetaData metaDataParser(String input)
+  public static InstrumentationMetadata metaDataParser(String input)
       throws JsonProcessingException {
-    return mapper.readValue(input, InstrumentationMetaData.class);
+    return mapper.readValue(input, InstrumentationMetadata.class);
   }
 
   public static EmittedMetrics emittedMetricsParser(String input) throws JsonProcessingException {