annotate test/test_init.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 198b6e810c67
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5037
diff changeset
1 #-*- encoding: utf-8 -*-
4816
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
2
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
3 import unittest, os, pprint, difflib, textwrap
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
4
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
5 from roundup.init import loadTemplateInfo
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
6
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
7
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
8 class TemplateInfoTestCase(unittest.TestCase):
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
9 def testLoadTemplateInfo(self):
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
10 path = os.path.join(os.path.dirname(__file__),
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
11 '../share/roundup/templates/classic')
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
12 self.maxDiff = None
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
13 self.assertEqual(
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
14 loadTemplateInfo(path),
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
15 {
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
16 'description': textwrap.dedent('''\
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
17 This is a generic issue tracker that may be used to track bugs,
4818
edb171528a7d init.loadTemplateInfo: replace rfc822 with email.parser (Python 3 compatible)
anatoly techtonik <techtonik@gmail.com>
parents: 4816
diff changeset
18 feature requests, project issues or any number of other types
edb171528a7d init.loadTemplateInfo: replace rfc822 with email.parser (Python 3 compatible)
anatoly techtonik <techtonik@gmail.com>
parents: 4816
diff changeset
19 of issues. Most users of Roundup will find that this template
edb171528a7d init.loadTemplateInfo: replace rfc822 with email.parser (Python 3 compatible)
anatoly techtonik <techtonik@gmail.com>
parents: 4816
diff changeset
20 suits them, with perhaps a few customisations.'''),
4816
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
21 'intended-for': 'All first-time Roundup users',
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
22 'name': 'classic',
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
23 'path': path
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
24 }
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
25 )
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
26
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
27 # vim: set et sts=4 sw=4 :

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