Issue #106: Added getter for optional FeatureDefinition.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
eclipse-ditto · Dec 9, 2021 · e2b5217 · e2b5217
1 parent e32db7f
commit e2b5217
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 0 deletions.
diff --git a/protocol/src/main/java/org/eclipse/ditto/protocol/mappingstrategies/MappingContext.java b/protocol/src/main/java/org/eclipse/ditto/protocol/mappingstrategies/MappingContext.java
@@ -31,6 +31,7 @@
 import org.eclipse.ditto.protocol.TopicPath;
 import org.eclipse.ditto.things.model.Attributes;
 import org.eclipse.ditto.things.model.Feature;
+import org.eclipse.ditto.things.model.FeatureDefinition;
 import org.eclipse.ditto.things.model.Features;
 import org.eclipse.ditto.things.model.Thing;
 import org.eclipse.ditto.things.model.ThingDefinition;
@@ -262,6 +263,28 @@ Optional<ThingDefinition> getThingDefinition() {
         return result;
     }
 
+    Optional<FeatureDefinition> getFeatureDefinition() {
+        final Optional<FeatureDefinition> result;
+        final Payload payload = adaptable.getPayload();
+        final Optional<JsonValue> payloadValueOptional = payload.getValue();
+        if (payloadValueOptional.isPresent()) {
+            final JsonValue jsonValue = payloadValueOptional.get();
+            if (jsonValue.isArray()) {
+                result = Optional.of(ThingsModelFactory.newFeatureDefinition(jsonValue.asArray()));
+            } else {
+                throw new IllegalAdaptableException(
+                        MessageFormat.format("Payload value is not a {0} as JSON array but <{1}>.",
+                                FeatureDefinition.class.getSimpleName(),
+                                jsonValue),
+                        adaptable.getDittoHeaders()
+                );
+            }
+        } else {
+            result = Optional.empty();
+        }
+        return result;
+    }
+
     Optional<PolicyId> getPolicyId() {
         final Optional<PolicyId> result;
         final Payload payload = adaptable.getPayload();

diff --git a/protocol/src/test/java/org/eclipse/ditto/protocol/mappingstrategies/MappingContextTest.java b/protocol/src/test/java/org/eclipse/ditto/protocol/mappingstrategies/MappingContextTest.java
@@ -29,6 +29,7 @@
 import org.eclipse.ditto.protocol.TopicPath;
 import org.eclipse.ditto.things.model.Attributes;
 import org.eclipse.ditto.things.model.Feature;
+import org.eclipse.ditto.things.model.FeatureDefinition;
 import org.eclipse.ditto.things.model.FeatureProperties;
 import org.eclipse.ditto.things.model.Features;
 import org.eclipse.ditto.things.model.Thing;
@@ -483,6 +484,43 @@ public void getThingDefinitionReturnsEmptyOptionalIfPayloadContainsNoValue() {
         assertThat(underTest.getThingDefinition()).isEmpty();
     }
 
+    @Test
+    public void getFeatureDefinitionReturnsExpectedThingDefinitionIfContainedInPayload() {
+        final FeatureDefinition featureDefinition =
+                ThingsModelFactory.newFeatureDefinition(JsonArray.of(JsonValue.of("example:test:definition")));
+        final Payload payload = ProtocolFactory.newPayloadBuilder()
+                .withValue(featureDefinition.toJson())
+                .build();
+        Mockito.when(adaptable.getPayload()).thenReturn(payload);
+        final MappingContext underTest = MappingContext.of(adaptable);
+
+        assertThat(underTest.getFeatureDefinition()).contains(featureDefinition);
+    }
+
+    @Test
+    public void getFeatureDefinitionThrowsExceptionIfPayloadContainsValueThatIsNoJsonString() {
+        final JsonValue value = JsonValue.of(true);
+        final Payload payload = ProtocolFactory.newPayloadBuilder()
+                .withValue(value)
+                .build();
+        Mockito.when(adaptable.getPayload()).thenReturn(payload);
+        final MappingContext underTest = MappingContext.of(adaptable);
+
+        assertThatExceptionOfType(IllegalAdaptableException.class)
+                .isThrownBy(underTest::getFeatureDefinition)
+                .withMessage("Payload value is not a FeatureDefinition as JSON array but <%s>.", value)
+                .withNoCause();
+    }
+
+    @Test
+    public void getFeatureDefinitionReturnsEmptyOptionalIfPayloadContainsNoValue() {
+        final Payload payload = ProtocolFactory.newPayloadBuilder().build();
+        Mockito.when(adaptable.getPayload()).thenReturn(payload);
+        final MappingContext underTest = MappingContext.of(adaptable);
+
+        assertThat(underTest.getFeatureDefinition()).isEmpty();
+    }
+
     @Test
     public void getPolicyIdReturnsPolicyIfContainedInPayload() {
         final PolicyId policyId = PolicyId.inNamespaceWithRandomName("org.ditto");