Skip to content

[bugfix] Fix formatting of lists of non-string objects when logging #1649

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

Merged
merged 2 commits into from
Dec 10, 2020
Merged

[bugfix] Fix formatting of lists of non-string objects when logging #1649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
485b871
Fix formatting of lists of non-string objects when logging
Dec 10, 2020
2a00db6
Merge branch 'master' into bugfix/log-format-crash
Dec 10, 2020
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
11 changes: 7 additions & 4 deletions reframe/core/logging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,14 +166,17 @@ def _format_time_rfc3339(timestamp, datefmt):


def _xfmt(val):
if isinstance(val, str):
return val
def _dofmt(v):
if isinstance(v, str):
return v
else:
return jsonext.dumps(v)

# NOTE: This is for compatibility with older formatting
if isinstance(val, (list, tuple, set)):
return ','.join(val)
return ','.join(_dofmt(v) for v in val)

return jsonext.dumps(val)
return _dofmt(val)


class CheckFieldFormatter(logging.Formatter):
Expand Down
5 changes: 3 additions & 2 deletions unittests/test_logging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def error():
'fakejob')
test.job._completion_time = time.time()
test.custom = 'hello extras'
test.custom_list = ['custom', 'attr']
test.custom_list = ['custom', 3.0, ['hello', 'world']]
test.custom_dict = {'a': 1, 'b': 2}
test.deferred = sn.defer('hello')
test.deferred_error = error()
Expand Down Expand Up @@ -163,7 +163,8 @@ def test_logger_dynamic_attributes(logfile, logger_with_check):
logger_with_check.logger.handlers[0].setFormatter(formatter)
logger_with_check.info('xxx')
assert _pattern_in_logfile(
r'hello extras\|custom,attr\|null\|{"a": 1, "b": 2}', logfile
r'hello extras\|custom,3.0,\["hello", "world"\]\|null\|'
r'{"a": 1, "b": 2}', logfile
)


Expand Down