ban, silence: support redis v3+ (MinoMino#36)

Author: em92

.github/workflows/test-pypa-ubuntu.yml

@@ -27,6 +27,8 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: 'true'
+      - name: Set up Redis server
+        run: sudo apt-get install redis
       - name: Include ppa repository
         run: sudo add-apt-repository ppa:deadsnakes/ppa
 
@@ -46,11 +48,6 @@ jobs:
       - name: Install pip
         run: python3 get-pip.py
 
-      # TODO: try to remove this after unpining redis
-      - name: Install setuptools
-        if: contains(fromJSON('["3.12"]'), matrix.python-version)
-        run: python3 get-pip.py "setuptools"
-
       - name: Install requirements
         run: python3 -m pip install -r requirements.txt
 

.github/workflows/test-ubuntu.yml

@@ -13,6 +13,8 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: 'true'
+      - name: Set up Redis server
+        run: sudo apt-get update && sudo apt-get install redis
       - name: Set up Python
         run: sudo apt-get install python3
       - name: Install requirements

.github/workflows/test-with-docker.yml

@@ -9,6 +9,9 @@ jobs:
         dockerfile-suffix: [
         "python35", "python36",
         ]
+        force-redis-package-version: [
+        "", "==2.10",
+        ]
 
     runs-on: ubuntu-latest
     steps:
@@ -26,6 +29,7 @@ jobs:
           push: false
           load: true
           tags: test:latest
+          build-args: FORCE_REDIS_PACKAGE_VERSION=${{ matrix.force-redis-package-version }}
 
       - name: Test
         run: |
@@ -35,5 +39,5 @@ jobs:
       - name: Upload coverage report as artifact
         uses: actions/upload-artifact@v4
         with:
-          name: coverage - docker - ${{ matrix.dockerfile-suffix }}.xml
+          name: coverage - docker - ${{ matrix.dockerfile-suffix }} - ${{ matrix.force-redis-package-version }}.xml
           path: ./output/coverage.xml

ban.py

@@ -20,6 +20,7 @@
 import datetime
 import time
 import re
+import redis
 
 LENGTH_REGEX = re.compile(r"(?P<number>[0-9]+) (?P<scale>seconds?|minutes?|hours?|days?|weeks?|months?|years?)")
 TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
@@ -199,7 +200,11 @@ def cmd_ban(self, player, msg, channel):
             base_key = PLAYER_KEY.format(ident) + ":bans"
             ban_id = self.db.zcard(base_key)
             db = self.db.pipeline()
-            db.zadd(base_key, time.time() + td.total_seconds(), ban_id)
+            ban_time = time.time() + td.total_seconds()
+            if redis.VERSION < (3,):
+                db.zadd(base_key, ban_time, ban_id)
+            else:
+                db.zadd(base_key, {ban_id: ban_time})
             ban = {"expires": expires, "reason": reason, "issued": now, "issued_by": player.steam_id}
             db.hmset(base_key + ":{}".format(ban_id), ban)
             db.execute()
@@ -239,7 +244,10 @@ def cmd_unban(self, player, msg, channel):
         else:
             db = self.db.pipeline()
             for ban_id, score in bans:
-                db.zincrby(base_key, ban_id, -score)
+                if redis.VERSION < (3,):
+                    db.zincrby(base_key, ban_id, -score)
+                else:
+                    db.zincrby(base_key, -score, ban_id)
             db.execute()
             channel.reply("^6{}^7 has been unbanned.".format(name))
 

requirements.txt

@@ -1,4 +1,4 @@
-redis>=2.10, <3.0
+redis
 hiredis
 requests
 pyzmq<18; python_version < '3.9'

silence.py

@@ -20,6 +20,7 @@
 import datetime
 import time
 import re
+import redis
 
 LENGTH_REGEX = re.compile(r"(?P<number>[0-9]+) (?P<scale>seconds?|minutes?|hours?|days?|weeks?|months?|years?)")
 TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
@@ -149,7 +150,10 @@ def cmd_silence(self, player, msg, channel):
             silence_id = self.db.zcard(base_key)
             score = time.time() + td.total_seconds()
             db = self.db.pipeline()
-            db.zadd(base_key, score, silence_id)
+            if redis.VERSION < (3,):
+                db.zadd(base_key, score, silence_id)
+            else:
+                db.zadd(base_key, {silence_id: score})
             silence = {"expires": expires, "reason": reason, "issued": now, "issued_by": player.steam_id}
             db.hmset(base_key + ":{}".format(silence_id), silence)
             db.execute()
@@ -194,7 +198,10 @@ def cmd_unsilence(self, player, msg, channel):
         else:
             db = self.db.pipeline()
             for silence_id, score in silences:
-                db.zincrby(base_key, silence_id, -score)
+                if redis.VERSION < (3,):
+                    db.zincrby(base_key, silence_id, -score)
+                else:
+                    db.zincrby(base_key, -score, silence_id)
             db.execute()
             if ident in self.silenced:
                 del self.silenced[ident]

tests/__init__.py

@@ -1 +1,3 @@
 from .test_balance import TestBalance
+from .test_ban import TestBan
+from .test_silence import TestSilence

tests/dockerfiles/Dockerfile.python35

@@ -11,6 +11,9 @@ RUN python3 -m pip install mockito coverage
 COPY . /opt/minqlx-plugins
 WORKDIR /opt/minqlx-plugins
 
+ARG FORCE_REDIS_PACKAGE_VERSION
+RUN if [ "$FORCE_REDIS_PACKAGE_VERSION" ] ; then python3 -m pip install redis"$FORCE_REDIS_PACKAGE_VERSION" ; fi
+
 RUN python3 -m pip install -r requirements.txt
 RUN patch -p1 < ./tests/minqlx_plugin_test/python35.patch
 CMD ["./tests/dockerfiles/entrypoint.sh"]

tests/dockerfiles/Dockerfile.python36

@@ -6,5 +6,8 @@ RUN python3 -m pip install mockito coverage
 COPY . /opt/minqlx-plugins
 WORKDIR /opt/minqlx-plugins
 
+ARG FORCE_REDIS_PACKAGE_VERSION
+RUN if [ "$FORCE_REDIS_PACKAGE_VERSION" ] ; then python3 -m pip install redis"$FORCE_REDIS_PACKAGE_VERSION" ; fi
+
 RUN python3 -m pip install -r requirements.txt
 CMD ["./tests/dockerfiles/entrypoint.sh"]

tests/test_ban.py

@@ -0,0 +1,51 @@
+import unittest
+from time import sleep
+
+from ban import ban, minqlx
+from mockito import unstub
+from minqlx_plugin_test import (
+    connected_players,
+    fake_player,
+    mocked_channel,
+    setup_cvars,
+    setup_plugin,
+)
+
+
+class TestBan(unittest.TestCase):
+    def setUp(self):
+        setup_plugin()
+        connected_players()
+        setup_cvars(
+            {
+                "qlx_database": "redis",
+                "qlx_redisDatabase": "0",
+                "qlx_redisUnixSocket": "0",
+                "qlx_redisAddress": "127.0.0.1",
+                "qlx_redisPassword": "",
+                "qlx_owner": "777",
+                "qlx_leaverBan": "0",
+            }
+        )
+        minqlx.Plugin.database = minqlx.database.Redis
+        self.plugin = ban()
+
+    def tearDown(self):
+        unstub()
+
+    def test_ban(self):
+        player = fake_player(666, "Woodpecker")
+        admin = fake_player(777, "Admin")
+        channel = mocked_channel()
+        connected_players(player)
+
+        self.plugin.cmd_ban(admin, ["!ban", "666", "3", "seconds"], channel)
+
+        player_connect_result = self.plugin.handle_player_connect(player)
+        self.assertTrue(isinstance(player_connect_result, str))
+        self.assertTrue(player_connect_result.startswith("You are banned until"))
+
+        sleep(3.5)
+
+        player_connect_result = self.plugin.handle_player_connect(player)
+        self.assertEqual(player_connect_result, None)