ToolInformation - Equals, HashCode, and multi-tool parsing fixes w/tests

src/main/java/org/cyclonedx/model/metadata/ToolInformation.java

@@ -1,6 +1,7 @@
 package org.cyclonedx.model.metadata;
 
 import java.util.List;
+import java.util.Objects;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import org.cyclonedx.model.Component;
@@ -28,4 +29,18 @@ public List<Service> getServices() {
   public void setServices(final List<Service> services) {
     this.services = services;
   }
+
+  @Override
+  public int hashCode() {
+      return Objects.hash(components, services);
+  }
+
+  @Override
+  public boolean equals(Object o) {
+      if (this == o) return true;
+      if (o == null || getClass() != o.getClass()) return false;
+      ToolInformation other = (ToolInformation) o;
+      return Objects.equals(components, other.components) &&
+              Objects.equals(services, other.services);
+  }
 }

src/main/java/org/cyclonedx/util/deserializer/MetadataDeserializer.java

@@ -140,6 +140,13 @@ private void parseComponents(JsonNode componentsNode, ToolInformation toolInform
         List<Component> components = mapper.convertValue(componentsNode, new TypeReference<List<Component>>() {});
         toolInformation.setComponents(components);
       } else if (componentsNode.isObject()) {
+        if (componentsNode.has("component")) {
+          JsonNode componentNode = componentsNode.get("component");
+          if (componentNode.isArray()) {
+            parseComponents(componentNode, toolInformation);
+            return;
+          }
+        }
         Component component = mapper.convertValue(componentsNode, Component.class);
         toolInformation.setComponents(Collections.singletonList(component));
       }
@@ -152,6 +159,13 @@ private void parseServices(JsonNode servicesNode, ToolInformation toolInformatio
         List<Service> services = mapper.convertValue(servicesNode, new TypeReference<List<Service>>() {});
         toolInformation.setServices(services);
       } else if (servicesNode.isObject()) {
+        if (servicesNode.has("service")) {
+          JsonNode serviceNode = servicesNode.get("service");
+          if (serviceNode.isArray()) {
+            parseServices(serviceNode, toolInformation);
+            return;
+          }
+        }
         Service service = mapper.convertValue(servicesNode, Service.class);
         toolInformation.setServices(Collections.singletonList(service));
       }

src/main/java/org/cyclonedx/util/serializer/MetadataSerializer.java

@@ -150,14 +150,13 @@ private <T> void writeArrayFieldJSON(JsonGenerator jsonGenerator, String fieldNa
 
   private <T> void writeArrayFieldXML(List<T> items, ToXmlGenerator xmlGenerator, String fieldName) throws IOException {
     if (items != null) {
-      xmlGenerator.writeFieldName(fieldName + "s");
-      xmlGenerator.writeStartArray();
+      xmlGenerator.writeObjectFieldStart(fieldName + "s");
+      xmlGenerator.writeArrayFieldStart(fieldName);
       for (T item : items) {
-        xmlGenerator.writeStartObject();
-        xmlGenerator.writeObjectField(fieldName, item);
-        xmlGenerator.writeEndObject();
+        xmlGenerator.writeObject(item);
       }
       xmlGenerator.writeEndArray();
+      xmlGenerator.writeEndObject();
     }
   }
 

src/test/java/org/cyclonedx/BomXmlGeneratorTest.java

@@ -27,6 +27,8 @@
 import org.cyclonedx.model.ExternalReference;
 import org.cyclonedx.model.License;
 import org.cyclonedx.model.LicenseChoice;
+import org.cyclonedx.model.Metadata;
+import org.cyclonedx.model.metadata.ToolInformation;
 import org.cyclonedx.parsers.JsonParser;
 import org.cyclonedx.parsers.XmlParser;
 import org.junit.jupiter.api.AfterEach;
@@ -41,6 +43,9 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+
 import javax.xml.XMLConstants;
 import javax.xml.transform.OutputKeys;
 import javax.xml.transform.Transformer;
@@ -375,4 +380,29 @@ private String documentToString(Document doc) {
             return null;
         }
     }
+
+    @Test
+    public void toolInformationSerialization() throws Exception {
+        final Component toolA = new Component();
+        toolA.setName("Tool-A");
+        toolA.setType(Component.Type.APPLICATION);
+        toolA.setVersion("1.0.0");
+        final Component toolB = new Component();
+        toolB.setName("Tool-B");
+        toolB.setVersion("2.0.0");
+
+        final Bom bom = new Bom();
+        final Metadata metadata = new Metadata();
+        final ToolInformation toolInformation = new ToolInformation();
+        toolInformation.setComponents(Arrays.asList(toolA, toolB));
+        metadata.setToolChoice(toolInformation);
+        bom.setMetadata(metadata);
+        bom.addComponent(toolA);
+
+        final BomXmlGenerator generator = BomGeneratorFactory.createXml(CycloneDxSchema.Version.VERSION_15, bom);
+        testDocument(generator.generate());
+
+        final Bom actual = new XmlParser().parse(writeToFile(generator.toXmlString()));
+        assertEquals(toolInformation, actual.getMetadata().getToolChoice());
+    }
 }

src/test/resources/1.5/valid-metadata-tools-1.5.json

@@ -0,0 +1,67 @@
+{
+  "bomFormat": "CycloneDX",
+  "specVersion": "1.5",
+  "serialNumber": "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79",
+  "version": 1,
+  "metadata": {
+    "tools": {
+      "components": [
+        {
+          "type": "application",
+          "group": "Awesome Vendor",
+          "name": "Awesome Tool",
+          "version": "9.1.2",
+          "hashes": [
+            {
+              "alg": "SHA-1",
+              "content": "25ed8e31b995bb927966616df2a42b979a2717f0"
+            },
+            {
+              "alg": "SHA-256",
+              "content": "a74f733635a19aefb1f73e5947cef59cd7440c6952ef0f03d09d974274cbd6df"
+            }
+          ]
+        },
+        {
+          "type": "application",
+          "group": "Awesome Vendor2",
+          "name": "Awesome Tool2",
+          "version": "7.4.0"
+        }
+      ],
+      "services": [
+        {
+          "provider": {
+            "name": "Acme Org",
+            "url": [
+              "https://example.com"
+            ]
+          },
+          "group": "com.example",
+          "name": "Acme Signing Server",
+          "description": "Signs artifacts",
+          "endpoints": [
+            "https://example.com/sign",
+            "https://example.com/verify",
+            "https://example.com/tsa"
+          ]
+        },
+        {
+          "provider": {
+            "name": "Example Org",
+            "url": [
+              "https://example.com"
+            ]
+          },
+          "group": "com.example",
+          "name": "Some service",
+          "description": "Provides services",
+          "endpoints": [
+            "https://example.com/whatever"
+          ]
+        }
+      ]
+    }
+  },
+  "components": []
+}

src/test/resources/1.5/valid-metadata-tools-1.5.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0"?>
+<bom serialNumber="urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79" version="1" xmlns="http://cyclonedx.org/schema/bom/1.5">
+    <metadata>
+        <tools>
+            <components>
+                <component type="application">
+                    <group>Awesome Vendor</group>
+                    <name>Awesome Tool</name>
+                    <version>9.1.2</version>
+                    <hashes>
+                        <hash alg="SHA-1">25ed8e31b995bb927966616df2a42b979a2717f0</hash>
+                        <hash alg="SHA-256">a74f733635a19aefb1f73e5947cef59cd7440c6952ef0f03d09d974274cbd6df</hash>
+                    </hashes>
+                </component>
+                <component type="application">
+                    <group>Awesome Vendor2</group>
+                    <name>Awesome Tool2</name>
+                    <version>7.4.0</version>
+                </component>
+            </components>
+            <services>
+                <service>
+                    <provider>
+                        <name>Acme Org</name>
+                        <url>https://example.com</url>
+                    </provider>
+                    <group>com.example</group>
+                    <name>Acme Signing Server</name>
+                    <description>Signs artifacts</description>
+                    <endpoints>
+                        <endpoint>https://example.com/sign</endpoint>
+                        <endpoint>https://example.com/verify</endpoint>
+                        <endpoint>https://example.com/tsa</endpoint>
+                    </endpoints>
+                </service>
+                <service>
+                    <provider>
+                        <name>Example Org</name>
+                        <url>https://example.com</url>
+                    </provider>
+                    <group>com.example</group>
+                    <name>Some service</name>
+                    <description>Provides services</description>
+                    <endpoints>
+                        <endpoint>https://example.com/whatever</endpoint>
+                    </endpoints>
+                </service>
+            </services>
+        </tools>
+    </metadata>
+    <components />
+</bom>