add test to ensure there are no \r

some of the specs are coming in with literal \r characters,
probably from being created in windows notepad. This makes reading
the specs very cumbersome. We should test against these.

Change-Id: I59ed022e882cfde00c004a66659a43134fd2df5c
This commit is contained in:
Sean Dague 2014-05-09 07:27:04 -04:00
parent f52cf2ffc3
commit e71dedc6b4
2 changed files with 342 additions and 333 deletions

View File

@ -1,333 +1,333 @@
.. ..
This work is licensed under a Creative Commons Attribution 3.0 Unported This work is licensed under a Creative Commons Attribution 3.0 Unported
License. License.
http://creativecommons.org/licenses/by/3.0/legalcode http://creativecommons.org/licenses/by/3.0/legalcode
==================================== ====================================
Nova REST API Sorting Enhancements Nova REST API Sorting Enhancements
==================================== ====================================
https://blueprints.launchpad.net/nova/+spec/nova-pagination https://blueprints.launchpad.net/nova/+spec/nova-pagination
Currently, the pagination support for Nova does not allow the caller to Currently, the pagination support for Nova does not allow the caller to
specify the sort order and direction of the data set. This blueprint specify the sort order and direction of the data set. This blueprint
enhances the pagination support for the /servers and /servers/detail enhances the pagination support for the /servers and /servers/detail
APIs so that multiple sort keys and sort directions can be supplied on APIs so that multiple sort keys and sort directions can be supplied on
the request. the request.
Problem description Problem description
=================== ===================
There is no support for retrieving server data in a specific order, it is There is no support for retrieving server data in a specific order, it is
defaulted to descending sort order by the "created date" and "id" keys. In defaulted to descending sort order by the "created date" and "id" keys. In
order to retrieve data in any sort order and direction, the REST APIs need order to retrieve data in any sort order and direction, the REST APIs need
to accept multiple sort keys and directions. to accept multiple sort keys and directions.
Use Case: A UI that displays a table with only the page of data that it Use Case: A UI that displays a table with only the page of data that it
has retrieved from the server. The items in this table need to be sorted has retrieved from the server. The items in this table need to be sorted
by status first and by display name second. In order to retrieve data in by status first and by display name second. In order to retrieve data in
this order, the APIs must accept multiple sort keys/directions. this order, the APIs must accept multiple sort keys/directions.
Proposed change Proposed change
=============== ===============
The /servers and /servers/detail APIs will support the following parameters The /servers and /servers/detail APIs will support the following parameters
being repeated on the request: being repeated on the request:
* sort_key: Key used to determine sort order * sort_key: Key used to determine sort order
* sort_dir: Direction for with the associated sort key ("asc" or "desc") * sort_dir: Direction for with the associated sort key ("asc" or "desc")
The caller can specify these parameters multiple times in order to generate The caller can specify these parameters multiple times in order to generate
a list of sort keys and sort directions. The first key listed is the primary a list of sort keys and sort directions. The first key listed is the primary
key, the next key is the secondary key, etc. key, the next key is the secondary key, etc.
For example: /servers?sort_key=status&sort_dir=desc&sort_key=display_name& For example: /servers?sort_key=status&sort_dir=desc&sort_key=display_name&
&sort_dir=desc&sort_key=created_at&sort_dir=desc &sort_dir=desc&sort_key=created_at&sort_dir=desc
Note: The "created_at" and "id" sort keys are always appended at the end of Note: The "created_at" and "id" sort keys are always appended at the end of
the key list if they are not already specified on the request. the key list if they are not already specified on the request.
The database layer already supports multiple sort keys and directions. This The database layer already supports multiple sort keys and directions. This
blueprint will update the API layer to retrieve the sort information from blueprint will update the API layer to retrieve the sort information from
the API request and pass that information down to the database layer. the API request and pass that information down to the database layer.
All sorting is handled in the sqlalchemy.utils.paginate_query function. This All sorting is handled in the sqlalchemy.utils.paginate_query function. This
function accepts an ORM model class as an argument and the only valid sort function accepts an ORM model class as an argument and the only valid sort
keys are attributes on the given model class. Therefore, the valid sort keys are attributes on the given model class. Therefore, the valid sort
keys are limited to the model attributes on the models.Instance class. keys are limited to the model attributes on the models.Instance class.
For the v2 API a new 'os-server-sort-keys' API extension will be created to For the v2 API a new 'os-server-sort-keys' API extension will be created to
signify that the new sorting parameters proposed in this blueprint should be signify that the new sorting parameters proposed in this blueprint should be
honored. The v3 API will support the new sorting parameters by default. honored. The v3 API will support the new sorting parameters by default.
Alternatives Alternatives
------------ ------------
Repeating parameter key/values was chosen because glance already did it: Repeating parameter key/values was chosen because glance already did it:
https://github.com/openstack/glance/blob/master/glance/api/v2/images.py#L526 https://github.com/openstack/glance/blob/master/glance/api/v2/images.py#L526
However, the list of sort keys and directions could be built by splitting the However, the list of sort keys and directions could be built by splitting the
associated parameter values. associated parameter values.
For example: For example:
/servers?sort_key=status,display_name,created_at&sort_dir=desc,desc,desc /servers?sort_key=status,display_name,created_at&sort_dir=desc,desc,desc
The downside of this approach is that it would require pre-defined token The downside of this approach is that it would require pre-defined token
characters. I'm open to this solution if it is deemed better. characters. I'm open to this solution if it is deemed better.
Data model impact Data model impact
----------------- -----------------
None None
REST API impact REST API impact
--------------- ---------------
A new v2 API extension will be created to signify that the new sorting A new v2 API extension will be created to signify that the new sorting
parameters should be honored. Extension details: parameters should be honored. Extension details:
* Name: ServerSortKeys * Name: ServerSortKeys
* Alias: os-server-sort-keys * Alias: os-server-sort-keys
Note that this API extension will behave in the same manner as the current Note that this API extension will behave in the same manner as the current
'os-user-data' extension. For example, the extension is defined as: 'os-user-data' extension. For example, the extension is defined as:
http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/compute http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/compute
/contrib/user_data.py /contrib/user_data.py
And it is checked in the v2 server API here: And it is checked in the v2 server API here:
http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/compute/ http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/compute/
servers.py#n850 servers.py#n850
The following existing v2 GET APIs will support the new sorting parameters The following existing v2 GET APIs will support the new sorting parameters
if the 'os-server-sort-keys' API extenstion is loaded: if the 'os-server-sort-keys' API extenstion is loaded:
* /v2/{tenant_id}/servers * /v2/{tenant_id}/servers
* /v2/{tenant_id}/servers/detail * /v2/{tenant_id}/servers/detail
The following existing v3 GET APIs will support the new sorting parameters The following existing v3 GET APIs will support the new sorting parameters
by default: by default:
* /v3/servers * /v3/servers
* /v3/servers/details * /v3/servers/details
Note that the design described in this blueprint could be applied to other GET Note that the design described in this blueprint could be applied to other GET
REST APIs but this blueprint is scoped to only those listed above. Once this REST APIs but this blueprint is scoped to only those listed above. Once this
design is finalized, then the same approach could be applied to other APIs. design is finalized, then the same approach could be applied to other APIs.
The existing API documentation needs to be updated to include the following The existing API documentation needs to be updated to include the following
new Request Parameters: new Request Parameters:
+-----------+-------+--------+---------------------------------------------+ +-----------+-------+--------+---------------------------------------------+
| Parameter | Style | Type | Description | | Parameter | Style | Type | Description |
+===========+=======+========+=============================================+ +===========+=======+========+=============================================+
| sort_key | query | string | Sort key (repeated for multiple), keys | | sort_key | query | string | Sort key (repeated for multiple), keys |
| | | | default to 'created_at' and 'id' | | | | | default to 'created_at' and 'id' |
+-----------+-------+--------+---------------------------------------------+ +-----------+-------+--------+---------------------------------------------+
| sort_dir | query | string | Sort direction, either 'asc' or 'desc' | | sort_dir | query | string | Sort direction, either 'asc' or 'desc' |
| | | | (repeated for multiple), defaults to 'desc' | | | | | (repeated for multiple), defaults to 'desc' |
+-----------+-------+--------+---------------------------------------------+ +-----------+-------+--------+---------------------------------------------+
Neither the API response format nor the return codes will be modified, only Neither the API response format nor the return codes will be modified, only
the order of the servers that are returned. the order of the servers that are returned.
In the event that an invalid sort key is specifed then a "badRequest" error In the event that an invalid sort key is specifed then a "badRequest" error
response (code 400) will be returned with a message like "Invalid input response (code 400) will be returned with a message like "Invalid input
received: Invalid sort key". received: Invalid sort key".
Security impact Security impact
--------------- ---------------
None None
Notifications impact Notifications impact
-------------------- --------------------
None None
Other end user impact Other end user impact
--------------------- ---------------------
The novaclient should be updated to accept sort keys and sort directions, new The novaclient should be updated to accept sort keys and sort directions, new
parameters: parameters:
+-------------+----------------------------------------------------------+ +-------------+----------------------------------------------------------+
| Parameter | Description | | Parameter | Description |
+=============+==========================================================+ +=============+==========================================================+
| --sort-keys | Comma-separated list of sort keys used to specify server | | --sort-keys | Comma-separated list of sort keys used to specify server |
| | ordering. Each key must be paired with a sort direction | | | ordering. Each key must be paired with a sort direction |
| | value. | | | value. |
+-------------+----------------------------------------------------------+ +-------------+----------------------------------------------------------+
| --sort-dirs | Comma-separated list of sort directions used to specify | | --sort-dirs | Comma-separated list of sort directions used to specify |
| | server ordering. Each key Must be paired with a sort key | | | server ordering. Each key Must be paired with a sort key |
| | value. Valid values are 'asc' and 'desc'. | | | value. Valid values are 'asc' and 'desc'. |
+-------------+----------------------------------------------------------+ +-------------+----------------------------------------------------------+
Performance Impact Performance Impact
------------------ ------------------
All sorting will be done in the database. The choice of sort keys is limited All sorting will be done in the database. The choice of sort keys is limited
to attributes on the models.Instance ORM class -- not every attribute key to attributes on the models.Instance ORM class -- not every attribute key
returned from a detailed query is a valid sort key. returned from a detailed query is a valid sort key.
Performance data was gathered by running on a simple devstack VM with 2GB Performance data was gathered by running on a simple devstack VM with 2GB
memory. 5000 instances were inserted into the DB. The data shows that the memory. 5000 instances were inserted into the DB. The data shows that the
sort time on the main data table is dwarfed (see first table below) when sort time on the main data table is dwarfed (see first table below) when
running a detailed query -- most of the time is spent querying the the other running a detailed query -- most of the time is spent querying the the other
tables for each item; therefore, the impact of the sort key on a detailed tables for each item; therefore, the impact of the sort key on a detailed
query is minimal. query is minimal.
For example, the data below compares the processing time of a GET request for For example, the data below compares the processing time of a GET request for
a non-detailed query to a detailed query with various limits using the default a non-detailed query to a detailed query with various limits using the default
sort keys. The purpose of this table is to show the the processing time for a sort keys. The purpose of this table is to show the the processing time for a
detailed query is dominated by getting the additional details for each item. detailed query is dominated by getting the additional details for each item.
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| Limit | Non-Detailed (sec) | Detailed (sec) | Non-Detailed / Detailed % | | Limit | Non-Detailed (sec) | Detailed (sec) | Non-Detailed / Detailed % |
+=======+====================+================+===========================+ +=======+====================+================+===========================+
| 50 | 0.0560 | 0.8621 | 6.5% | | 50 | 0.0560 | 0.8621 | 6.5% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 100 | 0.0813 | 1.6839 | 4.8% | | 100 | 0.0813 | 1.6839 | 4.8% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 150 | 0.0848 | 2.4705 | 3.4% | | 150 | 0.0848 | 2.4705 | 3.4% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 200 | 0.0874 | 3.2502 | 2.7% | | 200 | 0.0874 | 3.2502 | 2.7% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 250 | 0.0985 | 4.1237 | 2.4% | | 250 | 0.0985 | 4.1237 | 2.4% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 300 | 0.1229 | 4.8731 | 2.5% | | 300 | 0.1229 | 4.8731 | 2.5% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 350 | 0.1262 | 5.6366 | 2.2% | | 350 | 0.1262 | 5.6366 | 2.2% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 400 | 0.1282 | 6.5573 | 2.0% | | 400 | 0.1282 | 6.5573 | 2.0% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 450 | 0.1458 | 7.2921 | 2.0% | | 450 | 0.1458 | 7.2921 | 2.0% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 500 | 0.1770 | 8.1126 | 2.2% | | 500 | 0.1770 | 8.1126 | 2.2% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
| 1000 | 0.2589 | 16.0844 | 1.6% | | 1000 | 0.2589 | 16.0844 | 1.6% |
+-------+--------------------+----------------+---------------------------+ +-------+--------------------+----------------+---------------------------+
Non-detailed query data was also gathered. The table below compares the Non-detailed query data was also gathered. The table below compares the
processing time using default sort keys to the processing using display_name processing time using default sort keys to the processing using display_name
as the sort key. Items were added with a 40 character display_name that was as the sort key. Items were added with a 40 character display_name that was
generated in an out-of-alphabetical sort order. generated in an out-of-alphabetical sort order.
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| Limit | Default keys (sec) | display_name key (sec) | Slowdown % | | Limit | Default keys (sec) | display_name key (sec) | Slowdown % |
+=======+====================+========================+============+ +=======+====================+========================+============+
| 50 | 0.0560 | 0.0600 | 7.1% | | 50 | 0.0560 | 0.0600 | 7.1% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 100 | 0.0813 | 0.0832 | 2.3% | | 100 | 0.0813 | 0.0832 | 2.3% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 150 | 0.0848 | 0.0879 | 3.7% | | 150 | 0.0848 | 0.0879 | 3.7% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 200 | 0.0874 | 0.0906 | 3.7% | | 200 | 0.0874 | 0.0906 | 3.7% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 250 | 0.0985 | 0.1031 | 4.7% | | 250 | 0.0985 | 0.1031 | 4.7% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 300 | 0.1229 | 0.1198 | -2.5% | | 300 | 0.1229 | 0.1198 | -2.5% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 350 | 0.1262 | 0.1319 | 4.5% | | 350 | 0.1262 | 0.1319 | 4.5% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 400 | 0.1282 | 0.1368 | 6.7% | | 400 | 0.1282 | 0.1368 | 6.7% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 450 | 0.1458 | 0.1458 | 0.0% | | 450 | 0.1458 | 0.1458 | 0.0% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 500 | 0.1770 | 0.1619 | -8.5% | | 500 | 0.1770 | 0.1619 | -8.5% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
| 1000 | 0.2589 | 0.2659 | 2.7% | | 1000 | 0.2589 | 0.2659 | 2.7% |
+-------+--------------------+------------------------+------------+ +-------+--------------------+------------------------+------------+
In conclusion, the sort processing on the main data table has minimal impact In conclusion, the sort processing on the main data table has minimal impact
on the overall processing time. For a detailed query, the sort time is dwarfed on the overall processing time. For a detailed query, the sort time is dwarfed
by other processing -- even if the sort time when up 3x it would only by other processing -- even if the sort time when up 3x it would only
represent 4.8% of the total processing time for a detailed query with a limit represent 4.8% of the total processing time for a detailed query with a limit
of 1000 (and only increase the processing time by .11 sec with a limit of 50). of 1000 (and only increase the processing time by .11 sec with a limit of 50).
Other deployer impact Other deployer impact
--------------------- ---------------------
The choice of sort keys has a minimal impact on data retrieval performance The choice of sort keys has a minimal impact on data retrieval performance
(see performance data above). Therefore, the user should be allowed to (see performance data above). Therefore, the user should be allowed to
retrieve data in whatever order they need to for creating their views (see retrieve data in whatever order they need to for creating their views (see
use case in the Problem Description). use case in the Problem Description).
Developer impact Developer impact
---------------- ----------------
None None
Implementation Implementation
============== ==============
Assignee(s) Assignee(s)
----------- -----------
Primary assignee: Primary assignee:
Steven Kaufer Steven Kaufer
Other contributors: Other contributors:
None None
Work Items Work Items
---------- ----------
Ideally the logic for processing the sort parameters would be common to all Ideally the logic for processing the sort parameters would be common to all
components and would be done in oslo; a similar blueprint is also being components and would be done in oslo; a similar blueprint is also being
proposed in cinder: proposed in cinder:
https://blueprints.launchpad.net/cinder/+spec/cinder-pagination https://blueprints.launchpad.net/cinder/+spec/cinder-pagination
Therefore, I see the following work items: Therefore, I see the following work items:
* Create common functions to process the API parameters and create a list of * Create common functions to process the API parameters and create a list of
sort keys and directions sort keys and directions
* Update v2 and v3 APIs to retrieve the sort information and pass down to the * Update v2 and v3 APIs to retrieve the sort information and pass down to the
DB layer (requires changes to compute/api.py, objects/instance.py, DB layer (requires changes to compute/api.py, objects/instance.py,
db/api.py, and db\sqlalchemy\api.py) db/api.py, and db\sqlalchemy\api.py)
* Update the novaclient to accept and process multiple sort keys and sort * Update the novaclient to accept and process multiple sort keys and sort
directions directions
Dependencies Dependencies
============ ============
* Related (but independent) change being proposed in cinder: * Related (but independent) change being proposed in cinder:
https://blueprints.launchpad.net/cinder/+spec/cinder-pagination https://blueprints.launchpad.net/cinder/+spec/cinder-pagination
Testing Testing
======= =======
Both unit and Tempest tests need to be created to ensure that the data is Both unit and Tempest tests need to be created to ensure that the data is
retrieved in the specified sort order. Tests should also verify that the retrieved in the specified sort order. Tests should also verify that the
default sort keys ("created_at" and "id") are always appended to the user default sort keys ("created_at" and "id") are always appended to the user
supplied keys (if the user did not already specify them). supplied keys (if the user did not already specify them).
Testing should be done against multiple backend database types. Testing should be done against multiple backend database types.
Documentation Impact Documentation Impact
==================== ====================
The /servers and /servers/detail API documentation will need to be updated to: The /servers and /servers/detail API documentation will need to be updated to:
- Reflect the new sorting parameters and explain that these parameters will - Reflect the new sorting parameters and explain that these parameters will
affect the order in which the data is returned. affect the order in which the data is returned.
- Explain how the default sort keys will always be added at the end of the - Explain how the default sort keys will always be added at the end of the
sort key list sort key list
The documentation could also note that query performance will be affected by The documentation could also note that query performance will be affected by
the choice of the sort key, noting which keys are indexed. the choice of the sort key, noting which keys are indexed.
References References
========== ==========
None None

View File

@ -11,6 +11,7 @@
# under the License. # under the License.
import glob import glob
import re
import docutils.core import docutils.core
import testtools import testtools
@ -80,6 +81,13 @@ class TestTitles(testtools.TestCase):
msg="%s:%d: Line limited to a maximum of 79 characters." % msg="%s:%d: Line limited to a maximum of 79 characters." %
(tpl, i+1)) (tpl, i+1))
def _check_no_cr(self, tpl, raw):
matches = re.findall('\r', raw)
self.assertEqual(
len(matches), 0,
"Found %s literal carriage returns in file %s" %
(len(matches), tpl))
def test_template(self): def test_template(self):
files = ['specs/template.rst'] + glob.glob('specs/*/*') files = ['specs/template.rst'] + glob.glob('specs/*/*')
for filename in files: for filename in files:
@ -92,3 +100,4 @@ class TestTitles(testtools.TestCase):
titles = self._get_titles(spec) titles = self._get_titles(spec)
self._check_titles(titles) self._check_titles(titles)
self._check_lines_wrapping(filename, data) self._check_lines_wrapping(filename, data)
self._check_no_cr(filename, data)