Add unit tests

.dockerignore

@@ -5,5 +5,4 @@
 .mypy_cache/
 data/
 docker/
-install.bash
 venv/

.github/workflows/pytest.yaml

@@ -10,14 +10,9 @@ on:
   pull_request:
     branches: ["master"]
 
-permissions:
-  contents: read
-
 jobs:
-  build:
-
+  test:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python 3.9
@@ -27,12 +22,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pytest
           pip install -r requirements.txt -r tests/requirements.txt
       - name: Test with pytest
-        env:
-          MEMEBOT_DISCORD_CLIENT_TOKEN: ${{ secrets.MEMEBOT_DISCORD_CLIENT_TOKEN }}
-          MEMEBOT_TWITTER_CONSUMER_KEY: ${{ secrets.MEMEBOT_TWITTER_CONSUMER_KEY }}
-          MEMEBOT_TWITTER_CONSUMER_SECRET: ${{ secrets.MEMEBOT_TWITTER_CONSUMER_SECRET }}
         run: |
-          pytest
+          pytest --tb=long -v

README.md

@@ -81,6 +81,28 @@ Leaving variables empty just means that default values will be used.
 
 ## Tests
 
+### pytest
+
+Memebot has a suite of unit tests based on [`pytest`](https://pytest.org). The test code
+is located in the [tests](./tests) directory. Running the tests is straightforward:
+
+```shell
+$ python3 -m pytest [/path/to/test/package/or/module]
+```
+
+Running the above from the root of the repository with no path(s) specified will run 
+all the tests.
+
+The tests can also be run from the _test_ Docker image:
+
+```shell
+$ docker run --rm -it --entrypoint python3 memebot:test -m pytest [/path/to/test/package/or/module]
+
+# OR
+
+$ docker-compose run --rm --entrypoint python3 bot -m pytest [/path/to/test/package/or/module]
+```
+
 ### mypy
 
 Memebot uses static type checking from [mypy](http://mypy-lang.org) to improve code correctness. The config
@@ -90,31 +112,31 @@ To run mypy locally, ensure it is installed to the same python environment as al
 Memebot dependencies, and then run it using the proper interpreter. 
 
 ```shell
-$ venv/bin/mypy src
+$ venv/bin/mypy memebot
 
 # OR
 
 $ source venv/bin/activate
-$ mypy src
+$ mypy memebot
 ```
 
 To run mypy in Docker, ensure you are using an image built from the `test` target. 
 
 ```shell
-$ docker run --rm -it --entrypoint mypy memebot:test src
+$ docker run --rm -it --entrypoint mypy memebot:test memebot
 
 # OR
 
-$ docker-compose run --rm --entrypoint mypy bot src
+$ docker-compose run --rm --entrypoint mypy bot memebot
 ```
 
 You can speed up subsequent runs of mypy by mounting the `.mypy-cache` directory as a volume.
 This way, mypy can reuse the cache it generates inside the container on the next run. 
 
 ```shell
-$ docker run --rm --volume "$(pwd)/.mypy_cache:/opt/memebot/.mypy_cache" --entrypoint mypy -it memebot:test src
+$ docker run --rm --volume "$(pwd)/.mypy_cache:/opt/memebot/.mypy_cache" --entrypoint mypy -it memebot:test memebot
 
 # OR
 
-$ docker-compose run --rm --volume "$(pwd)/.mypy_cache:/opt/memebot/.mypy_cache" --entrypoint mypy bot src
+$ docker-compose run --rm --volume "$(pwd)/.mypy_cache:/opt/memebot/.mypy_cache" --entrypoint mypy bot memebot
 ```

docker-compose.yaml

@@ -27,7 +27,7 @@ services:
     restart: always
     volumes:
       - ./data/db:/data/db
-      - ./src/config/mongod.yaml:/etc/mongo/mongod.yaml:ro
+      - ./memebot/config/mongod.yaml:/etc/mongo/mongod.yaml:ro
     networks:
       default:
     dns:

docker/Dockerfile

@@ -1,4 +1,4 @@
 FROM python:3.9.6-slim as build
 WORKDIR /opt/memebot/
 
 # Install requirements.
@@ -15,19 +15,20 @@
 
 FROM build as build-test
 COPY tests tests
 RUN python3 -m pip install --no-cache-dir -r tests/requirements.txt
 
 # Prepare run image.
 FROM python:3.9.6-slim as run-base
 WORKDIR /opt/memebot/
 ENV PATH="/opt/venv/bin:$PATH"
-COPY src src
-ENTRYPOINT ["python3", "src/main.py"]
+COPY memebot memebot
+ENTRYPOINT ["python3", "memebot/main.py"]
 
 # Run release build.
 FROM run-base as release
 COPY --from=build /opt/venv /opt/venv
 
 # Run test build.
 FROM run-base as test
+COPY tests tests
 COPY --from=build-test /opt/venv /opt/venv

src/memebot.py → memebot/client.py

@@ -1,20 +1,22 @@
+import functools
 import logging
 
 import discord
 import discord.ext.commands
 
-import commands
-import config
-import db
-import log
-from integrations import twitter
-from lib import exception, util
+from memebot import commands
+from memebot import config
+from memebot import db
+from memebot import log
+from memebot.integrations import twitter
+from memebot.lib import exception, util
 
 
 async def on_ready() -> None:
     """
     Determines what the bot does as soon as it is logged into discord
     """
+    memebot = get_memebot()
     if not memebot.user:
         raise exception.MemebotInternalError("Memebot is not logged in to Discord")
     log.info(f"Logged in as {memebot.user}")
@@ -36,7 +38,7 @@ async def on_interaction(interaction: discord.Interaction) -> None:
     """
     log.interaction(
         interaction,
-        f"{util.parse_invocation(interaction.data)} from {interaction.user}",
+        f"{util.parse_invocation(interaction)} from {interaction.user}",
     )
 
 
@@ -48,7 +50,7 @@ async def on_command_error(
         log.exception(error)
         return
 
-    invocation = util.parse_invocation(interaction.data)
+    invocation = util.parse_invocation(interaction)
 
     if isinstance(error, exception.MemebotInternalError):
         # For intentionally thrown internal errors
@@ -84,20 +86,22 @@ async def on_command_error(
     )
 
 
-memebot = discord.ext.commands.Bot(
-    command_prefix="!",
-    intents=discord.Intents().all(),
-    activity=discord.Game(name="• /hello"),
-)
+@functools.cache
+def get_memebot() -> discord.ext.commands.Bot:
+    new_memebot = discord.ext.commands.Bot(
+        command_prefix="/",
+        intents=discord.Intents().all(),
+        activity=discord.Game(name="• /hello"),
+    )
 
-memebot.tree.add_command(commands.hello)
-memebot.tree.add_command(commands.poll)
-memebot.tree.add_command(commands.role)
+    new_memebot.tree.add_command(commands.hello)
+    new_memebot.tree.add_command(commands.poll)
+    new_memebot.tree.add_command(commands.role)
 
-memebot.add_listener(on_ready)
-memebot.add_listener(on_interaction)
-memebot.tree.error(on_command_error)
-if config.twitter_enabled:
-    memebot.add_listener(twitter.process_message_for_interaction, "on_message")
+    new_memebot.add_listener(on_ready)
+    new_memebot.add_listener(on_interaction)
+    new_memebot.tree.error(on_command_error)
+    if config.twitter_enabled:
+        new_memebot.add_listener(twitter.process_message_for_interaction, "on_message")
 
-run = memebot.run
+    return new_memebot

src/commands/poll.py → memebot/commands/poll.py

@@ -6,7 +6,7 @@
 import discord.ext.commands
 import emoji
 
-from lib import constants, exception
+from memebot.lib import constants, exception
 
 
 @discord.app_commands.command(
@@ -35,7 +35,8 @@ async def poll(
     yes_no = False
     if len(choices) == 1:
         raise exception.MemebotUserError(
-            f"_Only 1 choice provided. {interaction.command.qualified_name} requires either 0 or 2+ choices!_"
+            f"_Only 1 choice provided. {interaction.command.qualified_name} "
+            f"requires either 0 or 2+ choices!_"
         )
     elif len(choices) == 0 or [c.lower() for c in choices] in (
         ["yes", "no"],

src/commands/role.py → memebot/commands/role.py

@@ -1,9 +1,8 @@
-from code import interact
-from typing import Optional, Any, Union, Annotated
+from typing import Optional, Any, Union
 
 import discord
 
-from lib import exception
+from memebot.lib import exception
 
 
 class RoleActionError(exception.MemebotUserError):
@@ -37,6 +36,18 @@ def __init__(self, action: str, target_name: str, *args: Any) -> None:
         )
 
 
+class RoleFailure(exception.MemebotInternalError):
+    def __init__(self, action: str, target_name: str, *args: Any) -> None:
+        """
+        Unexpected, but handled internal failure
+        """
+        super(RoleFailure, self).__init__(
+            f"Failed to {action} role `@{target_name}. "
+            f"It seems that Discord's API is having problems.",
+            *args,
+        )
+
+
 class RoleLocationError(exception.MemebotUserError):
     """
     Generic message for role commands which are executed in DMs
@@ -106,8 +117,8 @@ async def create(interaction: discord.Interaction, role_name: str) -> None:
         )
     except discord.Forbidden:
         raise RolePermissionError("create", target_name)
-    except (discord.HTTPException, TypeError):
-        raise RoleActionError("create", target_name)
+    except discord.HTTPException:
+        raise RoleFailure("create", target_name)
 
     await interaction.response.send_message(f"Created new role {new_role.mention}!")
 
@@ -133,7 +144,7 @@ async def delete(
     except discord.Forbidden:
         raise RolePermissionError("delete", target_role.name)
     except discord.HTTPException:
-        raise RoleActionError("delete", target_role.name)
+        raise RoleFailure("delete", target_role.name)
 
     await interaction.response.send_message(f"Deleted role `@{target_role.name}`")
 
@@ -161,7 +172,7 @@ async def join(
     except discord.Forbidden:
         raise RolePermissionError("join", target_role.name)
     except discord.HTTPException:
-        raise RoleActionError("join", target_role.name)
+        raise RoleFailure("join", target_role.name)
 
     await interaction.response.send_message(
         f"{author.name} successfully joined `@{target_role.name}`"
@@ -192,7 +203,7 @@ async def leave(
     except discord.Forbidden:
         raise RolePermissionError("leave", target_role.name)
     except discord.HTTPException:
-        raise RoleActionError("leave", target_role.name)
+        raise RoleFailure("leave", target_role.name)
 
     await interaction.response.send_message(
         f"{author.name} successfully left `@{target_role.name}`"
@@ -205,7 +216,8 @@ async def role_list(
     target: Optional[Union[discord.Role, discord.Member]],
 ) -> None:
     """
-    List all roles managed by Memebot, or all members of a role managed by Memebot.
+    List all roles managed by Memebot, all managed roles of which a user is a member,
+    or all members of a role managed by Memebot.
     """
     if not interaction.guild:
         raise RoleLocationError

src/config/__init__.py → memebot/config/__init__.py

@@ -3,7 +3,7 @@
 import os
 import urllib.parse
 
-from config import validators
+from memebot.config import validators
 
 # Discord API token
 discord_api_token: str
@@ -148,6 +148,3 @@ def populate_config_from_command_line() -> None:
     global database_uri
     database_enabled = args.database_enabled
     database_uri = args.database_uri
-
-
-populate_config_from_command_line()

src/config/validators.py → memebot/config/validators.py

@@ -2,6 +2,7 @@
 Functions that will validate string input from the command line and convert them into appropriate data for use
 by the config module.
 """
+
 import collections
 import logging
 import logging.handlers

src/db/__init__.py → memebot/db/__init__.py

@@ -1,4 +1,4 @@
-import config
+from memebot import config
 from .internals import DatabaseInternals
 
 db_internals = DatabaseInternals()

src/db/internals.py → memebot/db/internals.py

@@ -2,7 +2,7 @@
 
 import pymongo as mongo
 
-import config
+from memebot import config
 
 
 class DatabaseInternals: