steffen/marl-factory-grid
1
0
Fork 0
mirror of https://github.com/illiumst/marl-factory-grid.git synced 2025-07-05 09:01:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

finished documenmtation of steptests and test

Browse Source
This commit is contained in:
Joel Friedrich
2023-12-29 10:45:10 +01:00
parent 78e1d5b4fc
commit ecf53e7d64
2 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
marl_factory_grid/environment/tests.py
View File

@ -17,7 +17,8 @@ class Test(unittest.TestCase):
def __init__(self): def __init__(self):
""" """
Base test class for unit tests. Base test class for unit tests that provides base functions to be overwritten that are automatically called by
the StepTests class.
""" """
super().__init__() super().__init__()
@ -56,7 +57,7 @@ class MaintainerTest(Test):
def tick_step(self, state) -> List[TickResult]: def tick_step(self, state) -> List[TickResult]:
for maintainer in state.entities[M.MAINTAINERS]: for maintainer in state.entities[M.MAINTAINERS]:
# has valid actionresult # has valid action result
self.assertIsInstance(maintainer.state, ActionResult) self.assertIsInstance(maintainer.state, ActionResult)
# self.assertEqual(maintainer.state.validity, True) # self.assertEqual(maintainer.state.validity, True)
# print(f"state validity {maintainer.state.validity}") # print(f"state validity {maintainer.state.validity}")

21
marl_factory_grid/utils/states.py
View File

@ -309,6 +309,9 @@ class Gamestate(object):
class StepTests: class StepTests:
def __init__(self, *args): def __init__(self, *args):
"""
The StepTests class is responsible for calling all tests and their respective hooks at the right time.
"""
if args: if args:
self.tests = list(args) self.tests = list(args)
else: else:
@ -326,6 +329,12 @@ class StepTests:
return True return True
def do_all_init(self, state, lvl_map) -> bool: def do_all_init(self, state, lvl_map) -> bool:
"""
Iterate all **Tests** that override the *on_check_done* hook.
:return: valid
:rtype: bool
"""
for test in self.tests: for test in self.tests:
if test_init_printline := test.on_init(state, lvl_map): if test_init_printline := test.on_init(state, lvl_map):
state.print(test_init_printline) state.print(test_init_printline)
@ -335,11 +344,7 @@ class StepTests:
""" """
Iterate all **Tests** that override the *tick_step* hook. Iterate all **Tests** that override the *tick_step* hook.
:return: List of Results :return: List of Results
""" """
Iterate all **Tests** that override the *on_check_done* hook.
:return: List of Results
""" """
test_results = list() test_results = list()
for test in self.tests: for test in self.tests:
@ -351,7 +356,7 @@ class StepTests:
""" """
Iterate all **Tests** that override the *pre_step* hook. Iterate all **Tests** that override the *pre_step* hook.
:return: List of Results :return: List of Results
""" """
test_results = list() test_results = list()
for test in self.tests: for test in self.tests:
@ -363,7 +368,7 @@ class StepTests:
""" """
Iterate all **Tests** that override the *post_step* hook. Iterate all **Tests** that override the *post_step* hook.
:return: List of Results :return: List of Results
""" """
test_results = list() test_results = list()
for test in self.tests: for test in self.tests:
@ -375,7 +380,7 @@ class StepTests:
""" """
Iterate all **Tests** that override the *on_check_done* hook. Iterate all **Tests** that override the *on_check_done* hook.
:return: List of Results :return: List of Results
""" """
test_results = list() test_results = list()
for test in self.tests: for test in self.tests: