refactor: Load shelve db paths from env

Author: Sanielia

.env.example

@@ -5,4 +5,7 @@ GITHUB_PROJECT_NODE_ID=your-github-project-node-id
 GITHUB_ID_TO_DISCORD_ID_MAPPING_PATH=path-to-github-username-to-discord-id-mapping.json
 IP_ADDRESS=0.0.0.0
 PORT=8000
-GITHUB_WEBHOOK_SECRET=your-github-webhook-secret
+GITHUB_WEBHOOK_SECRET=your-github-webhook-secret
+# Shelve databases
+ITEM_NAME_TO_NODE_ID_DB_PATH=path-to-item-name-to-node-id.db
+POST_ID_DB_PATH=path-to-post-id.db

README.md

@@ -34,7 +34,7 @@ uv run pytest
 
 For deployment follow these steps:
 - set all environment variables accordingly,
-- setup file_mount for `github_id_to_discord_id_mapping.json` on `/app/github_usernames_to_discord_id_mapping.json`,
+- setup file_mount for volumes specified in `docker-compose.yaml` on /app/path_set_in_env,
 - set up a webhook in your GitHub repository to point to your server's `/webhook_endpoint` endpoint,
 - use Dockerfile to build the image.
 

docker-compose.yaml

@@ -10,7 +10,7 @@ services:
     env_file:
       - .env
     volumes:
-      - github_id_to_discord_id_mapping:/app/github_id_to_discord_id_mapping.yaml
+      - github_id_to_discord_id_mapping:/app/${GITHUB_ID_TO_DISCORD_ID_MAPPING_PATH}
 
 volumes:
   github_id_to_discord_id_mapping:

src/tests/test_e2e.py

@@ -42,7 +42,16 @@ async def test_e2e(
 ):
     mock_restapp_acquire.return_value = RestClientContextManagerMock(rest_client_mock)
     mock_fetch_channel.side_effect = [forum_channel_mock, post_mock]
-    mock_getenv.side_effect = ["some_token", 1, 2, "some_secret", "fake_project_id", "meow.yaml"]
+    mock_getenv.side_effect = [
+        "some_token",
+        1,
+        2,
+        "some_secret",
+        "fake_project_id",
+        "db-path.db",
+        "meow.yaml",
+        "db-path.db",
+    ]
     post_id_shelf = MockShelf({})
     mock_shelve_open.side_effect = [MockShelf({"item123": "audacity4"}), post_id_shelf]
     mock_fetch_active_threads.return_value = [post_mock]

src/tests/test_integration/test_bot.py

@@ -64,7 +64,7 @@ async def test_basic_event_only_creation(
     forum_channel_mock,
     logger_mock,
 ):
-    mock_os_getenv.side_effect = ["some_token", 1, 2, "some_path"]
+    mock_os_getenv.side_effect = ["some_token", 1, 2, "some_path", "db-path.db"]
     mock_restapp_acquire.return_value = RestClientContextManagerMock(rest_client_mock)
     mock_fetch_channel.return_value = forum_channel_mock
     mock_fetch_active_threads.return_value = []

src/tests/test_integration/test_server.py

@@ -114,7 +114,7 @@ def test_missing_item_node_id(mock_os_getenv):
 @patch("shelve.open")
 @patch("os.getenv")
 def test_could_not_fetch_item_name(mock_os_getenv, mock_shelve_open, mock_post_request):
-    mock_os_getenv.side_effect = ["some_secret", 123, "some_token"]
+    mock_os_getenv.side_effect = ["some_secret", 123, "some_token", "db-path.db"]
     mock_shelve_open.return_value = MockShelf({})
     mock_post_request.return_value = MockResponse({})
     signature = generate_signature("some_secret", b'{"projects_v2_item": {"project_node_id": 123, "node_id": "123"}}')
@@ -130,7 +130,7 @@ def test_could_not_fetch_item_name(mock_os_getenv, mock_shelve_open, mock_post_r
 @patch("shelve.open")
 @patch("os.getenv")
 def test_missing_action(mock_os_getenv, mock_shelve_open):
-    mock_os_getenv.side_effect = ["some_secret", 123]
+    mock_os_getenv.side_effect = ["some_secret", 123, "db-path.db"]
     mock_shelve_open.return_value = MockShelf({"123": "Meow"})
     signature = generate_signature("some_secret", b'{"projects_v2_item": {"project_node_id": 123, "node_id": "123"}}')
     response = test_client.post(
@@ -152,7 +152,7 @@ def test_edited_action(mock_os_getenv, mock_shelve_open, mock_post_request):
         "changes": {"field_value": {"field_type": "title"}},
     }
     payload: str = json.dumps(payload)
-    mock_os_getenv.side_effect = ["some_secret", 123, "some_token"]
+    mock_os_getenv.side_effect = ["some_secret", 123, "some_token", "db-path.db"]
     mock_shelve_open.return_value = MockShelf({"123": "Meow"})
     mock_post_request.return_value = MockResponse({"data": {"node": {"content": {"title": "Meow"}}}})
     signature = generate_signature(

src/utils/__init__.py

@@ -9,7 +9,7 @@
 
 
 async def get_item_name(item_node_id: str) -> str | None:
-    with shelve.open("item_name_to_node_id.db") as db:
+    with shelve.open(os.getenv("ITEM_NAME_TO_NODE_ID_DB_PATH", "item_name_to_node_id.db")) as db:
         try:
             item_name: str = db[item_node_id]
         except KeyError:

src/utils/discord_rest_client.py

@@ -1,3 +1,4 @@
+import os
 import shelve
 
 from hikari import ForumTag, GuildForumChannel, GuildThreadChannel
@@ -19,7 +20,7 @@ def get_new_tag(new_tag_name: str, available_tags: list[ForumTag]) -> ForumTag |
 async def get_post_id(
     name: str, discord_guild_id: int, forum_channel_id: int, rest_client: RESTClientImpl
 ) -> int | GuildThreadChannel | None:
-    with shelve.open("post_id.db") as db:
+    with shelve.open(os.getenv("POST_ID_DB_PATH", "post_id.db")) as db:
         try:
             post_id: str = db[name]
             return int(post_id)