Issue #106: Added getter for optional FeatureProperties.

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

Hide file tree

Showing 2 changed files with 62 additions and 1 deletion.
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
@@ -32,6 +32,7 @@
 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;
 import org.eclipse.ditto.things.model.ThingDefinition;
@@ -285,6 +286,28 @@ Optional<FeatureDefinition> getFeatureDefinition() {
         return result;
     }
 
+    Optional<FeatureProperties> getFeatureProperties() {
+        final Optional<FeatureProperties> result;
+        final Payload payload = adaptable.getPayload();
+        final Optional<JsonValue> payloadValueOptional = payload.getValue();
+        if (payloadValueOptional.isPresent()) {
+            final JsonValue jsonValue = payloadValueOptional.get();
+            if (jsonValue.isObject()) {
+                result = Optional.of(ThingsModelFactory.newFeatureProperties(jsonValue.asObject()));
+            } else {
+                throw new IllegalAdaptableException(
+                        MessageFormat.format("Payload value is not a {0} as JSON object but <{1}>.",
+                                FeatureProperties.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
@@ -485,7 +485,7 @@ public void getThingDefinitionReturnsEmptyOptionalIfPayloadContainsNoValue() {
     }
 
     @Test
-    public void getFeatureDefinitionReturnsExpectedThingDefinitionIfContainedInPayload() {
+    public void getFeatureDefinitionReturnsExpectedFeatureDefinitionIfContainedInPayload() {
         final FeatureDefinition featureDefinition =
                 ThingsModelFactory.newFeatureDefinition(JsonArray.of(JsonValue.of("example:test:definition")));
         final Payload payload = ProtocolFactory.newPayloadBuilder()
@@ -521,6 +521,44 @@ public void getFeatureDefinitionReturnsEmptyOptionalIfPayloadContainsNoValue() {
         assertThat(underTest.getFeatureDefinition()).isEmpty();
     }
 
+    @Test
+    public void getFeaturePropertiesReturnsExpectedFeaturePropertiesIfContainedInPayload() {
+        final FeatureProperties featureProperties = FeatureProperties.newBuilder()
+                .set("uint8_t HX711_DT[3]", "{A1, 11, 7}")
+                .build();
+        final Payload payload = ProtocolFactory.newPayloadBuilder()
+                .withValue(featureProperties)
+                .build();
+        Mockito.when(adaptable.getPayload()).thenReturn(payload);
+        final MappingContext underTest = MappingContext.of(adaptable);
+
+        assertThat(underTest.getFeatureProperties()).contains(featureProperties);
+    }
+
+    @Test
+    public void getFeaturePropertiesThrowsExceptionIfPayloadContainsValueThatIsNoJsonObject() {
+        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::getFeatureProperties)
+                .withMessage("Payload value is not a FeatureProperties as JSON object but <%s>.", value)
+                .withNoCause();
+    }
+
+    @Test
+    public void getFeaturePropertiesReturnsEmptyOptionalIfPayloadContainsNoValue() {
+        final Payload payload = ProtocolFactory.newPayloadBuilder().build();
+        Mockito.when(adaptable.getPayload()).thenReturn(payload);
+        final MappingContext underTest = MappingContext.of(adaptable);
+
+        assertThat(underTest.getFeatureProperties()).isEmpty();
+    }
+
     @Test
     public void getPolicyIdReturnsPolicyIfContainedInPayload() {
         final PolicyId policyId = PolicyId.inNamespaceWithRandomName("org.ditto");