tests: convert unit tests to pytest-style; add pytest-asyncio

Author: PrettyNeet

.github/workflows/ci.yml

@@ -1,29 +1,28 @@
-name: CI/CD Pipeline
+name: CI
 
 on:
-    push:
-        branches: [main]
-    pull_request:
-        branches: [main]
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
 
 jobs:
-    build:
-        runs-on: ubuntu-latest
-
-        steps:
-            - name: checkout repo
-              uses: actions/checkout@v4
-
-            - name: setup python
-              uses: actions/setup-python@v5
-              with:
-                python-version: '3.8'
-
-            - name: Install dependencies
-              run: |
-                python -m pip install --upgrade pip
-                pip install -r requirements.txt
-                pip install flake8
-
-            - name: lint with flake8
-              run: flake8 --ignore=E501,W292,W293
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run tests
+        run: |
+          python -m unittest discover -v
+      - name: Lint (optional)
+        run: |
+          pip install flake8
+          flake8 --max-line-length=120

Dockerfile

@@ -17,7 +17,14 @@ COPY . .
 
 # Creates a non-root user with an explicit UID and adds permission to access the /app folder
 # For more info, please refer to https://aka.ms/vscode-docker-python-configure-containers
-RUN adduser -u 5678 --disabled-password --gecos "" appuser && chown -R appuser /app
+RUN adduser -u 5678 --disabled-password --gecos "" appuser && \
+    mkdir -p /app/logs && \
+    mkdir -p /app/data/db && \
+    chown -R appuser:appuser /app && \
+    chmod -R 755 /app && \
+    chmod 777 /app/logs && \
+    chmod 777 /app/data/db
+
 USER appuser
 
 # During debugging, this entry point will be overridden. For more information, please refer to https://aka.ms/vscode-docker-python-debug

bot/bot.py

@@ -1,4 +1,5 @@
 import os
+import aiohttp
 from discord.ext import commands
 from config.settings import BOT_PREFIX, INTENTS
 from bot.utils.logger import setup_logging
@@ -10,13 +11,31 @@
 class MyBot(commands.Bot):
     def __init__(self):
         super().__init__(command_prefix=BOT_PREFIX, intents=INTENTS)
+        self.http_session: aiohttp.ClientSession | None = None
 
     async def setup_hook(self):
+        # Create a shared aiohttp session for the bot to reuse
+        if self.http_session is None:
+            headers = {}
+            try:
+                from config.settings import HEADERS
+                headers = HEADERS
+            except Exception:
+                headers = {}
+            self.http_session = aiohttp.ClientSession(headers=headers)
+
         await self.load_extension("bot.commands.herb_profit")
         await self.load_extension("bot.commands.fish_profit")
         await self.load_extension("bot.commands.duel")
         logger.info("loaded all extensions/commands")
 
+    async def close(self):
+        # Close the aiohttp session when shutting down
+        if self.http_session is not None:
+            await self.http_session.close()
+            self.http_session = None
+        await super().close()
+
 
 bot = MyBot()
 
@@ -27,4 +46,15 @@ async def on_ready():
     await bot.tree.sync()
 
 
-bot.run(os.getenv("DISCORD_BOT_TOKEN"))
+@bot.tree.error
+async def on_app_command_error(interaction, error):
+    # Log the error and show a friendly ephemeral message to the user
+    logger.exception("App command error: %s", error)
+    try:
+        await interaction.response.send_message("An unexpected error occurred. The incident has been logged.", ephemeral=True)
+    except Exception:
+        # If response already sent/acknowledged, use followup
+        try:
+            await interaction.followup.send("An unexpected error occurred. The incident has been logged.", ephemeral=True)
+        except Exception:
+            pass

bot/commands/duel.py

@@ -1,7 +1,10 @@
 import discord
 from discord.ext import commands
-from bot.utils.DButil import get_db_connection, initialize_db, add_predefined_weapons
+from discord import app_commands
+import aiosqlite
+from bot.utils.DButil import get_db_path, get_db_connection, initialize_db, add_predefined_weapons, async_get_db_connection
 
+# Ensure DB is initialized on import (safe)
 initialize_db()
 add_predefined_weapons()
 
@@ -10,29 +13,29 @@ class Duel(commands.Cog):
     def __init__(self, bot):
         self.bot = bot
 
-    @commands.command(name='dm_register')
-    async def register_user(self, ctx):
-        user_id = str(ctx.author.id)
-        conn = get_db_connection()
-        c = conn.cursor()
-        c.execute('INSERT OR IGNORE INTO users (user_id) VALUES (?)', (user_id,))
-        conn.commit()
-        conn.close()
-        await ctx.send(f"{ctx.author.mention}, you have been registered!")
-
-    @commands.command(name='dm_balance')
-    async def check_balance(self, ctx):
-        user_id = str(ctx.author.id)
-        conn = get_db_connection()
-        c = conn.cursor()
-        c.execute('SELECT gold FROM users WHERE user_id = ?', (user_id,))
-        user_data = c.fetchone()
-        conn.close()
-        if user_data:
-            await ctx.send(f"{ctx.author.mention}, you have {user_data['gold']} gold.")
+    @app_commands.command(name='dm_register', description='Register for duel economy')
+    async def register_user(self, interaction: discord.Interaction):
+        user_id = str(interaction.user.id)
+        db = await async_get_db_connection()
+        await db.execute('INSERT OR IGNORE INTO users (user_id) VALUES (?)', (user_id,))
+        await db.commit()
+        await db.close()
+        await interaction.response.send_message(f"{interaction.user.mention}, you have been registered!", ephemeral=True)
+
+    @app_commands.command(name='dm_balance', description='Check your duel balance')
+    async def check_balance(self, interaction: discord.Interaction):
+        user_id = str(interaction.user.id)
+        db = await async_get_db_connection()
+        async with db.execute('SELECT gold FROM users WHERE user_id = ?', (user_id,)) as cursor:
+            row = await cursor.fetchone()
+        await db.close()
+
+        if row:
+            gold = row[0]
+            await interaction.response.send_message(f"{interaction.user.mention}, you have {gold} gold.", ephemeral=True)
         else:
-            await ctx.send(f"{ctx.author.mention}, you need to register first by using /dm_register.")
-            
+            await interaction.response.send_message(f"{interaction.user.mention}, you need to register first by using /dm_register.", ephemeral=True)
+    
     @commands.command(name='dm_storage')
     async def view_storage(self, ctx):
         user_id = ctx.author.id

bot/commands/fish_profit.py

@@ -22,6 +22,11 @@ def __init__(self, bot, interaction, fish_prices):
         custom_id="select_format"
     )
     async def select_callback(self, interaction: discord.Interaction, select: discord.ui.Select):
+        # Ensure only the original user can interact with this view
+        if interaction.user.id != self.interaction.user.id:
+            await interaction.response.send_message("This menu is not for you.", ephemeral=True)
+            return
+
         format_choice = select.values[0]
         await interaction.response.defer()
 
@@ -70,11 +75,12 @@ def __init__(self, bot):
         ]
     )
     async def fish_profit(self, interaction: discord.Interaction, price_type: app_commands.Choice[str]):
+        session = getattr(self.bot, 'http_session', None)
         if price_type.value == "latest":
-            prices = fetch_latest_prices()
+            prices = await fetch_latest_prices(session=session)
             price_key = "high"
         elif price_type.value == "1h":
-            prices = fetch_1h_prices()
+            prices = await fetch_1h_prices(session=session)
             price_key = "avgHighPrice"
         else:
             await self.interaction.followup.send("error in price type selection")
@@ -103,8 +109,8 @@ async def fish_profit(self, interaction: discord.Interaction, price_type: app_co
                     "GP/hr": gphr
                 })
 
-        view = FormatSelectView(bot=self.bot, interaction=interaction, fish_prices=profit_results)
-        await interaction.response.send_message("Choose the format for the reply:", view=view)
+    view = FormatSelectView(bot=self.bot, interaction=interaction, fish_prices=profit_results)
+    await interaction.response.send_message("Choose the format for the reply:", view=view, ephemeral=True)
 
 
 async def setup(bot):

bot/commands/herb_profit.py

@@ -44,6 +44,11 @@ def __init__(self, bot, interaction, farming_level, patches, weiss, trollheim, h
         custom_id="select_format"
     )
     async def select_callback(self, interaction: discord.Interaction, select):
+        # Ensure only the original user can interact with this view
+        if interaction.user.id != self.interaction.user.id:
+            await interaction.response.send_message("This menu is not for you.", ephemeral=True)
+            return
+
         # Sets the format choice
         format_choice = interaction.data["values"][0]
         await interaction.response.defer()
@@ -147,11 +152,12 @@ async def herb_profit(
         compost: app_commands.Choice[str],
         price_type: app_commands.Choice[str]
     ):
+        session = getattr(self.bot, 'http_session', None)
         if price_type.value == "latest":
-            prices = fetch_latest_prices()
+            prices = await fetch_latest_prices(session=session)
             price_key = "high"
         elif price_type.value == "1h":
-            prices = fetch_1h_prices()
+            prices = await fetch_1h_prices(session=session)
             price_key = "avgHighPrice"
         else:
             await self.interaction.followup.send("error is checking price type value")
@@ -168,7 +174,7 @@ async def herb_profit(
             kourend=kourend, magic_secateurs=magic_secateurs, farming_cape=farming_cape, bottomless_bucket=bottomless_bucket, attas=attas,
             compost=compost.value, prices=prices, price_key=price_key, price_type=price_type.value
         )
-        await interaction.response.send_message("Choose the format for the reply:", view=view)
+        await interaction.response.send_message("Choose the format for the reply:", view=view, ephemeral=True)
 
 
 async def setup(bot):

bot/utils/DButil.py

@@ -1,14 +1,29 @@
 import sqlite3
+import os
+import aiosqlite
+from typing import Optional
+
+
+def get_db_path() -> str:
+    """Return the DB path from environment or default to local data/db/weapons.db"""
+    return os.getenv('WEAPONS_DB_PATH', os.path.join(os.getcwd(), 'data', 'db', 'weapons.db'))
 
 
 def get_db_connection():
-    conn = sqlite3.connect('duelbot.db')
-    conn.row_factory = sqlite3.Row
-    return conn
+    db_path = get_db_path()
+    os.makedirs(os.path.dirname(db_path), exist_ok=True)
+    return sqlite3.connect(db_path)
+
+
+async def async_get_db_connection() -> aiosqlite.Connection:
+    db_path = get_db_path()
+    os.makedirs(os.path.dirname(db_path), exist_ok=True)
+    return await aiosqlite.connect(db_path)
 
 
 def initialize_db():
     conn = get_db_connection()
+    conn.row_factory = sqlite3.Row
     c = conn.cursor()
 
     # Create a version table if it doesn't exist
@@ -92,6 +107,7 @@ def add_predefined_weapons():
         ('Granite Maul', 35, 5, 15000)
     ]
     conn = get_db_connection()
+    conn.row_factory = sqlite3.Row
     c = conn.cursor()
     c.executemany('INSERT OR IGNORE INTO weapons (name, damage, speed, cost) VALUES (?, ?, ?, ?)', weapons)
     conn.commit()

bot/utils/api.py

@@ -1,22 +1,66 @@
-import requests
-from config.settings import HEADERS
+import aiohttp
+import asyncio
+# Import HEADERS and CACHE_TTL from settings
+from config.settings import HEADERS, CACHE_TTL
 
+# Simple in-memory TTL cache
+_CACHE = {
+    'latest': {'ts': 0, 'data': None},
+    '1h': {'ts': 0, 'data': None}
+}
+_CACHE_TTL = CACHE_TTL
 
-# Grabs latest prices from wiki API, returns the entire list of all items to save an API resource
-def fetch_latest_prices():
+
+# Asynchronous fetchers using aiohttp. Accept an optional session for reuse.
+async def fetch_latest_prices(session: aiohttp.ClientSession | None = None):
+    # Check cache
+    now = asyncio.get_event_loop().time()
+    if _CACHE['latest']['data'] is not None and (now - _CACHE['latest']['ts']) < _CACHE_TTL:
+        return _CACHE['latest']['data']
     url = "https://prices.runescape.wiki/api/v1/osrs/latest"
-    response = requests.get(url, headers=HEADERS)  # OSRS wiki demands custom user-agent headers, defined in config.yaml. python requests are blocked by default
-    data = response.json()
+    close_session = False
+    if session is None:
+        session = aiohttp.ClientSession(headers=HEADERS)
+        close_session = True
+
+    try:
+        async with session.get(url) as resp:
+            data = await resp.json()
+    except asyncio.CancelledError:
+        raise
+    finally:
+        if close_session:
+            await session.close()
 
     if "data" not in data:
         raise ValueError("Error fetching data from API")
+    _CACHE['latest']['ts'] = asyncio.get_event_loop().time()
+    _CACHE['latest']['data'] = data["data"]
     return data["data"]
 
 
-def fetch_1h_prices():
+async def fetch_1h_prices(session: aiohttp.ClientSession | None = None):
+    # Check cache
+    now = asyncio.get_event_loop().time()
+    if _CACHE['1h']['data'] is not None and (now - _CACHE['1h']['ts']) < _CACHE_TTL:
+        return _CACHE['1h']['data']
     url = "https://prices.runescape.wiki/api/v1/osrs/1h"
-    response = requests.get(url, headers=HEADERS)
-    data = response.json()
+    close_session = False
+    if session is None:
+        session = aiohttp.ClientSession(headers=HEADERS)
+        close_session = True
+
+    try:
+        async with session.get(url) as resp:
+            data = await resp.json()
+    except asyncio.CancelledError:
+        raise
+    finally:
+        if close_session:
+            await session.close()
+
     if "data" not in data:
         raise ValueError("Error fetching data from API")
+    _CACHE['1h']['ts'] = asyncio.get_event_loop().time()
+    _CACHE['1h']['data'] = data["data"]
     return data["data"]

bot/utils/calculations.py

@@ -66,6 +66,7 @@ def calculate_custom_profit(prices, herbs, farming_level, patches, weiss, trollh
 
         # Calculate expected yield for protected patches
         total_yield_protected = 0
+        expected_yield_protected = 0
         if protected_patches > 0:
             for _ in range(protected_patches):
                 if "Hosidius" in protected_names and kourend: