Merge pull request #2 from leancloud/feat/hook-test

add game hook test

Author: ylgrgyq

.gitignore

@@ -1,4 +1,6 @@
 .idea/
+.vscode/
+__pycache__/
 # Compiled class file
 *.class
 

game-hook-base/pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>cn.leancloud.play</groupId>
     <artifactId>game-hook-base</artifactId>
-    <version>1.2-SNAPSHOT</version>
+    <version>1.3-SNAPSHOT</version>
 
     <properties>
         <clojure.version>1.10.0</clojure.version>

game-hook-template/pom.xml

@@ -12,7 +12,7 @@
         <dependency>
             <groupId>cn.leancloud.play</groupId>
             <artifactId>game-hook-base</artifactId>
-            <version>1.1</version>
+            <version>1.2</version>
         </dependency>
     </dependencies>
 

game-hook-template/src/main/java/cn/leancloud/play/hook/template/MasterIsWatchingYouHook.java

@@ -0,0 +1,50 @@
+package cn.leancloud.play.hook.template;
+
+import cn.leancloud.play.hook.AbstractGameHook;
+import cn.leancloud.play.hook.Actor;
+import cn.leancloud.play.hook.HookedRoom;
+import cn.leancloud.play.hook.context.BeforeRaiseRpcContext;
+import cn.leancloud.play.hook.request.RaiseRpcOptions;
+import cn.leancloud.play.hook.request.RaiseRpcRequest;
+import cn.leancloud.play.hook.request.ReceiverGroup;
+
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
+
+
+public class MasterIsWatchingYouHook extends AbstractGameHook {
+    @Override
+    public void onBeforeRaiseRpc(BeforeRaiseRpcContext ctx) {
+        RaiseRpcRequest req = ctx.getRequest();
+        HookedRoom room = ctx.getHookedRoom();
+        Actor master = room.getMaster();
+        if (master == null) {
+            // no master in this room
+            // reject and swallow this request
+            ctx.skipProcess();
+            return;
+        }
+
+        boolean masterIsInTargets = true;
+        List<Integer> targetActors = req.getToActorIds();
+        if (!targetActors.isEmpty() &&
+                targetActors.stream().noneMatch(actorId -> actorId == master.getActorId())) {
+            masterIsInTargets = false;
+
+            ArrayList<Integer> newTargets = new ArrayList<>(targetActors);
+            newTargets.add(master.getActorId());
+            req.setToActorIds(newTargets);
+        }
+
+        ctx.continueProcess();
+
+        if (!masterIsInTargets) {
+            String msg = String.format("actor %d is sending sneaky rpc", req.getFromActorId());
+            room.raiseRpcToReceiverGroup(ReceiverGroup.ALL,
+                    master.getActorId(),
+                    msg.getBytes(StandardCharsets.UTF_8),
+                    RaiseRpcOptions.emptyOption);
+        }
+    }
+}

…/java/hook/template/MyFancyGameHook.java …/play/hook/template/MyFancyGameHook.javagame-hook-template/src/main/java/hook/template/MyFancyGameHook.java renamed to game-hook-template/src/main/java/cn/leancloud/play/hook/template/MyFancyGameHook.java game-hook-template/src/main/java/hook/template/MyFancyGameHook.java renamed to game-hook-template/src/main/java/cn/leancloud/play/hook/template/MyFancyGameHook.java

@@ -1,4 +1,4 @@
-package hook.template;
+package cn.leancloud.play.hook.template;
 
 import cn.leancloud.play.hook.AbstractGameHook;
 import cn.leancloud.play.hook.context.*;

game-hook-template/src/main/java/cn/leancloud/play/hook/template/MyFancyHookFactory.java

@@ -0,0 +1,25 @@
+package cn.leancloud.play.hook.template;
+
+import cn.leancloud.play.hook.HookedRoom;
+import cn.leancloud.play.utils.Log;
+import cn.leancloud.play.hook.GameHook;
+import cn.leancloud.play.hook.HookFactory;
+
+import java.util.Map;
+
+public class MyFancyHookFactory implements HookFactory {
+    @Override
+    public GameHook create(HookedRoom room, String hookName, Map<String, String> initConfigs) {
+        if (hookName != null && hookName.length() > 0) {
+            switch (hookName) {
+                case "fancy-hook":
+                    return new MyFancyGameHook(initConfigs);
+                case "master is watching you hook":
+                    return new MasterIsWatchingYouHook();
+            }
+        }
+
+        Log.error("unknown hook name {}", hookName);
+        return null;
+    }
+}

game-hook-template/src/main/java/hook/template/MyFancyHookFactory.java

@@ -0,0 +1,9 @@
+
+[local]
+APPID=hahahahaha-long-long-long-long-local-appid
+APPKEY=keykeykeykey
+APP_MASTER_KEY=master-key
+GAME_ROUTER_URL=http://localhost:8081/v1
+GAME_ROUTER_INTERNAL_URL=http://localhost:8081
+GAME_ROUTER_AUTH_KEY=key-auth-key
+TEST_WITH_HOOK=True

integration-test-scripts/config.ini

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+RED='\033[0;31m'
+NC='\033[0m'
+
+CONFIG_TAG="local"
+
+export PYTHONPATH=../testing-tools
+
+function execute_test
+{
+    local TEST_FILE=$1
+
+    echo -e "\n${RED}start run test: $TEST_FILE${NC}\n"
+    python3 $TEST_FILE $CONFIG_TAG
+    if [ "$?" -ne 0 ]; then
+        echo -e "\n${RED}failed finishing test: $TEST_FILE${NC}\n"
+        break
+    else
+        echo -e "\n${RED}finishing test: $TEST_FILE${NC}\n"
+    fi
+}
+
+if [ "$#" == 1 ]; then
+    CONFIG_TAG=$1
+fi
+
+if [ "$#" == 2 ]; then
+    CONFIG_TAG=$1
+    execute_test $2
+else
+    for i in test_*.py; do
+        execute_test $i
+        sleep 0.5
+    done
+
+fi
+

integration-test-scripts/run-tests.sh

@@ -0,0 +1,59 @@
+from tools.base import client
+from tools import utils
+from tools.base import lobby_shortcuts
+from tools.base.matcher import MATCH_ANY
+from tools.base import config
+
+
+@utils.integration_test()
+def test_game_hook():
+    if not config.TEST_WITH_HOOK:
+        return
+
+    room_id = "master_is_watching_you_hook_room"
+    client_a, client_b, client_c = 'Alpha', 'Bravo', 'Charlie'
+
+    ca = utils.open_session(
+        client_a,
+        lambda: lobby_shortcuts.create_room(client_a, room_id=room_id))
+    ca.send_msg_with_expect_msgs({
+        'cmd': 'conv',
+        'op': 'start',
+        'cid': room_id,
+        'maxMember': 23,
+        'hookName': 'master is watching you hook'
+    }, [{
+        'cmd': 'conv',
+        'op': 'started',
+        'masterActorId': 1,
+        "members": [{
+            "pid": client_a,
+            "actorId": 1,
+            "attr": {}
+        }],
+        "open": True
+    }])
+
+    cb, cc = list(
+        map(lambda c: utils.join_room(c, room_id), [client_b, client_c]))
+
+    # Charlie send a secret msg to Bravo, but it is caught by master Alpha
+    sneaky_msg = "I'm super man"
+    future = client.add_expect_msgs_for_all(
+        [ca, cb], [{
+            'cmd': 'direct',
+            'fromActorId': 3,
+            'msg': sneaky_msg,
+            'timestamp': MATCH_ANY
+        }, {
+            'cmd': 'direct',
+            'fromActorId': 1,
+            'msg': "actor 3 is sending sneaky rpc",
+            'timestamp': MATCH_ANY
+        }])
+    cc.send_msg({'cmd': 'direct', 'msg': sneaky_msg, 'toActorIds': [2]}, )
+    future.get()
+
+
+if __name__ == '__main__':
+    test_game_hook()