Merge branch 'more-unit-tests' into release

Author: oxoo2a

README.md

@@ -1,6 +1,10 @@
 # sim4da - Simulator for Distributed Algorithms
 
-The simulator strives to abstract from most of the details in network programming and to ease the development of algorithm simulations. The simulator core is self-contained in a Java module `dev.oxoo2a.sim4da`. The distributed algorithm simulation is controlled by an instance of class `Simulator`:
+The simulator strives to abstract from most of the details in network programming and to ease the development of algorithm simulations. The simulator core is self-contained in a Java module `dev.oxoo2a.sim4da`.
+
+## Writing your own simulation
+
+The distributed algorithm simulation is controlled by an instance of class `Simulator`:
 
 ```Java
     Simulator s = new Simulator(n_nodes);
@@ -31,3 +35,36 @@ Inside `main`, the following methods are available:
 - `sendBroadcast(Message message)`: sending a `HashMap`-like message encoded in JSON to all nodes (except the sender itself)
 - `stillSimulating()`: returns `true` while the duration for the simulation is not exceeded
 - `receive()`: blocks until a message is received by the node; an object of type `Network.Message` is returned, which stores `sender_id`, `receiver_id`, send mode (unicast or broadcast), and the `payload` as a string. If a `Message` is expected, this payload must be deserialized from JSON back into an object of type `Message` by calling `Message.fromJson(payload)`.
+
+An example implementation for a distributed algorithm simulation is available as a test case (`BroadcastNode.java` and `SimulatorTest.java`).
+
+## Building the sim4da jar
+
+`Gradle` is used as the build tool. `gradle build` and `gradle shadowJar` within the root directory of the repository generate the required jar files. The fat jar contains the transitive dependencies to `gson`, `junit` and `log4j2`.
+
+## Logging
+
+The simulator core can create trace files of every simulation thanks to the logging framework `log4j2`. A default configuration file is part of the simulator resources. The default logging configuration is similar to:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<Configuration status="WARN">
+    <Appenders>
+        <Console name="console" target="SYSTEM_OUT">
+            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n" />
+        </Console>
+
+        <File name="logfile" fileName="sim4da-app.log" append="false">
+            <PatternLayout pattern="%msg%n"/>
+        </File>
+    </Appenders>
+    <Loggers>
+        <Logger name="sim4da" level="trace" additivity="false">
+            <AppenderRef ref="logfile"/>
+        </Logger>
+        <Root level="warn">
+            <AppenderRef ref="console"/>
+        </Root>
+    </Loggers>
+</Configuration>
+```

build.gradle

@@ -29,7 +29,7 @@ dependencies {
 }
 
 group = 'dev.oxoo2a'
-version = '1.0-SNAPSHOT'
+version = '1.4-SNAPSHOT'
 description = 'sim4da'
 java.sourceCompatibility = JavaVersion.VERSION_17
 

src/test/java/dev/oxoo2a/sim4da/MessageTest.java

@@ -2,12 +2,28 @@
 
 import static org.junit.jupiter.api.Assertions.*;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.BeforeAll;
 
 public class MessageTest {
+	@BeforeAll
+	public static void createMessage () {
+		m = new Message().add("a","b").add("c","d");
+	}
+
+	private static Message m;
 
 	@Test
 	public void testMessageBasics () {
-		Message m = new Message().add("a","b");
 		assertEquals(m.query("a"), "b");
+		assertEquals(m.query("c"), "d");
+		assertEquals(m.query("no_key"),null);
+	}
+
+	@Test
+	public void serializeAndDeserialize () {
+		String m_json = m.toJson();
+		Message m2 = Message.fromJson(m_json);
+		assertEquals(m2.query("a"),"b");
+		assertEquals(m2.query("c"),"d");
 	}
 }

src/test/java/dev/oxoo2a/sim4da/SimulatorTest.java

@@ -1,15 +1,17 @@
 package dev.oxoo2a.sim4da;
 
 import static org.junit.jupiter.api.Assertions.*;
+
+import java.beans.Transient;
+
 import org.junit.jupiter.api.Test;
 
 public class SimulatorTest {
+    private final int n_nodes = 3;
+    private final int duration = 2;
 
     @Test
     public void simpleSimulation() {
-        int n_nodes = 3;
-        int duration = 1;
-
         Simulator s = Simulator.createDefaultSimulator(n_nodes);
         for (int id=0; id<n_nodes; id++) {
             Node n = new BroadcastNode(id);
@@ -22,4 +24,12 @@ public void simpleSimulation() {
             fail("Not all nodes instantiated");
         }
     }
+
+    @Test
+    public void someNodesNotInstantiated () {
+        Simulator s = Simulator.createDefaultSimulator(n_nodes);
+        s.attachNode(0,new BroadcastNode(0));
+        s.attachNode(1,new BroadcastNode(1));
+        assertThrows(InstantiationException.class,() -> {s.runSimulation(duration);});
+    }
 }