System of systems test data, update of the README

Author: dariol83

README.md

@@ -104,6 +104,24 @@ The automation drivers support 3 different languages so far, even though 2 are p
 
 The two buggy languages are encapsulated into experimental automation drivers.
 
+### Remote Driver
+
+The remote driver allows a hierarchical decomposition of the entire system into independent Reatmetric systems. An example 
+of configuration enabling such decomposition is located in the module eu.dariolucia.reatmetric.remoting.test. Two station
+simulations can be individually executed, and a high-level M&C system can connect to both systems and provide a unified 
+monitoring and control experience.
+
+The purpose of such capability is to distribute the processing across several nodes, while still being able to offer a 
+common M&C view of the whole system. The high level system can reflect only a subset of the processing elements of each
+sub-system. 
+
+Moreover, the approach is scalable and not limited to a 2-tiers deployments. 
+
+The UI module, when properly configured, allows the connection to each system with just two clicks.
+
+The only limitation of the design is that each system entity in the overall system deployment **must have** a unique System Entity ID,
+for the elements that must be accessible to any remote high-level system.
+
 ### Performance
 The performance are computed with reference to the following 2 platforms:
 
@@ -176,7 +194,6 @@ If you want to quickly try Reatmetric out, I suggest the following approach:
 - Build the complete tree with maven: mvn clean install
 - Create a folder called 'reatmetric' inside your home folder and decompress there the configuration zip inside eu.dariolucia.reatmetric.ui.test/src/main/resources
 - Update the configuration data as appropriate. There is no need to change the processing definition data
-- Go inside eu.dariolucia.reatmetric.ui.test/target/deps and remove jffi-1.2.19-native.jar
 - Go inside eu.dariolucia.reatmetric.ui.test/target and run the following line (assuming Java is in your path)
 
 (Windows)
@@ -191,7 +208,6 @@ If you want to try Reatmetric using a client-server deployment, I suggest the fo
 - Build the complete tree with maven: mvn clean install
 - Create a folder called 'reatmetric' inside your home folder and decompress there the configuration zip inside eu.dariolucia.reatmetric.ui.test/src/main/resources
 - Update the configuration data as appropriate. There is no need to change the processing definition data
-- Go inside eu.dariolucia.reatmetric.remoting.test/target/deps and remove jffi-1.2.19-native.jar
 - Go inside eu.dariolucia.reatmetric.remoting.test/target and run the following line (assuming Java is in your path)
 
 (Windows)
@@ -202,7 +218,6 @@ java --module-path="deps" -Dreatmetric.core.config=path to Reatmetric/configurat
 
 - Create a folder called 'reatmetric_remoting' inside your home folder
 - Inside the folder created in the previous step, create a remoting configuration, so that the UI can connect
-- Go inside eu.dariolucia.reatmetric.ui.remoting/target/deps and remove jffi-1.2.19-native.jar
 - Go inside eu.dariolucia.reatmetric.ui.remoting/target and run the following line (assuming Java is in your path)
 
 (Windows)

eu.dariolucia.reatmetric.driver.remote/src/main/java/eu/dariolucia/reatmetric/driver/remote/definition/RemoteConfiguration.java

@@ -50,8 +50,8 @@ public static RemoteConfiguration load(InputStream is) throws IOException {
 
     /**
      * Prefix added to the remote definitions in the processing model.
-     * This property is needed to derive the system entity paths of the remote processing model,
-     * starting from the paths of the local processing model.
+     * This property is needed to derive the system entity paths of the remote (lower level) processing model,
+     * starting from the paths of the local (higher level) processing model.
      * <p>
      *     For instance:
      *     <ul>

eu.dariolucia.reatmetric.driver.remote/src/main/resources/configuration.xml

@@ -0,0 +1,21 @@
+<!--
+  ~ Copyright (c)  2022 Dario Lucia (https://www.dariolucia.eu)
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~          http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<ns1:remote xmlns:ns1="http://dariolucia.eu/reatmetric/driver/remote"
+	remote-system-name="Test System Station 1"
+	remote-path-prefix="MASTER."
+	remote-path-selector="MASTER.STATION">
+</ns1:remote>

eu.dariolucia.reatmetric.driver.test/pom.xml

@@ -45,6 +45,11 @@
             <artifactId>eu.dariolucia.reatmetric.processing</artifactId>
             <version>${project.parent.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish.jaxb</groupId>
+            <artifactId>jaxb-runtime</artifactId>
+            <version>${jaxb.version}</version>
+        </dependency>
     </dependencies>
 
 </project>

eu.dariolucia.reatmetric.driver.test/src/main/java/eu/dariolucia/reatmetric/driver/test/CommandEncoder.java

@@ -26,9 +26,9 @@ public class CommandEncoder {
 
     private final AtomicInteger commandTagSequencer = new AtomicInteger(0);
 
-    public Pair<Integer, byte[]> encode(IActivityHandler.ActivityInvocation activityInvocation) {
+    public Pair<Integer, byte[]> encode(IActivityHandler.ActivityInvocation activityInvocation, int systemEntityOffset) {
         // Read the activityInvocation arguments and encode accordingly
-        int eqId = ((Number) activityInvocation.getArguments().get(TestDriver.EQUIPMENT_ID_ARGKEY)).intValue();
+        int eqId = ((Number) activityInvocation.getArguments().get(TestDriver.EQUIPMENT_ID_ARGKEY)).intValue() - systemEntityOffset;
         int commandId = ((Number) activityInvocation.getArguments().get(TestDriver.COMMAND_ID_ARGKEY)).intValue();
         Number arg1 = (Number) activityInvocation.getArguments().get(TestDriver.ARG_1_ARGKEY);
         if(arg1 == null) {

eu.dariolucia.reatmetric.driver.test/src/main/java/eu/dariolucia/reatmetric/driver/test/MonitoringDecoder.java

@@ -37,9 +37,11 @@ public class MonitoringDecoder implements IRawDataSubscriber {
     private final Map<Integer, Consumer<RawData>> monitoringMap = new HashMap<>();
     private final Map<Integer, Function<RawData, LinkedHashMap<String, Pair<Integer, Object>>>> renderingMap = new HashMap<>();
     private final IProcessingModel model;
+    private final int systemEntityOffset;
 
-    public MonitoringDecoder(IProcessingModel model, IRawDataBroker broker) {
+    public MonitoringDecoder(IProcessingModel model, IRawDataBroker broker, int systemEntityOffset) {
         this.model = model;
+        this.systemEntityOffset = systemEntityOffset;
         // Initialise monitoring processing map
         monitoringMap.put(1, this::powerSupplyMon);
         monitoringMap.put(2, this::powerSupplyMon);
@@ -178,7 +180,7 @@ private void inject(Instant genTime, LinkedHashMap<String, Pair<Integer, Object>
     }
 
     private ParameterSample toParameterSample(Instant generationTime, Pair<Integer, Object> integerObjectPair) {
-        return ParameterSample.of(integerObjectPair.getFirst(), generationTime, Instant.now(), integerObjectPair.getSecond());
+        return ParameterSample.of(integerObjectPair.getFirst() + this.systemEntityOffset, generationTime, Instant.now(), integerObjectPair.getSecond());
     }
 
     private void processMonitoringData(RawData rd) {

eu.dariolucia.reatmetric.driver.test/src/main/java/eu/dariolucia/reatmetric/driver/test/TestDriver.java

@@ -42,8 +42,12 @@
 import eu.dariolucia.reatmetric.core.api.IServiceCoreContext;
 import eu.dariolucia.reatmetric.core.api.exceptions.DriverException;
 import eu.dariolucia.reatmetric.core.configuration.ServiceCoreConfiguration;
+import eu.dariolucia.reatmetric.driver.test.definition.TestDriverConfiguration;
 import eu.dariolucia.reatmetric.processing.definition.ProcessingDefinition;
 
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
 import java.nio.ByteBuffer;
 import java.time.Instant;
 import java.util.Arrays;
@@ -106,12 +110,17 @@ public class TestDriver implements IDriver, IActivityHandler, IRawDataRenderer {
     public static final String EXECUTION_COMPLETED_STAGE = "Execution Completed";
     public static final String TRANSMISSION_STAGE = "Transmission";
 
+    private static final String CONFIGURATION_FILE = "configuration.xml";
+
     private volatile String name;
     private volatile IServiceCoreContext context;
     private volatile IProcessingModel model;
     private volatile ProcessingDefinition definitions;
     private volatile IDriverListener subscriber;
 
+    // Driver configuration
+    private volatile TestDriverConfiguration configuration;
+
     // For activity execution
     private final ExecutorService executor = Executors.newFixedThreadPool(1, (t) -> {
         Thread toReturn = new Thread(t, "TestDriver Activity Handler Thread");
@@ -149,6 +158,13 @@ public void initialise(String name, String driverConfigurationDirectory, IServic
         this.subscriber = subscriber;
         try {
             this.definitions = ProcessingDefinition.loadAll(coreConfiguration.getDefinitionsLocation());
+
+            // Read the configuration
+            this.configuration = TestDriverConfiguration.load(new FileInputStream(driverConfigurationDirectory + File.separator + CONFIGURATION_FILE));
+        } catch (IOException e) {
+            // You can ignore, assuming no offset will be used
+            LOG.log(Level.WARNING, "Test driver: no configuration file found at " + driverConfigurationDirectory + File.separator + CONFIGURATION_FILE + ", assuming no offset will be used");
+            this.configuration = new TestDriverConfiguration();
         } catch (ReatmetricException e) {
             throw new DriverException(e);
         }
@@ -159,7 +175,7 @@ public void initialise(String name, String driverConfigurationDirectory, IServic
         this.rawDataSubscriber = this::eventReceived;
         this.context.getRawDataBroker().subscribe(this.rawDataSubscriber, null, new RawDataFilter(true, null, null, Collections.singletonList(STATION_EVENT), null, Collections.singletonList(Quality.GOOD)), null);
         // Decoder
-        this.decoder = new MonitoringDecoder(context.getProcessingModel(), context.getRawDataBroker());
+        this.decoder = new MonitoringDecoder(context.getProcessingModel(), context.getRawDataBroker(), this.configuration.getSystemEntityOffset());
         // CommandVerifier
         this.verifier = new CommandVerifier(this, context.getRawDataBroker());
 
@@ -182,7 +198,7 @@ private void eventReceived(List<RawData> rawDatas) {
             int code = bb.getInt();
             equipmentId += code;
             //
-            this.context.getProcessingModel().raiseEvent(EventOccurrence.of(equipmentId, Instant.ofEpochMilli(genTime), Instant.now(), null, null, code, TestDriver.STATION_ROUTE, TestDriver.STATION_SOURCE, null));
+            this.context.getProcessingModel().raiseEvent(EventOccurrence.of(equipmentId + this.configuration.getSystemEntityOffset(), Instant.ofEpochMilli(genTime), Instant.now(), null, null, code, TestDriver.STATION_ROUTE, TestDriver.STATION_SOURCE, null));
         }
     }
 
@@ -292,7 +308,7 @@ private boolean connectorReady() {
     private void execute(IActivityHandler.ActivityInvocation activityInvocation, IProcessingModel model) {
         Pair<Integer, byte[]> encodedCommand = null;
         try {
-            encodedCommand = encoder.encode(activityInvocation);
+            encodedCommand = encoder.encode(activityInvocation, this.configuration.getSystemEntityOffset());
             storeRawData(activityInvocation.getActivityOccurrenceId(), activityInvocation.getPath(), activityInvocation.getGenerationTime(), activityInvocation.getRoute(), activityInvocation.getType(), activityInvocation.getSource(), encodedCommand.getSecond());
             synchronized (this) {
                 // Record verification

eu.dariolucia.reatmetric.driver.test/src/main/java/eu/dariolucia/reatmetric/driver/test/definition/TestDriverConfiguration.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c)  2020 Dario Lucia (https://www.dariolucia.eu)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package eu.dariolucia.reatmetric.driver.test.definition;
+
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.Unmarshaller;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlAttribute;
+import javax.xml.bind.annotation.XmlRootElement;
+import java.io.IOException;
+import java.io.InputStream;
+
+@XmlRootElement(name = "test-driver", namespace = "http://dariolucia.eu/reatmetric/driver/test")
+@XmlAccessorType(XmlAccessType.FIELD)
+public class TestDriverConfiguration {
+
+    public static TestDriverConfiguration load(InputStream is) throws IOException {
+        try {
+            JAXBContext jc = JAXBContext.newInstance(TestDriverConfiguration.class);
+            Unmarshaller u = jc.createUnmarshaller();
+            return (TestDriverConfiguration) u.unmarshal(is);
+        } catch (JAXBException e) {
+            throw new IOException(e);
+        }
+    }
+
+    /**
+     * System entity offset: it is applied (added) to the system entity ID of parameters, events and (subtracted) telecommands.
+     */
+    @XmlAttribute(name = "system-entity-offset")
+    private int systemEntityOffset = 0;
+
+    public int getSystemEntityOffset() {
+        return systemEntityOffset;
+    }
+
+    public void setSystemEntityOffset(int systemEntityOffset) {
+        this.systemEntityOffset = systemEntityOffset;
+    }
+}

eu.dariolucia.reatmetric.driver.test/src/main/java/module-info.java

@@ -1,12 +1,14 @@
 open module eu.dariolucia.reatmetric.driver.test {
     requires java.logging;
     requires java.rmi;
+    requires java.xml.bind;
 
     requires eu.dariolucia.reatmetric.api;
     requires eu.dariolucia.reatmetric.core;
     requires eu.dariolucia.reatmetric.processing;
 
     exports eu.dariolucia.reatmetric.driver.test;
+    exports eu.dariolucia.reatmetric.driver.test.definition;
 
     provides eu.dariolucia.reatmetric.core.api.IDriver with eu.dariolucia.reatmetric.driver.test.TestDriver;
 }