Merge pull request #149 from TotallyNotRobots/gonzobot+fix-cap-values

Fix cap value handling

Author: linuxdaemon

plugins/core/cap.py

@@ -34,7 +34,7 @@ async def handle_available_caps(conn, caplist, event, irc_paramlist, bot):
         results = await asyncio.gather(*tasks)
         if any(ok and (res or res is None) for ok, res in results):
             cap_queue[name_cf] = async_util.create_future(conn.loop)
-            conn.cmd("CAP", "REQ", cap)
+            conn.cmd("CAP", "REQ", name)
 
     if irc_paramlist[2] != '*':
         await asyncio.gather(*cap_queue.values())

tests/core_tests/test_plugin_manager.py

@@ -7,6 +7,7 @@
 
 from cloudbot import hook
 from cloudbot.plugin import PluginManager
+from tests.util.mock_module import MockModule
 
 
 @pytest.fixture()
@@ -30,11 +31,6 @@ def mock_manager(mock_bot):
     yield mgr
 
 
-class MockModule:
-    def __init__(self, **kwargs):
-        self.__dict__.update(kwargs)
-
-
 def test_get_plugin(mock_manager):
     assert mock_manager.get_plugin('plugins/test.py') is None
     assert mock_manager.find_plugin('test') is None

tests/plugin_tests/cap_test.py

@@ -0,0 +1,77 @@
+import asyncio
+from pathlib import Path
+from unittest.mock import MagicMock, patch
+
+import pytest
+from irclib.parser import ParamList
+
+from cloudbot import hook
+from cloudbot.event import Event
+from cloudbot.plugin import PluginManager
+from cloudbot.util import async_util
+from plugins.core import cap
+from tests.util.mock_module import MockModule
+
+
+@pytest.fixture()
+def patch_import_module():
+    with patch("importlib.import_module") as mocked:
+        yield mocked
+
+
+@pytest.mark.asyncio()
+async def test_cap_req(patch_import_module):
+    caps = [
+        "some-cap",
+        "another-cap",
+        "a.vendor/cap",
+        "a-cap=with-value",
+        "a.vendor/cap=with-value",
+    ]
+    cap_names = [s.split("=")[0] for s in caps]
+
+    params = ParamList.parse("* LS :" + " ".join(caps))
+    event = Event(irc_paramlist=params, bot=MagicMock(), conn=MagicMock(),)
+    event.conn.loop = event.bot.loop = asyncio.get_event_loop()
+    event.bot.config = {}
+    event.conn.type = "irc"
+    event.bot.base_dir = Path(".").resolve()
+    event.bot.plugin_manager = manager = PluginManager(event.bot)
+
+    called = False
+
+    def func():
+        nonlocal called
+        called = True
+        return True
+
+    for c in cap_names:
+        func = hook.on_cap_available(c)(func)
+
+    patch_import_module.return_value = MockModule(func=func)
+    await manager.load_plugin("plugins/test.py")
+
+    event.conn.memory = {}
+
+    cap.send_cap_ls(event.conn)
+    event.conn.cmd.assert_called_with("CAP", "LS", "302")
+
+    event.conn.cmd.reset_mock()
+
+    calls = []
+
+    def cmd(cmd, subcmd, *args):
+        calls.append((cmd, subcmd) + args)
+        p = ParamList.parse("* ACK :" + " ".join(args))
+        cmd_event = Event(irc_paramlist=p, bot=event.bot, conn=event.conn,)
+        async_util.wrap_future(cap.on_cap(p, cmd_event), loop=event.loop)
+
+    with patch.object(event.conn, "cmd", new=cmd):
+        res = await cap.on_cap(params, event)
+        assert called
+        assert res is None
+
+    caps = event.conn.memory["server_caps"]
+    assert caps == {c: True for c in cap_names}
+
+    assert calls == [("CAP", "REQ", c) for c in cap_names]

tests/util/mock_module.py

@@ -0,0 +1,3 @@
+class MockModule:
+    def __init__(self, **kwargs):
+        self.__dict__.update(kwargs)