Miroirs/mame
1
0
Fork 0
mirror of https://github.com/mamedev/mame.git synced 2024-11-16 07:48:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Improve abstract class docs

Browse source
This commit is contained in:
angelosa 2021-02-15 00:24:03 +01:00
parent e9906b995b
commit d944c7e7a9
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
regtests/tool_tester/tool_tester/_selfexe.py
View file

@ -24,7 +24,7 @@ class SelfExeTests(ABC):
if it needs finer logging granularity (such as printing with logging.debug) if it needs finer logging granularity (such as printing with logging.debug)
Returns: Returns:
Dict: key for test_handle, value is an arbitrary list or dataclass driven object (preferably latter) Dict: key for test_handle, value is an arbitrary list or dataclass driven object.
""" """
test_pool = self._collect_tests() test_pool = self._collect_tests()
logging.info("Detected %s tests", len(test_pool)) logging.info("Detected %s tests", len(test_pool))
@ -35,7 +35,7 @@ class SelfExeTests(ABC):
"""Mapping fn that the client must override """Mapping fn that the client must override
Returns: Returns:
Dict: key for test_handle, value is an arbitrary list or dataclass driven object (preferably latter) Dict: key for test_handle, value is an arbitrary list or dataclass driven object.
""" """
def execute_tests(self, test_pool: Dict) -> bool: def execute_tests(self, test_pool: Dict) -> bool:
@ -58,8 +58,11 @@ class SelfExeTests(ABC):
__launch_fullpath, __launch_fullpath,
encoding="utf-8", encoding="utf-8",
capture_output=True, capture_output=True,
# TODO: we need to disable check here cause pngcmp has a returncode of 1 when diverging snapshots occurs (wtf) # we need to disable check=True here, it would be hairy to handle
#check=True, # for several reasons, namely:
# - pngcmp returns a status of 1 when diverging snapshots occurs.
# - (eventually) usage instruction test, which technically should return a non-zero status code.
# (which one is tbd)
check=False, check=False,
text=True, text=True,
shell=False shell=False
@ -67,7 +70,7 @@ class SelfExeTests(ABC):
logging.debug("Subprocess test %s pass", __test_name) logging.debug("Subprocess test %s pass", __test_name)
self._assert_test_result(launch_result, test_handle, test_params) self._assert_test_result(launch_result, test_handle, test_params)
logging.info("Test %s passed", __test_name) logging.info("Test %s passed", __test_name)
except (subprocess.CalledProcessError, AssertionError) as ex: except (subprocess.CalledProcessError, AssertionError, FileNotFoundError) as ex:
logging.exception(str(ex)) logging.exception(str(ex))
test_result = False test_result = False
return test_result return test_result
@ -87,7 +90,7 @@ class SelfExeTests(ABC):
@abstractmethod @abstractmethod
def _assert_test_result(self, launch_result: subprocess.CompletedProcess, test_handle: str, test_params: List): def _assert_test_result(self, launch_result: subprocess.CompletedProcess, test_handle: str, test_params: List):
"""Unit test fn an actual test against the resulting output from subprocess """Factory fn for testing out if expected behaviour is satisfied.
A bare minimum is to assert against returncode, stdout and stderr. A bare minimum is to assert against returncode, stdout and stderr.
If you need to check against binary formats give extra carefulness that the test If you need to check against binary formats give extra carefulness that the test