Mercurial > p > roundup > code
annotate roundup/test/tx_Source_detector.py @ 7800:2d4684e4702d
fix: enhancement to history command output and % template fix.
Rather than using the key field, use the label field for descriptions.
Call cls.labelprop(default_to_id=True) so it returns id rather than
the first sorted property name.
If labelprop() returns 'id' or 'title', we return nothing. 'id' means
there is no label set and no properties named 'name' or 'title'. So
have the caller do whatever it wants (prepend classname for example)
when there is no human readable name. This prevents %(name)s%(key)s
from producing: 23(23).
Also don't accept the 'title' property. Titles can be too
long. Arguably we could: '%(name)20s' to limit the title
length. However without ellipses or something truncating the title
might be confusing. So again pretend there is no human readable name.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 12 Mar 2024 11:52:17 -0400 |
| parents | 137aabd876ad |
| children | 9c3ec0a5c7fc |
| rev | line source |
|---|---|
| 4781 | 1 # |
| 2 # Example output when the web interface changes item 3 and the email | |
| 3 # (non pgp) interface changes item 4: | |
| 4 # | |
| 5 # tx_SourceCheckAudit(3) pre db.tx_Source: cgi | |
| 6 # tx_SourceCheckAudit(4) pre db.tx_Source: email | |
| 7 # tx_SourceCheckAudit(3) post db.tx_Source: cgi | |
| 8 # tx_SourceCheckAudit(4) post db.tx_Source: email | |
| 9 # tx_SourceCheckReact(4) pre db.tx_Source: email | |
| 10 # tx_SourceCheckReact(4) post db.tx_Source: email | |
| 11 # tx_SourceCheckReact(3) pre db.tx_Source: cgi | |
| 12 # tx_SourceCheckReact(3) post db.tx_Source: cgi | |
| 13 # | |
| 14 # Note that the calls are interleaved, but the proper | |
| 15 # tx_Source is associated with the same ticket. | |
| 16 | |
|
5376
64b05e24dbd8
Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents:
4781
diff
changeset
|
17 from __future__ import print_function |
| 7033 | 18 |
| 4781 | 19 |
| 20 def tx_SourceCheckAudit(db, cl, nodeid, newvalues): | |
| 21 ''' An auditor to print the value of the source of the | |
| 22 transaction that trigger this change. The sleep call | |
| 23 is used to delay the transaction so that multiple changes will | |
| 24 overlap. The expected output from this detector are 2 lines | |
| 25 with the same value for tx_Source. Tx source is: | |
| 26 None - Reported when using a script or it is an error if | |
| 27 the change arrives by another method. | |
| 28 "cli" - reported when using roundup-admin | |
|
5881
9938c40e03bc
Add "rest" and "xmlrpc" values for database tx_Source property
John Rouillard <rouilj@ieee.org>
parents:
5376
diff
changeset
|
29 "web" - reported when using html based web pages |
|
9938c40e03bc
Add "rest" and "xmlrpc" values for database tx_Source property
John Rouillard <rouilj@ieee.org>
parents:
5376
diff
changeset
|
30 "rest" - reported when using the /rest web API |
|
9938c40e03bc
Add "rest" and "xmlrpc" values for database tx_Source property
John Rouillard <rouilj@ieee.org>
parents:
5376
diff
changeset
|
31 "xmlrpc" - reported when using the /xmlrpc web API |
| 4781 | 32 "email" - reported when using an unautheticated email based technique |
| 33 "email-sig-openpgp" - reported when email with a valid pgp | |
| 34 signature is used | |
| 35 ''' | |
| 36 if __debug__ and False: | |
| 7033 | 37 print("\n tx_SourceCheckAudit(%s) db.tx_Source: %s" % ( |
| 38 nodeid, db.tx_Source)) | |
| 4781 | 39 |
| 40 newvalues['tx_Source'] = db.tx_Source | |
| 41 | |
| 42 # example use for real to prevent a change from happening if it's | |
| 43 # submited via email | |
| 44 # | |
| 45 # if db.tx_Source == "email": | |
| 46 # raise Reject, 'Change not allowed via email' | |
| 47 | |
| 7033 | 48 |
| 4781 | 49 def tx_SourceCheckReact(db, cl, nodeid, oldvalues): |
| 50 ''' An reactor to print the value of the source of the | |
| 51 transaction that trigger this change. The sleep call | |
| 52 is used to delay the transaction so that multiple changes will | |
| 53 overlap. The expected output from this detector are 2 lines | |
| 54 with the same value for tx_Source. Tx source is: | |
| 55 None - Reported when using a script or it is an error if | |
| 56 the change arrives by another method. | |
| 57 "cli" - reported when using roundup-admin | |
|
5881
9938c40e03bc
Add "rest" and "xmlrpc" values for database tx_Source property
John Rouillard <rouilj@ieee.org>
parents:
5376
diff
changeset
|
58 "web" - reported when using html based web pages |
|
9938c40e03bc
Add "rest" and "xmlrpc" values for database tx_Source property
John Rouillard <rouilj@ieee.org>
parents:
5376
diff
changeset
|
59 "rest" - reported when using the /rest web API |
|
9938c40e03bc
Add "rest" and "xmlrpc" values for database tx_Source property
John Rouillard <rouilj@ieee.org>
parents:
5376
diff
changeset
|
60 "xmlrpc" - reported when using the /xmlrpc web API |
| 4781 | 61 "email" - reported when using an unautheticated email based technique |
| 62 "email-sig-openpgp" - reported when email with a valid pgp | |
| 63 signature is used | |
| 64 ''' | |
| 65 | |
| 66 if __debug__ and False: | |
| 7033 | 67 print(" tx_SourceCheckReact(%s) db.tx_Source: %s" % ( |
| 68 nodeid, db.tx_Source)) | |
| 4781 | 69 |
| 70 | |
| 71 def init(db): | |
| 72 db.issue.audit('create', tx_SourceCheckAudit) | |
| 73 db.issue.audit('set', tx_SourceCheckAudit) | |
| 74 | |
| 75 db.issue.react('set', tx_SourceCheckReact) | |
| 76 db.issue.react('create', tx_SourceCheckReact) | |
| 77 | |
| 78 db.msg.audit('create', tx_SourceCheckAudit) |