Merge pull request #77 from INTO-CPS-Association/72-009-hotfix

This solves issues #70, #71 and #75

Author: DisasterlyDisco

README.md

@@ -53,7 +53,7 @@ The current responsible for the tool maintenance is [Claudio Gomes](https://clag
 To display the synopsis use the `--help` flag.
 
 ```
-unifmu 0.0.9
+unifmu 0.0.10
 
 Implement Functional Mock-up units (FMUs) in various source languages.
 

assets/java/src/main/java/Model.java

@@ -6,8 +6,11 @@
 import java.io.ByteArrayOutputStream;
 import java.io.ObjectInputStream;
 import java.io.ObjectOutputStream;
+import java.io.Serializable;
 
-public class Model {
+public class Model implements Serializable {
+
+    private static final long serialVersionUID = 1L;
 
     public Double real_a;
     public Double real_b;
@@ -22,7 +25,7 @@ public class Model {
     public String string_b;
     public String string_c;
 
-    private ArrayList<Field> references_to_attributes;
+    private transient ArrayList<Field> references_to_attributes;
 
     public Model() throws Exception {
 

cli/Cargo.toml

@@ -2,7 +2,7 @@
 authors = ["Christian Legaard <clegaard@outlook.com>"]
 edition = "2021"
 name = "unifmu"
-version = "0.0.9"
+version = "0.0.10"
 
 [dependencies]
 clap = { version = "4.5.3", features = ["derive"] }

cli/tests/common/mod.rs

@@ -525,7 +525,7 @@ impl BreakableFmu for LocalFmu {
     fn do_step_function_line_number(&self) -> u64 {
         match self.language() {
             FmuBackendImplementationLanguage::CSharp => 50,
-            FmuBackendImplementationLanguage::Java => 47,
+            FmuBackendImplementationLanguage::Java => 51,
             FmuBackendImplementationLanguage::Python => {
                 match self.version() {
                     FmiVersion::Fmi2 => 38,
@@ -1263,9 +1263,12 @@ pub trait RemoteBackend: DistributedFileStructure {
             FmuBackendImplementationLanguage::CSharp => duct::cmd!(
                 "dotnet", "run", "backend.cs", port
             ),
-            FmuBackendImplementationLanguage::Java => duct::cmd!(
-                "sh", "gradlew", "run", "--args='{port}'"
-            ),
+            FmuBackendImplementationLanguage::Java => {
+                let args_list = format!("--args='{port}'");
+                duct::cmd!(
+                    "sh", "gradlew", "run", args_list
+                )
+            },
             FmuBackendImplementationLanguage::Python => {
                 // Unix systems differentiates version 2 and 3 of python in their binary names
                 // Windows doesn't
@@ -1365,7 +1368,7 @@ static CSHARP_FMI2: LazyLock<LocalFmu> = LazyLock::new(|| {
 static JAVA_FMI2: LazyLock<LocalFmu> = LazyLock::new(|| {
     LocalFmu::new_persistent(
         FmiVersion::Fmi2,
-        FmuBackendImplementationLanguage::CSharp,
+        FmuBackendImplementationLanguage::Java,
         "PROMETHEAN_java_fmi2",
     )
 });
@@ -1397,7 +1400,7 @@ static ZIPPED_CSHARP_FMI2: LazyLock<ZippedLocalFmu> = LazyLock::new(|| {
 static ZIPPED_JAVA_FMI2: LazyLock<ZippedLocalFmu> = LazyLock::new(|| {
     ZippedLocalFmu::new_persistent(
         FmiVersion::Fmi2,
-        FmuBackendImplementationLanguage::CSharp,
+        FmuBackendImplementationLanguage::Java,
         "PROMETHEAN_zipped_java_fmi2",
     )
 });
@@ -1429,7 +1432,7 @@ static DISTRIBUTED_CSHARP_FMI2: LazyLock<DistributedFmu> = LazyLock::new(|| {
 static DISTRIBUTED_JAVA_FMI2: LazyLock<DistributedFmu> = LazyLock::new(|| {
     DistributedFmu::new_persistent(
         FmiVersion::Fmi2,
-        FmuBackendImplementationLanguage::CSharp,
+        FmuBackendImplementationLanguage::Java,
         "PROMETHEAN_distributed_java_fmi2",
     )
 });
@@ -1461,7 +1464,7 @@ static ZIPPED_DISTRIBUTED_CSHARP_FMI2: LazyLock<ZippedDistributedFmu> = LazyLock
 static ZIPPED_DISTRIBUTED_JAVA_FMI2: LazyLock<ZippedDistributedFmu> = LazyLock::new(|| {
     ZippedDistributedFmu::new_persistent(
         FmiVersion::Fmi2,
-        FmuBackendImplementationLanguage::CSharp,
+        FmuBackendImplementationLanguage::Java,
         "PROMETHEAN_zipped_distributed_java_fmi2",
     )
 });

fmiapi/src/dispatcher.rs

@@ -75,16 +75,16 @@ impl Dispatch for Dispatcher {
 /// Holds the handle for the subprocess as well as the handle for the socket
 /// to said subprocess.
 pub struct LocalDispatcher {
-    runtime: Runtime,
     socket: BackendSocket,
     subprocess: BackendSubprocess,
+    runtime: Runtime,
 }
 
 impl LocalDispatcher {
     pub fn create(
         resource_path: &Path,
         launch_command: &Vec<String>,
-    ) -> Result<Self, DispatcherError> {
+    ) -> DispatcherResult<Self> {
         let runtime = match tokio::runtime::Builder::new_current_thread()
             .enable_all()
             .build() {
@@ -107,9 +107,9 @@ impl LocalDispatcher {
 
         Ok(
             Self {
-                runtime,
                 socket,
-                subprocess
+                subprocess,
+                runtime,
             }
         )
     }
@@ -147,25 +147,16 @@ impl Dispatch for LocalDispatcher {
     }
 }
 
-impl Drop for LocalDispatcher {
-    fn drop(&mut self) {
-        match self.subprocess.terminate() {
-            Ok(_) => {},
-            Err(_) => error!("Terminating subprocess returned an error.")
-        };
-    }
-}
-
 /// Dispatcher for dispatching FMI commands to a remote backend.
 /// 
 /// Holds the socket to the remote backend.
 pub struct RemoteDispatcher {
-    runtime: Runtime,
     socket: BackendSocket,
+    runtime: Runtime,
 }
 
 impl RemoteDispatcher {
-    pub fn create() -> Result<Self, DispatcherError> {
+    pub fn create() -> DispatcherResult<Self> {
         let runtime = match tokio::runtime::Builder::new_current_thread()
             .enable_all()
             .build() {
@@ -192,8 +183,8 @@ impl RemoteDispatcher {
 
         Ok(
             Self {
-                runtime,
                 socket,
+                runtime,
             }
         )
     }
@@ -273,7 +264,7 @@ struct BackendSocket {
 }
 
 impl BackendSocket {
-    pub async fn create(endpoint: &str) -> Result<Self, DispatcherError> {
+    pub async fn create(endpoint: &str) -> DispatcherResult<Self> {
         let mut socket = RepSocket::new();
 
         let endpoint = match socket.bind(endpoint).await {
@@ -297,7 +288,7 @@ impl BackendSocket {
     /// ZeroMQ message queue, NOT when the message has actually been received
     /// by the backend. As such, there is no absolute guarantee that the
     /// message has been received when this returns. 
-    async fn send<S: Message>(&mut self, msg: &S) -> Result<(), DispatcherError> {
+    async fn send<S: Message>(&mut self, msg: &S) -> DispatcherResult<()> {
         let bytes_send: Bytes = msg.encode_to_vec().into();
         match  self.socket.send(bytes_send.into()).await {
             Ok(_) => Ok(()),
@@ -317,7 +308,7 @@ impl BackendSocket {
     /// 
     /// A call to recv() will await until a message is received through the
     /// ZeroMQ socket.
-    async fn recv<R: Message + Default>(&mut self) -> Result<R, DispatcherError> {
+    async fn recv<R: Message + Default>(&mut self) -> DispatcherResult<R> {
         match self.socket.recv().await {
             Ok(buf) => {
                 let buf: Bytes = match buf.get(0) {
@@ -347,7 +338,7 @@ impl BackendSocket {
     async fn send_and_recv<S: Message, R: Message + Default>(
         &mut self,
         msg: &S,
-    ) -> Result<R, DispatcherError> {
+    ) -> DispatcherResult<R> {
         self.send(msg).await?;
         self.recv().await
     }
@@ -443,17 +434,4 @@ impl BackendSubprocess {
             }
         }
     }
-
-    /// Terminates the subprocess
-    /// 
-    /// On Unix-like systems, this sends the `SIGTERM` signal to the
-    /// subprocess, which can be caught by the subprocess in order to perform
-    /// cleanup befoure exiting.
-    /// 
-    /// On Windows, it invokes `TerminateProcess` on the process handle, which
-    /// cannot be caught.
-    fn terminate(&mut self) -> DispatcherResult<()> {
-        self.subprocess.terminate()
-            .map_err(|_| DispatcherError::SubprocessError)
-    }
 }

fmiapi/src/fmi2.rs

@@ -12,7 +12,7 @@ use libc::size_t;
 
 
 use url::Url;
-use tracing::{error, warn};
+use tracing::{info, error, warn};
 use tracing_subscriber;
 
 use std::{
@@ -176,7 +176,7 @@ impl Drop for Fmi2Slave {
         };
 
         match self.dispatcher.send(&cmd) {
-            Ok(_) => (),
+            Ok(_) => {info!("Send free instance message to shut down backend");},
             Err(error) => error!(
                 "Freeing instance failed with error: {:?}.", error
             ),