From 1c0568c31d60d4e690b4b9aec2e14f660b72a5c8 Mon Sep 17 00:00:00 2001
From: Fabian Mastenbroek <mail.fabianm@gmail.com>
Date: Wed, 21 Apr 2021 14:30:55 +0200
Subject: simulator: Introduce SimulationCoroutineDispatcher

This change introduces the SimulationCoroutineDispatcher implementation
which replaces the TestCoroutineDispatcher for running single-threaded
simulations.

Previously, we used the TestCoroutineDispatcher from the
kotlinx-coroutines-test modules for running simulations. However, this
module is aimed at coroutine tests and not at simulations.

In particular, having to construct a Clock object each time for the
TestCoroutineDispatcher caused a lot of unnecessary lines. With the new
approach, the SimulationCoroutineDispatcher automatically exposes a
usable Clock object.

In addition to ergonomic benefits, the SimulationCoroutineDispatcher is
much faster than the TestCoroutineDispatcher due to the assumption that
simulations run in only a single thread. As a result, the dispatcher
does not need to perform synchronization and can use the fast
PriorityQueue implementation.
---
 .../opendc-utils/src/test/kotlin/org/opendc/utils/TimerSchedulerTest.kt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'simulator/opendc-utils/src/test')

diff --git a/simulator/opendc-utils/src/test/kotlin/org/opendc/utils/TimerSchedulerTest.kt b/simulator/opendc-utils/src/test/kotlin/org/opendc/utils/TimerSchedulerTest.kt
index 1fcb5d38..314b3faa 100644
--- a/simulator/opendc-utils/src/test/kotlin/org/opendc/utils/TimerSchedulerTest.kt
+++ b/simulator/opendc-utils/src/test/kotlin/org/opendc/utils/TimerSchedulerTest.kt
@@ -27,7 +27,7 @@ import kotlinx.coroutines.test.runBlockingTest
 import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertThrows
-import org.opendc.simulator.utils.DelayControllerClockAdapter
+import org.opendc.simulator.core.DelayControllerClockAdapter
 
 /**
  * A test suite for the [TimerScheduler] class.
-- 
cgit v1.2.3


From 62678b2890a7f3640836b99ca2fec9efd7485929 Mon Sep 17 00:00:00 2001
From: Fabian Mastenbroek <mail.fabianm@gmail.com>
Date: Wed, 21 Apr 2021 16:35:52 +0200
Subject: simulator: Migrate to SimulationCoroutineDispatcher

This change migrates the remainder of the codebase to the
SimulationCoroutineDispatcher implementation.
---
 .../kotlin/org/opendc/utils/TimerSchedulerTest.kt  | 24 ++++++++--------------
 1 file changed, 8 insertions(+), 16 deletions(-)

(limited to 'simulator/opendc-utils/src/test')

diff --git a/simulator/opendc-utils/src/test/kotlin/org/opendc/utils/TimerSchedulerTest.kt b/simulator/opendc-utils/src/test/kotlin/org/opendc/utils/TimerSchedulerTest.kt
index 314b3faa..101a6546 100644
--- a/simulator/opendc-utils/src/test/kotlin/org/opendc/utils/TimerSchedulerTest.kt
+++ b/simulator/opendc-utils/src/test/kotlin/org/opendc/utils/TimerSchedulerTest.kt
@@ -23,11 +23,10 @@
 package org.opendc.utils
 
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.runBlockingTest
 import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertThrows
-import org.opendc.simulator.core.DelayControllerClockAdapter
+import org.opendc.simulator.core.runBlockingSimulation
 
 /**
  * A test suite for the [TimerScheduler] class.
@@ -36,8 +35,7 @@ import org.opendc.simulator.core.DelayControllerClockAdapter
 internal class TimerSchedulerTest {
     @Test
     fun testBasicTimer() {
-        runBlockingTest {
-            val clock = DelayControllerClockAdapter(this)
+        runBlockingSimulation {
             val scheduler = TimerScheduler<Int>(coroutineContext, clock)
 
             scheduler.startSingleTimer(0, 1000) {
@@ -49,8 +47,7 @@ internal class TimerSchedulerTest {
 
     @Test
     fun testCancelNonExisting() {
-        runBlockingTest {
-            val clock = DelayControllerClockAdapter(this)
+        runBlockingSimulation {
             val scheduler = TimerScheduler<Int>(coroutineContext, clock)
 
             scheduler.cancel(1)
@@ -60,8 +57,7 @@ internal class TimerSchedulerTest {
 
     @Test
     fun testCancelExisting() {
-        runBlockingTest {
-            val clock = DelayControllerClockAdapter(this)
+        runBlockingSimulation {
             val scheduler = TimerScheduler<Int>(coroutineContext, clock)
 
             scheduler.startSingleTimer(0, 1000) {
@@ -79,8 +75,7 @@ internal class TimerSchedulerTest {
 
     @Test
     fun testCancelAll() {
-        runBlockingTest {
-            val clock = DelayControllerClockAdapter(this)
+        runBlockingSimulation {
             val scheduler = TimerScheduler<Int>(coroutineContext, clock)
 
             scheduler.startSingleTimer(0, 1000) {
@@ -97,8 +92,7 @@ internal class TimerSchedulerTest {
 
     @Test
     fun testOverride() {
-        runBlockingTest {
-            val clock = DelayControllerClockAdapter(this)
+        runBlockingSimulation {
             val scheduler = TimerScheduler<Int>(coroutineContext, clock)
 
             scheduler.startSingleTimer(0, 1000) {
@@ -115,8 +109,7 @@ internal class TimerSchedulerTest {
 
     @Test
     fun testStopped() {
-        runBlockingTest {
-            val clock = DelayControllerClockAdapter(this)
+        runBlockingSimulation {
             val scheduler = TimerScheduler<Int>(coroutineContext, clock)
 
             scheduler.close()
@@ -131,8 +124,7 @@ internal class TimerSchedulerTest {
 
     @Test
     fun testNegativeDelay() {
-        runBlockingTest {
-            val clock = DelayControllerClockAdapter(this)
+        runBlockingSimulation {
             val scheduler = TimerScheduler<Int>(coroutineContext, clock)
 
             assertThrows<IllegalArgumentException> {
-- 
cgit v1.2.3