Filtering services by name doesn't work

[Juan Antonio Osorio Robles]

doing a query for listing services filtering by name doesn't work in the SQL backend. This is due to a couple of things:

* 'name' doesn't appear in the filterprotected decorator in keystone.catalog.controllers line 250 (https://github.com/openstack/keystone/blob/d9bfb7a695b3f886dbb961e721bce91194e14cce/keystone/catalog/controllers.py#L250)

* the sql model for the service doesn't have an explicit name attribute in keystone.catalog.backends.sql

This is an issue since some clients (namely python-openstackclient) give the option to create endpoints
with the service name as a parameter (you can give the service id, name or type), even though it is not
possible to retrieve a service from keystone using the name.

[Juan Antonio Osorio Robles (juan-osorio-robles)]

So I would like to know, should I add name as an sql column in the backend to enable this filtering?
Or should filtering by name not be possible and thus, should I then fix it in the python-openstackclient?

[Lance Bragstad (lbragstad)]

It looks like the `name` attribute of a service is stored in the `extra` field of the SQL backend:

http://paste.openstack.org/show/89172/

It looks like the`service` table is never created with a name column:

https://github.com/openstack/keystone/blob/d9bfb7a695b3f886dbb961e721bce91194e14cce/keystone/common/sql/migrate_repo/versions/036_havana.py#L125-L131

One way to fix this would be to add a migration, but the information you need is in the `extra` column of the service table. Until it's decided if a migration is needed or not, maybe find a way to pull the data out of `extra` and filter accordingly?

[Lance Bragstad (lbragstad)]

The `enabled` column seems to have been added to the service table in a subsequent migration:

https://github.com/openstack/keystone/blob/d9bfb7a695b3f886dbb961e721bce91194e14cce/keystone/common/sql/migrate_repo/versions/044_service_enabled.py

[Henry Nash (henry-nash)]

So we don't need to actually create the 'name' field in the SQL to implement filtering by 'name', since the SQL backend is not required to be able to satisfy all the filters - its on a best efforts basis. Any filters it fails to satisfy, will be satisfied in the controller wrapper. This is obviously less efficient, since it is being done in python code instead of using the DB query code, but should still work if we think this filter is infrequently used.

What we MAY need to do in order to just do this at the controller level is fix the TODO I wrote in common/sql/core.py to say that we should check whether the filter exists as a valid column and if it does not, then ignore that filter (and leave it for the controller to carry out when the response is passed back to it)

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/110904

[Dolph Mathews (dolph)]

identity-api impact: https://review.openstack.org/#/c/111818/

[Lance Bragstad (lbragstad)]

This was discussed in the Keystone meeting and we've decided to move forward with the proposed review and include this in Juno RC1.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/110904
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=27f4380fb1bd87154f5b7958c69846545b81ce97
Submitter: Jenkins
Branch: master

commit 27f4380fb1bd87154f5b7958c69846545b81ce97
Author: Juan Antonio Osorio <email address hidden>
Date: Thu Jul 31 13:30:32 2014 +0300

    Enable filtering of services by name

    This commit enables the filtering of services through the service's
    name. This wasn't available before, since the name is not saved in the
    backend as a column, but instead it's stored as an extra attribute.

    Thus, this commits enables this type of search by asserting a TODO that
    was left in the SQL backend, and also adding the `name` attribute to the
    filterprotected decorator.

    This is needed since some clients (namely python-openstackclient) assume
    that this functionality already exists and thus give the option to
    create endpoints with the service name as a parameter.

    Change-Id: Ifc9c1e44e908410740f6f20380b264d35096fcac
    Closes-Bug: #1350273