forked from mirror/Archipelago
49f2d30587
* sc2: Changing default campaign options to something more performative and desirable for new players * sc2: Fixing broken test that was missed in roundup * SC2: Update tests for new defaults * SC2: Fix incomplete test * sc2: Updating description for enabled campaigns to mention which are free to play * sc2: PR comments; Updating additional unit tests that were affected by a default change * sc2: Adding a comment to the Enabled Campaigns option to list all the valid campaign names * sc2: Adding quotes wrapping sample values in enabled_campaigns comment to aid copy-pasting --------- Co-authored-by: Salzkorn <salzkitty@gmail.com>
222 lines
9.0 KiB
Python
222 lines
9.0 KiB
Python
"""
|
|
Unit tests for custom mission orders
|
|
"""
|
|
|
|
from .test_base import Sc2SetupTestBase
|
|
from .. import MissionFlag
|
|
from ..item import item_tables, item_names
|
|
from BaseClasses import ItemClassification
|
|
from .. import options
|
|
|
|
class TestCustomMissionOrders(Sc2SetupTestBase):
|
|
def test_mini_wol_generates(self):
|
|
world_options = {
|
|
**self.ALL_CAMPAIGNS,
|
|
'mission_order': 'custom',
|
|
'custom_mission_order': {
|
|
'Mini Wings of Liberty': {
|
|
'global': {
|
|
'type': 'column',
|
|
'mission_pool': [
|
|
'terran missions',
|
|
'^ wol missions'
|
|
]
|
|
},
|
|
'Mar Sara': {
|
|
'size': 1
|
|
},
|
|
'Colonist': {
|
|
'size': 2,
|
|
'entry_rules': [{
|
|
'scope': '../Mar Sara'
|
|
}]
|
|
},
|
|
'Artifact': {
|
|
'size': 3,
|
|
'entry_rules': [{
|
|
'scope': '../Mar Sara'
|
|
}],
|
|
'missions': [
|
|
{
|
|
'index': 1,
|
|
'entry_rules': [{
|
|
'scope': 'Mini Wings of Liberty',
|
|
'amount': 4
|
|
}]
|
|
},
|
|
{
|
|
'index': 2,
|
|
'entry_rules': [{
|
|
'scope': 'Mini Wings of Liberty',
|
|
'amount': 8
|
|
}]
|
|
}
|
|
]
|
|
},
|
|
'Prophecy': {
|
|
'size': 2,
|
|
'entry_rules': [{
|
|
'scope': '../Artifact/1'
|
|
}],
|
|
'mission_pool': [
|
|
'protoss missions',
|
|
'^ prophecy missions'
|
|
]
|
|
},
|
|
'Covert': {
|
|
'size': 2,
|
|
'entry_rules': [{
|
|
'scope': 'Mini Wings of Liberty',
|
|
'amount': 2
|
|
}]
|
|
},
|
|
'Rebellion': {
|
|
'size': 2,
|
|
'entry_rules': [{
|
|
'scope': 'Mini Wings of Liberty',
|
|
'amount': 3
|
|
}]
|
|
},
|
|
'Char': {
|
|
'size': 3,
|
|
'entry_rules': [{
|
|
'scope': '../Artifact/2'
|
|
}],
|
|
'missions': [
|
|
{
|
|
'index': 0,
|
|
'next': [2]
|
|
},
|
|
{
|
|
'index': 1,
|
|
'entrance': True
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
self.generate_world(world_options)
|
|
flags = self.world.custom_mission_order.get_used_flags()
|
|
self.assertEqual(flags[MissionFlag.Terran], 13)
|
|
self.assertEqual(flags[MissionFlag.Protoss], 2)
|
|
self.assertEqual(flags.get(MissionFlag.Zerg, 0), 0)
|
|
sc2_regions = set(self.multiworld.regions.region_cache[self.player]) - {"Menu"}
|
|
self.assertEqual(len(self.world.custom_mission_order.get_used_missions()), len(sc2_regions))
|
|
|
|
def test_locked_and_necessary_item_appears_once(self):
|
|
# This is a filler upgrade with a parent
|
|
test_item = item_names.MARINE_OPTIMIZED_LOGISTICS
|
|
world_options = {
|
|
'mission_order': 'custom',
|
|
'locked_items': { test_item: 1 },
|
|
'custom_mission_order': {
|
|
'test': {
|
|
'type': 'column',
|
|
'size': 5, # Give the generator some space to place the key
|
|
'max_difficulty': 'easy',
|
|
'missions': [{
|
|
'index': 4,
|
|
'entry_rules': [{
|
|
'items': { test_item: 1 }
|
|
}]
|
|
}]
|
|
}
|
|
}
|
|
}
|
|
|
|
self.assertNotEqual(item_tables.item_table[test_item].classification, ItemClassification.progression, f"Test item {test_item} won't change classification")
|
|
|
|
self.generate_world(world_options)
|
|
test_items_in_pool = [item for item in self.multiworld.itempool if item.name == test_item]
|
|
test_items_in_pool += [item for item in self.multiworld.precollected_items[self.player] if item.name == test_item]
|
|
self.assertEqual(len(test_items_in_pool), 1)
|
|
self.assertEqual(test_items_in_pool[0].classification, ItemClassification.progression)
|
|
|
|
def test_start_inventory_and_necessary_item_appears_once(self):
|
|
# This is a filler upgrade with a parent
|
|
test_item = item_names.ZERGLING_METABOLIC_BOOST
|
|
world_options = {
|
|
'mission_order': 'custom',
|
|
'enabled_campaigns': set(options.EnabledCampaigns.valid_keys),
|
|
'start_inventory': { test_item: 1 },
|
|
'custom_mission_order': {
|
|
'test': {
|
|
'type': 'column',
|
|
'size': 5, # Give the generator some space to place the key
|
|
'max_difficulty': 'easy',
|
|
'missions': [{
|
|
'index': 4,
|
|
'entry_rules': [{
|
|
'items': { test_item: 1 }
|
|
}]
|
|
}]
|
|
}
|
|
}
|
|
}
|
|
|
|
self.generate_world(world_options)
|
|
test_items_in_pool = [item for item in self.multiworld.itempool if item.name == test_item]
|
|
self.assertEqual(len(test_items_in_pool), 0)
|
|
test_items_in_start_inventory = [item for item in self.multiworld.precollected_items[self.player] if item.name == test_item]
|
|
self.assertEqual(len(test_items_in_start_inventory), 1)
|
|
|
|
def test_start_inventory_and_locked_and_necessary_item_appears_once(self):
|
|
# This is a filler upgrade with a parent
|
|
test_item = item_names.ZERGLING_METABOLIC_BOOST
|
|
world_options = {
|
|
'mission_order': 'custom',
|
|
'enabled_campaigns': set(options.EnabledCampaigns.valid_keys),
|
|
'start_inventory': { test_item: 1 },
|
|
'locked_items': { test_item: 1 },
|
|
'custom_mission_order': {
|
|
'test': {
|
|
'type': 'column',
|
|
'size': 5, # Give the generator some space to place the key
|
|
'max_difficulty': 'easy',
|
|
'missions': [{
|
|
'index': 4,
|
|
'entry_rules': [{
|
|
'items': { test_item: 1 }
|
|
}]
|
|
}]
|
|
}
|
|
}
|
|
}
|
|
|
|
self.generate_world(world_options)
|
|
test_items_in_pool = [item for item in self.multiworld.itempool if item.name == test_item]
|
|
self.assertEqual(len(test_items_in_pool), 0)
|
|
test_items_in_start_inventory = [item for item in self.multiworld.precollected_items[self.player] if item.name == test_item]
|
|
self.assertEqual(len(test_items_in_start_inventory), 1)
|
|
|
|
def test_key_item_rule_creates_correct_item_amount(self):
|
|
# This is an item that normally only exists once
|
|
test_item = item_names.ZERGLING
|
|
test_amount = 3
|
|
world_options = {
|
|
**self.ALL_CAMPAIGNS,
|
|
'mission_order': 'custom',
|
|
'locked_items': { test_item: 1 }, # Make sure it is generated as normal
|
|
'custom_mission_order': {
|
|
'test': {
|
|
'type': 'column',
|
|
'size': 12, # Give the generator some space to place the keys
|
|
'max_difficulty': 'easy',
|
|
'mission_pool': ['zerg missions'], # Make sure the item isn't excluded by race selection
|
|
'missions': [{
|
|
'index': 10,
|
|
'entry_rules': [{
|
|
'items': { test_item: test_amount } # Require more than the usual item amount
|
|
}]
|
|
}]
|
|
}
|
|
}
|
|
}
|
|
|
|
self.generate_world(world_options)
|
|
test_items_in_pool = [item for item in self.multiworld.itempool if item.name == test_item]
|
|
test_items_in_start_inventory = [item for item in self.multiworld.precollected_items[self.player] if item.name == test_item]
|
|
self.assertEqual(len(test_items_in_pool + test_items_in_start_inventory), test_amount)
|