Muse Dash: Fix bad generations occuring due to changing item ids (#2122)

worlds/musedash/test/TestCollection.py

@@ -0,0 +1,49 @@
+import unittest
+from ..MuseDashCollection import MuseDashCollections
+
+
+class CollectionsTest(unittest.TestCase):
+    REMOVED_SONGS = [
+        "CHAOS Glitch",
+        "FM 17314 SUGAR RADIO",
+    ]
+
+    def test_all_names_are_ascii(self) -> None:
+        bad_names = list()
+        collection = MuseDashCollections()
+        for name in collection.song_items.keys():
+            for c in name:
+                # This is taken directly from OoT. Represents the generally excepted characters.
+                if (0x20 <= ord(c) < 0x7e):
+                    continue
+
+                bad_names.append(name)
+                break
+
+        self.assertEqual(len(bad_names), 0, f"Muse Dash has {len(bad_names)} songs with non-ASCII characters.\n{bad_names}")
+
+    def test_ids_dont_change(self) -> None:
+        collection = MuseDashCollections()
+        itemsBefore = {name: code for name, code in collection.item_names_to_id.items()}
+        locationsBefore = {name: code for name, code in collection.location_names_to_id.items()}
+
+        collection.__init__()
+        itemsAfter = {name: code for name, code in collection.item_names_to_id.items()}
+        locationsAfter = {name: code for name, code in collection.location_names_to_id.items()}
+
+        self.assertDictEqual(itemsBefore, itemsAfter, "Item ID changed after secondary init.")
+        self.assertDictEqual(locationsBefore, locationsAfter, "Location ID changed after secondary init.")
+
+    def test_free_dlc_included_in_base_songs(self) -> None:
+        collection = MuseDashCollections()
+        songs = collection.get_songs_with_settings(False, False, 0, 11)
+
+        self.assertIn("Glimmer", songs, "Budget Is Burning Vol.1 is not being included in base songs")
+        self.assertIn("Out of Sense", songs, "Budget Is Burning: Nano Core is not being included in base songs")
+
+    def test_remove_songs_are_not_generated(self) -> None:
+        collection = MuseDashCollections()
+        songs = collection.get_songs_with_settings(True, False, 0, 11)
+
+        for song_name in self.REMOVED_SONGS:
+            self.assertNotIn(song_name, songs, f"Song '{song_name}' wasn't removed correctly.")

worlds/musedash/test/TestDifficultyRanges.py

@@ -9,8 +9,8 @@ class DifficultyRanges(MuseDashTestBase):
         difficulty_max = self.multiworld.song_difficulty_max[1]
 
         def test_range(inputRange, lower, upper):
-            assert inputRange[0] == lower and inputRange[1] == upper, \
-            f"Output incorrect. Got: {inputRange[0]} to {inputRange[1]}. Expected: {lower} to {upper}"
+            self.assertEqual(inputRange[0], lower)
+            self.assertEqual(inputRange[1], upper)
 
             songs = muse_dash_world.md_collection.get_songs_with_settings(True, False, inputRange[0], inputRange[1])
             for songKey in songs:
@@ -24,7 +24,7 @@ class DifficultyRanges(MuseDashTestBase):
                 if (song.master is not None and inputRange[0] <= song.master <= inputRange[1]):
                     continue
 
-                assert False, f"Invalid song '{songKey}' was given for range '{inputRange[0]} to {inputRange[1]}'"
+                self.fail(f"Invalid song '{songKey}' was given for range '{inputRange[0]} to {inputRange[1]}'")
 
         #auto ranges
         difficulty_choice.value = 0
@@ -65,5 +65,5 @@ class DifficultyRanges(MuseDashTestBase):
         for song_name in muse_dash_world.md_collection.DIFF_OVERRIDES:
             song = muse_dash_world.md_collection.song_items[song_name]
 
-            assert song.easy is not None and song.hard is not None and song.master is not None, \
-                f"Song '{song_name}' difficulty not set when it should be."
+            self.assertTrue(song.easy is not None and song.hard is not None and song.master is not None,
+                f"Song '{song_name}' difficulty not set when it should be.")

worlds/musedash/test/TestNames.py

@@ -1,18 +0,0 @@
-import unittest
-from ..MuseDashCollection import MuseDashCollections
-
-
-class NamesTest(unittest.TestCase):
-    def test_all_names_are_ascii(self) -> None:
-        bad_names = list()
-        collection = MuseDashCollections(0, 1)
-        for name in collection.song_items.keys():
-            for c in name:
-                # This is taken directly from OoT. Represents the generally excepted characters.
-                if (0x20 <= ord(c) < 0x7e):
-                    continue
-
-                bad_names.append(name)
-                break
-
-        assert len(bad_names) == 0, f"Muse Dash has {len(bad_names)} songs with non-ASCII characters.\n{bad_names}"

worlds/musedash/test/TestPlandoSettings.py

@@ -1,7 +1,7 @@
 from . import MuseDashTestBase
 
 
-class TestIncludedSongSizeDoesntGrow(MuseDashTestBase):
+class TestPlandoSettings(MuseDashTestBase):
     options = {
         "additional_song_count": 15,
         "allow_just_as_planned_dlc_songs": True,
@@ -14,14 +14,14 @@ class TestIncludedSongSizeDoesntGrow(MuseDashTestBase):
 
     def test_included_songs_didnt_grow_item_count(self) -> None:
         muse_dash_world = self.multiworld.worlds[1]
-        assert len(muse_dash_world.included_songs) == 15, \
-            f"Logical songs size grew when it shouldn't. Expected 15. Got {len(muse_dash_world.included_songs)}"
+        self.assertEqual(len(muse_dash_world.included_songs), 15,
+            f"Logical songs size grew when it shouldn't. Expected 15. Got {len(muse_dash_world.included_songs)}")
 
     def test_included_songs_plando(self) -> None:
         muse_dash_world = self.multiworld.worlds[1]
         songs = muse_dash_world.included_songs.copy()
         songs.append(muse_dash_world.victory_song_name)
 
-        assert "Operation Blade" in songs, "Logical songs is missing a plando song: Operation Blade"
-        assert "Autumn Moods" in songs, "Logical songs is missing a plando song: Autumn Moods"
-        assert "Fireflies" in songs, "Logical songs is missing a plando song: Fireflies"
+        self.assertIn("Operation Blade", songs, "Logical songs is missing a plando song: Operation Blade")
+        self.assertIn("Autumn Moods", songs, "Logical songs is missing a plando song: Autumn Moods")
+        self.assertIn("Fireflies", songs, "Logical songs is missing a plando song: Fireflies")

worlds/musedash/test/TestRemovedSongs.py

@@ -1,25 +0,0 @@
-from . import MuseDashTestBase
-
-
-class TestRemovedSongs(MuseDashTestBase):
-    options = {
-        "starting_song_count": 10,
-        "allow_just_as_planned_dlc_songs": True,
-        "additional_song_count": 500,
-    }
-
-    removed_songs = [
-        "CHAOS Glitch",
-        "FM 17314 SUGAR RADIO"
-    ]
-
-    def test_remove_songs_are_not_generated(self) -> None:
-        # This test is done on a world where every song should be added.
-        muse_dash_world = self.multiworld.worlds[1]
-
-        for song_name in self.removed_songs:
-            assert song_name not in muse_dash_world.starting_songs, \
-                f"Song '{song_name}' was included into the starting songs when it shouldn't."
-
-            assert song_name not in muse_dash_world.included_songs, \
-                f"Song '{song_name}' was included into the included songs when it shouldn't."