Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix unit tests for map

Browse source
This commit is contained in:
Griatch 2021-07-19 22:45:30 +02:00
parent a3995f5b67
commit 0a75577929
4 changed files with 80 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

8
evennia/contrib/xyzgrid/map_example.py
View file

@ -17,11 +17,11 @@ Then
""" """
from evennia.contrib.xyzgrid import map_legend from evennia.contrib.xyzgrid import xymap_legend
# default prototype parent. It's important that # default prototype parent. It's important that
# the typeclass inherits from the XYZRoom (or XYZExit) # the typeclass inherits from the XYZRoom (or XYZExit)
# the map_legend.XYZROOM_PARENT and XYZEXIT_PARENTS can also # the xymap_legend.XYZROOM_PARENT and XYZEXIT_PARENTS can also
# be used as a shortcut. # be used as a shortcut.
PARENT = { PARENT = {
@ -66,7 +66,7 @@ MAP1 = r"""
""" """
class TransitionToCave(map_legend.MapTransitionMapNode): class TransitionToCave(xymap_legend.MapTransitionMapNode):
""" """
A transition from 'the large tree' to 'the small cave' map. This node is never spawned A transition from 'the large tree' to 'the small cave' map. This node is never spawned
into a room but only acts as a target for finding the exit's destination. into a room but only acts as a target for finding the exit's destination.
@ -169,7 +169,7 @@ MAP2 = r"""
""" """
# custom map node # custom map node
class TransitionToLargeTree(map_legend.MapTransitionMapNode): class TransitionToLargeTree(xymap_legend.MapTransitionMapNode):
""" """
A transition from 'the small cave' to 'the large tree' map. This node is never spawned A transition from 'the small cave' to 'the large tree' map. This node is never spawned
into a room by only acts as a target for finding the exit's destination. into a room by only acts as a target for finding the exit's destination.

82
evennia/contrib/xyzgrid/tests.py
View file

@ -9,7 +9,7 @@ from random import randint
from parameterized import parameterized from parameterized import parameterized
from django.test import TestCase from django.test import TestCase
from evennia.utils.test_resources import EvenniaTest from evennia.utils.test_resources import EvenniaTest
from . import xymap, xyzgrid, map_legend, xyzroom from . import xymap, xyzgrid, xymap_legend, xyzroom
MAP1 = """ MAP1 = """
@ -374,7 +374,7 @@ class TestMap1(_MapTest):
""" """
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
self.assertEqual(str(self.map).strip(), MAP1_DISPLAY) self.assertEqual(str(self.map).replace("||", "|").strip(), MAP1_DISPLAY)
def test_node_from_coord(self): def test_node_from_coord(self):
node = self.map.get_node_from_coord((1, 1)) node = self.map.get_node_from_coord((1, 1))
@ -410,7 +410,8 @@ class TestMap1(_MapTest):
mapstr = self.map.get_visual_range(coord, dist=1, mode='scan', character=None) mapstr = self.map.get_visual_range(coord, dist=1, mode='scan', character=None)
maplst = self.map.get_visual_range(coord, dist=1, mode='scan', return_str=False, maplst = self.map.get_visual_range(coord, dist=1, mode='scan', return_str=False,
character=None) character=None)
self.assertEqual(expectstr, mapstr) maplst = [[part.replace("||", "|") for part in partlst] for partlst in maplst]
self.assertEqual(expectstr, mapstr.replace("||", "|"))
self.assertEqual(expectlst, maplst[::-1]) self.assertEqual(expectlst, maplst[::-1])
@parameterized.expand([ @parameterized.expand([
@ -429,8 +430,9 @@ class TestMap1(_MapTest):
mapstr = self.map.get_visual_range(coord, dist=1, mode='scan', character='@') mapstr = self.map.get_visual_range(coord, dist=1, mode='scan', character='@')
maplst = self.map.get_visual_range(coord, dist=1, mode='scan', return_str=False, maplst = self.map.get_visual_range(coord, dist=1, mode='scan', return_str=False,
character='@') character='@')
self.assertEqual(expectstr, mapstr) maplst = [[part.replace("||", "|") for part in partlst] for partlst in maplst]
self.assertEqual(expectlst, maplst[::-1]) # flip y-axis to match print direction self.assertEqual(expectstr, mapstr.replace("||", "|"))
self.assertEqual(expectlst, maplst[::-1]) # flip y-axis for print
@parameterized.expand([ @parameterized.expand([
((0, 0), 1, '# \n| \n@-#'), ((0, 0), 1, '# \n| \n@-#'),
@ -446,7 +448,7 @@ class TestMap1(_MapTest):
""" """
mapstr = self.map.get_visual_range(coord, dist=dist, mode='nodes', character='@') mapstr = self.map.get_visual_range(coord, dist=dist, mode='nodes', character='@')
self.assertEqual(expected, mapstr) self.assertEqual(expected, mapstr.replace("||", "|"))
def test_spawn(self): def test_spawn(self):
""" """
@ -471,7 +473,7 @@ class TestMap2(_MapTest):
# strip the leftover spaces on the right to better # strip the leftover spaces on the right to better
# work with text editor stripping this automatically ... # work with text editor stripping this automatically ...
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(stripped_map, MAP2_DISPLAY) self.assertEqual(stripped_map.replace("||", "|"), MAP2_DISPLAY)
def test_node_from_coord(self): def test_node_from_coord(self):
for mapnode in self.map.node_index_map.values(): for mapnode in self.map.node_index_map.values():
@ -510,7 +512,7 @@ class TestMap2(_MapTest):
""" """
mapstr = self.map.get_visual_range(coord, dist=4, mode='scan', character='@') mapstr = self.map.get_visual_range(coord, dist=4, mode='scan', character='@')
self.assertEqual(expected, mapstr) self.assertEqual(expected, mapstr.replace("||", "|"))
def test_extended_path_tracking__horizontal(self): def test_extended_path_tracking__horizontal(self):
""" """
@ -565,7 +567,7 @@ class TestMap2(_MapTest):
""" """
mapstr = self.map.get_visual_range(coord, dist=dist, mode='nodes', character='@', mapstr = self.map.get_visual_range(coord, dist=dist, mode='nodes', character='@',
max_size=max_size) max_size=max_size)
self.assertEqual(expected, mapstr) self.assertEqual(expected, mapstr.replace("||", "|"))
def test_spawn(self): def test_spawn(self):
""" """
@ -588,7 +590,7 @@ class TestMap3(_MapTest):
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(MAP3_DISPLAY, stripped_map) self.assertEqual(MAP3_DISPLAY, stripped_map.replace("||", "|"))
@parameterized.expand([ @parameterized.expand([
((0, 0), (1, 0), ()), # no node at (1, 0)! ((0, 0), (1, 0), ()), # no node at (1, 0)!
@ -624,7 +626,7 @@ class TestMap3(_MapTest):
""" """
mapstr = self.map.get_visual_range(coord, dist=dist, mode='nodes', character='@', mapstr = self.map.get_visual_range(coord, dist=dist, mode='nodes', character='@',
max_size=max_size) max_size=max_size)
self.assertEqual(expected, mapstr) self.assertEqual(expected, mapstr.replace("||", "|"))
def test_spawn(self): def test_spawn(self):
""" """
@ -647,7 +649,7 @@ class TestMap4(_MapTest):
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(MAP4_DISPLAY, stripped_map) self.assertEqual(MAP4_DISPLAY, stripped_map.replace("||", "|"))
@parameterized.expand([ @parameterized.expand([
((1, 0), (1, 2), ('n',)), # cross + vertically ((1, 0), (1, 2), ('n',)), # cross + vertically
@ -686,7 +688,7 @@ class TestMap5(_MapTest):
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(MAP5_DISPLAY, stripped_map) self.assertEqual(MAP5_DISPLAY, stripped_map.replace("||", "|"))
@parameterized.expand([ @parameterized.expand([
((0, 0), (1, 0), ('e',)), # cross one-way ((0, 0), (1, 0), ('e',)), # cross one-way
@ -723,7 +725,7 @@ class TestMap6(_MapTest):
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(MAP6_DISPLAY, stripped_map) self.assertEqual(MAP6_DISPLAY, stripped_map.replace("||", "|"))
@parameterized.expand([ @parameterized.expand([
((0, 0), (2, 0), ('e', 'e')), # cross one-way ((0, 0), (2, 0), ('e', 'e')), # cross one-way
@ -764,7 +766,7 @@ class TestMap7(_MapTest):
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(MAP7_DISPLAY, stripped_map) self.assertEqual(MAP7_DISPLAY, stripped_map.replace("||", "|"))
@parameterized.expand([ @parameterized.expand([
((1, 0), (1, 2), ('n', )), ((1, 0), (1, 2), ('n', )),
@ -801,7 +803,7 @@ class TestMap8(_MapTest):
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(MAP8_DISPLAY, stripped_map) self.assertEqual(MAP8_DISPLAY, stripped_map.replace("||", "|"))
@parameterized.expand([ @parameterized.expand([
((2, 0), (2, 2), ('n',)), ((2, 0), (2, 2), ('n',)),
@ -831,18 +833,18 @@ class TestMap8(_MapTest):
""" """
mapstr = self.map.get_visual_range(coord, dist=dist, mode='nodes', character='@', mapstr = self.map.get_visual_range(coord, dist=dist, mode='nodes', character='@',
max_size=max_size) max_size=max_size)
self.assertEqual(expected, mapstr) self.assertEqual(expected, mapstr.replace("||", "|"))
@parameterized.expand([ @parameterized.expand([
((2, 2), (3, 2), 1, None, ' #-o \n | \n# o \n| | \no-o-@.#\n | \n o ' ((2, 2), (3, 2), 1, None, ' #-o \n | \n# o \n| | \no-o-@..\n | \n o '
'\n | \n # '), '\n | \n # '),
((2, 2), (5, 3), 1, None, ' #-o \n | \n# o \n| | \no-o-@-#\n . \n . ' ((2, 2), (5, 3), 1, None, ' #-o \n | \n# o \n| | \no-o-@-#\n . \n . '
'\n . \n # '), '\n . \n ...'),
((2, 2), (5, 3), 2, None, '#-#-o \n| \\| \n#-o-o-# #\n| |\\ .\no-o-@-' ((2, 2), (5, 3), 2, None, '#-#-o \n| \\| \n#-o-o-# .\n| |\\ .\no-o-@-'
'# .\n . . \n . . \n . . \n#---... '), '# .\n . . \n . . \n . . \n#---... '),
((5, 3), (2, 2), 2, (13, 7), ' o-o\n | |\n o-@\n .\n# .\n. . '), ((5, 3), (2, 2), 2, (13, 7), ' o-o\n | |\n o-@\n .\n. .\n. . '),
((5, 3), (1, 1), 2, None, ' o-o\n | |\n o-@\n .\n ' ((5, 3), (1, 1), 2, None, ' o-o\n | |\n o-@\n. .\n..... '
'# .\n . . \n . . \n . . \n#---... ') '.\n . . \n . . \n . . \n#---... ')
]) ])
def test_get_visual_range_with_path(self, coord, target, dist, max_size, expected): def test_get_visual_range_with_path(self, coord, target, dist, max_size, expected):
""" """
@ -853,7 +855,7 @@ class TestMap8(_MapTest):
target=target, target_path_style=".", target=target, target_path_style=".",
character='@', character='@',
max_size=max_size) max_size=max_size)
self.assertEqual(expected, mapstr) self.assertEqual(expected, mapstr.replace("||", "|"))
def test_spawn(self): def test_spawn(self):
""" """
@ -876,7 +878,7 @@ class TestMap9(_MapTest):
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(MAP9_DISPLAY, stripped_map) self.assertEqual(MAP9_DISPLAY, stripped_map.replace("||", "|"))
@parameterized.expand([ @parameterized.expand([
((0, 0), (0, 1), ('u',)), ((0, 0), (0, 1), ('u',)),
@ -914,18 +916,19 @@ class TestMap10(_MapTest):
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(MAP10_DISPLAY, stripped_map) self.assertEqual(MAP10_DISPLAY, stripped_map.replace("||", "|"))
# interrupts are only relevant to the auto-stepper
@parameterized.expand([ @parameterized.expand([
((0, 0), (1, 0), ('n', 'e', 's')), ((0, 0), (1, 0), ('n', 'e', 's')),
((3, 0), (3, 1), ()), # the blockage hinders this ((3, 0), (3, 1), ()), # the blockage hinders this
((1, 3), (0, 4), ('e', 'n', 'w', 'w')), ((1, 3), (0, 4), ('e', 'n', 'w', 'w')),
((0, 1), (3, 2), ('e', 'n', 'e')), # path interrupted by I node ((0, 1), (3, 2), ('e', 'n', 'e', 'e')),
((0, 1), (0, 3), ('e', 'n', 'n')), # path interrupted by i link ((0, 1), (0, 3), ('e', 'n', 'n', 'w')),
((1, 3), (0, 3), ()), ((1, 3), (0, 3), ('w',)),
((3, 2), (2, 2), ('w',)), ((3, 2), (2, 2), ('w',)),
((3, 2), (1, 2), ('w',)), ((3, 2), (1, 2), ('w', 'w')),
((3, 3), (0, 3), ('w',)), ((3, 3), (0, 3), ('w', 'w')),
((2, 2), (3, 2), ('e',)), ((2, 2), (3, 2), ('e',)),
]) ])
def test_shortest_path(self, startcoord, endcoord, expected_directions): def test_shortest_path(self, startcoord, endcoord, expected_directions):
@ -938,7 +941,8 @@ class TestMap10(_MapTest):
@parameterized.expand([ @parameterized.expand([
((2, 2), (3, 2), ('e', ), ((2, 2), (2.5, 2), (3, 2))), ((2, 2), (3, 2), ('e', ), ((2, 2), (2.5, 2), (3, 2))),
((3, 3), (0, 3), ('w', ), ((3, 3), (2.5, 3.0), (2.0, 3.0), (1.5, 3.0), (1, 3))), ((3, 3), (0, 3), ('w', 'w'), ((3, 3), (2.5, 3.0), (2.0, 3.0),
(1.5, 3.0), (1, 3), (0.5, 3), (0, 3))),
]) ])
def test_paths(self, startcoord, endcoord, expected_directions, expected_path): def test_paths(self, startcoord, endcoord, expected_directions, expected_path):
""" """
@ -971,7 +975,7 @@ class TestMap11(_MapTest):
def test_str_output(self): def test_str_output(self):
"""Check the display_map""" """Check the display_map"""
stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(self.map).split('\n'))
self.assertEqual(MAP11_DISPLAY, stripped_map) self.assertEqual(MAP11_DISPLAY, stripped_map.replace("||", "|"))
@parameterized.expand([ @parameterized.expand([
((2, 0), (1, 2), ('e', 'nw', 'e')), ((2, 0), (1, 2), ('e', 'nw', 'e')),
@ -1002,8 +1006,8 @@ class TestMap11(_MapTest):
self.assertEqual(expected_path, tuple(strpositions)) self.assertEqual(expected_path, tuple(strpositions))
@parameterized.expand([ @parameterized.expand([
((2, 0), (1, 2), 3, None, '..# \n . \n . . \n . \n @..'), ((2, 0), (1, 2), 3, None, '... \n . \n . . \n . \n @..'),
((1, 2), (2, 0), 3, None, '..@ \n . \n . . \n . \n #..'), ((1, 2), (2, 0), 3, None, '..@ \n . \n . . \n . \n ...'),
]) ])
def test_get_visual_range_with_path(self, coord, target, dist, max_size, expected): def test_get_visual_range_with_path(self, coord, target, dist, max_size, expected):
@ -1164,7 +1168,7 @@ class TestXYZGrid(EvenniaTest):
"""Check the display_map""" """Check the display_map"""
xymap = self.grid.get_map(self.zcoord) xymap = self.grid.get_map(self.zcoord)
stripped_map = "\n".join(line.rstrip() for line in str(xymap).split('\n')) stripped_map = "\n".join(line.rstrip() for line in str(xymap).split('\n'))
self.assertEqual(MAP1_DISPLAY, stripped_map) self.assertEqual(MAP1_DISPLAY, stripped_map.replace("||", "|"))
def test_spawn(self): def test_spawn(self):
"""Spawn objects for the grid""" """Spawn objects for the grid"""
@ -1178,12 +1182,12 @@ class TestXYZGrid(EvenniaTest):
# map transitions # map transitions
class Map12aTransition(map_legend.MapTransitionMapNode): class Map12aTransition(xymap_legend.MapTransitionMapNode):
symbol = "T" symbol = "T"
target_map_xyz = (1, 0, "map12b") target_map_xyz = (1, 0, "map12b")
class Map12bTransition(map_legend.MapTransitionMapNode): class Map12bTransition(xymap_legend.MapTransitionMapNode):
symbol = "T" symbol = "T"
target_map_xyz = (0, 1, "map12a") target_map_xyz = (0, 1, "map12a")
@ -1280,7 +1284,7 @@ class TestBuildExampleGrid(EvenniaTest):
room2b = xyzroom.XYZRoom.objects.get_xyz(xyz=(1, 3, 'the small cave')) room2b = xyzroom.XYZRoom.objects.get_xyz(xyz=(1, 3, 'the small cave'))
self.assertEqual(room1a.key, "Dungeon Entrance") self.assertEqual(room1a.key, "Dungeon Entrance")
self.assertTrue(room1a.db.desc.startswith("To the west")) self.assertTrue(room1a.db.desc.startswith("To the east"))
self.assertEqual(room1b.key, "A gorgeous view") self.assertEqual(room1b.key, "A gorgeous view")
self.assertTrue(room1b.db.desc.startswith("The view from here is breathtaking,")) self.assertTrue(room1b.db.desc.startswith("The view from here is breathtaking,"))
self.assertEqual(room2a.key, "The entrance") self.assertEqual(room2a.key, "The entrance")

26
evennia/contrib/xyzgrid/xymap.py
View file

@ -111,7 +111,7 @@ from evennia.utils import logger
from evennia.prototypes import prototypes as protlib from evennia.prototypes import prototypes as protlib
from .utils import MapError, MapParserError, BIGVAL from .utils import MapError, MapParserError, BIGVAL
from . import map_legend from . import xymap_legend
_CACHE_DIR = settings.CACHE_DIR _CACHE_DIR = settings.CACHE_DIR
_LOADED_PROTOTYPES = None _LOADED_PROTOTYPES = None
@ -121,29 +121,7 @@ MAP_DATA_KEYS = [
"zcoord", "map", "legend", "prototypes", "options", "module_path" "zcoord", "map", "legend", "prototypes", "options", "module_path"
] ]
# these are all symbols used for x,y coordinate spots DEFAULT_LEGEND = xymap_legend.LEGEND
DEFAULT_LEGEND = {
"#": map_legend.BasicMapNode,
"T": map_legend.MapTransitionMapNode,
"I": map_legend.InterruptMapNode,
"|": map_legend.NSMapLink,
"-": map_legend.EWMapLink,
"/": map_legend.NESWMapLink,
"\\": map_legend.SENWMapLink,
"x": map_legend.CrossMapLink,
"+": map_legend.PlusMapLink,
"v": map_legend.NSOneWayMapLink,
"^": map_legend.SNOneWayMapLink,
"<": map_legend.EWOneWayMapLink,
">": map_legend.WEOneWayMapLink,
"o": map_legend.RouterMapLink,
"u": map_legend.UpMapLink,
"d": map_legend.DownMapLink,
"b": map_legend.BlockedMapLink,
"i": map_legend.InterruptMapLink,
't': map_legend.TeleporterMapLink,
}
# -------------------------------------------- # --------------------------------------------
# Map parser implementation # Map parser implementation

34
evennia/contrib/xyzgrid/map_legend.py → evennia/contrib/xyzgrid/xymap_legend.py
View file

@ -1,5 +1,5 @@
""" """
# Map legend components # Map legend comhponents
Each map-legend component is either a 'mapnode' - something that represents and actual in-game Each map-legend component is either a 'mapnode' - something that represents and actual in-game
location (usually a room) or a 'maplink' - something connecting nodes together. The start of a link location (usually a room) or a 'maplink' - something connecting nodes together. The start of a link
@ -1110,7 +1110,8 @@ class BasicMapNode(MapNode):
class InterruptMapNode(MapNode): class InterruptMapNode(MapNode):
"""A point of interest node/room. The pathfinder will always stop here if passing through.""" """A point of interest node/room. Pathfinder will ignore but auto-stepper will
stop here if passing through. Starting from here is fine."""
symbol = "I" symbol = "I"
display_symbol = "#" display_symbol = "#"
interrupt_path = True interrupt_path = True
@ -1218,7 +1219,8 @@ class DownMapLink(UpMapLink):
class InterruptMapLink(InvisibleSmartMapLink): class InterruptMapLink(InvisibleSmartMapLink):
"""A (still passable) link. Pathfinder will always abort before crossing this link.""" """A (still passable) link. Pathfinder will treat this as any link, but auto-stepper
will always abort before crossing this link - so this must be crossed manually."""
symbol = "i" symbol = "i"
interrupt_path = True interrupt_path = True
prototype = "xyz_exit" prototype = "xyz_exit"
@ -1248,3 +1250,29 @@ class TeleporterMapLink(SmartTeleporterMapLink):
one-way link out of the teleporter on one side. one-way link out of the teleporter on one side.
""" """
symbol = 't' symbol = 't'
# all map components; used as base if not overridden
LEGEND = {
# nodes
"#": BasicMapNode,
"T": MapTransitionMapNode,
"I": InterruptMapNode,
# links
"|": NSMapLink,
"-": EWMapLink,
"/": NESWMapLink,
"\\": SENWMapLink,
"x": CrossMapLink,
"+": PlusMapLink,
"v": NSOneWayMapLink,
"^": SNOneWayMapLink,
"<": EWOneWayMapLink,
">": WEOneWayMapLink,
"o": RouterMapLink,
"u": UpMapLink,
"d": DownMapLink,
"b": BlockedMapLink,
"i": InterruptMapLink,
't': TeleporterMapLink,
}