mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 11:18:54 -05:00
b983d5904b
* Switch RPC libs for websockets support * Implement RPC handling for core * Black reformat * Fix docs for build on travis * Modify RPC to use a Cog base class * Refactor rpc server reference as global * Handle cogbase unload method * Add an init call to handle mutable base attributes * Move RPC server reference back to the bot object * Remove unused import * Add tests for rpc method add/removal * Add tests for rpc method add/removal and cog base unloading * Add one more test * Black reformat * Add RPC mixin...fix MRO * Correct internal rpc method names * Add rpc test html file for debugging/example purposes * Add documentation * Add get_method_info * Update docs with an example RPC call specifying parameter formatting * Make rpc methods UPPER * Black reformat * Fix doc example * Modify this to match new method naming convention * Add more tests
146 lines
3.2 KiB
Python
146 lines
3.2 KiB
Python
import pytest
|
|
from redbot.core.rpc import RPC, RPCMixin, get_name
|
|
|
|
from unittest.mock import MagicMock
|
|
|
|
|
|
@pytest.fixture()
|
|
def rpc():
|
|
return RPC()
|
|
|
|
|
|
@pytest.fixture()
|
|
def rpcmixin():
|
|
r = RPCMixin()
|
|
r.rpc = MagicMock(spec=RPC)
|
|
return r
|
|
|
|
|
|
@pytest.fixture()
|
|
def cog():
|
|
class Cog:
|
|
async def cofunc(*args, **kwargs):
|
|
pass
|
|
|
|
async def cofunc2(*args, **kwargs):
|
|
pass
|
|
|
|
async def cofunc3(*args, **kwargs):
|
|
pass
|
|
|
|
def func(*args, **kwargs):
|
|
pass
|
|
|
|
return Cog()
|
|
|
|
|
|
@pytest.fixture()
|
|
def existing_func(rpc, cog):
|
|
rpc.add_method(cog.cofunc)
|
|
|
|
return cog.cofunc
|
|
|
|
|
|
@pytest.fixture()
|
|
def existing_multi_func(rpc, cog):
|
|
funcs = [cog.cofunc, cog.cofunc2, cog.cofunc3]
|
|
rpc.add_multi_method(*funcs)
|
|
|
|
return funcs
|
|
|
|
|
|
def test_get_name(cog):
|
|
assert get_name(cog.cofunc) == "COG__COFUNC"
|
|
assert get_name(cog.cofunc2) == "COG__COFUNC2"
|
|
assert get_name(cog.func) == "COG__FUNC"
|
|
|
|
|
|
def test_internal_methods_exist(rpc):
|
|
assert "GET_METHODS" in rpc._rpc.methods
|
|
|
|
|
|
def test_add_method(rpc, cog):
|
|
rpc.add_method(cog.cofunc)
|
|
|
|
assert get_name(cog.cofunc) in rpc._rpc.methods
|
|
|
|
|
|
def test_double_add(rpc, cog):
|
|
rpc.add_method(cog.cofunc)
|
|
count = len(rpc._rpc.methods)
|
|
|
|
rpc.add_method(cog.cofunc)
|
|
|
|
assert count == len(rpc._rpc.methods)
|
|
|
|
|
|
def test_add_notcoro_method(rpc, cog):
|
|
with pytest.raises(TypeError):
|
|
rpc.add_method(cog.func)
|
|
|
|
|
|
def test_add_multi(rpc, cog):
|
|
funcs = [cog.cofunc, cog.cofunc2, cog.cofunc3]
|
|
rpc.add_multi_method(*funcs)
|
|
|
|
names = [get_name(f) for f in funcs]
|
|
|
|
assert all(n in rpc._rpc.methods for n in names)
|
|
|
|
|
|
def test_add_multi_bad(rpc, cog):
|
|
funcs = [cog.cofunc, cog.cofunc2, cog.cofunc3, cog.func]
|
|
|
|
with pytest.raises(TypeError):
|
|
rpc.add_multi_method(*funcs)
|
|
|
|
names = [get_name(f) for f in funcs]
|
|
|
|
assert not any(n in rpc._rpc.methods for n in names)
|
|
|
|
|
|
def test_remove_method(rpc, existing_func):
|
|
before_count = len(rpc._rpc.methods)
|
|
rpc.remove_method(existing_func)
|
|
|
|
assert get_name(existing_func) not in rpc._rpc.methods
|
|
assert before_count - 1 == len(rpc._rpc.methods)
|
|
|
|
|
|
def test_remove_multi_method(rpc, existing_multi_func):
|
|
before_count = len(rpc._rpc.methods)
|
|
name = get_name(existing_multi_func[0])
|
|
prefix = name.split("__")[0]
|
|
|
|
rpc.remove_methods(prefix)
|
|
|
|
assert before_count - len(existing_multi_func) == len(rpc._rpc.methods)
|
|
|
|
names = [get_name(f) for f in existing_multi_func]
|
|
|
|
assert not any(n in rpc._rpc.methods for n in names)
|
|
|
|
|
|
def test_rpcmixin_register(rpcmixin, cog):
|
|
rpcmixin.register_rpc_handler(cog.cofunc)
|
|
|
|
assert rpcmixin.rpc.add_method.called_once_with(cog.cofunc)
|
|
|
|
name = get_name(cog.cofunc)
|
|
cogname = name.split("__")[0]
|
|
|
|
assert cogname in rpcmixin.rpc_handlers
|
|
|
|
|
|
def test_rpcmixin_unregister(rpcmixin, cog):
|
|
rpcmixin.register_rpc_handler(cog.cofunc)
|
|
rpcmixin.unregister_rpc_handler(cog.cofunc)
|
|
|
|
assert rpcmixin.rpc.remove_method.called_once_with(cog.cofunc)
|
|
|
|
name = get_name(cog.cofunc)
|
|
cogname = name.split("__")[0]
|
|
|
|
if cogname in rpcmixin.rpc_handlers:
|
|
assert cog.cofunc not in rpcmixin.rpc_handlers[cogname]
|