rework: centralize XStream instantiation & remove plugin api

Author: xeruf

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

@@ -2,7 +2,6 @@
 
 import ch.qos.logback.classic.Level;
 import ch.qos.logback.classic.Logger;
-import com.thoughtworks.xstream.XStream;
 import jargs.gnu.CmdLineParser;
 import jargs.gnu.CmdLineParser.Option;
 import org.slf4j.LoggerFactory;
@@ -11,7 +10,6 @@
 import sc.networking.TcpNetwork;
 import sc.networking.clients.XStreamClient;
 import sc.plugin2021.util.Constants;
-import sc.protocol.helpers.LobbyProtocol;
 import sc.protocol.requests.*;
 import sc.protocol.responses.*;
 import sc.server.Configuration;
@@ -21,7 +19,6 @@
 import java.io.IOException;
 import java.net.Socket;
 import java.util.Arrays;
-import java.util.Collection;
 import java.util.List;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
@@ -132,7 +129,7 @@ public static void main(String[] args) {
         Runtime.getRuntime().addShutdownHook(new Thread(server::destroyForcibly));
         Thread.sleep(1000);
       }
-      testclient = new TestClient(Configuration.getXStream(), sc.plugin2020.util.Configuration.getClassesToRegister(), host, port, numberOfTests);
+      testclient = new TestClient(host, port, numberOfTests);
       Runtime.getRuntime().addShutdownHook(new Thread(testclient::printScores));
     } catch (Exception e) {
       logger.error("Error while initializing: " + e.toString());
@@ -155,11 +152,9 @@ public static void main(String[] args) {
 
   private ExecutorService waiter = Executors.newSingleThreadExecutor();
 
-  public TestClient(XStream xstream, Collection<Class<?>> protocolClasses,
-                    String host, int port, int totalTests) throws IOException {
-    super(xstream, createTcpNetwork(host, port));
-    LobbyProtocol.registerMessages(xstream);
-    LobbyProtocol.registerAdditionalMessages(xstream, protocolClasses);
+  public TestClient(String host, int port, int totalTests) throws IOException {
+    super(createTcpNetwork(host, port));
+
     this.host = host;
     this.port = port;
     this.totalTests = totalTests;

plugin/src/client/sc/plugin2020/AbstractClient.java

@@ -48,7 +48,7 @@ public abstract class AbstractClient implements ILobbyClientListener {
   public AbstractClient(String host, int port, PlayerType id) throws IOException {
     this.gameType = GamePlugin.PLUGIN_UUID;
     try {
-      this.client = new LobbyClient(Configuration.getXStream(), Configuration.getClassesToRegister(), host, port);
+      this.client = new LobbyClient(host, port);
     } catch(ConnectException e) {
       logger.error("Could not connect to Server: " + e.getMessage());
       System.exit(1);

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

@@ -7,7 +7,6 @@ import sc.framework.plugins.protocol.MoveRequest
 import sc.networking.clients.IControllableGame
 import sc.networking.clients.ILobbyClientListener
 import sc.networking.clients.LobbyClient
-import sc.plugin2021.util.Configuration
 import sc.protocol.responses.PrepareGameProtocolMessage
 import sc.protocol.responses.ProtocolErrorMessage
 import sc.protocol.responses.ProtocolMessage
@@ -39,8 +38,8 @@ abstract class AbstractClient @Throws(IOException::class) constructor(
     protected var handler: IGameHandler? = null
 
     /** The lobby client that connects to the room. Stops on connection failure. */
-    private val client = try {
-        LobbyClient(Configuration.xStream, Configuration.classesToRegister, host, port)
+    private val client: LobbyClient = try {
+        LobbyClient(host, port)
     } catch (e: ConnectException) {
         logger.error("Could not connect to Server: ${e.message}")
         exitProcess(1)

plugin/src/server/sc/plugin2020/Game.java

@@ -201,7 +201,7 @@ public WinCondition checkWinCondition() {
   public void loadFromFile(String file) {
     logger.info("Loading game from: " + file);
     GameLoader gl = new GameLoader(GameState.class);
-    Object gameInfo = gl.loadGame(Configuration.getXStream(), file);
+    Object gameInfo = gl.loadGame(file);
     if(gameInfo != null) {
       loadGameInfo(gameInfo);
     }
@@ -239,7 +239,7 @@ public void loadFromFile(String file, int turn) {
       e.printStackTrace();
     }
     GameLoader gl = new GameLoader(GameState.class);
-    Object gameInfo = gl.loadGame(Configuration.getXStream(), "./tmp_replay.xml");
+    Object gameInfo = gl.loadGame("./tmp_replay.xml");
     if(gameInfo != null) {
       loadGameInfo(gameInfo);
     }

plugin/src/server/sc/plugin2020/GamePlugin.java

@@ -2,9 +2,10 @@
 
 import sc.api.plugins.IGameInstance;
 import sc.api.plugins.IGamePlugin;
-import sc.api.plugins.host.IGamePluginHost;
+import sc.helpers.XStreamKt;
 import sc.plugin2020.util.Configuration;
 import sc.plugins.PluginDescriptor;
+import sc.protocol.helpers.LobbyProtocol;
 import sc.shared.ScoreAggregation;
 import sc.shared.ScoreDefinition;
 import sc.shared.ScoreFragment;
@@ -30,8 +31,8 @@ public IGameInstance createGame() {
   }
 
   @Override
-  public void initialize(IGamePluginHost host) {
-    host.registerProtocolClasses(Configuration.getClassesToRegister());
+  public void initialize() {
+    LobbyProtocol.registerAdditionalMessages(XStreamKt.getXStream(), Configuration.getClassesToRegister());
   }
 
   @Override

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

@@ -2,12 +2,13 @@ package sc.plugin2021
 
 import sc.api.plugins.IGameInstance
 import sc.api.plugins.IGamePlugin
-import sc.api.plugins.host.IGamePluginHost
-import sc.plugin2021.util.Configuration.classesToRegister
+import sc.plugin2021.xstream.BoardConverter
 import sc.plugins.PluginDescriptor
+import sc.protocol.helpers.LobbyProtocol
 import sc.shared.ScoreAggregation
 import sc.shared.ScoreDefinition
 import sc.shared.ScoreFragment
+import sc.helpers.xStream as xstream
 
 @PluginDescriptor(name = "Blokus", uuid = "swc_2021_blokus", author = "")
 class GamePlugin: IGamePlugin {
@@ -20,19 +21,34 @@ class GamePlugin: IGamePlugin {
                 ScoreFragment("Gewinner"),
                 ScoreFragment("\u2205 Punkte", ScoreAggregation.AVERAGE)
         ))
+        
+        private val classesToRegister: List<Class<*>>
+            get() = listOf(Board::class.java, Coordinates::class.java,
+                    Field::class.java, GameState::class.java,
+                    Move::class.java, Piece::class.java,
+                    Color::class.java, Team::class.java)
+        
+        fun registerXStream() {
+            LobbyProtocol.registerAdditionalMessages(xstream, classesToRegister)
+            
+            xstream.registerConverter(BoardConverter())
+        }
+        
+        @JvmStatic
+        val xStream by lazy {
+            registerXStream()
+            xstream
+        }
     }
 
     override fun createGame(): IGameInstance {
         return Game()
     }
 
-    override fun initialize(host: IGamePluginHost) {
-        host.registerProtocolClasses(classesToRegister)
-    }
-    
-    override fun unload() {
-        TODO("Not yet implemented")
+    override fun initialize() {
+        registerXStream()
     }
 
     override fun getScoreDefinition(): ScoreDefinition = SCORE_DEFINITION
+    
 }

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

@@ -4,7 +4,7 @@ import io.kotest.matchers.shouldBe
 import io.kotest.core.spec.style.StringSpec
 import org.junit.jupiter.api.assertDoesNotThrow
 import org.junit.jupiter.api.assertThrows
-import sc.plugin2021.util.Configuration
+import sc.plugin2021.GamePlugin.Companion.xStream
 import sc.plugin2021.util.GameRuleLogic
 import sc.shared.InvalidMoveException
 
@@ -68,13 +68,12 @@ class GameStateTest: StringSpec({
 
     }
     "XML conversion works" {
-        val xstream = Configuration.xStream
         val state = GameState()
 
-        xstream.fromXML(xstream.toXML(state)).toString() shouldBe state.toString()
-        xstream.fromXML(xstream.toXML(state))            shouldBe state
+        xStream.fromXML(xStream.toXML(state)).toString() shouldBe state.toString()
+        xStream.fromXML(xStream.toXML(state))            shouldBe state
 
-        val transformed = xstream.fromXML(xstream.toXML(GameState())) as GameState
+        val transformed = xStream.fromXML(xStream.toXML(GameState())) as GameState
         transformed.deployedPieces shouldBe null
         GameRuleLogic.isFirstMove(transformed) shouldBe true
         transformed.getPointsForPlayer(Team.ONE)

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

@@ -4,7 +4,7 @@ import io.kotest.matchers.shouldBe
 import io.kotest.matchers.shouldNotBe
 import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.collections.shouldContainExactly
-import sc.plugin2020.util.Constants
+import sc.plugin2021.util.Constants
 import sc.plugin2021.util.GameRuleLogic
 import sc.shared.PlayerScore
 import sc.shared.ScoreCause

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

@@ -7,6 +7,7 @@ import io.kotest.matchers.maps.shouldContain
 import io.kotest.matchers.maps.shouldContainExactly
 import io.kotest.matchers.shouldBe
 import org.opentest4j.AssertionFailedError
+import sc.plugin2021.GamePlugin.Companion.xStream
 import sc.plugin2021.util.*
 
 
@@ -186,9 +187,9 @@ class PieceTest: StringSpec({
                     </piece>
                 """.trimIndent())
         ) {piece, xml ->
-            Configuration.xStream.toXML(piece) shouldBe xml
+            xStream.toXML(piece) shouldBe xml
 
-            val converted = Configuration.xStream.fromXML(Configuration.xStream.toXML(piece)) as Piece
+            val converted = xStream.fromXML(xStream.toXML(piece)) as Piece
             converted.toString() shouldBe piece.toString()
             converted shouldBe piece
         }