fix: RectangularBoard serialization - all tests pass

Author: xeruf

.dev/githooks/commit-msg

@@ -5,7 +5,7 @@ scopes_file=".dev/scopes.txt"
 test -r $scopes_file &&
   scopes="($(cat "$scopes_file" | sed '/^\(#.*\|\)$/d' | sed ':a;N;s/\n/|/g;ta'))"
 
-grep -Eq "(fix|feat|docs|style|refactor|test|chore|rework|release)(\(${scopes:-.*}(/.+)?\))?: [a-z]" "$1"
+grep -Eq "(fix|feat|docs|style|refactor|test|chore|rework|release)(\(${scopes:-.*}(/.+)?\))?: [A-z]" "$1"
 result=$?
 if test $result -ne 0
 then echo "Please check the guidelines at http://karma-runner.github.io/latest/dev/git-commit-msg.html$(test -n "$scopes" && echo ", the scope should be one of $scopes as defined in $scopes_file")"

plugin/src/test/kotlin/sc/plugin2023/GamePlayTest.kt

@@ -7,6 +7,7 @@ import io.kotest.matchers.booleans.*
 import io.kotest.matchers.collections.shouldNotBeEmpty
 import io.kotest.matchers.shouldBe
 import io.kotest.matchers.shouldNotBe
+import org.slf4j.LoggerFactory
 import sc.api.plugins.IGamePlugin
 import sc.api.plugins.IGameState
 import sc.api.plugins.Team
@@ -25,6 +26,7 @@ import kotlin.time.ExperimentalTime
  * It is the only test that should stay between seasons. */
 @OptIn(ExperimentalTime::class)
 class GamePlayTest: WordSpec({
+    val logger = LoggerFactory.getLogger(GamePlayTest::class.java)
     isolationMode = IsolationMode.SingleInstance
     fun createGame() = IGamePlugin.loadPlugin().createGame() as AbstractGame
     "A Game" should {
@@ -62,13 +64,14 @@ class GamePlayTest: WordSpec({
             var finalState: Int? = null
             game.addGameListener(object: IGameListener {
                 override fun onGameOver(results: Map<Player, PlayerScore>) {
-                    println("Game over: $results")
+                    logger.info("Game over: $results")
                 }
 
                 override fun onStateChanged(data: IGameState, observersOnly: Boolean) {
                     data.hashCode() shouldNotBe finalState
                     // hashing it to avoid cloning, since we get the original mutable object
                     finalState = data.hashCode()
+                    logger.debug("Updating state to $finalState")
                 }
             })
 
@@ -77,14 +80,18 @@ class GamePlayTest: WordSpec({
                     try {
                         val condition = game.checkWinCondition()
                         if (condition != null) {
-                            println("Game ended with $condition")
+                            logger.info("Game ended with $condition")
                             break
                         }
+                        
+                        if(finalState != null)
+                            finalState shouldBe state.hashCode()
+                        
                         val moves = state.getPossibleMoves()
                         moves.shouldNotBeEmpty()
                         game.onAction(game.players[state.currentTeam.index], moves.random())
                     } catch (e: Exception) {
-                        println(e.message)
+                        logger.warn(e.message)
                         break
                     }
                 }

sdk/src/main/server-api/sc/api/plugins/RectangularBoard.kt

@@ -68,7 +68,7 @@ open class RectangularBoard<FIELD: IField<FIELD>>(
     override fun toString() =
             gameField.joinToString(separator = "\n") { row ->
                 row.joinToString(separator = "") { it.toString() }
-            }
+            }.ifEmpty { "Empty Board@" + System.identityHashCode(this) }
 
     override fun clone() = RectangularBoard(this.gameField)
 
@@ -98,15 +98,24 @@ open class RectangularBoard<FIELD: IField<FIELD>>(
         }
     }
 
-    override fun containsAll(elements: Collection<FIELD>): Boolean {
-        TODO("Not yet implemented")
-    }
+    override fun containsAll(elements: Collection<FIELD>): Boolean = elements.all { contains(it) }
 
-    override fun contains(element: FIELD): Boolean {
-        TODO("Not yet implemented")
-    }
+    override fun contains(element: FIELD): Boolean = gameField.any { it.contains(element) }
 
     // TODO do this properly for non-squared boards
     operator fun get(index: Int): FIELD =
             gameField[index.div(gameField.size)][index.mod(gameField.size)]
+    
+    fun readResolve(): Any {
+        if(gameField == null) {
+            val field = RectangularBoard::class.java.getDeclaredField("gameField")
+            field.isAccessible = true
+            field.set(this, ArrayList<MutableList<FIELD>>())
+        }
+        return this
+    }
+    
+    override fun equals(other: Any?) = gameField == (other as? RectangularBoard<*>)?.gameField
+    
+    override fun hashCode(): Int = gameField.hashCode()
 }

sdk/src/main/server-api/sc/framework/PublicCloneable.kt

@@ -1,6 +1,8 @@
 package sc.framework
 
-interface PublicCloneable<T: Cloneable>: Cloneable {
+import java.io.Serializable
+
+interface PublicCloneable<T: Cloneable>: Cloneable, Serializable {
     /** Eine tiefe Kopie des Objekts. */
     public override fun clone(): T
 }

sdk/src/main/server-api/sc/framework/plugins/AbstractGame.kt

@@ -242,7 +242,8 @@ abstract class AbstractGame(override val pluginUUID: String): IGameInstance, Pau
 
     protected fun notifyOnNewState(mementoState: IGameState, observersOnly: Boolean) {
         listeners.forEach {
-            logger.debug("Notifying $it about new game state")
+            if(logger.isDebugEnabled)
+                logger.debug("Notifying $it about new game state with hash ${mementoState.hashCode()}")
             try {
                 it.onStateChanged(mementoState, observersOnly)
             } catch(e: Exception) {

sdk/src/test/config/sc/helpers/XStreamMatcher.kt

@@ -15,12 +15,16 @@ object XStreamProjectListener: ProjectListener {
 
 lateinit var testXStream: XStream
 
-inline infix fun <reified T : Any> T.shouldSerializeTo(serialized: String)
-    = checkSerialization(testXStream, this, serialized)
+inline infix fun <reified T: Any> T.shouldSerializeTo(serialized: String) =
+        checkSerialization(testXStream, this, serialized)
 
 inline fun <reified T: Any> checkSerialization(
         xStream: XStream, obj: T, serialized: String,
-        matcher: (obj: T, deserialized: T) -> Unit = { original, deserialized -> deserialized shouldBe original }) {
+        matcher: (obj: T, deserialized: T) -> Unit = { original, deserialized ->
+            deserialized shouldBe original
+            deserialized.hashCode() shouldBe original.hashCode()
+        },
+) {
     xStream.toXML(obj) shouldBe serialized
     val deserialized = xStream.fromXML(serialized)
     deserialized.javaClass shouldBe obj.javaClass