Merge pull request #231 from kit-data-manager/fix-#226-allow-arrays-of-literals-as-property-values

Pfeil · web-flow · commit ea55acade31e · 2025-03-14T15:11:36.000+01:00
Fix #226 allow arrays of literals as property values
diff --git a/src/main/java/edu/kit/datamanager/ro_crate/entities/AbstractEntity.java b/src/main/java/edu/kit/datamanager/ro_crate/entities/AbstractEntity.java
@@ -158,11 +158,12 @@ public void removeProperties(Collection<String> keys) {
     }
 
     /**
-     * Add a JSON property to the entity. Here the value of the property is a
-     * String.
+     * Adds a property to the entity.
+     * <p>
+     * It may override values, if the key already exists.
      *
-     * @param key the name of the property (term).
-     * @param value the value that the property has.
+     * @param key the key of the property.
+     * @param value value of the property.
      */
     public void addProperty(String key, String value) {
         if (key != null && value != null) {
@@ -172,11 +173,12 @@ public void addProperty(String key, String value) {
     }
 
     /**
-     * This is another way of adding a property, this time the value is a long
-     * integer.
+     * Adds a property to the entity.
+     * <p>
+     * It may override values, if the key already exists.
      *
-     * @param key the String key of the property.
-     * @param value the long value.
+     * @param key the key of the property.
+     * @param value value of the property.
      */
     public void addProperty(String key, long value) {
         if (key != null) {
@@ -186,10 +188,12 @@ public void addProperty(String key, long value) {
     }
 
     /**
-     * Another way of adding a property this time the value is a double.
+     * Adds a property to the entity.
+     * <p>
+     * It may override values, if the key already exists.
      *
-     * @param key the string key of the property.
-     * @param value double value of the property.
+     * @param key the key of the property.
+     * @param value value of the property.
      */
     public void addProperty(String key, double value) {
         if (key != null) {
@@ -199,11 +203,17 @@ public void addProperty(String key, double value) {
     }
 
     /**
-     * This is the most generic way of adding a property. The value is a
-     * JsonNode that could contain anything possible. This is way firstly it is
-     * validated that it follows the correct guidelines.
+     * Adds a generic property to the entity.
+     * <p>
+     * It may fail with an error message on stdout, in which case the
+     * value is not added.
+     * It may override values, if the key already exists.
+     * This is the most generic way to add a property. The value is a
+     * JsonNode that could contain anything possible. It is limited to
+     * objects allowed to flattened documents, which means any literal,
+     * an array of literals, or an object with an @id property.
      *
-     * @param key String key of the property.
+     * @param key   String key of the property.
      * @param value The JsonNode representing the value.
      */
     public void addProperty(String key, JsonNode value) {
@@ -222,8 +232,8 @@ private static boolean addProperty(ObjectNode whereToAdd, String key, JsonNode v
     }
 
     /**
-     * Add a property that looks like this: "name" : {"@id" : "id"} If the name
-     * property already exists add a second @id to it.
+     * Add a property that looks like this: "name" : {"@id" : "id"} If the
+     * name property already exists add a second @id to it.
      *
      * @param name the "key" of the property.
      * @param id the "id" of the property.
diff --git a/src/main/resources/json_schemas/entity_field_structure_schema.json b/src/main/resources/json_schemas/entity_field_structure_schema.json
@@ -7,7 +7,10 @@
       "items": {
         "anyOf": [
           { "$ref": "#/$defs/idProperty"},
-          {"type": "string"}
+          {"type": "string"},
+          {"type": "number"},
+          {"type": "boolean"},
+          {"type": "null"}
         ]
 
       }
@@ -30,14 +33,15 @@
   ],
   "$defs" : {
     "idProperty": {
-      "type": "object",
+      "type": ["object"],
       "properties": {
         "@id": {
-          "type": "string"
+          "type": ["string"]
         }
       },
+      "required": ["@id"],
       "additionalProperties": false
     }
 
-  }
+    }
 }
diff --git a/src/test/java/edu/kit/datamanager/ro_crate/entities/data/DataEntityTest.java b/src/test/java/edu/kit/datamanager/ro_crate/entities/data/DataEntityTest.java
@@ -1,6 +1,8 @@
 package edu.kit.datamanager.ro_crate.entities.data;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
 import java.io.IOException;
@@ -9,14 +11,18 @@
 import edu.kit.datamanager.ro_crate.HelpFunctions;
 import edu.kit.datamanager.ro_crate.entities.data.DataEntity.DataEntityBuilder;
 import edu.kit.datamanager.ro_crate.objectmapper.MyObjectMapper;
-import java.net.MalformedURLException;
 import java.net.URI;
 
 import java.net.URISyntaxException;
+import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Arrays;
 import java.util.List;
+import java.util.stream.Stream;
+
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
@@ -93,12 +99,14 @@ void testUriCheck() {
 
         assertNotNull(dataEntity);
 
-        Exception exception = assertThrows(IllegalArgumentException.class, () -> {
-            new DataEntity.DataEntityBuilder()
-                    .addType("File")
-                    .setLocationWithExceptions(URI.create("zzz://wrong/url"))
-                    .build();
-        });
+        Exception exception = assertThrows(
+                IllegalArgumentException.class,
+                () ->
+                        new DataEntity.DataEntityBuilder()
+                                .addType("File")
+                                .setLocationWithExceptions(URI.create("zzz://wrong/url"))
+                                .build()
+        );
 
         assertEquals("This Data Entity remote ID does not resolve to a valid URL.", exception.getMessage());
 
@@ -114,22 +122,25 @@ void testPathCheck() throws IOException {
                 .addProperty("name", "RO-Crate specification")
                 .setEncodingFormat("application/json")
                 .build();
-        assertEquals(dataEntity.getId(), "example.json");
+        assertEquals("example.json", dataEntity.getId());
         HelpFunctions.compareEntityWithFile(dataEntity, "/json/entities/data/localFile.json");
 
+        String fileName = "cp7glop.ai";
+        Path filePath = Paths.get(fileName);
+
         dataEntity = new FileEntity.FileEntityBuilder()
-                .setLocationWithExceptions(Paths.get("cp7glop.ai"))
-                .setId("cp7glop.ai")
+                .setLocationWithExceptions(filePath)
+                .setId(fileName)
                 .addProperty("name", "Diagram showing trend to increase")
                 .setEncodingFormat("application/pdf")
                 .build();
-        assertEquals(dataEntity.getId(), "cp7glop.ai");
-        assertEquals(dataEntity.getPath(), Paths.get("cp7glop.ai"));
-        assertEquals(dataEntity.getProperty("encodingFormat").asText(), "application/pdf");
+        assertEquals(fileName, dataEntity.getId());
+        assertEquals(dataEntity.getPath(), filePath);
+        assertEquals("application/pdf", dataEntity.getProperty("encodingFormat").asText());
     }
 
     @Test
-    void testEncodedUrl() throws MalformedURLException, URISyntaxException {
+    void testEncodedUrl() throws URISyntaxException {
         //this entity id is a valid URL so there should not be any console information
         DataEntity dataEntity = new DataEntity.DataEntityBuilder()
                 .addType("File")
@@ -156,15 +167,15 @@ void testEncodedUrl() throws MalformedURLException, URISyntaxException {
                 .build();
 
         assertTrue(dataEntity.getTypes().contains("File"));
-        assertEquals(dataEntity.getId(), "almost-50%25.json");
+        assertEquals("almost-50%25.json", dataEntity.getId());
 
         // even if the Path is not correctly encoded, the data entity will be added with an encoded Path.
         dataEntity = new DataEntity.DataEntityBuilder()
                 .addType("File")
                 .setLocationWithExceptions(Paths.get("/json/crate/Results and Diagrams/almost-50%.json"))
                 .setId("almost-50%.json")
                 .build();
-        assertEquals(dataEntity.getId(), "almost-50%25.json");
+        assertEquals("almost-50%25.json", dataEntity.getId());
 
     }
 
@@ -179,10 +190,50 @@ void testRemoveProperty() {
 
         dataEntity.removeProperty("url");
         assertNull(dataEntity.getProperty("url"));
-        assertEquals(dataEntity.getProperties().size(), 4);
+        assertEquals(4, dataEntity.getProperties().size());
 
         List<String> keyList = Arrays.asList("encodingFormat", "name");
         dataEntity.removeProperties(keyList);
-        assertEquals(dataEntity.getProperties().size(), 2);
+        assertEquals(2, dataEntity.getProperties().size());
+    }
+
+    @Test
+    void testMixedArrayProperties() {
+        ObjectMapper mapper = new ObjectMapper();
+
+        ArrayNode propertyValue = mapper.createArrayNode();
+        propertyValue
+                .add(1)
+                .add("2")
+                .add(3.14)
+                .add(true)
+                .add((JsonNode) null)
+                .add(mapper.nullNode());
+        String propertyName = "mixedArray";
+
+        DataEntity entity = new DataEntityBuilder()
+                .addProperty(propertyName, propertyValue)
+                .build();
+        assertEquals(propertyValue, entity.getProperty(propertyName));
+    }
+
+    @ParameterizedTest
+    @MethodSource("provideInvalidPropertyValues")
+    void testNestedArrayProperties(ArrayNode propertyValue) {
+        String propertyName = "invalidArray";
+        DataEntity entity = new DataEntityBuilder()
+                .addProperty(propertyName, propertyValue)
+                .build();
+        assertNull(entity.getProperty(propertyName));
+    }
+
+    private static Stream<ArrayNode> provideInvalidPropertyValues() {
+        ObjectMapper mapper = new ObjectMapper();
+        ArrayNode withSubArray = mapper.createArrayNode().add(1).add("2");
+        withSubArray.addArray();
+        ArrayNode withSubObject = mapper.createArrayNode().add(1).add("2");
+        withSubObject.addObject();
+
+        return Stream.of(withSubArray, withSubObject);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,10 @@`
`7`	`7`	`"items": {`
`8`	`8`	`"anyOf": [`
`9`	`9`	`{ "$ref": "#/$defs/idProperty"},`
`10`		`- {"type": "string"}`
	`10`	`+ {"type": "string"},`
	`11`	`+ {"type": "number"},`
	`12`	`+ {"type": "boolean"},`
	`13`	`+ {"type": "null"}`
`11`	`14`	`]`
`12`	`15`
`13`	`16`	`}`
`@@ -30,14 +33,15 @@`
`30`	`33`	`],`
`31`	`34`	`"$defs" : {`
`32`	`35`	`"idProperty": {`
`33`		`- "type": "object",`
	`36`	`+ "type": ["object"],`
`34`	`37`	`"properties": {`
`35`	`38`	`"@id": {`
`36`		`- "type": "string"`
	`39`	`+ "type": ["string"]`
`37`	`40`	`}`
`38`	`41`	`},`
	`42`	`+ "required": ["@id"],`
`39`	`43`	`"additionalProperties": false`
`40`	`44`	`}`
`41`	`45`
`42`		`- }`
	`46`	`+ }`
`43`	`47`	`}`