Mercurial > p > roundup > code
annotate doc/debugging.txt @ 4781:6e9b9743de89
Implementation for:
http://issues.roundup-tracker.org/issue2550731
Add mechanism for the detectors to be able to tell the source of the
data changes.
Support for tx_Source property on database handle. Can be
used by detectors to find out the source of a change in an auditor to
block changes arriving by unauthenticated mechanisms (e.g. plain email
where headers can be faked). The property db.tx_Source has the
following values:
* None - Default value set to None. May be valid if it's a script
that is created by the user. Otherwise it's an error and indicates
that some code path is not properly setting the tx_Source property.
* "cli" - this string value is set when using roundup-admin and
supplied scripts.
* "web" - this string value is set when using any web based
technique: html interface, xmlrpc ....
* "email" - this string value is set when using an unauthenticated
email based technique.
* "email-sig-openpgp" - this string value is set when email with a
valid pgp signature is used. (*NOTE* the testing for this mode
is incomplete. If you have a pgp infrastructure you should test
and verify that this is properly set.)
This also includes some (possibly incomplete) tests cases for the
modes above and an example of using ts_Source in the customization.txt
document.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 23 Apr 2013 23:06:09 -0400 |
| parents | b6f1aaba4827 |
| children | a635a60ffb84 |
| 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 |
|
4377
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
10 LOGGING_LEVEL=DEBUG python run_tests.py |
|
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 |
