Merge pull request #5 from Robso-creator/issue-2

feat: add pytest to repo

.github/workflows/tests.yml

@@ -0,0 +1,35 @@
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: '3.10'
+    - uses: pre-commit/action@v3.0.0
+
+  run-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+
+      - name: Run Tests
+        run: |
+          python -m pytest

Makefile

@@ -2,10 +2,14 @@ all:
 	@echo "#### functions implemented"
 	@echo "make up ...................... runs main.py"
 	@echo "make pc ...................... runs pre-commit on all files"
+	@echo "make test .................... runs all tests (pytest)"
 
 pc:
 	@echo "[PRE-COMMIT] All files"
 	pre-commit run --all-files
 
 up:
 	python3 -m src.main
+
+test:
+	python3 -m pytest

docs/README-en.md

@@ -1,5 +1,6 @@
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 ![makefile](https://img.shields.io/badge/makefile-enabled-brightgreen?logo=gmail&logoColor=blue)
+[![pytest](https://img.shields.io/badge/pytest-enabled-brightgreen?logo=pytest&logoColor=#0A9EDC)](https://docs.pytest.org/en/7.4.x/)
 
 # Discord Bot
 <sub>Não fala inglês? [Clique aqui](https://github.com/Robso-creator/discord_bot/blob/main/README.md) para ver esta página em português</sub>

docs/README.md

@@ -1,5 +1,6 @@
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 ![makefile](https://img.shields.io/badge/makefile-enabled-brightgreen?logo=gmail&logoColor=blue)
+[![pytest](https://img.shields.io/badge/pytest-enabled-brightgreen?logo=pytest&logoColor=#0A9EDC)](https://docs.pytest.org/en/7.4.x/)
 
 # Bot do Discord
 <sub>Don't speak portuguese? [Click here](https://github.com/Robso-creator/discord_bot/blob/main/README-en.md) to view this page in English</sub>

requirements-dev.txt

@@ -0,0 +1,4 @@
+-r requirements.txt
+
+pytest==7.4.4
+pytest-sugar==0.9.7

src/main.py

@@ -2,8 +2,6 @@
 
 import discord
 
-import settings
-
 intents = discord.Intents.default()
 intents.typing = False
 intents.presences = False
@@ -23,5 +21,7 @@ async def on_message(self, message):
             )
 
 
-client = MyClient(intents=intents)
-client.run(settings.DISCORD_TOKEN)
+if __name__ == '__main__':
+    import settings
+    client = MyClient(intents=intents)
+    client.run(settings.DISCORD_TOKEN)

tests/test_bot_funcs.py

@@ -0,0 +1,30 @@
+from unittest.mock import MagicMock
+
+import pytest
+
+from src.main import MyClient
+
+
+@pytest.fixture
+def mocked_discord_client(monkeypatch):
+    mocked_client = MagicMock(spec=MyClient)
+
+    monkeypatch.setattr(mocked_client, 'run', MagicMock())
+
+    return mocked_client
+
+
+def test_on_ready_called(mocked_discord_client):
+    client = mocked_discord_client()
+
+    client.on_ready()
+
+    assert client.on_ready.called
+
+
+def test_on_message_called(mocked_discord_client):
+    client = mocked_discord_client()
+
+    client.on_message('Mocked')
+
+    assert client.on_message.called