test: add unit tests to this project (#43)

* test: add unit tests to this project

* Improve based on feedback

Author: WilliamBergamin

.github/workflows/black.yml

@@ -2,7 +2,7 @@ name: Formatting validation using black
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
 
 jobs:
@@ -11,19 +11,19 @@ jobs:
     timeout-minutes: 5
     strategy:
       matrix:
-        python-version: ['3.9']
-    
+        python-version: ["3.13"]
+
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        pip install -U pip
-        pip install -r requirements.txt
-    - name: Format with black
-      run: |
-        black .
-        if git status --porcelain | grep .; then git --no-pager diff; exit 1; fi
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install -U pip
+          pip install -r requirements.txt
+      - name: Format with black
+        run: |
+          black .
+          if git status --porcelain | grep .; then git --no-pager diff; exit 1; fi

.github/workflows/flake8.yml

@@ -2,7 +2,7 @@ name: Linting validation using flake8
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
 
 jobs:
@@ -11,18 +11,18 @@ jobs:
     timeout-minutes: 5
     strategy:
       matrix:
-        python-version: ['3.9']
-    
+        python-version: ["3.13"]
+
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        pip install -U pip
-        pip install -r requirements.txt
-    - name: Lint with flake8
-      run: |
-        flake8 *.py && flake8 listeners/
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install -U pip
+          pip install -r requirements.txt
+      - name: Lint with flake8
+        run: |
+          flake8 *.py && flake8 listeners/

.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Run unit tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install -U pip
+          pip install -r requirements.txt
+      - name: Run all tests
+        run: |
+          pytest . -v

README.md

@@ -52,6 +52,12 @@ flake8 *.py && flake8 listeners/
 black .
 ```
 
+#### Testing
+```zsh
+# Run pytest from root directory for unit testing
+pytest .
+```
+
 ## Project Structure
 
 ### `manifest.json`

listeners/events/app_home_opened.py

@@ -1,7 +1,9 @@
 from logging import Logger
 
+from slack_sdk import WebClient
 
-def app_home_opened_callback(client, event, logger: Logger):
+
+def app_home_opened_callback(client: WebClient, event: dict, logger: Logger):
     # ignore the app_home_opened event for anything but the Home tab
     if event["tab"] != "home":
         return

listeners/messages/sample_message.py

@@ -1,10 +1,9 @@
 from logging import Logger
 
 from slack_bolt import BoltContext, Say
-from slack_sdk import WebClient
 
 
-def sample_message_callback(context: BoltContext, client: WebClient, say: Say, logger: Logger):
+def sample_message_callback(context: BoltContext, say: Say, logger: Logger):
     try:
         greeting = context["matches"][0]
         say(f"{greeting}, how are you?")

requirements.txt

@@ -1,4 +1,4 @@
-slack-bolt
-pytest
+slack-bolt==1.22.0
+pytest==8.3.4
 flake8==7.1.1
-black
+black==24.10.0

tests/listeners/__init__.py

@@ -0,0 +1,46 @@
+import logging
+from unittest.mock import Mock
+
+from slack_bolt import Ack
+from slack_sdk import WebClient
+
+from listeners.actions.sample_action import sample_action_callback
+
+test_logger = logging.getLogger(__name__)
+
+
+class TestSampleAction:
+    def setup_method(self):
+        self.fake_ack = Mock(Ack)
+        self.fake_body = {"view": {"id": "test_id", "hash": "156772938.1827394"}}
+
+        self.fake_client = Mock(WebClient)
+        self.fake_client.views_update = Mock(WebClient.views_update)
+
+    def test_sample_action_callback(self):
+        sample_action_callback(
+            ack=self.fake_ack,
+            body=self.fake_body,
+            client=self.fake_client,
+            logger=test_logger,
+        )
+
+        self.fake_ack.assert_called_once()
+
+        self.fake_client.views_update.assert_called_once()
+        kwargs = self.fake_client.views_update.call_args.kwargs
+        assert kwargs["view_id"] == self.fake_body["view"]["id"]
+        assert kwargs["hash"] == self.fake_body["view"]["hash"]
+        assert kwargs["view"] is not None
+
+    def test_ack_exception(self, caplog):
+        self.fake_ack.side_effect = Exception("test exception")
+        sample_action_callback(
+            ack=self.fake_ack,
+            body=self.fake_body,
+            client=self.fake_client,
+            logger=test_logger,
+        )
+
+        self.fake_ack.assert_called_once()
+        assert str(self.fake_ack.side_effect) in caplog.text