fix simulation adapter not having subscription as a property in the json schema (#447)

DC2-DanielKrueger · web-flow · commit 6a6e9e0b8d5f · 2024-06-06T17:40:29.000+02:00
diff --git a/hivemq-edge/src/main/java/com/hivemq/edge/modules/adapters/simulation/SimulationAdapterConfig.java b/hivemq-edge/src/main/java/com/hivemq/edge/modules/adapters/simulation/SimulationAdapterConfig.java
@@ -19,18 +19,22 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.hivemq.adapter.sdk.api.annotations.ModuleConfigField;
-import com.hivemq.adapter.sdk.api.config.PollingContext;
 import com.hivemq.adapter.sdk.api.config.ProtocolAdapterConfig;
 import com.hivemq.extension.sdk.api.annotations.NotNull;
 
 import java.util.ArrayList;
 import java.util.List;
 
+@SuppressWarnings({"unused", "FieldCanBeLocal", "FieldMayBeFinal"})
 @JsonPropertyOrder({"minValue", "maxValue", "subscriptions"})
 public class SimulationAdapterConfig implements ProtocolAdapterConfig {
 
     private static final @NotNull String ID_REGEX = "^([a-zA-Z_0-9-_])*$";
 
+    @JsonProperty("subscriptions")
+    @ModuleConfigField(title = "subscription", description = "List of subscriptions for the simulation")
+    private @NotNull List<SimulationPollingContext> pollingContexts = new ArrayList<>();
+
     @JsonProperty(value = "id", required = true)
     @ModuleConfigField(title = "Identifier",
                        description = "Unique identifier for this protocol adapter",
@@ -41,7 +45,6 @@ public class SimulationAdapterConfig implements ProtocolAdapterConfig {
                        stringMaxLength = 1024)
     protected @NotNull String id;
 
-
     @JsonProperty("pollingIntervalMillis")
     @JsonAlias(value = "publishingInterval") //-- Ensure we cater for properties created with legacy configuration
     @ModuleConfigField(title = "Polling Interval [ms]",
@@ -57,20 +60,6 @@ public class SimulationAdapterConfig implements ProtocolAdapterConfig {
                        defaultValue = "10")
     private int maxPollingErrorsBeforeRemoval = 10;
 
-    public int getPollingIntervalMillis() {
-        return pollingIntervalMillis;
-    }
-
-    public int getMaxPollingErrorsBeforeRemoval() {
-        return maxPollingErrorsBeforeRemoval;
-    }
-
-    @JsonProperty("subscriptions")
-    @ModuleConfigField(title = "Subscriptions",
-                       description = "List of subscriptions for the simulation",
-                       required = true)
-    private @NotNull List<PollingContext> adapterSubscriptions = new ArrayList<>();
-
     @JsonProperty("minValue")
     @ModuleConfigField(title = "Min. Generated Value",
                        description = "Minimum value of the generated decimal number",
@@ -88,34 +77,27 @@ public int getMaxPollingErrorsBeforeRemoval() {
     public SimulationAdapterConfig() {
     }
 
-    public SimulationAdapterConfig(
-            final @NotNull String id, final @NotNull List<PollingContext> adapterSubscriptions) {
-        this.id = id;
-        this.adapterSubscriptions = adapterSubscriptions;
+    public @NotNull List<SimulationPollingContext> getPollingContexts() {
+       return pollingContexts;
     }
 
     public @NotNull String getId() {
         return id;
     }
 
-    public void setId(final @NotNull String id) {
-        this.id = id;
-    }
-
-
-    public void setSubscriptions(@NotNull List<PollingContext> adapterSubscriptions) {
-        this.adapterSubscriptions = adapterSubscriptions;
-    }
-
-    public @NotNull List<PollingContext> getSubscriptions() {
-        return adapterSubscriptions;
-    }
-
     public int getMinValue() {
         return minValue;
     }
 
     public int getMaxValue() {
         return maxValue;
     }
+
+    public int getPollingIntervalMillis() {
+        return pollingIntervalMillis;
+    }
+
+    public int getMaxPollingErrorsBeforeRemoval() {
+        return maxPollingErrorsBeforeRemoval;
+    }
 }
diff --git a/hivemq-edge/src/main/java/com/hivemq/edge/modules/adapters/simulation/SimulationConfigConverter.java b/hivemq-edge/src/main/java/com/hivemq/edge/modules/adapters/simulation/SimulationConfigConverter.java
diff --git a/hivemq-edge/src/main/java/com/hivemq/edge/modules/adapters/simulation/SimulationPollingContext.java b/hivemq-edge/src/main/java/com/hivemq/edge/modules/adapters/simulation/SimulationPollingContext.java
@@ -0,0 +1,104 @@
+package com.hivemq.edge.modules.adapters.simulation;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.hivemq.adapter.sdk.api.annotations.ModuleConfigField;
+import com.hivemq.adapter.sdk.api.config.MessageHandlingOptions;
+import com.hivemq.adapter.sdk.api.config.PollingContext;
+import com.hivemq.adapter.sdk.api.config.UserProperty;
+import com.hivemq.extension.sdk.api.annotations.NotNull;
+import com.hivemq.extension.sdk.api.annotations.Nullable;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class SimulationPollingContext implements PollingContext {
+
+    @JsonProperty(value = "destination", required = true)
+    @ModuleConfigField(title = "Destination Topic",
+                       description = "The topic to publish data on",
+                       required = true,
+                       format = ModuleConfigField.FieldType.MQTT_TOPIC)
+    protected @Nullable String destination;
+
+    @JsonProperty(value = "qos", required = true)
+    @ModuleConfigField(title = "QoS",
+                       description = "MQTT Quality of Service level",
+                       required = true,
+                       numberMin = 0,
+                       numberMax = 2,
+                       defaultValue = "0")
+    protected int qos = 0;
+
+    @JsonProperty(value = "messageHandlingOptions")
+    @ModuleConfigField(title = "Message Handling Options",
+                       description = "This setting defines the format of the resulting MQTT message, either a message per changed tag or a message per subscription that may include multiple data points per sample",
+                       enumDisplayValues = {
+                               "MQTT Message Per Device Tag",
+                               "MQTT Message Per Subscription (Potentially Multiple Data Points Per Sample)"},
+                       defaultValue = "MQTTMessagePerTag")
+    protected @NotNull MessageHandlingOptions messageHandlingOptions = MessageHandlingOptions.MQTTMessagePerTag;
+
+    @JsonProperty(value = "includeTimestamp")
+    @ModuleConfigField(title = "Include Sample Timestamp In Publish?",
+                       description = "Include the unix timestamp of the sample time in the resulting MQTT message",
+                       defaultValue = "true")
+    protected @NotNull Boolean includeTimestamp = Boolean.TRUE;
+
+    @JsonProperty(value = "includeTagNames")
+    @ModuleConfigField(title = "Include Tag Names In Publish?",
+                       description = "Include the names of the tags in the resulting MQTT publish",
+                       defaultValue = "false")
+    protected @NotNull Boolean includeTagNames = Boolean.FALSE;
+
+    @JsonProperty(value = "userProperties")
+    @ModuleConfigField(title = "User Properties",
+                       description = "Arbitrary properties to associate with the subscription",
+                       arrayMaxItems = 10)
+    private @NotNull List<UserProperty> userProperties = new ArrayList<>();
+
+    public SimulationPollingContext() {
+    }
+
+    @JsonCreator
+    public SimulationPollingContext(
+            @JsonProperty("destination") @Nullable final String destination,
+            @JsonProperty("qos") final int qos,
+            @JsonProperty("userProperties") @Nullable List<UserProperty> userProperties) {
+        this.destination = destination;
+        this.qos = qos;
+        if (userProperties != null) {
+            this.userProperties = userProperties;
+        }
+    }
+
+    @Override
+    public @Nullable String getDestinationMqttTopic() {
+        return destination;
+    }
+
+    @Override
+    public int getQos() {
+        return qos;
+    }
+
+    @Override
+    public @NotNull MessageHandlingOptions getMessageHandlingOptions() {
+        return messageHandlingOptions;
+    }
+
+    @Override
+    public @NotNull Boolean getIncludeTimestamp() {
+        return includeTimestamp;
+    }
+
+    @Override
+    public @NotNull Boolean getIncludeTagNames() {
+        return includeTagNames;
+    }
+
+    @Override
+    public @NotNull List<UserProperty> getUserProperties() {
+        return userProperties;
+    }
+}
diff --git a/hivemq-edge/src/main/java/com/hivemq/edge/modules/adapters/simulation/SimulationProtocolAdapter.java b/hivemq-edge/src/main/java/com/hivemq/edge/modules/adapters/simulation/SimulationProtocolAdapter.java
@@ -16,7 +16,6 @@
 package com.hivemq.edge.modules.adapters.simulation;
 
 import com.hivemq.adapter.sdk.api.ProtocolAdapterInformation;
-import com.hivemq.adapter.sdk.api.config.PollingContext;
 import com.hivemq.adapter.sdk.api.model.ProtocolAdapterInput;
 import com.hivemq.adapter.sdk.api.model.ProtocolAdapterStartInput;
 import com.hivemq.adapter.sdk.api.model.ProtocolAdapterStartOutput;
@@ -33,7 +32,7 @@
 
 import static com.hivemq.adapter.sdk.api.state.ProtocolAdapterState.ConnectionStatus.STATELESS;
 
-public class SimulationProtocolAdapter implements PollingProtocolAdapter<PollingContext> {
+public class SimulationProtocolAdapter implements PollingProtocolAdapter<SimulationPollingContext> {
 
     private final @NotNull ProtocolAdapterInformation adapterInformation;
     private final @NotNull SimulationAdapterConfig adapterConfig;
@@ -71,7 +70,7 @@ public void stop(@NotNull final ProtocolAdapterStopInput input, @NotNull final P
 
     @Override
     public void poll(
-            final @NotNull PollingInput<com.hivemq.adapter.sdk.api.config.PollingContext> pollingInput, final @NotNull PollingOutput pollingOutput) {
+            final @NotNull PollingInput<SimulationPollingContext> pollingInput, final @NotNull PollingOutput pollingOutput) {
         pollingOutput.addDataPoint("sample",
                 ThreadLocalRandom.current()
                         .nextDouble(Math.min(adapterConfig.getMinValue(), adapterConfig.getMaxValue()),
@@ -80,8 +79,8 @@ public void poll(
     }
 
     @Override
-    public @NotNull List<PollingContext> getPollingContexts() {
-        return adapterConfig.getSubscriptions();
+    public @NotNull List<SimulationPollingContext> getPollingContexts() {
+        return adapterConfig.getPollingContexts();
     }
 
     @Override
diff --git a/hivemq-edge/src/main/java/com/hivemq/protocols/ProtocolAdapterUtils.java b/hivemq-edge/src/main/java/com/hivemq/protocols/ProtocolAdapterUtils.java
@@ -22,9 +22,7 @@
 import com.fasterxml.jackson.databind.module.SimpleAbstractTypeResolver;
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.databind.type.LogicalType;
-import com.hivemq.adapter.sdk.api.config.PollingContext;
 import com.hivemq.adapter.sdk.api.config.UserProperty;
-import com.hivemq.edge.modules.config.impl.PollingContextImpl;
 import com.hivemq.edge.modules.config.impl.UserPropertyImpl;
 import com.hivemq.extension.sdk.api.annotations.NotNull;
 
@@ -44,7 +42,7 @@ public class ProtocolAdapterUtils {
         SimpleModule module = new SimpleModule("UserPropertyModule", Version.unknownVersion());
         SimpleAbstractTypeResolver resolver = new SimpleAbstractTypeResolver();
         resolver.addMapping(UserProperty.class, UserPropertyImpl.class);
-        resolver.addMapping(PollingContext.class, PollingContextImpl.class);
+     //   resolver.addMapping(PollingContext.class, PollingContextImpl.class);
 
         module.setAbstractTypes(resolver);
         copyObjectMapper.registerModule(module);
diff --git a/hivemq-edge/src/test/java/com/hivemq/configuration/writer/LargeConfigFileTest.java b/hivemq-edge/src/test/java/com/hivemq/configuration/writer/LargeConfigFileTest.java
