annotate doc/debugging.txt @ 6814:3f60a71b0812

Summary: Support selecion session/otk data store. Add redis as data store. Allow admin to select the backend data store. Compatibility matrix: main\/ session>| anydbm | sqlite | redis | mysql | postgresql | anydbm | D | | X | | | sqlite | X | D | X | | | mysql | | | | D | | postgresql | | | | | D | --------------------------------------------------------------+ D - default if unconfigured, X - compatible choice DETAILS roundup/configuration.py: add config.ini section sessiondb with settings: backend and redis_url. CHANGES.txt, doc/admin_guide.txt, doc/installation.txt, doc/upgrading.txt: doc on config of session db and redis. Plus some other fixes: admin - clarified why we do not drop __words and __testids table in native-fts conversion. TYpo fix. upgrading - doc how you can keep using anydbm for session data with sqlite. Fix dupe sentence in an upgrading config.ini section. roundup/backends/back_anydbm.py, roundup/backends/back_sqlite.py: code to support redis, redis/anydbm backends respectively. roundup/backends/sessions_redis.py new storage backend for redis. roundup/rest.py, roundup/cgi/actions.py, roundup/cgi/templating.py redis uses a different way of calculating lifetime/timestamp. Since expiration of an item occurred if its timestamp was more than 1 week old, code would calculate: now - 1 week + lifetime. But this results in faster expiration in redis if used for lifetime/timestamp. Convert code to use the lifetime() method in BasicDatabase that generates the right timestamp for each backend. test/session_common.py: added tests for more cases, get without default, getall non-existing key etc. timestamp test changed to use new self.get_ts which is overridden in other tests. Test that datatypes survive storage. test/test_redis_session.py: test redis session store with sqlite and anydbm primary databases test/test_anydbm.py, test/test_sqlite.py add test to make sure the databases are properly set up sqlite - add test cases where anydbm is used as datastore anydbm - remove updateTimestamp override add get_ts(). test/test_config.py tests on redis_url and compatibility on choice of sessiondb backend .travis.yml: add redis db and redis-py
author John Rouillard <rouilj@ieee.org>
date Thu, 04 Aug 2022 14:41:58 -0400
parents a635a60ffb84
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
1 Debugging Aids
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
2 --------------
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
3
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
4 Try turning on logging of DEBUG level messages. This may be done a number
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
5 of ways, depending on what it is you're testing:
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
6
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
7 1. If you're testing the database unit tests, then set the environment
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
8 variable ``LOGGING_LEVEL=DEBUG``. This may be done like so:
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
9
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 4377
diff changeset
10 LOGGING_LEVEL=DEBUG python -m pytest test/
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
11
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
12 This variable replaces the older HYPERDBDEBUG environment var.
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
13
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
14 2. If you're testing a particular tracker, then set the logging level in
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
15 your tracker's ``config.ini``.
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
16
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
17 SENDMAILDEBUG
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
18 =============
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
19
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
20 Set to a filename and roundup will write each email message
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
21 that it sends to that file instead to the internet.
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
22 This environment variable is independent of the python -O flag.
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
23

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