Sort packages, files, and relationship arrays

Fixes #83

Author: goneall

src/main/java/org/spdx/jacksonstore/JacksonSerializer.java

@@ -28,6 +28,8 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -268,14 +270,17 @@ public ObjectNode docToJsonNode(String documentUri) throws InvalidSPDXAnalysisEx
 			doc.put(SpdxConstantsCompatV2.PROP_DOCUMENT_NAMESPACE.getName(), documentUri);
 			ArrayNode packages = getDocElements(documentUri, SpdxConstantsCompatV2.CLASS_SPDX_PACKAGE, relationships);
 			if (!packages.isEmpty()) {
+				sortArrayNode(packages);
 				doc.set(SpdxConstantsCompatV2.PROP_DOCUMENT_PACKAGES.getName(), packages);
 			}
 			ArrayNode files = getDocElements(documentUri, SpdxConstantsCompatV2.CLASS_SPDX_FILE, relationships);
 			if (!files.isEmpty()) {
+				sortArrayNode(files);
 				doc.set(SpdxConstantsCompatV2.PROP_DOCUMENT_FILES.getName(), files);
 			}
 			ArrayNode snippets = getDocElements(documentUri, SpdxConstantsCompatV2.CLASS_SPDX_SNIPPET, relationships);
 			if (!snippets.isEmpty()) {
+				sortArrayNode(snippets);
 				doc.set(SpdxConstantsCompatV2.PROP_DOCUMENT_SNIPPETS.getName(), snippets);
 			}
 			//Remove duplicate relationships
@@ -302,7 +307,7 @@ public ObjectNode docToJsonNode(String documentUri) throws InvalidSPDXAnalysisEx
 					relatedIds.add(relatedID);
 				}
 			}
-			
+			sortArrayNode(deDupedRelationships);
 
 			doc.set(SpdxConstantsCompatV2.PROP_DOCUMENT_RELATIONSHIPS.getName(), deDupedRelationships);
 			ObjectNode output;
@@ -326,6 +331,16 @@ public ObjectNode docToJsonNode(String documentUri) throws InvalidSPDXAnalysisEx
 		}
 	}
 
+	/**
+	 * Sorts the elements of an ArrayNode in place
+	 * @param an ArrayNode to sort
+	 */
+	private void sortArrayNode(ArrayNode an) {
+		List<JsonNode> arrayElements = StreamSupport.stream(an.spliterator(), false).sorted(NODE_COMPARATOR).collect(Collectors.toList());
+		an.removeAll();
+		an.addAll(arrayElements);
+    }
+
 	/**
 	 * Convert a typed value into an ObjectNode adding all stored properties
 	 * @param documentUri Document namespace or Uri

src/test/java/org/spdx/jacksonstore/MultiFormatStoreTest.java

@@ -92,7 +92,8 @@ public class MultiFormatStoreTest extends TestCase {
 	static final String JSON_NO_HAS_FILES_FILE_PATH = "testResources" + File.separator + "noHasFilesDescribes.json";
 	static final String XML_1REL_FILE_PATH = "testResources" + File.separator + "SPDXXML-SingleRel-v2.3.spdx.xml";
 	static final String JSON_SCHEMA_V2_3 = "testResources" + File.separator + "spdx-schema.json";
-	
+	static final String UNSORTED_JSON = "testResources" + File.separator + "SPDXJSONUnsortedIds.json";
+
 	/* (non-Javadoc)
 	 * @see junit.framework.TestCase#setUp()
 	 */
@@ -720,4 +721,41 @@ private List<String> getDocUris(ISerializableModelStore resultStore) throws Inva
 			.map(tv -> tv.getObjectUri().substring(0, tv.getObjectUri().indexOf('#')))
 			.collect(Collectors.toList());
 	}
+
+	public void testSortOrder() throws InvalidSPDXAnalysisException, IOException, SpdxCompareException, ProcessingException {
+		File jsonFile = new File(UNSORTED_JSON);
+		MultiFormatStore inputStore = new MultiFormatStore(new InMemSpdxStore(), Format.JSON_PRETTY);
+		try (InputStream input = new FileInputStream(jsonFile)) {
+			inputStore.deSerialize(input, false);
+		}
+		Path tempDirPath = Files.createTempDirectory("mfsTestunsorted");
+		File serFile = tempDirPath.resolve("testspdx.json").toFile();
+		assertTrue(serFile.createNewFile());
+		try {
+			try (OutputStream stream = new FileOutputStream(serFile)) {
+				inputStore.serialize(stream);
+			}
+			ISerializableModelStore resultStore = new MultiFormatStore(new InMemSpdxStore(), MultiFormatStore.Format.JSON);
+			try (InputStream inStream = new FileInputStream(serFile)) {
+				JsonNode root = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT).readTree(inStream);
+				String previousId = "SPDXRef-Package-0";
+				for (JsonNode pkgNode : root.get("packages")) {
+					String spdxId = pkgNode.get("SPDXID").asText();
+					assertTrue(previousId.compareTo(spdxId) < 0);
+					previousId = spdxId;
+				}
+				previousId = "SPDXRef-File-0";
+				for (JsonNode pkgNode : root.get("files")) {
+					String spdxId = pkgNode.get("SPDXID").asText();
+					assertTrue(previousId.compareTo(spdxId) < 0);
+					previousId = spdxId;
+				}
+			}
+		} finally {
+			if (serFile.exists()) {
+				serFile.delete();
+			}
+			tempDirPath.toFile().delete();
+		}
+	}
 }