Mercurial > p > roundup > code
annotate test/test_init.py @ 5710:0b79bfcb3312
Add support for making an idempotent POST. This allows retrying a POST
that was interrupted. It involves creating a post once only (poe) url
/rest/data/<class>/@poe/<random_token>. This url acts the same as a
post to /rest/data/<class>. However once the @poe url is used, it
can't be used for a second POST.
To make these changes:
1) Take the body of post_collection into a new post_collection_inner
function. Have post_collection call post_collection_inner.
2) Add a handler for POST to rest/data/class/@poe. This will return a
unique POE url. By default the url expires after 30 minutes. The
POE random token is only good for a specific user and is stored in
the session db.
3) Add a handler for POST to rest/data/<class>/@poe/<random token>.
The random token generated in 2 is validated for proper class (if
token is not generic) and proper user and must not have expired.
If everything is valid, call post_collection_inner to process the
input and generate the new entry.
To make recognition of 2 stable (so it's not confused with
rest/data/<:class_name>/<:item_id>), removed @ from
Routing::url_to_regex.
The current Routing.execute method stops on the first regular
expression to match the URL. Since item_id doesn't accept a POST, I
was getting 405 bad method sometimes. My guess is the order of the
regular expressions is not stable, so sometime I would get the right
regexp for /data/<class>/@poe and sometime I would get the one for
/data/<class>/<item_id>. By removing the @ from the url_to_regexp,
there was no way for the item_id case to match @poe.
There are alternate fixes we may need to look at. If a regexp matches
but the method does not, return to the regexp matching loop in
execute() looking for another match. Only once every possible match
has failed should the code return a 405 method failure.
Another fix is to implement a more sophisticated mechanism so that
@Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'PATCH')
has different regexps for matching <:class_name> <:item_id> and
<:attr_name>. Currently the regexp specified by url_to_regex is used
for every component.
Other fixes:
Made failure to find any props in props_from_args return an empty
dict rather than throwing an unhandled error.
Make __init__ for SimulateFieldStorageFromJson handle an empty json
doc. Useful for POSTing to rest/data/class/@poe with an empty
document.
Testing:
added testPostPOE to test/rest_common.py that I think covers
all the code that was added.
Documentation:
Add doc to rest.txt in the "Client API" section titled: Safely
Re-sending POST". Move existing section "Adding new rest endpoints" in
"Client API" to a new second level section called "Programming the
REST API". Also a minor change to the simple rest client moving the
header setting to continuation lines rather than showing one long
line.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 14 Apr 2019 21:07:11 -0400 |
| parents | 198b6e810c67 |
| children |
| 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 : |
