Add tests for `bot.cogs.token_remover`.

3 files changed, 144 insertions, 1 deletions

diff --git a/tests/cogs/test_token_remover.py b/tests/cogs/test_token_remover.py
new file mode 100644
index 000000000..9d46b3a05
--- /dev/null
+++ b/tests/cogs/test_token_remover.py
@@ -0,0 +1,133 @@
+import asyncio
+from unittest.mock import MagicMock
+
+import pytest
+from discord import Colour
+
+from bot.cogs.token_remover import (
+    DELETION_MESSAGE_TEMPLATE,
+    TokenRemover,
+    setup as setup_cog,
+)
+from bot.constants import Channels, Colours, Event, Icons
+from tests.helpers import AsyncMock
+
+
[email protected]()
+def token_remover():
+    bot = MagicMock()
+    bot.get_cog.return_value = MagicMock()
+    bot.get_cog.return_value.send_log_message = AsyncMock()
+    return TokenRemover(bot=bot)
+
+
[email protected]()
+def message():
+    message = MagicMock()
+    message.author.__str__.return_value = 'lemon'
+    message.author.bot = False
+    message.author.avatar_url_as.return_value = 'picture-lemon.png'
+    message.author.id = 42
+    message.author.mention = '@lemon'
+    message.channel.send = AsyncMock()
+    message.channel.mention = '#lemonade-stand'
+    message.content = ''
+    message.delete = AsyncMock()
+    message.id = 555
+    return message
+
+
[email protected](
+    ('content', 'expected'),
+    (
+        ('MTIz', True),  # 123
+        ('YWJj', False),  # abc
+    )
+)
+def test_is_valid_user_id(content: str, expected: bool):
+    assert TokenRemover.is_valid_user_id(content) is expected
+
+
[email protected](
+    ('content', 'expected'),
+    (
+        ('DN9r_A', True),  # stolen from dapi, thanks to the author of the 'token' tag!
+        ('MTIz', False),  # 123
+    )
+)
+def test_is_valid_timestamp(content: str, expected: bool):
+    assert TokenRemover.is_valid_timestamp(content) is expected
+
+
+def test_mod_log_property(token_remover):
+    token_remover.bot.get_cog.return_value = 'lemon'
+    assert token_remover.mod_log == 'lemon'
+    token_remover.bot.get_cog.assert_called_once_with('ModLog')
+
+
+def test_ignores_bot_messages(token_remover, message):
+    message.author.bot = True
+    coroutine = token_remover.on_message(message)
+    assert asyncio.run(coroutine) is None
+
+
[email protected]('content', ('', 'lemon wins'))
+def test_ignores_messages_without_tokens(token_remover, message, content):
+    message.content = content
+    coroutine = token_remover.on_message(message)
+    assert asyncio.run(coroutine) is None
+
+
[email protected]('content', ('foo.bar.baz', 'x.y.'))
+def test_ignores_invalid_tokens(token_remover, message, content):
+    message.content = content
+    coroutine = token_remover.on_message(message)
+    assert asyncio.run(coroutine) is None
+
+
[email protected](
+    'content, censored_token',
+    (
+        ('MTIz.DN9R_A.xyz', 'MTIz.DN9R_A.xxx'),
+    )
+)
+def test_censors_valid_tokens(
+    token_remover, message, content, censored_token, caplog
+):
+    message.content = content
+    coroutine = token_remover.on_message(message)
+    assert asyncio.run(coroutine) is None  # still no rval
+
+    # asyncio logs some stuff about its reactor, discard it
+    [_, record] = caplog.records
+    assert record.message == (
+        "Censored a seemingly valid token sent by lemon (`42`) in #lemonade-stand, "
+        f"token was `{censored_token}`"
+    )
+
+    message.delete.assert_called_once_with()
+    message.channel.send.assert_called_once_with(
+        DELETION_MESSAGE_TEMPLATE.format(mention='@lemon')
+    )
+    token_remover.bot.get_cog.assert_called_with('ModLog')
+    message.author.avatar_url_as.assert_called_once_with(static_format='png')
+
+    mod_log = token_remover.bot.get_cog.return_value
+    mod_log.ignore.assert_called_once_with(Event.message_delete, message.id)
+    mod_log.send_log_message.assert_called_once_with(
+        icon_url=Icons.token_removed,
+        colour=Colour(Colours.soft_red),
+        title="Token removed!",
+        text=record.message,
+        thumbnail='picture-lemon.png',
+        channel_id=Channels.mod_alerts
+    )
+
+
+def test_setup(caplog):
+    bot = MagicMock()
+    setup_cog(bot)
+    [record] = caplog.records
+
+    bot.add_cog.assert_called_once()
+    assert record.message == "Cog loaded: TokenRemover"
diff --git a/tests/helpers.py b/tests/helpers.py
new file mode 100644
index 000000000..57c6fcc1a
--- /dev/null
+++ b/tests/helpers.py
@@ -0,0 +1,10 @@
+from unittest.mock import MagicMock
+
+
+__all__ = ('AsyncMock',)
+
+
+# TODO: Remove me on 3.8
+class AsyncMock(MagicMock):
+    async def __call__(self, *args, **kwargs):
+        return super(AsyncMock, self).__call__(*args, **kwargs)
diff --git a/tox.ini b/tox.ini
index c84827570..21097cd97 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,6 @@
 [flake8]
 max-line-length=120
-application_import_names=bot
+application_import_names=bot,tests
 exclude=.cache,.venv
 ignore=B311,W503,E226,S311,T000
 import-order-style=pycharm