feat: include gameTimeout in plugin

Author: xeruf

GUIDELINES.md

@@ -5,9 +5,16 @@ This document captures development standards and architecture decisions of this
 ## Testing
 
 Unsere Unittests nutzen das [Kotest-Framework](https://kotest.io) mit [JUnit](https://junit.org) im Hintergrund.
-Dabei setzen wir auf die [WordSpec](https://kotest.io/styles/#word-spec), da man damit semantisch übersichtlich sowohl einfache Tests als auch Behavior Driven Development umsetzen kann.
-
-Bisherige Tests nutzen die StringSpec, welche jedoch schnell unübersichtlich wird da sie keine Verschachtelung erlaubt, und im server-modul gibt es noch einige JUnit5-Tests.
+Dabei setzen wir auf [WordSpec](https://kotest.io/styles/#word-spec),
+da man damit semantisch übersichtlich
+sowohl einfache Tests als auch Behavior Driven Development umsetzen kann.
+Für Tests von Algorithmen ohne Logik/Verhalten
+kann auch [FunSpec](https://kotest.io/styles/#fun-spec) nützlich sein
+
+Viele Tests nutzen noch die StringSpec,
+welche jedoch schnell unübersichtlich wird,
+da sie keine Verschachtelung erlaubt.
+Im Server gibt es außerdem noch einige JUnit5-Tests.
 Diese sollten bei größeren Änderungen direkt zum neuen Stil migriert werden.
 
 ## XStream

helpers/test-client/src/sc/TestClient.java

@@ -18,7 +18,6 @@
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.List;
-import java.util.ServiceLoader;
 import java.util.StringTokenizer;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
@@ -42,7 +41,7 @@
 public class TestClient extends XStreamClient {
   private static final Logger logger = (Logger) LoggerFactory.getLogger(TestClient.class);
 
-  private static final String gameType = IGamePlugin.loadPluginId();
+  private static final IGamePlugin plugin = IGamePlugin.loadPlugin();
   private static final ClientPlayer[] players = {new ClientPlayer(), new ClientPlayer()};
   private static final File logDir = new File("log").getAbsoluteFile();
 
@@ -281,8 +280,7 @@ protected void onObject(@NotNull ProtocolMessage message) {
                 logger.error("{} crashed, look into {}", player.name, logDir);
                 exit(2);
               }
-            // TODO move timeout to GamePlugin and obtain it
-            if (slept > 200.000) {
+            if (slept > plugin.getGameTimeout()) {
               logger.error("The game seems to hang, exiting!");
               exit(2);
             }
@@ -332,7 +330,7 @@ private void prepareNewClients() {
     for (int i = 0; i < 2; i++)
       slots[(finishedTests + i) % 2] = new SlotDescriptor(players[i].name, players[i].canTimeout);
     logger.debug("Prepared client slots: " + Arrays.toString(slots));
-    send(new PrepareGameRequest(gameType, slots[0], slots[1], false));
+    send(new PrepareGameRequest(plugin.getId(), slots[0], slots[1], false));
   }
 
   private static void exit(int status) {

plugin/src/client/sc/plugin2021/AbstractClient.kt

@@ -1,6 +1,7 @@
 package sc.plugin2021
 
 import org.slf4j.LoggerFactory
+import sc.api.plugins.IGamePlugin
 import sc.api.plugins.IGameState
 import sc.framework.plugins.protocol.MoveRequest
 import sc.networking.clients.AbstractLobbyClientListener
@@ -102,7 +103,7 @@ abstract class AbstractClient(
     /** [start] and join any game with the appropriate [gameType]. */
     fun joinAnyGame() {
         start()
-        client.joinRoomRequest(GamePlugin.PLUGIN_UUID)
+        client.joinRoomRequest(GamePlugin.PLUGIN_ID)
     }
 
     override fun onGameLeft(roomId: String) {

plugin/src/server/sc/plugin2021/Game.kt

@@ -14,7 +14,7 @@ import sc.shared.PlayerScore
 import sc.shared.ScoreCause
 import sc.shared.WinCondition
 
-class Game(override val currentState: GameState = GameState()): AbstractGame<Player>(GamePlugin.PLUGIN_UUID) {
+class Game(override val currentState: GameState = GameState()): AbstractGame<Player>(GamePlugin.PLUGIN_ID) {
     companion object {
         val logger = LoggerFactory.getLogger(Game::class.java)
     }

plugin/src/server/sc/plugin2021/GamePlugin.kt

@@ -3,31 +3,35 @@ package sc.plugin2021
 import sc.api.plugins.IGameInstance
 import sc.api.plugins.IGamePlugin
 import sc.api.plugins.IGameState
-import sc.api.plugins.host.GameLoader
+import sc.plugin2021.util.Constants
 import sc.plugins.PluginDescriptor
 import sc.shared.ScoreAggregation
 import sc.shared.ScoreDefinition
 import sc.shared.ScoreFragment
-import java.io.File
 
-@PluginDescriptor(name = "Blokus", uuid = GamePlugin.PLUGIN_UUID)
+@PluginDescriptor(name = "Blokus", uuid = GamePlugin.PLUGIN_ID)
 class GamePlugin: IGamePlugin {
     companion object {
-        const val PLUGIN_UUID = "swc_2021_blokus"
+        const val PLUGIN_ID = "swc_2021_blokus"
+        val scoreDefinition: ScoreDefinition =
+                ScoreDefinition(arrayOf(
+                        ScoreFragment("Gewinner"),
+                        ScoreFragment("\u2205 Punkte", ScoreAggregation.AVERAGE)
+                ))
     }
 
-    override fun id() = PLUGIN_UUID
+    override val id = PLUGIN_ID
+    
+    override val scoreDefinition =
+            Companion.scoreDefinition
+    
+    override val gameTimeout: Int =
+            Constants.GAME_TIMEOUT
 
     override fun createGame(): IGameInstance =
             Game()
 
     override fun createGameFromState(state: IGameState): IGameInstance =
             Game(state as GameState)
 
-    override val scoreDefinition: ScoreDefinition =
-            ScoreDefinition(arrayOf(
-                    ScoreFragment("Gewinner"),
-                    ScoreFragment("\u2205 Punkte", ScoreAggregation.AVERAGE)
-            ))
-    
 }

plugin/src/shared/sc/plugin2021/util/Constants.kt

@@ -23,11 +23,11 @@ object Constants {
     const val ROUND_LIMIT = 25
 
     /** Zeit (in ms), die für einen Zug zur Verfügung steht. */
-    const val SOFT_TIMEOUT = 2000L
+    const val SOFT_TIMEOUT = 2_000
     /** Zeit (in ms), ab dem eine Zuganfrage abgebrochen wird. */
-    const val HARD_TIMEOUT = 10000L
+    const val HARD_TIMEOUT = 10_000
 
-    // Max game length: turns(ROUND_LIMIT * 2) * SOFT_TIMEOUT, one second buffer per round
+    // Max game length: turns(=ROUND_LIMIT*2) * SOFT_TIMEOUT, one second buffer per round
     /** Zeit (in ms), die ein Spiel höchstens dauern sollte. */
     @JvmField
     val GAME_TIMEOUT = TOTAL_PIECE_SHAPES * COLORS * SOFT_TIMEOUT

plugin/src/test/sc/plugin2021/GameTest.kt

@@ -18,7 +18,10 @@ import sc.plugin2021.util.GameRuleLogic
 import sc.shared.PlayerScore
 import sc.shared.ScoreCause
 import java.math.BigDecimal
+import kotlin.time.ExperimentalTime
+import kotlin.time.milliseconds
 
+@OptIn(ExperimentalTime::class)
 class GameTest: WordSpec({
     isolationMode = IsolationMode.SingleInstance
     val startGame = {
@@ -28,7 +31,7 @@ class GameTest: WordSpec({
         game.start()
         Pair(game, game.currentState)
     }
-    "A Game start with two players" When {
+    "A Game started with two players" When {
         "played normally" should {
             val (game, state) = startGame()
 
@@ -47,7 +50,7 @@ class GameTest: WordSpec({
                 }
             })
 
-            "finish without issues" {
+            "finish without issues".config(invocationTimeout = Constants.GAME_TIMEOUT.milliseconds) {
                 while (true) {
                     try {
                         val condition = game.checkWinCondition()

sdk/src/server-api/sc/api/plugins/IGamePlugin.kt

@@ -5,13 +5,14 @@ import sc.shared.ScoreDefinition
 import java.util.ServiceLoader
 
 interface IGamePlugin: IPlugin {
-    fun id(): String
+    val id: String
+    val scoreDefinition: ScoreDefinition
+    val gameTimeout: Int
+    
     /** @return eine neues Spiel dieses Typs. */
     fun createGame(): IGameInstance
     fun createGameFromState(state: IGameState): IGameInstance
 
-    val scoreDefinition: ScoreDefinition
-    
     companion object {
         @JvmStatic
         fun loadPlugin(): IGamePlugin {
@@ -23,6 +24,6 @@ interface IGamePlugin: IPlugin {
 
         @JvmStatic
         fun loadPluginId(): String =
-                loadPlugin().id()
+                loadPlugin().id
     }
 }

sdk/src/server-api/sc/framework/plugins/ActionTimeout.java

@@ -21,8 +21,8 @@ public class ActionTimeout {
   private long startTimestamp = 0;
   private long stopTimestamp = 0;
 
-  private static final long DEFAULT_HARD_TIMEOUT = 10000;
-  private static final long DEFAULT_SOFT_TIMEOUT = 5000;
+  private static final int DEFAULT_HARD_TIMEOUT = 10000;
+  private static final int DEFAULT_SOFT_TIMEOUT = 5000;
 
   private enum Status {
     NEW, STARTED, STOPPED
@@ -32,11 +32,11 @@ public ActionTimeout(boolean canTimeout) {
     this(canTimeout, DEFAULT_HARD_TIMEOUT, DEFAULT_SOFT_TIMEOUT);
   }
 
-  public ActionTimeout(boolean canTimeout, long hardTimeoutInMilliseconds) {
+  public ActionTimeout(boolean canTimeout, int hardTimeoutInMilliseconds) {
     this(canTimeout, hardTimeoutInMilliseconds, hardTimeoutInMilliseconds);
   }
 
-  public ActionTimeout(boolean canTimeout, long hardTimeoutInMilliseconds, long softTimeoutInMilliseconds) {
+  public ActionTimeout(boolean canTimeout, int hardTimeoutInMilliseconds, int softTimeoutInMilliseconds) {
     if (hardTimeoutInMilliseconds < softTimeoutInMilliseconds) {
       throw new IllegalArgumentException(
               "HardTimeout must be greater or equal the SoftTimeout");

server/test/sc/server/plugins/TestGame.kt

@@ -57,7 +57,7 @@ data class TestGame(
     override fun loadGameInfo(gameInfo: Any) {}
 
     override fun getTimeoutFor(player: Player): ActionTimeout =
-            ActionTimeout(false, 100000000L, 20000000L)
+            ActionTimeout(false)
 
     companion object {
         private val logger = LoggerFactory.getLogger(TestGame::class.java)