Merge pull request zeusops#6 from zeusops/attachment

Modlist attachment for /zeus-upload

Author: Gehock

CHANGELOG.md

@@ -5,6 +5,12 @@ The project uses semantic versioning (see [semver](https://semver.org)).
 
 ## [Unreleased]
 
+### Added
+
+- `/zeus-upload` command now accepts an optional modlist (JSON snippet exported
+  from Mod Presets menu in Reforger).
+- Command line flag `--debug` for enabling more verbose debug logging.
+
 ### Fixed
 
 - Uploaded missions are now pretty-printed, to make it reviewable.

src/zeusops_bot/cli.py

@@ -9,6 +9,7 @@
 from zeusops_bot import reforger_config_gen as cmd
 from zeusops_bot.discord import ZeusopsBot
 from zeusops_bot.errors import ZeusopsBotConfigException
+from zeusops_bot.logging import setup_logging
 from zeusops_bot.models import ModDetail
 from zeusops_bot.settings import ZeusopsBotConfig, load
 
@@ -35,6 +36,11 @@ def parse_arguments(args: list[str]) -> argparse.Namespace:
         "zeusops-bot",
         description="Multipurpose discord bot for the Zeusops community",
     )
+    parser.add_argument(
+        "--debug",
+        help="Enable debug logging",
+        action="store_true",
+    )
     return parser.parse_args(args)
 
 
@@ -43,10 +49,10 @@ def cli(arguments: list[str] | None = None):
     if arguments is None:
         arguments = sys.argv[1:]
     _args = parse_arguments(arguments)
-    return main()
+    return main(_args.debug)
 
 
-def main():
+def main(debug: bool = False):
     """Run the main bot"""
     try:
         config = load(ZeusopsBotConfig)
@@ -60,11 +66,9 @@ def main():
         print("Error while loading the bot's config from envvars", file=sys.stderr)
         raise
 
-    logging.basicConfig(level=logging.DEBUG)
-    logging.getLogger("discord").setLevel(logging.INFO)
-    logging.getLogger("discord.gateway").setLevel(logging.WARNING)
+    setup_logging(debug)
 
-    bot = ZeusopsBot(config, logging.getLogger("discord"))
+    bot = ZeusopsBot(config, logging.getLogger("zeusops.discord"))
     bot.run()  # Token is already in config
 
 

src/zeusops_bot/cogs/zeus_upload.py

@@ -2,19 +2,24 @@
 
 import discord
 from discord.ext import commands
+from pydantic import TypeAdapter, ValidationError
 
 from zeusops_bot.errors import (
     ConfigFileInvalidJson,
     ConfigFileNotFound,
     ConfigPatchingError,
 )
-from zeusops_bot.reforger_config_gen import ReforgerConfigGenerator
+from zeusops_bot.models import ModDetail
+from zeusops_bot.reforger_config_gen import ReforgerConfigGenerator, extract_mods
+from zeusops_bot.settings import ZeusopsBotConfig
+
+modlist_typeadapter = TypeAdapter(list[ModDetail])
 
 
 class ZeusUpload(commands.Cog):
     """ZeusUpload cog for handling mission uploads"""
 
-    def __init__(self, bot, config):
+    def __init__(self, bot: discord.Bot, config: ZeusopsBotConfig):
         """Initialise the cog"""
         self.bot = bot
         self.config = config
@@ -24,31 +29,66 @@ def __init__(self, bot, config):
         )
 
     @commands.slash_command(name="zeus-upload")
+    @discord.option(
+        "modlist",
+        description="Modlist JSON exported from Reforger",
+        input_type=discord.SlashCommandOptionType.attachment,
+        required=False,
+    )
     async def zeus_upload(
-        self, ctx: discord.ApplicationContext, scenario_id: str, filename: str
+        self,
+        ctx: discord.ApplicationContext,
+        scenario_id: str,
+        filename: str,
+        modlist: discord.Attachment | None = None,
     ):
         """Upload a mission as a Zeus"""
-        try:  # TODO: How do we pass modlist != None
+        extracted_mods = None
+        try:
+            if modlist is not None:
+                data = await modlist.read()
+                extracted_mods = extract_mods(data.decode())
+        except ConfigFileInvalidJson as e:
+            await ctx.respond(
+                "Failed to understand the attached modlist as JSON. "
+                "Check the file was exported from the workshop, "
+                "try confirming with an online validator like "
+                "<https://jsonlint.com/>.\n\n"
+                f"Parse error was:\n```\n{e}\n```"
+            )
+            return
+        except ValidationError as e:
+            await ctx.respond(
+                "Failed to understand the modlist given: valid JSON, "
+                "but not a list of mod objects (name/ID/optional-version). "
+                "Check the file was exported from the workshop.\n\n"
+                f"Error was:\n```\n{e}\n```"
+            )
+            return
+        try:
             path = self.reforger_confgen.zeus_upload(
-                scenario_id, filename, modlist=None
+                scenario_id, filename, modlist=extracted_mods
             )
-            await ctx.respond(f"Mission uploaded successfully under {path=}")
         except ConfigFileNotFound:
             await ctx.respond(
                 "Bot config error: the base config file could not be found"
-                " Tell the Techmins! Path was: "
-                + str(self.reforger_confgen.base_config)
+                f" Tell the Techmins! Path was: {self.reforger_confgen.base_config}"
             )
+            return
         except ConfigFileInvalidJson as e:
             await ctx.respond(
                 "Bot config error: the base config file is invalid JSON "
-                "Tell the Techmins! Error was: " + str(e)
+                "Tell the Techmins!\n\n"
+                f"Error was:\n```\n{e}\n```"
             )
+            return
         except ConfigPatchingError as e:
             await ctx.respond(
-                "Failed to patch your requested change over base config.\n"
-                f"Error was: {str(e)}"
+                "Failed to patch your requested change over base config.\n\n"
+                f"Error was:\n```\n{e}\n```"
             )
+            return
+        await ctx.respond(f"Mission uploaded successfully under {path=}")
 
     @commands.slash_command(name="zeus-set-mission")
     async def zeus_set_mission(self, ctx: discord.ApplicationContext, filename: str):
@@ -77,11 +117,11 @@ async def current_mission(self, ctx: discord.ApplicationContext):
                 f"Current mission: `{self.reforger_confgen.current_mission()}`"
             )
         except ConfigFileNotFound as e:
-            await ctx.respond(f"Could not find configured mission: {str(e)}")
+            await ctx.respond(f"Could not find configured mission: {e}")
 
     @commands.Cog.listener()
     async def on_application_command_error(
         self, ctx: discord.ApplicationContext, error: discord.DiscordException
     ):
         """Handles application command errors that are not caught elsewhere"""
-        await ctx.respond(f"Unhandled exception: {error}")
+        await ctx.respond(f"Unhandled exception: \n\nError was: {error}")

src/zeusops_bot/discord.py

@@ -1,5 +1,7 @@
 """Manage the Discord-side horrors"""
 
+from logging import Logger
+
 from discord import Bot
 
 from zeusops_bot.cogs import ZeusUpload
@@ -9,7 +11,7 @@
 class ZeusopsBot(Bot):
     """A Discord Client for general purposes"""
 
-    def __init__(self, config: ZeusopsBotConfig, logger, *args, **kwargs):
+    def __init__(self, config: ZeusopsBotConfig, logger: Logger, *args, **kwargs):
         """Initialize the Client"""
         super().__init__(*args, **kwargs)
         self.config = config

src/zeusops_bot/logging.py

@@ -0,0 +1,16 @@
+"""Logging-related utilities"""
+
+import logging
+
+
+def setup_logging(debug):
+    """Set up basic logger"""
+    if debug:
+        logging.basicConfig(level=logging.DEBUG)
+    else:
+        logging.basicConfig(level=logging.INFO)
+
+        # By default the Discord library is very verbose, so we're limiting it
+        # a bit
+        logging.getLogger("discord").setLevel(logging.INFO)
+        logging.getLogger("discord.gateway").setLevel(logging.WARNING)

src/zeusops_bot/reforger_config_gen.py

@@ -4,10 +4,14 @@
 from pathlib import Path
 
 import jsonpatch
+from pydantic import TypeAdapter, ValidationError
 
 from zeusops_bot import errors
+from zeusops_bot.errors import ConfigFileInvalidJson
 from zeusops_bot.models import ModDetail
 
+modlist_typeadapter = TypeAdapter(list["ModDetail"])
+
 SYMLINK_FILENAME = "current-config.json"
 
 
@@ -138,3 +142,24 @@ def patch_file(source: dict, modlist: list[ModDetail] | None, scenario_id: str)
     except jsonpatch.JsonPatchException as e:
         raise errors.ConfigPatchingError(e)
     return mod
+
+
+def extract_mods(modlist: str | None) -> list[ModDetail] | None:
+    """Extracts a list of ModDetail entries from a mod list exported from Reforger."""
+    if modlist is None:
+        return None
+    modlist = f"[{modlist}]"
+    try:
+        return modlist_typeadapter.validate_json(modlist)
+    except ValidationError as e:
+        errors = e.errors()
+        if len(errors) > 1:
+            # Got more than 1 error, not our problem
+            raise e
+        error = errors[0]
+        match error["type"]:
+            case "json_invalid":
+                raise ConfigFileInvalidJson(e)
+            case _:
+                # Unknown error
+                raise e

tests/fixtures.py

@@ -10,12 +10,34 @@
 
 BASE_CONFIG: ConfigFile = {"game": {"scenarioId": "old-value", "mods": []}}
 
-MODLIST: list[ModDetail] = [
+MODLIST_DICT: list[ModDetail] = [
     {"modId": "595F2BF2F44836FB", "name": "RHS - Status Quo", "version": "0.10.4075"},
     {"modId": "5EB744C5F42E0800", "name": "ACE Chopping", "version": "1.2.0"},
     {"modId": "60EAEA0389DB3CC2", "name": "ACE Trenches", "version": "1.2.0"},
 ]
 
+# NOTE: These two formats are not 100% equivalent: Reforger exports the mods in
+# a JSON list, but doesn't actually include the outer [] in the exported
+# string, because the data is meant to be pasted directly inside the
+# `"mods": [ ]` entry of the config file.
+MODLIST_JSON: str = """
+    {
+        "modId": "595F2BF2F44836FB",
+        "name": "RHS - Status Quo",
+        "version": "0.10.4075"
+    },
+    {
+        "modId": "5EB744C5F42E0800",
+        "name": "ACE Chopping",
+        "version": "1.2.0"
+    },
+    {
+        "modId": "60EAEA0389DB3CC2",
+        "name": "ACE Trenches",
+        "version": "1.2.0"
+    }
+"""
+
 
 @pytest.fixture
 def mission_dir(tmp_path: Path) -> Path:

tests/test_upload_mission.py

@@ -8,8 +8,8 @@
 
 import json
 
-from tests.fixtures import BASE_CONFIG, MODLIST
-from zeusops_bot.reforger_config_gen import ReforgerConfigGenerator
+from tests.fixtures import BASE_CONFIG, MODLIST_DICT, MODLIST_JSON
+from zeusops_bot.reforger_config_gen import ReforgerConfigGenerator, extract_mods
 
 
 def test_upload_edits_files(tmp_path):
@@ -23,13 +23,15 @@ def test_upload_edits_files(tmp_path):
     source_file.write_text(json.dumps(BASE_CONFIG))
     gen = ReforgerConfigGenerator(base_config_file=source_file, target_folder=dest)
     # When Zeus calls "/zeus-upload"
-    out_path = gen.zeus_upload(scenario_id, filename, MODLIST)
+    modlist = extract_mods(MODLIST_JSON)
+    out_path = gen.zeus_upload(scenario_id, filename, modlist)
     # Then a new server config file is created
     assert out_path.is_file(), "Should have generated a file on disk"
     # And the config file is patched with <modlist.json> and <scenarioId>
     config = json.loads(out_path.read_text())
     assert config["game"]["scenarioId"] == scenario_id, "Should update scenarioId"
-    assert config["game"]["mods"] == MODLIST, "Should update modlist"
+    assert isinstance(config["game"]["mods"], list)
+    assert config["game"]["mods"][0] == MODLIST_DICT[0]
 
 
 def test_upload_edits_files_without_modlist(tmp_path):
@@ -49,4 +51,5 @@ def test_upload_edits_files_without_modlist(tmp_path):
     # And the config file is patched with just <scenarioId>
     config = json.loads(out_path.read_text())
     assert config["game"]["scenarioId"] == scenario_id, "Should update scenarioId"
+    assert isinstance(config["game"]["mods"], list)
     assert config["game"]["mods"] == BASE_CONFIG["game"]["mods"], "Should keep modlist"