Skip to content

mutest: improved traceback printing #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
liambrady wants to merge 1 commit into
base: main
Choose a base branch
from
Open

mutest: improved traceback printing #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions munet/mutest/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,16 +323,23 @@ async def run_tests(args):
passed, failed, e = await execute_test(
unet, test, args, tnum, exec_handler
)

if e is not None and not isinstance(e, uapi.CLIOnErrorError):
e_tb = e.__traceback__
e_info = (type(e), e, e_tb)
logging.error(
"Script error executing test %s: %s", test, e, exc_info=e_info
)
except KeyboardInterrupt as error:
errlog.warning("KeyboardInterrupt while running test %s", test_name)
passed, failed, e = 0, 0, error
raise
except Exception as error:
logging.error(
"Error executing test %s: %s", test, error, exc_info=True
)
errlog.error(
"Error executing test %s: %s", test, error, exc_info=True
"Internal error executing test %s: %s", test, error, exc_info=True
)
logging.error(
"Internal error executing test %s: %s", test, error, exc_info=True
)
passed, failed, e = 0, 0, error
finally:
Expand Down
95 changes: 54 additions & 41 deletions munet/mutest/userapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,9 +268,13 @@ def execute(self):
"""
assert TestCase.g_tc is None
self.oplogf("execute")
e = None
try:
TestCase.g_tc = self
e = self.__exec_script(self.info.path, True, False)
self.__exec_script(self.info.path, True, False)
except ScriptError as err:
# 'Unwrap' the ScriptError when possible
e = err.__cause__ if err.__cause__ is not None else err
except BaseException:
self.__end_test()
raise
Expand Down Expand Up @@ -344,11 +348,14 @@ def __exec_script(self, path, print_header, add_newline):
+ "\n return ok_result\n"
+ "\n"
)
exec(s2)
exec_locals = {}
# Ensures that Traceback paths are the file path (and not "<string>")
code = compile(s2, str(path), "exec")
exec(code, globals(), exec_locals)

# Extract any docstring as a title.
if print_header:
title = locals()[f"_{name}"].__doc__
title = exec_locals[f"_{name}"].__doc__
if title is None:
title = ""
title = title.lstrip()
Expand All @@ -360,26 +367,33 @@ def __exec_script(self, path, print_header, add_newline):
self.__print_header(self.info.tag, title, add_newline)
self.__space_before_result = False

# Execute the function.
result = locals()[f"_{name}"](_ok_result)
# Execute the function after fixing Traceback line numbers
func = exec_locals[f"_{name}"]
func.__code__ = func.__code__.replace(
co_filename=str(path),
co_firstlineno=0,
)
result = func(_ok_result)

# Here's where we can do async in the future if we want.
# result = await locals()[f"_{name}"](_ok_result)
except ScriptError as error:
return error
except ScriptError:
# The current script has include()'ed a subordinate script and that script has raised
# a ScriptError. We should continue to pass the error back upwards.
raise
except CLIOnErrorError:
raise
except Exception as error:
logging.error(
"Unexpected exception executing %s: %s", name, error, exc_info=True
)
return error
# Pop the 'func(_ok_result)' frame off of the traceback
tb = error.__traceback__
if tb is not None and tb.tb_next is not None:
tb = tb.tb_next
raise ScriptError("Mutest script error") from error.with_traceback(tb)
else:
if result is not _ok_result:
logging.info("%s returned early, result: %s", name, result)
else:
self.oplogf("__exec_script: name %s completed normally", name)
return None

def __post_result(self, target, success, rstr, logstr=None):
self.oplogf(
Expand Down Expand Up @@ -681,41 +695,40 @@ def include(self, pathname: str, new_section: bool = False):
self.oplogf("include: swapped info path: new %s old %s", path, old_path)

try:
e = self.__exec_script(
path, print_header=new_section, add_newline=new_section
self.__exec_script(
path, print_header=new_section, add_newline=new_section,
)
except ScriptError:
# The include()'ed script or one if it's subordinate scripts threw an error. We should
# continue to pass the error back upwards.
raise
except CLIOnErrorError:
do_cli = True
raise
finally:
if new_section:
# Something within the section creating include has also created a section
# end it, sections do not cross section creating file boundaries
if self.__in_section:
self.oplogf(
"include done: path: %s __in_section calling __end_section", path
)
self.__end_section()

# We should now be back to the info we started with, b/c we don't actually
# start a new section (__in_section) that then could have been ended inside
# the included file.
assert our_info == self.info

if new_section:
# Something within the section creating include has also created a section
# end it, sections do not cross section creating file boundaries
if self.__in_section:
self.oplogf(
"include done: path: %s __in_section calling __end_section", path
"include done: path: %s new_section calling __end_section", path
)
self.__end_section()

# We should now be back to the info we started with, b/c we don't actually
# start a new section (__in_section) that then could have been ended inside
# the included file.
assert our_info == self.info

self.oplogf(
"include done: path: %s new_section calling __end_section", path
)
self.__end_section()
else:
# The current top path could be anything due to multiple inline includes as
# well as section swap in and out. Forcibly return the top path to the file
# we are returning to
self.info.path = old_path
self.oplogf("include: restored info path: %s", old_path)

if do_cli:
raise CLIOnErrorError()

@choppsv1 choppsv1 Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So how is the CLI on error handled since this is being removed?

@liambrady liambrady Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is re-raised on line 706

if e:
raise ScriptError(e)
else:
# The current top path could be anything due to multiple inline includes as
# well as section swap in and out. Forcibly return the top path to the file
# we are returning to
self.info.path = old_path
self.oplogf("include: restored info path: %s", old_path)

def __end_section(self):
self.oplogf("__end_section: __in_section: %s", self.__in_section)
Expand Down
Loading