dockipelago/worlds/brotato/test/test_starting_characters.py

from collections.abc import Sequence

from ..constants import BASE_GAME_CHARACTERS
from ..items import item_name_groups
from . import BrotatoTestBase

_character_items = item_name_groups["Characters"]


class TestBrotatoStartingCharacters(BrotatoTestBase):
    @property
    def run_default_tests(self) -> bool:
        return False  # TODO: Flaky results, need to track down why

    def _run_and_check(
        self,
        num_characters: int,
        custom_starting_characters: bool = True,
        expected_characters: Sequence[str] | None = None,
    ):
        # Create world with relevant options
        run_options = {
            "starting_characters": int(custom_starting_characters),
            "num_characters": num_characters,
            "num_starting_characters": num_characters,
        }
        with self._run(run_options):
            # Get precollected items
            player_precollected = self.multiworld.precollected_items[self.player]
            precollected_characters = [p for p in player_precollected if p.name in _character_items]

            # Check that the number of starting characters is correct
            self.assertEqual(len(precollected_characters), num_characters)

            # Check that we have exactly some characters. This works best for testing the default characters, it's
            # flakier for others since we rely on the seed and random() calls to be consistent.
            if expected_characters is not None:
                self.assertEqual(len(expected_characters), num_characters)
                for ec in expected_characters:
                    expected_item = self.world.create_item(ec)
                    self.assertIn(expected_item, precollected_characters)

    def test_default_starting_characters(self):
        self._run_and_check(
            num_characters=BASE_GAME_CHARACTERS.num_default_characters,
            custom_starting_characters=False,
            expected_characters=BASE_GAME_CHARACTERS.default_characters,
        )

    def test_custom_starting_characters(self):
        for num_characters in range(1, BASE_GAME_CHARACTERS.num_characters):
            with self.subTest(msg=f"{num_characters} starting characters"):
                self._run_and_check(num_characters=num_characters)