Skip to content

Improve test report formatting #5018

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
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Improve test report formatting #5018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d2d36c6
Improve test report formatting
Flamefire Oct 7, 2025
822faeb
make extended status bold
Flamefire Oct 7, 2025
1c32d9e
Fix formatting
Flamefire Oct 7, 2025
8b92e94
Adapt test
Flamefire Oct 7, 2025
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
20 changes: 12 additions & 8 deletions easybuild/tools/testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,20 +237,21 @@ def create_test_report(msg, ecs_with_res, init_session_state, pr_nrs=None, gist_
else:
build_overview = ["#### Overview of tested easyconfigs (in order)"]
for (ec, ec_res) in ecs_with_res:
test_log = ''
additional_info = ''
if ec_res.get('success', False):
test_result = 'SUCCESS'
error_descr = ''
else:
test_result = 'FAIL'
# compose test result string
test_result = 'FAIL '
if 'err' in ec_res:
if isinstance(ec_res['err'], EasyBuildError):
test_result += '(build issue)'
error_descr = '(build issue)'
else:
test_result += '(unhandled exception: %s)' % ec_res['err']
test_result += ec_res['traceback']
error_descr = '(unhandled exception: `%s`)' % ec_res['err']
additional_info = f"```{ec_res['traceback']}\n```"
else:
test_result += '(unknown cause, not an exception?!)'
error_descr = '(unknown cause, not an exception?!)'

# create gist for log file (if desired and available)
if gist_log and 'log_file' in ec_res:
Expand All @@ -266,9 +267,12 @@ def create_test_report(msg, ecs_with_res, init_session_state, pr_nrs=None, gist_

fn = '%s_partial.log' % os.path.basename(ec['spec'])[:-3]
gist_url = create_gist(partial_log_txt, fn, descr=descr, github_user=github_user)
test_log = "(partial log available at %s)" % gist_url
additional_info += f"(partial log available at {gist_url})"

build_overview.append(" * **%s** _%s_ %s" % (test_result, os.path.basename(ec['spec']), test_log))
filename = os.path.basename(ec['spec'])
if error_descr:
error_descr = f"**{error_descr}**" # Make bold if set
build_overview.append(f" * **{test_result}** _{filename}_ {error_descr}\n {additional_info}")
build_overview.append("")
test_report.extend(build_overview)

Expand Down
2 changes: 1 addition & 1 deletion test/framework/github.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1355,7 +1355,7 @@ def test_github_create_test_report(self):
res = create_test_report("just a test", ecs_with_res, init_session_state)
patterns = [
"**SUCCESS** _test.eb_",
"**FAIL (build issue)** _fail.eb_",
"**FAIL** _fail.eb_ **(build issue)**",
"01 Jan 1970 00:00:00",
"EASYBUILD_DEBUG=1",
"USER = test",
Expand Down