Grinch-AP/worlds/stardew_valley/test/assertion/option_assert.py

from unittest import TestCase

from BaseClasses import MultiWorld
from .world_assert import get_all_item_names, get_all_location_names
from ... import StardewValleyWorld, options, item_table, Group, location_table
from ...locations import LocationTags
from ...strings.ap_names.transport_names import Transportation


def get_stardew_world(multiworld: MultiWorld) -> StardewValleyWorld:
    for world_key in multiworld.worlds:
        world = multiworld.worlds[world_key]
        if isinstance(world, StardewValleyWorld):
            return world
    raise ValueError("no stardew world in this multiworld")


def get_stardew_options(multiworld: MultiWorld) -> options.StardewValleyOptions:
    return get_stardew_world(multiworld).options


class OptionAssertMixin(TestCase):

    def assert_has_item(self, multiworld: MultiWorld, item: str):
        all_item_names = set(get_all_item_names(multiworld))
        self.assertIn(item, all_item_names)

    def assert_has_not_item(self, multiworld: MultiWorld, item: str):
        all_item_names = set(get_all_item_names(multiworld))
        self.assertNotIn(item, all_item_names)

    def assert_has_location(self, multiworld: MultiWorld, item: str):
        all_location_names = set(get_all_location_names(multiworld))
        self.assertIn(item, all_location_names)

    def assert_has_not_location(self, multiworld: MultiWorld, item: str):
        all_location_names = set(get_all_location_names(multiworld))
        self.assertNotIn(item, all_location_names)

    def assert_can_reach_island(self, multiworld: MultiWorld):
        all_item_names = get_all_item_names(multiworld)
        self.assertIn(Transportation.boat_repair, all_item_names)
        self.assertIn(Transportation.island_obelisk, all_item_names)

    def assert_cannot_reach_island(self, multiworld: MultiWorld):
        all_item_names = get_all_item_names(multiworld)
        self.assertNotIn(Transportation.boat_repair, all_item_names)
        self.assertNotIn(Transportation.island_obelisk, all_item_names)

    def assert_can_reach_island_if_should(self, multiworld: MultiWorld):
        stardew_options = get_stardew_options(multiworld)
        include_island = stardew_options.exclude_ginger_island.value == options.ExcludeGingerIsland.option_false
        if include_island:
            self.assert_can_reach_island(multiworld)
        else:
            self.assert_cannot_reach_island(multiworld)

    def assert_cropsanity_same_number_items_and_locations(self, multiworld: MultiWorld):
        is_cropsanity = get_stardew_options(multiworld).cropsanity.value == options.Cropsanity.option_enabled
        if not is_cropsanity:
            return

        all_item_names = set(get_all_item_names(multiworld))
        all_location_names = set(get_all_location_names(multiworld))
        all_cropsanity_item_names = {item_name for item_name in all_item_names if Group.CROPSANITY in item_table[item_name].groups}
        all_cropsanity_location_names = {location_name
                                         for location_name in all_location_names
                                         if LocationTags.CROPSANITY in location_table[location_name].tags
                                         # Qi Beans do not have an item
                                         and location_name != "Harvest Qi Fruit"}
        self.assertEqual(len(all_cropsanity_item_names) + 1, len(all_cropsanity_location_names))

    def assert_all_rarecrows_exist(self, multiworld: MultiWorld):
        all_item_names = set(get_all_item_names(multiworld))
        for rarecrow_number in range(1, 9):
            self.assertIn(f"Rarecrow #{rarecrow_number}", all_item_names)

    def assert_has_deluxe_scarecrow_recipe(self, multiworld: MultiWorld):
        self.assert_has_item(multiworld, "Deluxe Scarecrow Recipe")

    def assert_festivals_give_access_to_deluxe_scarecrow(self, multiworld: MultiWorld):
        stardew_options = get_stardew_options(multiworld)
        has_festivals = stardew_options.festival_locations.value != options.FestivalLocations.option_disabled
        if not has_festivals:
            return

        self.assert_all_rarecrows_exist(multiworld)
        self.assert_has_deluxe_scarecrow_recipe(multiworld)

    def assert_has_festival_recipes(self, multiworld: MultiWorld):
        stardew_options = get_stardew_options(multiworld)
        has_festivals = stardew_options.festival_locations.value != options.FestivalLocations.option_disabled
        festival_items = ["Tub o' Flowers Recipe", "Jack-O-Lantern Recipe"]
        for festival_item in festival_items:
            if has_festivals:
                self.assert_has_item(multiworld, festival_item)
                self.assert_has_location(multiworld, festival_item)
            else:
                self.assert_has_not_item(multiworld, festival_item)
                self.assert_has_not_location(multiworld, festival_item)