Automatically remove version numbers from uploaded modlists. (zeusops#21)

* Describe and test for automatic version number removal

* Automatically remove version numbers from uploaded modlists

* Add `keep_versions` flag to `/zeus-upload`

Author: Gehock

CHANGELOG.md

@@ -9,6 +9,9 @@ The project uses semantic versioning (see [semver](https://semver.org)).
 
 - New optional argument `activate` to `/zeus-upload`. If set to true, the
   uploaded mission is automatically set as the active config.
+- Version numbers are automatically removed from the uploaded modlist. A new
+  optional argument `keep_versions=False` for `/zeus-upload` can be used to
+  preserve the version numbers.
 
 ## v0.5.0 - 2025-03-26
 

features/reforger_upload.feature

@@ -13,6 +13,14 @@ Scenario: Upload next mission
   And Zeus specifies <modlist.json>, <scenarioId>, <filename>
   Then a new server config file is created
   And the config file is patched with <modlist.json> and <scenarioId>
+  And the version numbers are removed from the mods.
+
+Scenario: Upload next mission with versions retained
+  Given a Zeusops mission locally ready
+  When Zeus calls "/zeus-upload" with "keep_versions=True"
+  Then a new server config file is created
+  And the config file is patched with <modlist.json> and <scenarioId>
+  And the version numbers are kept as-is.
 
 Scenario: Upload next mission and activate
   Given a Zeusops mission locally ready

src/zeusops_bot/cogs/zeus_upload.py

@@ -51,20 +51,30 @@ def __init__(self, bot: "ZeusopsBot", reforger_confgen: ReforgerConfigGenerator)
         description="Immediately use this uploaded mission as the active mission",
         required=False,
     )
+    @discord.option(
+        "keep_versions",
+        description=(
+            "Prevent version numbers from being removed from the uploaded modlist"
+        ),
+        required=False,
+    )
     async def zeus_upload(
         self,
         ctx: discord.ApplicationContext,
         scenario_id: str,
         filename: str,
         modlist: discord.Attachment | None = None,
         activate: bool = False,
+        keep_versions: bool = True,
     ):
         """Upload a mission as a Zeus"""
         extracted_mods = None
         try:
             if modlist is not None:
                 data = await modlist.read()
-                extracted_mods = extract_mods(data.decode())
+                extracted_mods = extract_mods(
+                    data.decode(), keep_versions=keep_versions
+                )
         except ConfigFileInvalidJson as e:
             await ctx.respond(
                 "Failed to understand the attached modlist as JSON. "

src/zeusops_bot/reforger_config_gen.py

@@ -158,13 +158,14 @@ def patch_file(source: dict, modlist: list[ModDetail] | None, scenario_id: str)
     return mod
 
 
-def extract_mods(modlist: str | None) -> list[ModDetail] | None:
+def extract_mods(modlist: str | None, keep_versions=False) -> list[ModDetail] | None:
     """Extracts a list of ModDetail entries from a mod list exported from Reforger
 
     Args:
       modlist: A partial JSON string of mods to extract. Can be None if the
                user did not provide any mods, in which case the operation is a
                no-op.
+      keep_versions: Preserve mod versions in the extracted list of mods.
 
     Raises:
       pydantic.ValidationError: Generic error in validating the mod list
@@ -177,7 +178,7 @@ def extract_mods(modlist: str | None) -> list[ModDetail] | None:
         return None
     modlist = f"[{modlist}]"
     try:
-        return modlist_typeadapter.validate_json(modlist)
+        mods = modlist_typeadapter.validate_json(modlist)
     except ValidationError as e:
         errors = e.errors()
         if len(errors) > 1:
@@ -190,3 +191,9 @@ def extract_mods(modlist: str | None) -> list[ModDetail] | None:
             case _:
                 # Unknown error
                 raise e
+
+    if not keep_versions:
+        for mod in mods:
+            del mod["version"]
+
+    return mods

tests/fixtures.py

@@ -22,6 +22,12 @@
     {"modId": "60EAEA0389DB3CC2", "name": "ACE Trenches", "version": "1.2.0"},
 ]
 
+MODLIST_DICT_VERSIONLESS: list[ModDetail] = [
+    {"modId": "595F2BF2F44836FB", "name": "RHS - Status Quo"},
+    {"modId": "5EB744C5F42E0800", "name": "ACE Chopping"},
+    {"modId": "60EAEA0389DB3CC2", "name": "ACE Trenches"},
+]
+
 # 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

tests/test_upload_mission.py

@@ -11,12 +11,29 @@
 
 import pytest
 
-from tests.fixtures import BASE_CONFIG, MODLIST_DICT, MODLIST_JSON
+from tests.fixtures import (
+    BASE_CONFIG,
+    MODLIST_DICT,
+    MODLIST_DICT_VERSIONLESS,
+    MODLIST_JSON,
+)
+from zeusops_bot.models import ModDetail
 from zeusops_bot.reforger_config_gen import ReforgerConfigGenerator, extract_mods
 
 
-@pytest.mark.parametrize("activate", (False, True))
-def test_upload_edits_files(base_config: Path, mission_dir: Path, activate: bool):
+@pytest.mark.parametrize(
+    "keep_versions,mods",
+    [(False, MODLIST_DICT_VERSIONLESS), (True, MODLIST_DICT)],
+    ids=["strip versions", "keep versions"],
+)
+@pytest.mark.parametrize("activate", (False, True), ids=["no activate", "activate"])
+def test_upload_edits_files(
+    base_config: Path,
+    mission_dir: Path,
+    activate: bool,
+    keep_versions: bool,
+    mods: list[ModDetail],
+):
     """Scenario: Upload next mission creates file"""
     # Given a Zeusops mission locally ready
     # And Zeus specifies <modlist.json>, <scenarioId>, <filename>
@@ -26,15 +43,15 @@ def test_upload_edits_files(base_config: Path, mission_dir: Path, activate: bool
         base_config_file=base_config, target_folder=mission_dir
     )
     # When Zeus calls "/zeus-upload"
-    modlist = extract_mods(MODLIST_JSON)
+    modlist = extract_mods(MODLIST_JSON, keep_versions)
     out_path = config_gen.zeus_upload(scenario_id, filename, modlist, activate)
     # 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 isinstance(config["game"]["mods"], list)
-    assert config["game"]["mods"][0] == MODLIST_DICT[0]
+    assert config["game"]["mods"][0] == mods[0]
 
 
 def test_upload_activate_mission(base_config: Path, mission_dir: Path):