annotate test/pytest_patcher.py @ 8446:14c7c07b32d8

feature: add thread local trace_id and trace_reason to logging. Added trace_id to default logging so that all logs for a given request share the same trace_id. This allows correlation of logs across a request. admin_guide.txt, upgrading.txt: add docs update sample configs to include trace_id. rewrite logging docs in admin_guide. Hopefully they are clearer now. clean up some stuff in the logging config file docs. admin.py: add decorators to run_command to enable trace_id. change calls to db.commit() to use run_command to get trace_id. configuration.py: clean up imports. update docstrings, comments and inline docs. add trace_id to default log format. add function for testing decorated with trace_id. add support for dumping stack trace in logging. add check for pytest in sys.modules to enable log propagation when pytest is running. Otherwise tests fail as the caplog logger doesn't see the roundup logs. logcontext.py: new file to handle thread local contextvar mangement. mailgw.py: add decorators for trace_id etc. scripts/roundup_xlmrpc_server.py: add decorators for trace_id etc. fix encoding bug turning bytes into a string. fix command line issue where we can't set encoding. (not sure if changing encoding via command line even works) cgi/client.py decorate two entry points for trace_id etc. cgi/wsgi_handler.py: decorate entry point for trace_id etc. test/test_config.py: add test for trace_id in new log format. test various cases for sinfo and errors in formating msg.
author John Rouillard <rouilj@ieee.org>
date Tue, 16 Sep 2025 22:53:00 -0400
parents 1c94afabb2cb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5109
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
1 """
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
2 The following code was taken from:
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
3
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
4 https://github.com/pytest-dev/pytest/issues/568#issuecomment-216569420
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
5
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
6 to resolve a bug with using pytest.mark.skip(). Once the bug is resolved in
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
7 pytest this file can be removed along with all the wrapper mark_class()
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
8 references in the other test files.
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
9 """
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
10 import types
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
11
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
12
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
13 def mark_class(marker):
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
14 '''Workaround for https://github.com/pytest-dev/pytest/issues/568'''
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
15 def copy_func(f):
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
16 try:
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
17 return types.FunctionType(f.__code__, f.__globals__,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
18 name=f.__name__, argdefs=f.__defaults__,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
19 closure=f.__closure__)
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
20 except AttributeError:
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
21 return types.FunctionType(f.func_code, f.func_globals,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
22 name=f.func_name,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
23 argdefs=f.func_defaults,
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
24 closure=f.func_closure)
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
25
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
26 def mark(cls):
5111
1c94afabb2cb Fix mark_class decorator to work in all cases
John Kristensen <john@jerrykan.com>
parents: 5109
diff changeset
27 if isinstance(cls, types.FunctionType):
1c94afabb2cb Fix mark_class decorator to work in all cases
John Kristensen <john@jerrykan.com>
parents: 5109
diff changeset
28 return marker(copy_func(cls))
1c94afabb2cb Fix mark_class decorator to work in all cases
John Kristensen <john@jerrykan.com>
parents: 5109
diff changeset
29
5109
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
30 for method in dir(cls):
5111
1c94afabb2cb Fix mark_class decorator to work in all cases
John Kristensen <john@jerrykan.com>
parents: 5109
diff changeset
31 if method.startswith('test'):
5109
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
32 f = copy_func(getattr(cls, method))
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
33 setattr(cls, method, marker(f))
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
34 return cls
43a1f7fe39f5 Improved work-around for pytest markers bug
John Kristensen <john@jerrykan.com>
parents:
diff changeset
35 return mark

Roundup Issue Tracker: http://roundup-tracker.org/