Added descriptions and IT

Author: Bytekeeper

.travis.yml

@@ -21,8 +21,17 @@ before_script:
   - popd
   - "[ -f /tmp/sc-docker/starcraft.zip ] || cp sc-docker/scbw/local_docker/starcraft.zip /tmp/sc-docker/starcraft.zip"
   - scbw.play --install
+  - unzip sc-docker/scbw/local_docker/starcraft.zip -d it/openbw/
+
 script:
   - sh mvnw clean install
   - sh mvnw -f it/bots/pom.xml package
   - for bot in $(ls -d it/bots/*/); do BOTNAME=$(basename $bot); echo "Setting up $BOTNAME"; mkdir -p "$HOME/.scbw/bots/$BOTNAME/AI" "$HOME/.scbw/bots/$BOTNAME/read" "$HOME/.scbw/bots/$BOTNAME/write"; cp it/sc-docker-support/BWAPI.dll "$HOME/.scbw/bots/$BOTNAME"; cp "$bot/target/"*-with-dependencies.jar "$HOME/.scbw/bots/$BOTNAME/AI"; cp "$bot/bot.json" "$HOME/.scbw/bots/$BOTNAME"; done
-  - scbw.play --headless --bots jbwapibot SittingDuck --timeout 180 --docker_image starcraft:game 2>&1 | grep 'Winner is BotPlayer:jbwapibot:T' || (cat $HOME/.scbw/games/*/logs_0/* && false)
+  - scbw.play --headless --bots jbwapibot SittingDuck --timeout 180 --docker_image starcraft:game 2>&1 | grep 'Winner is BotPlayer:jbwapibot:T' || (cat $HOME/.scbw/games/*/logs_0/* && exit 1)
+  - pushd it/openbw
+  - chmod u+x BWAPILauncher
+  - BWAPI_CONFIG_AUTO_MENU__RACE=Terran BWAPI_CONFIG_AUTO_MENU__MAP=~/.scbw/maps/sscai/\(3\)Neo\ Moon\ Glaive.scx ./BWAPILauncher&
+  - BWAPI_CONFIG_AUTO_MENU__RACE=Terran BWAPI_CONFIG_AUTO_MENU__MAP=~/.scbw/maps/sscai/\(3\)Neo\ Moon\ Glaive.scx ./BWAPILauncher&
+  - sleep 1
+  - java -cp ../bots/SittingDuck/target/SittingDuck-*-jar-with-dependencies.jar SittingDuck &
+  - java -jar ../bots/jbwapibot/target/MarineHell-*-jar-with-dependencies.jar | grep "Hello from JBWAPI!" || exit 1

it/bots/SittingDuck/src/main/java/SittingDuck.java

@@ -1,4 +1,8 @@
+import bwapi.BWClient;
 import bwapi.DefaultBWListener;
 
 public class SittingDuck extends DefaultBWListener {
+    public static void main(String[] args) {
+        new BWClient(new SittingDuck()).startGame();
+    }
 }

it/openbw/BWAPILauncher

@@ -178,7 +178,7 @@ boolean connect() {
         }
 
         try {
-            clientConnector.waitForServerReady();
+            clientConnector.waitForServerData();
         } catch (Exception e) {
             System.err.println(e.getMessage());
             if (bwClient.getConfiguration().getDebugConnection()) {

src/main/java/bwapi/Client.java

@@ -2,6 +2,9 @@
 
 import java.io.IOException;
 
+/**
+ * Client - Server connection abstraction
+ */
 interface ClientConnection {
     void disconnect();
 
@@ -11,8 +14,6 @@ interface ClientConnection {
 
     void connectSharedLock(int serverProcID) throws IOException;
 
-    void waitForServerReady() throws IOException;
-
     void waitForServerData() throws IOException;
 
     void submitClientData() throws IOException;

src/main/java/bwapi/ClientConnection.java

@@ -1,26 +1,44 @@
 package bwapi;
 
 import com.sun.jna.LastErrorException;
+import com.sun.jna.Library;
 import com.sun.jna.Native;
 import com.sun.jna.Pointer;
 import com.sun.jna.platform.linux.Fcntl;
-import com.sun.jna.platform.linux.LibC;
 import com.sun.jna.platform.linux.LibRT;
+import com.sun.jna.platform.unix.LibC;
 import org.newsclub.net.unix.AFUNIXSocket;
 import org.newsclub.net.unix.AFUNIXSocketAddress;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.function.Supplier;
 
 import static com.sun.jna.platform.linux.Mman.*;
 
+/**
+ * To be used with OpenBWs BWAPI including server support. At time of writing, only the following fork includes this:
+ * https://github.com/basil-ladder/openbw
+ */
 class ClientConnectionPosix implements ClientConnection {
     interface LibCExt extends LibC {
         LibCExt INSTANCE = Native.load(LibCExt.class);
 
         Pointer mmap(Pointer addr, int length, int prot, int flags, int fd, int offset) throws LastErrorException;
     }
 
+    interface PosixShm extends Library {
+        PosixShm INSTANCE = ((Supplier<PosixShm>) (() -> {
+            // Linux required librt to be loaded, Unix generally does not
+            if (System.getProperty("os.name").toLowerCase().contains("linux")) {
+                Native.load("rt", LibRT.class);
+            }
+            return Native.load(PosixShm.class);
+        })).get();
+
+        int shm_open(String name, int oflag, int mode);
+    }
+
     private AFUNIXSocket syncSocket = null;
 
     @Override
@@ -37,7 +55,7 @@ public void disconnect() {
 
     @Override
     public WrappedBuffer getGameTable() {
-        int fd = LibRT.INSTANCE.shm_open("/bwapi_shared_memory_game_list", Fcntl.O_RDWR, 0);
+        int fd = PosixShm.INSTANCE.shm_open("/bwapi_shared_memory_game_list", Fcntl.O_RDWR, 0);
         if (fd < 0) throw new IllegalStateException("SHM not found");
         Pointer gameTableView = LibCExt.INSTANCE.mmap(Pointer.NULL, GameTable.SIZE, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
         return new WrappedBuffer(gameTableView, GameTable.SIZE);
@@ -67,11 +85,6 @@ public void connectSharedLock(int serverProcID) {
         }
     }
 
-    @Override
-    public void waitForServerReady() {
-        // NOOP
-    }
-
     @Override
     public void waitForServerData() throws IOException {
         while ((syncSocket.getInputStream().read() != 2)) ;

src/main/java/bwapi/ClientConnectionPosix.java

@@ -8,8 +8,10 @@
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.RandomAccessFile;
-import java.io.UncheckedIOException;
 
+/**
+ * Default Windows BWAPI pipe connection with shared memory.
+ */
 class ClientConnectionW32 implements ClientConnection {
     private static final int READ_WRITE = 0x1 | 0x2 | 0x4;
 
@@ -65,29 +67,13 @@ public void connectSharedLock(int serverProcID) {
         }
     }
 
-    @Override
-    public void waitForServerReady() throws IOException {
-        byte code = 1;
-        while (code != 2) {
-            try {
-                code = pipeObjectHandle.readByte();
-            } catch (IOException e) {
-                throw new UncheckedIOException("Unable to read pipe object.", e);
-            }
-        }
-    }
-
     @Override
     public void waitForServerData() throws IOException {
-        byte code = 1;
-        pipeObjectHandle.writeByte(code);
-        while (code != 2) {
-            code = pipeObjectHandle.readByte();
-        }
+        while (pipeObjectHandle.readByte() != 2) ;
     }
 
     @Override
     public void submitClientData() throws IOException {
-        // Noop
+        pipeObjectHandle.writeByte(1);
     }
 }