Merge branch 'master'

Author: xeruf

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
+* @xeruf @SKoschnike

.gitignore

@@ -8,5 +8,7 @@ out/
 !.idea/codeStyles/
 *.iml
 
+# Artifacts from test runs
 logs/
-log/
+log/
+replays/

CHANGELOG.md

@@ -8,17 +8,24 @@ The version should always be in sync with the [GUI](https://github.com/CAU-Kiel-
 - The major version `x` corresponds to the year of the contest and thus only changes once a year
 - `y` is bumped for any major updates or backwards-incompatible changes
 
-## [21.4.0](https://github.com/CAU-Kiel-Tech-Inf/backend/commits/21.4.0)
+## [22.0.0](https://github.com/CAU-Kiel-Tech-Inf/backend/commits/22.0.0)
 - Removed PlayerScoreRequest - add up the GameResults instead
 
+## [21.4.0](https://github.com/CAU-Kiel-Tech-Inf/backend/commits/21.4.0) - 2021-05-28
+- Enable preparing games without reservations
+- Implement generic replay saving & loading
+- Create an AdminClient to interface more conveniently with the server
+- Distinguish RoomMessages from ProtocolPackets
+- The GamePaused message is now actually sent after a Game has been paused
+
 ## [21.3.3](https://github.com/CAU-Kiel-Tech-Inf/backend/commits/21.3.3) - 2021-03-01
 - Game: Refactor turn advancing logic ([#391](https://github.com/CAU-Kiel-Tech-Inf/backend/pull/391))
 - Networking: Improve Exception handling within games and rooms ([#383](https://github.com/CAU-Kiel-Tech-Inf/backend/pull/383))
 
 ## [21.3.2](https://github.com/CAU-Kiel-Tech-Inf/backend/commits/21.3.2) - 2021-02-12
 ### Fixed
 - GameState: Round number is now always aligned with turn number (49676b64c)
-- TestClient: prevent a race-condition that could occur when getting the results of the first game (4f33fc01f)
+- TestClient: Prevent a race-condition that could occur when getting the results of the first game (4f33fc01f)
 
 ## [21.3.1](https://github.com/CAU-Kiel-Tech-Inf/backend/commits/21.3.1) - 2021-02-11
 ### Fixed

gradle.properties

@@ -1,4 +1,4 @@
 socha.gameName=blokus
 socha.version.year=21
-socha.version.minor=03
-socha.version.patch=03
+socha.version.minor=04
+socha.version.patch=00

player/src/main/sc/player2021/Starter.java

@@ -17,16 +17,18 @@
 public class Starter {
   private static final Logger logger = LoggerFactory.getLogger(Starter.class);
 
-  public Starter(String host, int port, String reservation) {
+  public Starter(String host, int port, String reservation, String roomId) {
     // Strategie zuweisen
     IGameHandler logic = new Logic();
     PlayerClient client = new PlayerClient(host, port, logic);
 
     // einem Spiel beitreten
-    if (reservation == null || reservation.isEmpty()) {
-      client.joinAnyGame();
-    } else {
+    if (reservation != null && !reservation.isEmpty()) {
       client.joinPreparedGame(reservation);
+    } else if (roomId != null) {
+      client.joinGameRoom(roomId);
+    } else {
+      client.joinAnyGame();
     }
   }
 
@@ -38,6 +40,7 @@ public static void main(String[] args) {
     CmdLineParser.Option hostOption = parser.addStringOption('h', "host");
     CmdLineParser.Option portOption = parser.addIntegerOption('p', "port");
     CmdLineParser.Option reservationOption = parser.addStringOption('r', "reservation");
+    CmdLineParser.Option roomOption = parser.addStringOption("room");
 
     try {
       // Parameter auslesen
@@ -51,11 +54,12 @@ public static void main(String[] args) {
     // Parameter laden
     String host = (String) parser.getOptionValue(hostOption, "localhost");
     int port = (Integer) parser.getOptionValue(portOption, SharedConfiguration.DEFAULT_PORT);
-    String reservation = (String) parser.getOptionValue(reservationOption, "");
+    String reservation = (String) parser.getOptionValue(reservationOption);
+    String room = (String) parser.getOptionValue(roomOption);
 
     // einen neuen client erzeugen
     try {
-      new Starter(host, port, reservation);
+      new Starter(host, port, reservation, room);
     } catch (Exception e) {
       logger.error("Beim Starten den Clients ist ein Fehler aufgetreten:", e);
       e.printStackTrace();
@@ -66,11 +70,12 @@ public static void main(String[] args) {
   private static void showHelp(String errorMsg) {
     String jarName = new File(Starter.class.getProtectionDomain().getCodeSource().getLocation().getFile()).getName();
     System.out.println("\n" + errorMsg);
-    System.out.println("\nBitte das Programm mit folgenden Parametern (optional) aufrufen: \n"
+    System.out.println("\nFolgende Parameter sind erlaubt: \n"
             + "java -jar " + jarName + " [{-h,--host} hostname]\n"
             + "                               [{-p,--port} port]\n"
-            + "                               [{-r,--reservation} reservierung]");
-    System.out.println("\nBeispiel: \n"
+            + "                               [{-r,--reservation} reservierung]\n"
+            + "                               [--room raumnummer]\n");
+    System.out.println("Beispiel: \n"
             + "java -jar " + jarName + " --host 127.0.0.1 --port 10500 --reservation 1234\n");
   }
 

plugin/src/main/sc/plugin2022/Game.kt

@@ -3,14 +3,14 @@ package sc.plugin2022
 import org.slf4j.LoggerFactory
 import sc.api.plugins.ITeam
 import sc.api.plugins.Team
+import sc.api.plugins.IMove
 import sc.api.plugins.exceptions.TooManyPlayersException
 import sc.framework.plugins.AbstractGame
 import sc.framework.plugins.ActionTimeout
 import sc.framework.plugins.Player
 import sc.plugin2022.util.Constants
 import sc.plugin2022.util.MoveMistake
 import sc.plugin2022.util.WinReason
-import sc.protocol.room.RoomMessage
 import sc.shared.InvalidMoveException
 import sc.shared.PlayerScore
 import sc.shared.ScoreCause
@@ -24,22 +24,18 @@ class Game(override val currentState: GameState = GameState()): AbstractGame<Pla
     private val availableTeams = ArrayDeque<ITeam>().also { it.addAll(Team.values()) }
     override fun onPlayerJoined(): Player {
         if (availableTeams.isEmpty())
-            throw TooManyPlayersException()
+            throw TooManyPlayersException(this)
 
         val player = Player(availableTeams.removeFirst())
         players.add(player)
         return player
     }
 
-    override val winners: MutableList<Player>
+    override val winners: List<Player>
         get() {
-            if (players.first().hasViolated()) {
-                if (players.last().hasViolated())
-                    return mutableListOf()
-                return players.subList(1, 2)
-            }
-            if (players.last().hasViolated())
-                return players.subList(0, 1)
+            val compliant = players.filter { !it.hasViolated() && !it.hasLeft() }
+            if (compliant.size < players.size)
+                return compliant
 
             val first = currentState.getPointsForTeam(players.first().team)
             val second = currentState.getPointsForTeam(players.last().team)
@@ -126,12 +122,12 @@ class Game(override val currentState: GameState = GameState()): AbstractGame<Pla
             ActionTimeout(true, Constants.HARD_TIMEOUT, Constants.SOFT_TIMEOUT)
 
     @Throws(InvalidMoveException::class)
-    override fun onRoundBasedAction(data: RoomMessage) {
-        if (data !is Move)
+    override fun onRoundBasedAction(move: IMove) {
+        if (move !is Move)
             throw InvalidMoveException(MoveMistake.INVALID_FORMAT)
 
-        logger.debug("Performing $data")
-        currentState.performMove(data)
+        logger.debug("Performing $move")
+        currentState.performMove(move)
         next()
         logger.debug("Current State: ${currentState.longString()}")
     }

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

@@ -40,9 +40,6 @@ class GameTest: WordSpec({
                     // hashing it to avoid cloning, since we get the original mutable object
                     finalState = data.hashCode()
                 }
-        
-                override fun onPaused(nextPlayer: Player) {
-                }
             })
 
             "finish without issues".config(invocationTimeout = Constants.GAME_TIMEOUT.milliseconds) {

sdk/build.gradle.kts

@@ -36,5 +36,5 @@ dependencies {
     implementation("xmlpull", "xmlpull", "1.1.3.1")
 
     "testConfigApi"("io.kotest", "kotest-assertions-core")
-    "testConfigApi"("io.kotest", "kotest-runner-junit5-jvm", "4.4.1")
+    "testConfigApi"("io.kotest", "kotest-runner-junit5-jvm", "4.4.3")
 }

sdk/src/framework/sc/shared/GameResult.kt

@@ -3,7 +3,8 @@ package sc.shared
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamImplicit
 import sc.framework.plugins.Player
-import sc.protocol.room.RoomMessage
+import sc.protocol.room.ObservableRoomMessage
+import sc.protocol.room.RoomOrchestrationMessage
 
 /**
  * Das Endergebnis eines Spiels.
@@ -17,7 +18,7 @@ data class GameResult(
         val scores: List<PlayerScore>,
         @XStreamImplicit(itemFieldName = "winner")
         val winners: List<Player>?
-): RoomMessage {
+): RoomOrchestrationMessage, ObservableRoomMessage {
 
     val isRegular: Boolean
         get() = scores.all { it.cause == ScoreCause.REGULAR }

sdk/src/framework/sc/shared/SlotDescriptor.kt

@@ -6,5 +6,7 @@ import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 @XStreamAlias(value = "slotDescriptor")
 data class SlotDescriptor
 @JvmOverloads constructor(
-    @XStreamAsAttribute val displayName: String = "Unknown",
-    @XStreamAsAttribute val canTimeout: Boolean = true)
+    @XStreamAsAttribute val displayName: String,
+    @XStreamAsAttribute val canTimeout: Boolean = true,
+    @XStreamAsAttribute val reserved: Boolean = true,
+)